อัปเดตสเปรดชีต

เอกสารนี้อธิบายพื้นฐานของการใช้ spreadsheets.batchUpdate เมธอดใน spreadsheetsทรัพยากร

นอกเหนือจากข้อมูลค่าที่อยู่ในเซลล์แล้ว สเปรดชีตยังมี ข้อมูลประเภทอื่นๆ อีกมากมาย เช่น

• ขนาด
• รูปแบบและเส้นขอบของเซลล์
• ช่วงที่ตั้งชื่อแล้ว
• ช่วงที่ป้องกันไว้
• การจัดรูปแบบตามเงื่อนไข

ข้อมูลเหล่านี้เป็นเพียงส่วนหนึ่งของข้อมูลหลายประเภทที่ควบคุมลักษณะและการทำงานของสเปรดชีต เมธอด spreadsheets.batchUpdate ช่วยให้คุณอัปเดตรายละเอียดสเปรดชีตเหล่านี้ได้ ระบบจะจัดกลุ่มการเปลี่ยนแปลงเป็นชุดเพื่อให้หากคำขอหนึ่งไม่สำเร็จ ระบบจะไม่เขียนการเปลี่ยนแปลงอื่นๆ (ที่อาจขึ้นอยู่กับคำขอแรก)

หากต้องการอ่านและเขียนข้อมูลค่าเซลล์ คุณยังใช้ทรัพยากร spreadsheets.values ได้ตามที่อธิบายไว้ในหัวข้ออ่านและเขียนค่าเซลล์ values

ประเภทการดำเนินการ

การดำเนินการเฉพาะที่เมธอด spreadsheets.batchUpdate รองรับสามารถจัดกลุ่มได้เป็นประเภทการดำเนินการกว้างๆ ดังต่อไปนี้

หมวดหมู่	คำอธิบาย
เพิ่ม (และ ทำซ้ำ)	เพิ่มออบเจ็กต์ใหม่ (บางครั้งอิงตามออบเจ็กต์เก่า เช่น ในคำขอทำซ้ำ)
อัปเดต (และ ตั้งค่า)	อัปเดตพร็อพเพอร์ตี้บางอย่างของออบเจ็กต์ โดยปกติแล้วจะคงพร็อพเพอร์ตี้เก่าไว้ (ในขณะที่คำขอตั้งค่าจะเขียนทับข้อมูลก่อนหน้า)
ลบ	นำออบเจ็กต์ออก

เราจะใช้หมวดหมู่เหล่านี้ในส่วนถัดไปเพื่ออธิบายลักษณะการทำงานของการดำเนินการที่เฉพาะเจาะจง

การดำเนินการอัปเดตเป็นกลุ่ม

เมธอด spreadsheets.batchUpdate ทำงานโดยรับออบเจ็กต์อย่างน้อย 1 รายการ Request ซึ่งแต่ละรายการจะระบุคำขอประเภทเดียวที่จะดำเนินการ ตารางต่อไปนี้แสดงประเภทคำขออัปเดตเป็นกลุ่ม ซึ่งจัดกลุ่มตามออบเจ็กต์ทรัพยากรและประเภทการดำเนินการ

ออบเจ็กต์	เพิ่ม / ทำซ้ำ	อัปเดต / ตั้งค่า	ลบ
BandedRange	AddBandingRequest	UpdateBandingRequest	DeleteBandingRequest
Borders		UpdateBordersRequest
Cells (รวมถึงค่า รูปแบบ การตรวจสอบข้อมูล ฯลฯ)	InsertRangeRequest	RepeatCellRequest UpdateCellsRequest AppendCellsRequest	DeleteRangeRequest
ConditionalFormatRule	AddConditionalFormatRuleRequest	UpdateConditionalFormatRuleRequest	DeleteConditionalFormatRuleRequest
DataSource	AddDataSourceRequest	UpdateDataSourceRequest RefreshDataSourceRequest CancelDataSourceRefreshRequest	DeleteDataSourceRequest
DataValidationRule		SetDataValidationRequest
developerMetadata	CreateDeveloperMetadataRequest	UpdateDeveloperMetadataRequest	DeleteDeveloperMetadataRequest
Dimension (รวมถึง DimensionRange)	InsertDimensionRequest AppendDimensionRequest	UpdateDimensionPropertiesRequest MoveDimensionRequest AutoResizeDimensionsRequest	DeleteDimensionRequest
DimensionGroup	AddDimensionGroupRequest	UpdateDimensionGroupRequest	DeleteDimensionGroupRequest
EmbeddedChart	AddChartRequest	UpdateChartSpecRequest UpdateEmbeddedObjectPositionRequest UpdateEmbeddedObjectBorderRequest	DeleteEmbeddedObjectRequest
FilterView (รวมถึง BasicFilter)	AddFilterViewRequest DuplicateFilterViewRequest	UpdateFilterViewRequest SetBasicFilterRequest	ClearBasicFilterRequest DeleteFilterViewRequest
ผสานเซลล์ (รวมถึง MergeType)	MergeCellsRequest		UnmergeCellsRequest
NamedRange	AddNamedRangeRequest	UpdateNamedRangeRequest	DeleteNamedRangeRequest
ProtectedRange	AddProtectedRangeRequest	UpdateProtectedRangeRequest	DeleteProtectedRangeRequest
Sheets	AddSheetRequest DuplicateSheetRequest	UpdateSheetPropertiesRequest	DeleteSheetRequest
Slicer	AddSlicerRequest	UpdateSlicerSpecRequest
SpreadsheetProperties		UpdateSpreadsheetPropertiesRequest
Table	AddTableRequest	UpdateTableRequest	DeleteTableRequest

