Sentiment von Feedback mit der Google Cloud Natural Language API analysieren

Programmierkenntnisse: Mittelstufe
Dauer: 20 Minuten
Projekttyp: Automatisierung mit einem benutzerdefinierten Menü

Ziele

Verstehen Sie, was die Lösung bewirkt.
Verstehen, wie die Apps Script-Dienste in der Lösung funktionieren.
die Umgebung einrichten
Das Script einrichten.
Das Script ausführen.

Informationen zu dieser Lösung

Sie können Textdaten wie ergebnisoffenes Feedback in großem Umfang analysieren. Um Entitäts- und Sentimentanalysen in Google Tabellen durchzuführen, wird in dieser Lösung der UrlFetch-Dienst verwendet, um eine Verbindung zur Google Cloud Natural Language API herzustellen.

Abbildung zur Funktionsweise der Sentimentanalyse

Funktionsweise

Das Skript ruft Text aus der Tabelle ab und stellt eine Verbindung zur Google Cloud Natural Language API her, um die im String enthaltenen Entitäten und das Sentiment zu analysieren. In einer Pivot-Tabelle wird der durchschnittliche Sentiment-Score für jede erwähnte Einheit in allen Zeilen der Textdaten zusammengefasst.

Apps Script-Dienste

Für diese Lösung werden die folgenden Dienste verwendet:

Tabellendienst: Sendet die Textdaten an die Google Cloud Natural Language API und markiert jede Zeile als „Abgeschlossen“, sobald ihr Sentiment analysiert wurde.
UrlFetch-Dienst: Stellt eine Verbindung zur Google Cloud Natural Language API her, um eine Entitäts- und Sentimentanalyse des Texts durchzuführen.

Vorbereitung

Für dieses Beispiel müssen die folgenden Voraussetzungen erfüllt sein:

Ein Google-Konto (für Google Workspace-Konten ist möglicherweise die Genehmigung durch den Administrator erforderlich).
Einen Webbrowser mit Internetzugriff.
Ein Google Cloud-Projekt mit einem zugehörigen Rechnungskonto. Weitere Informationen finden Sie unter Abrechnung für ein Projekt aktivieren.

Umgebung einrichten

Führen Sie die folgenden Einrichtungsschritte aus, um diese Lösung zu verwenden.

Cloud-Projekt in der Google Cloud Console öffnen

Öffnen Sie das Cloud-Projekt, das Sie für dieses Beispiel verwenden möchten, falls es noch nicht geöffnet ist:

Rufen Sie in der Google Cloud Console die Seite Projekt auswählen auf.
Cloud-Projekt auswählen
Wählen Sie das Google Cloud-Projekt aus, das Sie verwenden möchten. Klicken Sie alternativ auf Projekt erstellen und folgen Sie der Anleitung auf dem Bildschirm. Wenn Sie ein Google Cloud-Projekt erstellen, müssen Sie möglicherweise die Abrechnung für das Projekt aktivieren.

Google Cloud Natural Language API aktivieren

Diese Lösung stellt eine Verbindung zur Google Cloud Natural Language API her. Bevor Sie Google APIs verwenden können, müssen Sie sie in einem Google Cloud-Projekt aktivieren. Sie können eine oder mehrere APIs in einem einzelnen Google Cloud-Projekt aktivieren.

Aktivieren Sie die Google Cloud Natural Language API in Ihrem Cloud-Projekt.

API aktivieren

OAuth-Zustimmungsbildschirm konfigurieren

Für diese Lösung ist ein Cloud-Projekt mit einem konfigurierten Einwilligungsbildschirm erforderlich. Wenn Sie den OAuth-Zustimmungsbildschirm konfigurieren, legen Sie fest, was Google den Nutzern anzeigt. Außerdem wird Ihre App registriert, damit Sie sie später veröffentlichen können.

Rufen Sie in der Google Cloud Console das Menü > Google Auth platform > Branding auf.
Zum Branding
Wenn Sie die Google Auth platformbereits konfiguriert haben, können Sie die folgenden Einstellungen für den OAuth-Zustimmungsbildschirm unter Branding, Zielgruppe und Datenzugriff konfigurieren. Wenn Sie die Meldung Google Auth platform noch nicht konfiguriert sehen, klicken Sie auf Jetzt starten:

