این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

اتصال به API: تجزیه و تحلیل احساسات بازخورد

سطح کدنویسی : متوسط
مدت زمان : 20 دقیقه
نوع پروژه : اتوماسیون با منوی سفارشی

اهداف

درک کنید که راه حل چه کاری انجام می دهد.
آنچه را که سرویس های Apps Script در راه حل انجام می دهند، بدانید.
محیط خود را تنظیم کنید.
اسکریپت را تنظیم کنید
اسکریپت را اجرا کنید.

در مورد این راه حل

شما می توانید داده های متنی، مانند بازخورد باز، را در مقیاس تجزیه و تحلیل کنید. برای انجام تجزیه و تحلیل موجودیت و احساسات از داخل کاربرگ‌نگار Google، این راه‌حل از سرویس UrlFetch برای اتصال به Google Cloud Natural Language API استفاده می‌کند.

نمودار نحوه عملکرد تحلیل احساسات

چگونه کار می کند

این اسکریپت متن را از صفحه‌گسترده جمع‌آوری می‌کند و به Google Cloud Natural Language API متصل می‌شود تا موجودیت‌ها و احساسات موجود در رشته را تجزیه و تحلیل کند. جدول محوری میانگین امتیاز احساسات را برای هر موجودیت ذکر شده در تمام ردیف‌های داده‌های متنی خلاصه می‌کند.

خدمات اسکریپت برنامه ها

این راه حل از خدمات زیر استفاده می کند:

سرویس صفحه‌گسترده – داده‌های متنی را به Google Cloud Natural Language API می‌فرستد و هر سطر را پس از تجزیه و تحلیل احساس آن به‌عنوان «کامل» علامت‌گذاری می‌کند.
سرویس UrlFetch – برای انجام تجزیه و تحلیل موجودیت و احساسات بر روی متن به Google Cloud Natural Language API متصل می شود.

پیش نیازها

برای استفاده از این نمونه به پیش نیازهای زیر نیاز دارید:

یک حساب Google (حساب‌های Google Workspace ممکن است به تأیید سرپرست نیاز داشته باشند).
یک مرورگر وب با دسترسی به اینترنت.
یک پروژه Google Cloud با یک حساب صورت‌حساب مرتبط. به فعال کردن صورتحساب برای یک پروژه مراجعه کنید.

محیط خود را تنظیم کنید

پروژه Cloud خود را در کنسول Google Cloud باز کنید

اگر قبلاً باز نشده است، پروژه Cloud را که می‌خواهید برای این نمونه استفاده کنید باز کنید:

در کنسول Google Cloud، به صفحه انتخاب پروژه بروید.
یک پروژه Cloud را انتخاب کنید
پروژه Google Cloud را که می خواهید استفاده کنید انتخاب کنید. یا روی ایجاد پروژه کلیک کنید و دستورالعمل های روی صفحه را دنبال کنید. اگر یک پروژه Google Cloud ایجاد می‌کنید، ممکن است لازم باشد صورت‌حساب پروژه را روشن کنید .

Google Cloud Natural Language API را روشن کنید

این راه حل به Google Cloud Natural Language API متصل می شود. قبل از استفاده از Google API، باید آنها را در پروژه Google Cloud روشن کنید. می‌توانید یک یا چند API را در یک پروژه Google Cloud روشن کنید.

در پروژه Cloud خود، Google Cloud Natural Language API را روشن کنید.
API را روشن کنید

صفحه رضایت OAuth را پیکربندی کنید

این راه حل به یک پروژه Cloud با صفحه رضایت پیکربندی شده نیاز دارد. پیکربندی صفحه رضایت OAuth مشخص می کند که Google چه چیزی را برای کاربران نمایش می دهد و برنامه شما را ثبت می کند تا بتوانید بعداً آن را منتشر کنید.

در کنسول Google Cloud، به منو > APIs & Services > صفحه رضایت OAuth بروید.
به صفحه رضایت OAuth بروید
برای نوع User Internal را انتخاب کنید، سپس روی Create کلیک کنید.
فرم ثبت نام برنامه را تکمیل کنید، سپس روی ذخیره و ادامه کلیک کنید.
در حال حاضر، می‌توانید از افزودن دامنه‌ها صرفنظر کنید و روی ذخیره و ادامه کلیک کنید. در آینده، وقتی برنامه‌ای را برای استفاده خارج از سازمان Google Workspace خود ایجاد می‌کنید، باید نوع کاربر را به خارجی تغییر دهید و سپس محدوده‌های مجوز مورد نیاز برنامه خود را اضافه کنید.
خلاصه ثبت برنامه خود را مرور کنید. برای ایجاد تغییرات، روی ویرایش کلیک کنید. اگر ثبت برنامه خوب به نظر می رسد، روی بازگشت به داشبورد کلیک کنید.