คำขอจัดการข้อมูล

นอกจากนี้ยังมีคำขอเพิ่มเติมบางรายการที่จำลองการดำเนินการของผู้ใช้เพื่อจัดการข้อมูล ดังนี้

คำขอ	คำอธิบาย
AutoFillRequest	ป้อนข้อมูลเพิ่มเติมโดยอัตโนมัติตามข้อมูลที่มีอยู่
CopyPasteRequest	คัดลอกข้อมูลจากพื้นที่หนึ่งและวางลงในอีกพื้นที่หนึ่ง
CutPasteRequest	ตัดข้อมูลจากพื้นที่หนึ่งและวางลงในอีกพื้นที่หนึ่ง
DeleteDuplicatesRequest	นำแถวที่มีค่าซ้ำกันในคอลัมน์ที่ระบุของช่วงเซลล์ ออก
FindReplaceRequest	ค้นหาและแทนที่ข้อความบางส่วนด้วยข้อความอื่น
PasteDataRequest	วางข้อมูล (HTML หรือข้อมูลที่คั่นด้วยตัวคั่น) ลงในชีต
RandomizeRangeRequest	สุ่มลำดับแถวในช่วง
SortRangeRequest	จัดเรียงข้อมูลในช่วง
TextToColumnsRequest	แปลงคอลัมน์ข้อความเป็นคอลัมน์ข้อความหลายคอลัมน์
TrimWhitespaceRequest	ตัดช่องว่าง (เช่น ช่องว่าง แท็บ หรือบรรทัดใหม่) ในเซลล์

ดูข้อมูลเพิ่มเติมเกี่ยวกับขีดจำกัดของเซลล์และแถวใน Google ชีตได้ที่ ไฟล์ที่คุณ จัดเก็บใน Google ไดรฟ์

ใช้มาสก์ของฟิลด์เพื่ออัปเดตฟิลด์ที่เฉพาะเจาะจง

คำขออัปเดตหลายรายการต้องใช้ FieldMask มาสก์ของฟิลด์คือรายการฟิลด์ที่คั่นด้วยคอมมา ซึ่งใช้เพื่อระบุฟิลด์ในออบเจ็กต์ที่จะอัปเดต โดยจะคงฟิลด์อื่นๆ ทั้งหมดไว้ไม่เปลี่ยนแปลง การใช้มาสก์ของฟิลด์จะป้องกันการเขียนทับฟิลด์ที่ไม่ได้ระบุไว้ในคำขอโดยไม่ตั้งใจ

ดูข้อมูลเพิ่มเติมเกี่ยวกับมาสก์ของฟิลด์ได้ที่ อัปเดตด้วยมาสก์ของฟิลด์

ตัวอย่างโค้ดต่อไปนี้แสดงวิธีใช้ UpdateSpreadsheetPropertiesRequest เพื่ออัปเดตเฉพาะชื่อของสเปรดชีต

คำขอ

POST https://sheets.googleapis.com/v4/spreadsheets/spreadsheetId:batchUpdate

เนื้อความของคำขอ

{
  "requests": [{
      "updateSpreadsheetProperties": {
          "properties": {"title": "TITLE"},
          "fields": "title"
      }
  }]
}

แทนที่ TITLE ด้วยชื่อใหม่ของสเปรดชีต

การตอบกลับการอัปเดตเป็นกลุ่ม