Geben Sie unter App-Informationen im Feld App-Name einen Namen für die App ein.
Wählen Sie unter E-Mail-Adresse des Nutzersupports eine Support-E-Mail-Adresse aus, über die Nutzer Sie mit Fragen zu ihrer Einwilligung kontaktieren können.
Klicken Sie auf Weiter.
Wählen Sie unter Zielgruppe die Option Intern aus.
Klicken Sie auf Weiter.
Geben Sie unter Kontaktdaten eine E-Mail-Adresse ein, unter der Sie über Änderungen an Ihrem Projekt benachrichtigt werden können.
Klicken Sie auf Weiter.
Sehen Sie sich unter Abschließen die Nutzerdatenrichtlinie für Google API-Dienste an. Wenn Sie damit einverstanden sind, wählen Sie Ich akzeptiere die Richtlinie zu Nutzerdaten für Google API-Dienste aus.
Klicken Sie auf Weiter.
Klicken Sie auf Erstellen.

Sie können das Hinzufügen von Bereichen vorerst überspringen. Wenn Sie in Zukunft eine App für die Verwendung außerhalb Ihrer Google Workspace-Organisation erstellen, müssen Sie den Nutzertyp in Extern ändern. Fügen Sie dann die Autorisierungsbereiche hinzu, die Ihre App benötigt. Weitere Informationen finden Sie in der vollständigen Anleitung OAuth-Zustimmung konfigurieren.

API-Schlüssel für die Google Cloud Natural Language API abrufen

Öffnen Sie die Google Cloud Console. Ihr Projekt mit aktivierter Abrechnung muss geöffnet sein.
Rufen Sie in der Google Cloud Console das Menü > APIs und Dienste > Anmeldedaten auf.

Zu den Anmeldedaten
Klicken Sie auf Anmeldedaten erstellen > API-Schlüssel.
Notieren Sie sich den API-Schlüssel, da Sie ihn in einem späteren Schritt benötigen.

Script einrichten

Führen Sie die folgenden Schritte aus, um das Script einzurichten.

Apps Script-Projekt erstellen

Klicken Sie auf die folgende Schaltfläche, um eine Kopie der Beispieltabellenkalkulation Sentimentanalyse für Feedback zu erstellen. Das Apps Script-Projekt für diese Lösung ist an die Tabelle angehängt.

Kopie erstellen
Klicken Sie auf Erweiterungen > Apps Script.
Aktualisieren Sie die folgende Variable in der Skriptdatei mit Ihrem API-Schlüssel:
```
const myApiKey = 'YOUR_API_KEY'; // Replace with your API key.
```
Klicken Sie auf „Speichern“ .

Textdaten hinzufügen

Kehren Sie zur Tabelle zurück.
Fügen Sie den Spalten id und comments Textdaten hinzu. Sie können Beispielrezensionen für Ferienunterkünfte von Kaggle verwenden oder Ihre eigenen Daten nutzen. Bei Bedarf können Sie weitere Spalten hinzufügen. Damit das Skript jedoch erfolgreich ausgeführt werden kann, müssen die Spalten id und comments Daten enthalten.

Skript ausführen

Klicken Sie oben in der Tabelle auf Sentiment Tools > Mark entities and sentiment (Einheiten und Stimmung markieren). Möglicherweise müssen Sie die Seite aktualisieren, damit dieses benutzerdefinierte Menü angezeigt wird.
Autorisieren Sie das Skript, wenn Sie dazu aufgefordert werden. <<../_snippets/oauth.md>>
Klicken Sie auf Sentiment Tools > noch einmal auf Mark entities and sentiment (Einheiten und Stimmung markieren).
Wenn das Skript abgeschlossen ist, wechseln Sie zum Tab Pivot-Tabelle, um die Ergebnisse zu sehen.

Code ansehen

Wenn Sie den Apps Script-Code für diese Lösung ansehen möchten, klicken Sie auf Quellcode ansehen:

Quellcode ansehen

Code.gs

solutions/automations/feedback-sentiment-analysis/code.js

Auf GitHub ansehen

// To learn how to use this script, refer to the documentation:
// https://developers.google.com/apps-script/samples/automations/feedback-sentiment-analysis

/*
Copyright 2022 Google LLC

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

// Sets API key for accessing Cloud Natural Language API.
const myApiKey = "YOUR_API_KEY"; // Replace with your API key.

// Matches column names in Review Data sheet to variables.
const COLUMN_NAME = {
  COMMENTS: "comments",
  ENTITY: "entity_sentiment",
  ID: "id",
};

/**
 * Creates a Demo menu in Google Spreadsheets.
 */
