Sheets API basics in Google Sheets - Dashboard Guide

Dashboard Mode - Sheets API basics

Dashboard Goal

Show how to use Google Sheets API to read and update spreadsheet data for a sales report.

Sample Data

Product	Region	Sales Q1	Sales Q2
Apples	East	100	150
Oranges	West	200	180
Bananas	East	150	130
Grapes	West	120	170
Pears	East	90	110

Dashboard Components

• KPI Card: Total Sales Q1
  Formula: =SUM(C2:C6)
  Result: 660
• KPI Card: Total Sales Q2
  Formula: =SUM(D2:D6)
  Result: 740
• Table: Sales by Product and Region
  Shows raw data from the sample table
• API Read Example: Script to read sales data range 'Sheet1'!A1:D6 using Sheets API
  GET https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values/Sheet1!A1:D6
• API Update Example: Script to update Sales Q2 for Apples to 160
  PUT https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values/Sheet1!D2?valueInputOption=USER_ENTERED
  Body: {"values":[[160]]}

Dashboard Layout

+----------------------+----------------------+
|   Total Sales Q1     |    Total Sales Q2    |
|       (660)          |        (740)         |
+----------------------+----------------------+
|                                      |
|          Sales Data Table             |
|                                      |
+--------------------------------------+

Interactivity

User can update sales numbers via Sheets API calls. When data updates, KPI cards and table refresh automatically to show new totals and values.

Self Check

If you update Sales Q2 for Apples from 150 to 160 using the API, which components update?
Answer: Total Sales Q2 KPI card and the Sales Data Table will update to reflect the new value.

Key Result

Dashboard shows total sales and detailed sales data with examples of reading and updating data using Google Sheets API.

Practice

1. What is the main purpose of the Google Sheets API?

easy

A. To read and write data in Google Sheets programmatically

B. To create charts manually in Google Sheets

C. To design the layout of a Google Sheet

D. To send emails from Google Sheets

Solution

1. Step 1: Understand the API's function

   The Sheets API allows programs to access and change sheet data automatically.

2. Step 2: Compare options with API purpose

   Only To read and write data in Google Sheets programmatically describes reading and writing data programmatically, which matches the API's main use.

3. Final Answer:

   To read and write data in Google Sheets programmatically -> Option A

4. Quick Check:

   Sheets API = read/write data [OK]

Hint: Think: API means program controls sheet data [OK]

Common Mistakes:

• Confusing API with manual tasks like chart creation
• Thinking API designs sheet layout
• Assuming API sends emails

2. Which of the following is the correct way to specify a range in the Sheets API to read cells A1 to C3 on a sheet named 'Data'?

easy

A. "Sheet1!A1-C3"

B. "A1:C3!Data"

C. "Data:A1-C3"

D. "Data!A1:C3"

Solution

1. Step 1: Recall range format in Sheets API

   The correct format is "SheetName!StartCell:EndCell" to specify a range.

2. Step 2: Match the correct option

   "Data!A1:C3" uses "Data!A1:C3", which matches the correct format for sheet 'Data' and cells A1 to C3.

3. Final Answer:

   "Data!A1:C3" -> Option D

4. Quick Check:

   Range format = SheetName!Start:End [OK]

Hint: Remember: SheetName!CellRange format [OK]

Common Mistakes:

• Putting sheet name after the range
• Using colon between sheet and range incorrectly
• Using wrong sheet name like 'Sheet1' instead of 'Data'

3. Given the following Sheets API call to read values:
spreadsheets.values.get({ spreadsheetId: 'abc123', range: 'Sheet1!B2:B4' })
and the sheet has values B2=10, B3=20, B4=30, what will be the returned values array?

medium

A. [[10, 20, 30]]

B. [[10], [20], [30]]

C. [10, 20, 30]

D. [10; 20; 30]

Solution

1. Step 1: Understand Sheets API value format

   Values are returned as a 2D array where each inner array is a row. Since range is a single column B2:B4, each row is an array with one value.

2. Step 2: Match the correct array format

   [[10], [20], [30]] shows [[10], [20], [30]], which matches the expected 2D array for three rows and one column.

3. Final Answer:

   [[10], [20], [30]] -> Option B

4. Quick Check:

   Single column range returns array of single-item arrays [OK]

Hint: Remember: Single column = array of single-item arrays [OK]

Common Mistakes:

• Expecting a flat array instead of 2D array
• Confusing rows and columns in returned data
• Using wrong brackets or separators

4. You wrote this Sheets API call to update cell A1 with value 'Hello':
spreadsheets.values.update({ spreadsheetId: 'xyz789', range: 'Sheet1!A1', values: 'Hello' })
But it gives an error. What is the mistake?

medium

A. The spreadsheetId is missing

B. The range should be 'A1!Sheet1' instead of 'Sheet1!A1'

C. The 'values' field should be a 2D array, not a string

D. The API does not support updating single cells

Solution

1. Step 1: Check the 'values' parameter format

   The Sheets API expects 'values' to be a 2D array (array of arrays), even for single cells.

2. Step 2: Identify the error cause

   Passing a string 'Hello' instead of [['Hello']] causes the error.

3. Final Answer:

   The 'values' field should be a 2D array, not a string -> Option C

4. Quick Check:

   Values must be 2D array for update [OK]

Hint: Always wrap values in double arrays [[value]] [OK]

Common Mistakes:

• Passing a plain string instead of array
• Swapping sheet name and range
• Assuming API can't update single cells

5. You want to use the Sheets API to copy data from range 'Sheet1!A1:B2' to 'Sheet2!C3:D4' in the same spreadsheet. Which approach correctly achieves this?

hard

A. First read values from 'Sheet1!A1:B2' using spreadsheets.get, then write them to 'Sheet2!C3:D4' using values.update

B. Directly call values.copy with source 'Sheet1!A1:B2' and destination 'Sheet2!C3:D4'

C. Use values.append to add 'Sheet1!A1:B2' data to 'Sheet2!C3:D4'

D. Change the spreadsheetId to 'Sheet2' and call values.update on 'A1:B2'

Solution

1. Step 1: Understand Sheets API capabilities

   The Sheets API does not have a direct values.copy method. To copy data, you must first read the values from the source range, then write them to the destination range.

2. Step 2: Match the correct option

   First read values from 'Sheet1!A1:B2' using spreadsheets.get, then write them to 'Sheet2!C3:D4' using values.update correctly describes the process.

3. Final Answer:

   First read values from 'Sheet1!A1:B2' using spreadsheets.get, then write them to 'Sheet2!C3:D4' using values.update -> Option A

4. Quick Check:

   Copying requires read then write steps [OK]

Hint: Use read then write to copy ranges [OK]

Common Mistakes:

• Assuming a direct copy method exists
• Using append which adds data below existing
• Confusing spreadsheetId with sheet name