เมื่ออัปเดตสเปรดชีต คำขอบางประเภทอาจแสดงผลการตอบกลับ ระบบจะแสดงผลการตอบกลับเหล่านี้ในอาร์เรย์ โดยการตอบกลับแต่ละรายการจะอยู่ในดัชนีเดียวกับคำขอที่เกี่ยวข้อง คำขอบางรายการไม่มีการตอบกลับ และการตอบกลับสำหรับคำขอเหล่านั้นจะเป็นค่าว่าง

โดยปกติแล้ว คำขอ "เพิ่ม" จะมีการตอบกลับที่แสดงผลข้อมูล เช่น รหัสของออบเจ็กต์ที่เพิ่ม ดูรายการการตอบกลับที่รองรับได้ที่ Responses

ตัวอย่างโค้ด: อัปเดตสเปรดชีตเป็นกลุ่ม

ตัวอย่างโค้ดต่อไปนี้แสดงวิธีดำเนินการต่อไปนี้

1. อัปเดตชื่อของสเปรดชีตโดยใช้ตัวแปร title
2. ค้นหาและแทนที่ค่าเซลล์ในสเปรดชีตโดยใช้ตัวแปร find และ replacement

Apps Script

sheets/api/spreadsheet_snippets.gs

ดูใน GitHub

/**
 * Updates the specified sheet using advanced sheet services
 * @param {string} spreadsheetId id of the spreadsheet to be updated
 * @param {string} title name of the sheet in the spreadsheet to be updated
 * @param {string} find string to be replaced
 * @param {string} replacement the string to replace the old data
 * @returns {*} the updated spreadsheet
 */
Snippets.prototype.batchUpdate = (spreadsheetId, title, find, replacement) => {
  // This code uses the Sheets Advanced Service, but for most use cases
  // the built-in method SpreadsheetApp.getActiveSpreadsheet()
  //     .getRange(range).setValues(values) is more appropriate.

  try {
    // Change the spreadsheet's title.
    const updateSpreadsheetPropertiesRequest =
      Sheets.newUpdateSpreadsheetPropertiesRequest();
    updateSpreadsheetPropertiesRequest.properties =
      Sheets.newSpreadsheetProperties();
    updateSpreadsheetPropertiesRequest.properties.title = title;
    updateSpreadsheetPropertiesRequest.fields = "title";

    // Find and replace text.
    const findReplaceRequest = Sheets.newFindReplaceRequest();
    findReplaceRequest.find = find;
    findReplaceRequest.replacement = replacement;
    findReplaceRequest.allSheets = true;

    const requests = [Sheets.newRequest(), Sheets.newRequest()];
    requests[0].updateSpreadsheetProperties =
      updateSpreadsheetPropertiesRequest;
    requests[1].findReplace = findReplaceRequest;

    const batchUpdateRequest = Sheets.newBatchUpdateSpreadsheetRequest();
    batchUpdateRequest.requests = requests;

    // Add additional requests (operations)
    const result = Sheets.Spreadsheets.batchUpdate(
      batchUpdateRequest,
      spreadsheetId,
    );
    return result;
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log("Failed with error %s", err.message);
  }
};

Java

sheets/snippets/src/main/java/BatchUpdate.java

ดูใน GitHub

import com.google.api.client.googleapis.json.GoogleJsonError;
import com.google.api.client.googleapis.json.GoogleJsonResponseException;
import com.google.api.client.http.HttpRequestInitializer;
import com.google.api.client.http.javanet.NetHttpTransport;
import com.google.api.client.json.gson.GsonFactory;
import com.google.api.services.sheets.v4.Sheets;
import com.google.api.services.sheets.v4.SheetsScopes;
import com.google.api.services.sheets.v4.model.BatchUpdateSpreadsheetRequest;
import com.google.api.services.sheets.v4.model.BatchUpdateSpreadsheetResponse;
import com.google.api.services.sheets.v4.model.FindReplaceRequest;
import com.google.api.services.sheets.v4.model.FindReplaceResponse;
import com.google.api.services.sheets.v4.model.Request;
import com.google.api.services.sheets.v4.model.SpreadsheetProperties;
import com.google.api.services.sheets.v4.model.UpdateSpreadsheetPropertiesRequest;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