یک کلید API برای Google Cloud Natural Language API دریافت کنید

به کنسول Google Cloud بروید. مطمئن شوید پروژه دارای صورتحساب شما باز است.
در کنسول Google Cloud، به منو > APIs & Services > Credentials بروید.
به Credentials بروید
روی ایجاد اعتبارنامه > کلید API کلیک کنید.
کلید API خود را برای استفاده در مرحله بعد یادداشت کنید.

اسکریپت را تنظیم کنید

پروژه Apps Script را ایجاد کنید

روی دکمه زیر کلیک کنید تا یک نسخه از تجزیه و تحلیل احساسات برای نمونه بازخورد صفحه گسترده تهیه کنید. پروژه Apps Script برای این راه حل به صفحه گسترده پیوست شده است.
یک کپی تهیه کنید
روی برنامه‌های افزودنی > اسکریپت برنامه‌ها کلیک کنید.
متغیر زیر را در فایل اسکریپت با کلید API خود به روز کنید:
```
const myApiKey = 'YOUR_API_KEY'; // Replace with your API key.
```
روی ذخیره کلیک کنید .

افزودن داده های متنی

به صفحه گسترده بازگردید.
داده های متنی را به ستون های شناسه و نظرات اضافه کنید. می‌توانید از نمونه بررسی‌های املاک تعطیلات Kaggle استفاده کنید یا از داده‌های خود استفاده کنید. در صورت نیاز می‌توانید ستون‌های بیشتری اضافه کنید، اما برای اجرای موفقیت‌آمیز، اسکریپت باید داده‌هایی در ستون‌های شناسه و نظرات داشته باشد.

اسکریپت را اجرا کنید

در بالای صفحه‌گسترده، روی ابزار احساسات > علامت‌گذاری نهادها و احساسات کلیک کنید. ممکن است لازم باشد صفحه را بازخوانی کنید تا این منوی سفارشی ظاهر شود.
وقتی از شما خواسته شد، اسکریپت را مجاز کنید. اگر صفحه رضایت OAuth اخطار را نشان می‌دهد، این برنامه تأیید نشده است ، با انتخاب پیشرفته > رفتن به {Project Name} (ناامن) ادامه دهید.
روی ابزار Sentiment > علامت گذاری نهادها و احساسات دوباره کلیک کنید.
وقتی اسکریپت تمام شد، به صفحه Pivot Table بروید تا نتایج را ببینید.

کد را مرور کنید

برای بررسی کد Apps Script برای این راه حل، روی مشاهده کد منبع در زیر کلیک کنید:

مشاهده کد منبع

Code.gs

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

در 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.
let 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
  let ss = SpreadsheetApp.getActiveSpreadsheet();
  let dataSheet = ss.getSheetByName('Review Data');
  let rows = dataSheet.getDataRange();
  let numRows = rows.getNumRows();
  let values = rows.getValues();
  let 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.
  let entitySheet = ss.getSheetByName('Entity Sentiment Data');
  if (entitySheet == null) {
   ss.insertSheet('Entity Sentiment Data');
   let entitySheet = ss.getSheetByName('Entity Sentiment Data');
   let esHeaderRange = entitySheet.getRange(1,1,1,6);
   let 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.
  let textColumnIdx = headerRow.indexOf(COLUMN_NAME.COMMENTS);
  let entityColumnIdx = headerRow.indexOf(COLUMN_NAME.ENTITY);
  let 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) {
    let value = values[i];
    let commentEnCellVal = value[textColumnIdx];
    let entityCellVal = value[entityColumnIdx];
    let reviewId = value[idColumnIdx];

    // Calls retrieveEntitySentiment function for each row that has a comment 
    // and also an empty entity_sentiment cell value.
    if(commentEnCellVal && !entityCellVal) {
        let nlData = retrieveEntitySentiment(commentEnCellVal);
        // Pastes each entity and sentiment score into Entity Sentiment Data sheet.
        let newValues = []
        for (let entity in nlData.entities) {
          entity = nlData.entities [entity];
          let 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) {
  let apiKey = myApiKey;
  let apiEndpoint = 'https://language.googleapis.com/v1/documents:analyzeEntitySentiment?key=' + apiKey;
  // Creates a JSON request, with text string, language, type and encoding
  let 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.
  let nlOptions = {
    method : 'post',
    contentType: 'application/json',  
    payload : JSON.stringify(nlData)
  };
  // Makes the API call.
  let response = UrlFetchApp.fetch(apiEndpoint, nlOptions);
  return JSON.parse(response);
};

مشارکت کنندگان

این نمونه توسط گوگل با کمک کارشناسان توسعه دهنده گوگل نگهداری می شود.