function onOpen() {
  SpreadsheetApp.getUi()
    .createMenu("Sentiment Tools")
    .addItem("Mark entities and sentiment", "markEntitySentiment")
    .addToUi();
}

/**
 * Analyzes entities and sentiment for each comment in
 * Review Data sheet and copies results into the
 * Entity Sentiment Data sheet.
 */
function markEntitySentiment() {
  // Sets variables for "Review Data" sheet
  const ss = SpreadsheetApp.getActiveSpreadsheet();
  const dataSheet = ss.getSheetByName("Review Data");
  const rows = dataSheet.getDataRange();
  const numRows = rows.getNumRows();
  const values = rows.getValues();
  const headerRow = values[0];

  // Checks to see if "Entity Sentiment Data" sheet is present, and
  // if not, creates a new sheet and sets the header row.
  const entitySheet = ss.getSheetByName("Entity Sentiment Data");
  if (entitySheet == null) {
    ss.insertSheet("Entity Sentiment Data");
    const entitySheet = ss.getSheetByName("Entity Sentiment Data");
    const esHeaderRange = entitySheet.getRange(1, 1, 1, 6);
    const esHeader = [
      [
        "Review ID",
        "Entity",
        "Salience",
        "Sentiment Score",
        "Sentiment Magnitude",
        "Number of mentions",
      ],
    ];
    esHeaderRange.setValues(esHeader);
  }

  // Finds the column index for comments, language_detected,
  // and comments_english columns.
  const textColumnIdx = headerRow.indexOf(COLUMN_NAME.COMMENTS);
  const entityColumnIdx = headerRow.indexOf(COLUMN_NAME.ENTITY);
  const idColumnIdx = headerRow.indexOf(COLUMN_NAME.ID);
  if (entityColumnIdx === -1) {
    Browser.msgBox(
      `Error: Could not find the column named ${COLUMN_NAME.ENTITY}. Please create an empty column with header "entity_sentiment" on the Review Data tab.`,
    );
    return; // bail
  }

  ss.toast("Analyzing entities and sentiment...");
  for (let i = 0; i < numRows; ++i) {
    const value = values[i];
    const commentEnCellVal = value[textColumnIdx];
    const entityCellVal = value[entityColumnIdx];
    const reviewId = value[idColumnIdx];

    // Calls retrieveEntitySentiment function for each row that has a comment
    // and also an empty entity_sentiment cell value.
    if (commentEnCellVal && !entityCellVal) {
      const nlData = retrieveEntitySentiment(commentEnCellVal);
      // Pastes each entity and sentiment score into Entity Sentiment Data sheet.
      const newValues = [];
      for (let entity in nlData.entities) {
        entity = nlData.entities[entity];
        const row = [
          reviewId,
          entity.name,
          entity.salience,
          entity.sentiment.score,
          entity.sentiment.magnitude,
          entity.mentions.length,
        ];
        newValues.push(row);
      }
      if (newValues.length) {
        entitySheet
          .getRange(
            entitySheet.getLastRow() + 1,
            1,
            newValues.length,
            newValues[0].length,
          )
          .setValues(newValues);
      }
      // Pastes "complete" into entity_sentiment column to denote completion of NL API call.
      dataSheet.getRange(i + 1, entityColumnIdx + 1).setValue("complete");
    }
  }
}

/**
 * Calls the Cloud Natural Language API with a string of text to analyze
 * entities and sentiment present in the string.
 * @param {String} the string for entity sentiment analysis
 * @return {Object} the entities and related sentiment present in the string
 */
function retrieveEntitySentiment(line) {
  const apiKey = myApiKey;
  const apiEndpoint = `https://language.googleapis.com/v1/documents:analyzeEntitySentiment?key=${apiKey}`;
  // Creates a JSON request, with text string, language, type and encoding
  const nlData = {
    document: {
      language: "en-us",
      type: "PLAIN_TEXT",
      content: line,
    },
    encodingType: "UTF8",
  };
  // Packages all of the options and the data together for the API call.
  const nlOptions = {
    method: "post",
    contentType: "application/json",
    payload: JSON.stringify(nlData),
  };
  // Makes the API call.
  const response = UrlFetchApp.fetch(apiEndpoint, nlOptions);
  return JSON.parse(response);
}

Beitragende

Dieses Beispiel wird von Google mit Unterstützung von Google Developer Experts verwaltet.

Sentiment von Feedback mit der Google Cloud Natural Language API analysieren Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.