/* Class to demonstrate the use of Spreadsheet Batch Update API */
public class BatchUpdate {
  /**
   * Updates spreadsheet's title and cell values.
   *
   * @param spreadsheetId - Id of the spreadsheet.
   * @param title         - New title of the spreadsheet.
   * @param find          - Find cell values
   * @param replacement   - Replaced cell values
   * @return response metadata
   * @throws IOException - if credentials file not found.
   */
  public static BatchUpdateSpreadsheetResponse batchUpdate(String spreadsheetId,
                                                           String title,
                                                           String find,
                                                           String replacement)
      throws IOException {
        /* Load pre-authorized user credentials from the environment.
           TODO(developer) - See https://developers.google.com/identity for
            guides on implementing OAuth2 for your application. */
    GoogleCredentials credentials = GoogleCredentials.getApplicationDefault()
        .createScoped(Collections.singleton(SheetsScopes.SPREADSHEETS));
    HttpRequestInitializer requestInitializer = new HttpCredentialsAdapter(
        credentials);

    // Create the sheets API client
    Sheets service = new Sheets.Builder(new NetHttpTransport(),
        GsonFactory.getDefaultInstance(),
        requestInitializer)
        .setApplicationName("Sheets samples")
        .build();

    List<Request> requests = new ArrayList<>();
    BatchUpdateSpreadsheetResponse response = null;
    try {
      // Change the spreadsheet's title.
      requests.add(new Request()
          .setUpdateSpreadsheetProperties(new UpdateSpreadsheetPropertiesRequest()
              .setProperties(new SpreadsheetProperties()
                  .setTitle(title))
              .setFields("title")));
      // Find and replace text.
      requests.add(new Request()
          .setFindReplace(new FindReplaceRequest()
              .setFind(find)
              .setReplacement(replacement)
              .setAllSheets(true)));

      BatchUpdateSpreadsheetRequest body =
          new BatchUpdateSpreadsheetRequest().setRequests(requests);
      response = service.spreadsheets().batchUpdate(spreadsheetId, body).execute();
      FindReplaceResponse findReplaceResponse = response.getReplies().get(1).getFindReplace();

      System.out.printf("%d replacements made.", findReplaceResponse.getOccurrencesChanged());
    } catch (GoogleJsonResponseException e) {
      // TODO(developer) - handle error appropriately
      GoogleJsonError error = e.getDetails();
      if (error.getCode() == 404) {
        System.out.printf("Spreadsheet not found with id '%s'.\n", spreadsheetId);
      } else {
        throw e;
      }
    }
    return response;
  }
}

JavaScript

sheets/snippets/sheets_batch_update.js

ดูใน GitHub

function batchUpdate(spreadsheetId, title, find, replacement, callback) {
  const requests = [];
  // Change the spreadsheet's title.
  requests.push({
    updateSpreadsheetProperties: {
      properties: {
        title: title,
      },
      fields: 'title',
    },
  });
  // Find and replace text.
  requests.push({
    findReplace: {
      find: find,
      replacement: replacement,
      allSheets: true,
    },
  });
  try {
    // Add additional requests (operations) ...
    const batchUpdateRequest = {requests: requests};
    gapi.client.sheets.spreadsheets.batchUpdate({
      spreadsheetId: spreadsheetId,
      resource: batchUpdateRequest,
    }).then((response) => {
      const findReplaceResponse = response.result.replies[1].findReplace;
      console.log(`${findReplaceResponse.occurrencesChanged} replacements made.`);
      if (callback) callback(response);
    });
  } catch (err) {
    document.getElementById('content').innerText = err.message;
    return;
  }
}

Node.js

sheets/snippets/sheets_batch_update.js

ดูใน GitHub

import {GoogleAuth} from 'google-auth-library';
import {google} from 'googleapis';

/**
 * Performs a batch update on a spreadsheet.
 * Updates the spreadsheet title and finds and replaces a string.
 * @param {string} spreadsheetId The ID of the spreadsheet to update.
 * @param {string} title The new title for the spreadsheet.
 * @param {string} find The string to find.
 * @param {string} replacement The string to replace the found string with.
 * @return {Promise<object>} The response from the batch update.
 */
async function batchUpdate(spreadsheetId, title, find, replacement) {
  // Authenticate with Google and get an authorized client.
  const auth = new GoogleAuth({
    scopes: 'https://www.googleapis.com/auth/spreadsheets',
  });

  // Create a new Sheets API client.
  const service = google.sheets({version: 'v4', auth});

  // Create a list of requests to be executed in the batch update.
  const requests = [];

  // Request to change the spreadsheet's title.
  requests.push({
    updateSpreadsheetProperties: {
      properties: {
        title,
      },
      fields: 'title',
    },
  });

  // Request to find and replace text.
  requests.push({
    findReplace: {
      find,
      replacement,
      allSheets: true,
    },
  });

  // Add more requests here if needed.

  // Create the batch update request.
  const batchUpdateRequest = {requests};

  // Execute the batch update request.
  const response = await service.spreadsheets.batchUpdate({
    spreadsheetId,
    requestBody: batchUpdateRequest,
  });

  // Get the response from the find and replace request and log the number of occurrences.
  const findReplaceResponse = response.data.replies[1].findReplace;
  console.log(`${findReplaceResponse.occurrencesChanged} replacements made.`);
  return response;
}

