initial checkin of news sample (#174)

* initial checkin of news sample

* slight update to readme

* A simple update to test new SSH key

* another test submit

* another tweak to readme. Just testing github

* Initial Checkin of News Sentiment

* Updates to ReadMe per initial review

* final checkin per Readme review

Author: cschalk-goog

news-sentiment/README.md

@@ -0,0 +1,81 @@
+---
+title: Analyze the Sentiment of News Headlines
+description: Analyze the sentiment of news headlines retrieved for a user-specified topic from a free news API.
+labels: Apps Script, Sheets, Cloud Natural Language
+material_icon: Feed
+create_time: 2021-03-22
+update_time: 2021-03-29
+---
+
+This solution showcases natural language sentiment analysis on current news headlines. It consists of a Google Sheet that uses Apps Script to fetch the current news headlines from the free news API `newsapi.org` using a user-provided `topic`.
+Once the news headlines are fetched and loaded into the sheet, it uses the Google Cloud Natural Language API to run a sentiment analysis for each headline. 
+As the sentiments are returned from the API, the script updates the sheet with both a numeric score as well as a `happy`, `meh`, or `sad` icon depending on the sentiment.
+ 
+## Technology highlights
+
+- This solution demonstrates the following:
+   * Shows how to add custom menus to the Sheets UI.
+   * Uses `UrlFetch` to load news headlines from an external API.
+   * Demonstrates the Cloud Natural Language API to analyze headlines.
+
+## Try it
+
+### Before you begin: Obtain your API keys
+To run this solution you need to get 2 API keys, one from the [Google Cloud Natural Language API](https://cloud.google.com/natural-language), and the second from the free News API @ [http://newsapi.org/](http://newsapi.org/).
+
+#### Get the Google Cloud Natural Language API key
+
+To get an API key for the Google Cloud Natural Language API, you must configure a Google Cloud Platform (GCP) project.
+
+1. Create a new or use an existing GCP project: 
+1. Navigate to the main {{console_name_short}} page.
+
+    [Cloud Console]({{console_url}}){: class="button button-primary" target="console" track-name="consoleLink" track-type="tutorial" track-metadata-position="body"}
+
+   * If you need to create a new project: 
+      * Select your associated billing account.
+      * Accept the defaults for organization and location.
+      * Click **Create**, and then select the new project in the console.
+   
+1.  At the top of the console, click <span class=”material-icons”>menu</span> <span aria-label="and then">></span> **APIs & Services**. 
+Click **+ Enable APIs and Services**.
+1. Search for `Cloud Natural Language API`, and enable it.
+1. On the left, click **Credentials** <span aria-label="and then">></span> **+ Create credentials**.
+1. In the drop-down menu, select **API key**. 
+1. Save this key to add to your Apps Script `Code.gs` file. 
+
+#### Register for the News API key.
+To get an API key for the News API, you need to create a free News API account.
+1. To create an account, go to the [News API](https://newsapi.org/) site.
+1. Click **Get API Key** and follow the steps.
+1. Save the key to add to your Apps Script `Code.gs` file. 
+
+### Create your copy of the solution
+Copy and customize the solution with your API keys.
+
+1. Click to make a copy of the [News Sentiment Analyzer - External spreadsheet](https://docs.google.com/spreadsheets/d/1Jw-d2ihbjSyO4SyzgXSiC5dzs36GY5aMGxuf_nc7WKU/copy). 
+
+1. To open the associated Apps Script Project, at the top, click **Tools <span aria-label="and then">></span> Script editor**.
+1. Update the `Code.gs` script file with your API keys:
+    * const googleAPIKey = `YOUR_GOOGLE_API_KEY`;
+    * const newsApiKey = `YOUR_NEWS_API_KEY`;
+1. Save the script and return to the spreadsheet.
+
+### Run the News Sentiment Analyzer
+1. At the top of the spreadsheet, click the custom menu item **News Headlines Sentiments**.
+1. Select **Analyze News Headlines**. 
+    * Note: Upon first run, you must go through the Google authorization steps. This leaves the script running, but paused. After you authorize the script, click **Dismiss**, and select **Analyze News Headlines** again.
+1. In the popup dialog, enter a news topic or keyword. For example `Global Warming`.
+1. Click **Ok** to start the analysis. 
+
+## Next steps
+
+* Experiment with other news topics.
+
+* Try adding code to do further steps. For example, you could save all topics and their average sentiments over time in a different tab to see if any trends emerge.
+
+* Add a time-based trigger to run the code on a daily basis with a set of topics selected from a different tab.
+
+* For more help with Apps Script coding, try the [Apps Script Fundamentals codelabs](https://developers.google.com/apps-script/quickstart/fundamentals-codelabs).
+
+* For more information on the Google Cloud Natural Language API, [try a quickstart](https://cloud.google.com/natural-language/docs/quickstarts).

news-sentiment/demo.gif

@@ -0,0 +1,251 @@
+// Copyright 2021 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.
+
+// Global variables
+const googleAPIKey = 'YOUR_GOOGLE_API_KEY';
+const newsApiKey = 'YOUR_NEWS_API_KEY';
+const apiEndPointHdr = 'https://newsapi.org/v2/everything?q=';
+const happyFace =
+  '=IMAGE(\"https://cdn.pixabay.com/photo/2016/09/01/08/24/smiley-1635449_1280.png\")';
+const mehFace =
+  '=IMAGE(\"https://cdn.pixabay.com/photo/2016/09/01/08/24/smiley-1635450_1280.png\")';
+const sadFace =
+  '=IMAGE(\"https://cdn.pixabay.com/photo/2016/09/01/08/25/smiley-1635454_1280.png\")';
+const happyColor = '#44f83d';
+const mehColor = '#f7f6cc';
+const sadColor = '#ff3c3d';
+const fullsheet = 'A2:D25';
+const sentimentCols = 'B2:D25';
+const articleMax = 20;
+const threshold = 0.3;
+
+let headlines = [];
+let rows = null;
+let rowValues = null;
+let topic = null;
+let bottomRow = 0;
+let ds = null;
+let ss = null;
+let headerRow = null;
+let sentimentCol = null;
+let headlineCol = null;
+let scoreCol = null;
+
+/**
+ * Create menu in the Google Spreadsheet when Spreadsheet is opened.
+ * 
+ */
+function onOpen() {
+  let ui = SpreadsheetApp.getUi();
+  ui.createMenu('News Headlines Sentiments')
+    .addItem('Analyze News Headlines...', 'showNewsPrompt')
+    .addToUi();
+}
+
+/**
+ * Prompt user to enter a new headline topic. 
+ * Calls main function AnalyzeHeadlines with entered topic.
+ */
+function showNewsPrompt() {
+  //Initialize global variables
+  ss = SpreadsheetApp.getActiveSpreadsheet();
+  ds = ss.getSheetByName('Sheet1');
+  headerRow = ds.getDataRange().getValues()[0];
+  sentimentCol = headerRow.indexOf('Sentiment');
+  headlineCol = headerRow.indexOf('Headlines');
+  scoreCol = headerRow.indexOf('Score');
+
+  // Build Menu
+  let ui = SpreadsheetApp.getUi();
+  let result = ui.prompt(
+    'Enter news topic:',
+    ui.ButtonSet.OK_CANCEL);
+
+  // Process the user's response.
+  let button = result.getSelectedButton();
+  topic = result.getResponseText();
+  if (button == ui.Button.OK) {
+    analyzeNewsHeadlines();
+  } else if (button == ui.Button.CANCEL) {
+    // User clicked "Cancel".
+    ui.alert('News topic not selected!');
+  }
+}
+
+/**
+ * For each headline cell, call NL API to get general sentiment and then update 
+ * sentiment response column.
+ */
+function analyzeNewsHeadlines() {
+  // Clear and reformat sheet
+  reformatSheet();
+
+  // Get headlines array
+  headlines = getHeadlinesArray();
+
+  // Sync headlines array to sheet using single setValues call 
+  if (headlines.length > 0){
+    ds.getRange(2, 1, headlines.length, headlineCol+1).setValues(headlines);
+    // Set global rowValues
+    rows = ds.getDataRange();
+    rowValues = rows.getValues();
+    getSentiments();
+  } else {
+    ss.toast("No headlines returned for topic: " + topic + '!');
+  }
+}
+
+/**
+ * Fetch current headlines from the Free News API
+ */
+function getHeadlinesArray() {
+  // Fetch headlines for a given topic
+  let hdlnsResp = [];
+  let encodedtopic = encodeURIComponent(topic);
+  ss.toast("Getting headlines for: " + topic);
+  let response = UrlFetchApp.fetch(apiEndPointHdr + encodedtopic + '&apiKey=' +
+    newsApiKey);
+  let results = JSON.parse(response);
+  let articles = results["articles"];
+
+  for (let i = 0; i < articles.length && i < articleMax; i++) {
+    let newsStory = articles[i]['title'];
+    if (articles[i]['description'] !== null) {
+      newsStory += ': ' + articles[i]['description'];
+    }
+    // Scrub newsStory of invalid characters
+    newsStory = scrub(newsStory);
+
+    // Construct hdlnsResp as a 2d array. This simplifies syncing to sheet.
+    hdlnsResp.push(new Array(newsStory));
+  }
+
+  return hdlnsResp;
+}
+
+/**
+ * For each article cell, call NL API to get general sentiment and then update 
+ * sentiment response columns.
+ */
+function getSentiments() {
+  ss.toast('Analyzing the headline sentiments...');
+
+  let articleCount = rows.getNumRows() - 1;
+  let avg = 0;
+
+  // Get sentiment for each row 
+  for (let i = 1; i <= articleCount; i++) {
+    let headlineCell = rowValues[i][headlineCol];
+    if (headlineCell) {
+      let sentimentData = retrieveSentiment(headlineCell);
+      let result = sentimentData['documentSentiment']['score'];
+      avg += result;
+      ds.getRange(i + 1, sentimentCol + 1).setBackgroundColor(getColor(result));
+      ds.getRange(i + 1, sentimentCol + 1).setValue(getFace(result));
+      ds.getRange(i + 1, scoreCol + 1).setValue(result);
+    }
+  }
+  let avgDecimal = (avg / articleCount).toFixed(2);
+ 
+  // Show news topic and average face, color and sentiment value.
+  bottomRow = articleCount + 3;
+  ds.getRange(bottomRow, 1, headlines.length, scoreCol+1).setFontWeight('bold');
+  ds.getRange(bottomRow, headlineCol + 1).setValue('Topic: \"' + topic + '\"');
+  ds.getRange(bottomRow, headlineCol + 2).setValue('Avg:');
+  ds.getRange(bottomRow, sentimentCol + 1).setValue(getFace(avgDecimal));
+  ds.getRange(bottomRow, sentimentCol + 1).setBackgroundColor(getColor(avgDecimal));
+  ds.getRange(bottomRow, scoreCol + 1).setValue(avgDecimal);
+  ss.toast("Done!!");
+}
+
+/**
+ * Call NL API to get sentiment response for headline.
+ * 
+ * Important note: Not all languages are supported by Google document 
+ * sentiment analysis. 
+ * Unsupported languages generate a "400" response: "INVALID_ARGUMENT".
+ */
+function retrieveSentiment(text) {
+  // Set REST call options   
+  let apiEndPoint =
+    'https://language.googleapis.com/v1/documents:analyzeSentiment?key=' +
+    googleAPIKey;
+  let jsonReq = JSON.stringify({
+    document: {
+      type: "PLAIN_TEXT",
+      content: text
+    },
+    encodingType: "UTF8"
+  });
+
+  let options = {
+    'method': 'post',
+    'contentType': 'application/json',
+    'payload': jsonReq
+  }
+
+  //  Make the REST call
+  let response = UrlFetchApp.fetch(apiEndPoint, options);
+  let responseData = JSON.parse(response);
+  return responseData;
+}
+
+// Helper Functions 
+
+/**
+ * Remove old headlines, sentiments and reset formatting
+ */
+function reformatSheet() {
+  let range = ds.getRange(fullsheet);
+  range.clearContent();
+  range.clearFormat();
+  range.setWrapStrategy(SpreadsheetApp.WrapStrategy.CLIP);
+
+  range = ds.getRange(sentimentCols); // Center the sentiment cols only
+  range.setHorizontalAlignment("center");
+}
+
+/**
+ * Return a corresponding face based on numeric value.
+ */
+function getFace(value){
+  if (value >= threshold) {
+    return happyFace;
+  } else if (value < threshold && value > -threshold){
+    return mehFace;
+  } else if (value <= -threshold) {
+   return sadFace;
+  }
+}
+
+/**
+ * Return a corresponding color based on numeric value.
+ */
+function getColor(value){
+  if (value >= threshold) {
+    return happyColor;
+  } else if (value < threshold && value > -threshold){
+    return mehColor;
+  } else if (value <= -threshold) {
+   return sadColor;
+  }
+}
+
+/**
+ * Scrub invalid characters out of headline text.
+ * Can be expanded if needed.
+ */
+function scrub(text) {
+  return text.replace(/[\‘\,\“\”\"\'\’\-\n\â\€]/g, ' ');
+}

news-sentiment/src/Code.js

@@ -0,0 +1,7 @@
+{
+  "timeZone": "America/Los_Angeles",
+  "dependencies": {
+  },
+  "exceptionLogging": "STACKDRIVER",
+  "runtimeVersion": "V8"
+}