Analiza la opinión de los comentarios con la API de Google Cloud Natural Language

Nivel de programación: Intermedio
Duración: 20 minutos
Tipo de proyecto: Automatización con un menú personalizado

Objetivos

Comprende qué hace la solución.
Comprende qué hacen los servicios de Apps Script dentro de la solución.
Configura el entorno.
Configura la secuencia de comandos.
Ejecuta la secuencia de comandos.

Acerca de esta solución

Puedes analizar datos de texto, como comentarios abiertos, a gran escala. Para realizar análisis de entidades y opiniones desde Hojas de cálculo de Google, esta solución usa el servicio UrlFetch para conectarse a la API de Google Cloud Natural Language.

Ilustración de cómo funciona el análisis de opiniones

Cómo funciona

La secuencia de comandos recopila texto de la hoja de cálculo y se conecta a la API de Google Cloud Natural Language para analizar las entidades y las opiniones presentes en la cadena. Una tabla dinámica resume la puntuación promedio de opiniones para cada entidad mencionada en todas las filas de datos de texto.

Servicios de Apps Script

Esta solución usa los siguientes servicios:

Servicio de hojas de cálculo: Envía los datos de texto a la API de Google Cloud Natural Language y marca cada fila como "Completada" una vez que se analiza su opinión.
Servicio UrlFetch: Se conecta a la API de Google Cloud Natural Language para realizar análisis de entidades y opiniones en el texto.

Requisitos previos

Para usar esta muestra, debes cumplir con los siguientes requisitos previos:

Una Cuenta de Google (es posible que las cuentas de Google Workspace requieran la aprobación del administrador)
Un navegador web con acceso a Internet
Un proyecto de Google Cloud con una cuenta de facturación asociada (consulta Habilita la facturación para un proyecto)

Configura tu entorno

Para usar esta solución, completa los siguientes pasos de configuración.

Abre tu proyecto de Cloud en la consola de Google Cloud

Si aún no está abierto, abre el proyecto de Cloud que deseas usar para esta muestra:

En la consola de Google Cloud, ve a la página Seleccionar un proyecto.
Selecciona un proyecto de Cloud
Selecciona el proyecto de Google Cloud que deseas usar. O bien, haz clic en Crear proyecto y sigue las instrucciones en pantalla. Si creas un proyecto de Google Cloud, es posible que debas activar la facturación para el proyecto.

Habilita la API de Google Cloud Natural Language

Esta solución se conecta a la API de Google Cloud Natural Language. Antes de usar las APIs de Google, debes activarlas en un proyecto de Google Cloud. Puedes activar una o más APIs en un solo proyecto de Google Cloud.

En tu proyecto de Cloud, activa la API de Google Cloud Natural Language.

Activa la API

Configura la pantalla de consentimiento de OAuth

Esta solución requiere un proyecto de Cloud con una pantalla de consentimiento configurada. La configuración de la pantalla de consentimiento de OAuth define lo que Google muestra a los usuarios y registra tu app para que puedas publicarla más adelante.

En la Consola de APIs de Google, ve a Menú > Plataforma de autenticación de Google > Branding.
Ir a Branding
Si ya configuraste la plataforma de autenticación de Google, puedes configurar los siguientes parámetros de configuración de la pantalla de consentimiento de OAuth en Branding, Público y Acceso a los datos. Si ves un mensaje que dice Aún no se configuró la plataforma de autenticación de Google, haz clic en Comenzar:

En Información de la aplicación, en Nombre de la aplicación, ingresa un nombre para la app.
En Correo electrónico de asistencia al usuario, elige una dirección de correo electrónico de asistencia en la que los usuarios puedan comunicarse contigo si tienen preguntas sobre su consentimiento.
Haz clic en Siguiente.
En Público, selecciona Interno.
Haz clic en Siguiente.
En Información de contacto, ingresa una Dirección de correo electrónico en la que puedas recibir notificaciones sobre cualquier cambio en tu proyecto.
Haz clic en Siguiente.
En Finalizar, revisa la Política de Datos del Usuario de los Servicios de las APIs de Google y, si estás de acuerdo, selecciona Acepto la Política de Datos del Usuario de los Servicios de las APIs de Google.
Haz clic en Continuar.
Haz clic en Crear.

Por ahora, puedes omitir la adición de permisos. En el futuro, cuando crees una app para usar fuera de tu organización de Google Workspace, debes cambiar el Tipo de usuario a Externo. Luego, agrega los permisos de autorización que requiere tu app. Para obtener más información, consulta la guía completa Configura el consentimiento de OAuth guide.

Obtén una clave de API para la API de Google Cloud Natural Language

Ve a la Consola de APIs de Google. Asegúrate de que esté abierto tu proyecto habilitado para la facturación.
En la Consola de APIs de Google, ve a Menú > APIs y servicios > Credenciales.

Ir a Credenciales
Haz clic en Crear credenciales > Clave de API.
Toma nota de tu clave de API para usarla en un paso posterior.

Configura la secuencia de comandos

Completa los siguientes pasos para configurar la secuencia de comandos.

Crea el proyecto de Apps Script

Haz clic en el siguiente botón para crear una copia de la hoja de cálculo de muestra Análisis de opiniones para comentarios. El proyecto de Apps Script para esta solución se adjunta a la hoja de cálculo.

Crear una copia
Haz clic en Extensiones > Apps Script.
Actualiza la siguiente variable en el archivo de secuencia de comandos con tu clave de API:
```
const myApiKey = 'YOUR_API_KEY'; // Replace with your API key.
```
Haz clic en Guardar .

Agrega datos de texto

Vuelve a la hoja de cálculo.
Agrega datos de texto a las columnas id y comments. Puedes usar muestras de opiniones de propiedades vacacionales de Kaggle o tus propios datos. Puedes agregar más columnas si es necesario, pero para que se ejecute correctamente, la secuencia de comandos debe tener datos en las columnas id y comments.

Ejecuta la secuencia de comandos

En la parte superior de la hoja de cálculo, haz clic en Herramientas de opiniones > Marcar entidades y opiniones. Es posible que debas actualizar la página para que aparezca este menú personalizado.
Cuando se te solicite, autoriza la secuencia de comandos. <<../_snippets/oauth.md>>
Vuelve a hacer clic en Herramientas de opiniones > Marcar entidades y opiniones.
Cuando finalice la secuencia de comandos, cambia a la hoja Tabla dinámica para ver los resultados.

Revisa el código

Para revisar el código de Apps Script de esta solución, haz clic en Ver el código fuente:

Ver el código fuente

Code.gs

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

Ver en GitHub

// 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);
}

Colaboradores

Google mantiene esta muestra con la ayuda de Google Developer Experts.

Analiza la opinión de los comentarios con la API de Google Cloud Natural Language Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.