PHP

sheets/snippets/src/SpreadsheetBatchUpdate.php

ดูใน GitHub

<?php
use Google\Client;
use Google\Service\Drive;
use Google\Service\Sheets\BatchUpdateSpreadsheetRequest;

/**
 * to batch update a spreadsheet
 */
function batchUpdate($spreadsheetId, $title, $find, $replacement)
    {   
        /* Load pre-authorized user credentials from the environment.
           TODO(developer) - See https://developers.google.com/identity for
            guides on implementing OAuth2 for your application. */
        $client = new Google\Client();
        $client->useApplicationDefaultCredentials();
        $client->addScope(Google\Service\Drive::DRIVE);
        $service = new Google_Service_Sheets($client);
        try{
            //execute the request
            $requests = [
                new Google_Service_Sheets_Request([
              'updateSpreadsheetProperties' => [
                  'properties' => [
                      'title' => $title
                    ],
                    'fields' => 'title'
              ]
          ]),
          new Google_Service_Sheets_Request([
              'findReplace' => [
                  'find' => $find,
                  'replacement' => $replacement,
                  'allSheets' => true
                  ]
                  ])
                ];
                $batchUpdateRequest = new Google_Service_Sheets_BatchUpdateSpreadsheetRequest([
                    'requests' => $requests
                ]);
        $response = $service->spreadsheets->batchUpdate($spreadsheetId, $batchUpdateRequest);
        $findReplaceResponse = $response->getReplies()[1]->getFindReplace();
        printf("%s replacements made.\n",
        $findReplaceResponse->getOccurrencesChanged());
        return $response;
    }
    catch(Exception $e) {
        // TODO(developer) - handle error appropriately
        echo 'Message: ' .$e->getMessage();
      }
    }

Python

sheets/snippets/sheets_batch_update.py

ดูใน GitHub

import google.auth
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError


def sheets_batch_update(spreadsheet_id, title, find, replacement):
  """
  Update the sheet details in batch, the user has access to.
  Load pre-authorized user credentials from the environment.
  TODO(developer) - See https://developers.google.com/identity
  for guides on implementing OAuth2 for the application.
  """

  creds, _ = google.auth.default()
  # pylint: disable=maybe-no-member

  try:
    service = build("sheets", "v4", credentials=creds)

    requests = []
    # Change the spreadsheet's title.
    requests.append(
        {
            "updateSpreadsheetProperties": {
                "properties": {"title": title},
                "fields": "title",
            }
        }
    )
    # Find and replace text
    requests.append(
        {
            "findReplace": {
                "find": find,
                "replacement": replacement,
                "allSheets": True,
            }
        }
    )
    # Add additional requests (operations) ...

    body = {"requests": requests}
    response = (
        service.spreadsheets()
        .batchUpdate(spreadsheetId=spreadsheet_id, body=body)
        .execute()
    )
    find_replace_response = response.get("replies")[1].get("findReplace")
    print(
        f"{find_replace_response.get('occurrencesChanged')} replacements made."
    )
    return response

  except HttpError as error:
    print(f"An error occurred: {error}")
    return error


if __name__ == "__main__":
  sheets_batch_update("spreadsheet_id", "title", "find", "replacement")

Ruby

sheets/snippets/lib/spreadsheet_snippets.rb

ดูใน GitHub

requests = []
# Change the name of sheet ID '0' (the default first sheet on every
# spreadsheet)
requests.push({
                update_sheet_properties: {
                  properties: { sheet_id: 0, title: 'New Sheet Name' },
                  fields:     'title'
                }
              })
# Find and replace text
requests.push({
                find_replace: {
                  find:        find,
                  replacement: replacement,
                  all_sheets:  true
                }
              })
# Add additional requests (operations) ...

body = { requests: requests }
result = service.batch_update_spreadsheet(spreadsheet_id, body, {})
find_replace_response = result.replies[1].find_replace
puts "#{find_replace_response.occurrences_changed} replacements made."