صفحات گسترده را به روز کنید

گذشته از داده‌های مقداری موجود در سلول‌های آن، یک صفحه گسترده شامل انواع دیگری از داده‌ها نیز می‌شود، مانند:

• ابعاد
• قالب‌ها و حاشیه‌های سلول
• محدوده‌های نامگذاری شده
• محدوده‌های حفاظت‌شده
• قالب‌بندی شرطی

اینها برخی از انواع داده‌هایی هستند که ظاهر و عملکرد یک صفحه گسترده را کنترل می‌کنند. متد spreadsheets.batchUpdate به شما امکان می‌دهد هر یک از این جزئیات صفحه گسترده را به‌روزرسانی کنید. تغییرات در یک دسته گروه‌بندی می‌شوند، به طوری که اگر یک درخواست ناموفق باشد، هیچ یک از تغییرات دیگر (که به طور بالقوه وابسته هستند) نوشته نمی‌شوند.

این صفحه اصول اولیه استفاده از متد spreadsheets.batchUpdate را شرح می‌دهد. اگر نیاز به خواندن و نوشتن داده‌های مقدار سلول دارید، می‌توانید از منبع spreadsheets.values ​​که در بخش «خواندن و نوشتن مقادیر سلول» توضیح داده شده است، نیز استفاده کنید.

دسته بندی عملیات

عملیات خاصی که توسط spreadsheets.batchUpdate پشتیبانی می‌شوند را می‌توان در دسته‌های کلی زیر گروه‌بندی کرد:

دسته بندی	توضیحات
اضافه کردن (و کپی کردن )	اشیاء جدید اضافه کنید (گاهی اوقات بر اساس اشیاء قدیمی، مانند درخواست‌های تکراری).
به‌روزرسانی (و تنظیم )	به‌روزرسانی ویژگی‌های خاصی از یک شیء، معمولاً بدون تغییر ویژگی‌های قدیمی (در حالی که درخواست Set داده‌های قبلی را بازنویسی می‌کند).
حذف	اشیاء را بردارید.

این دسته بندی ها در بخش بعدی برای توصیف رفتار عملیات خاص استفاده می شوند.

عملیات به‌روزرسانی دسته‌ای

متد spreadsheets.batchUpdate با گرفتن یک یا چند شیء Request کار می‌کند که هر کدام نوع درخواستی را برای اجرا مشخص می‌کنند. انواع مختلفی از درخواست‌ها وجود دارد. در اینجا به تفصیل انواع درخواست‌ها که در دسته‌های مختلف گروه‌بندی شده‌اند، آمده است.

شیء	اضافه کردن / کپی کردن	به‌روزرسانی / تنظیم	حذف
ویژگی‌های صفحه گسترده		درخواست به‌روزرسانی ویژگی‌های صفحه‌گسترده
ورق‌ها	درخواست افزودن برگه درخواست برگه تکراری	درخواست ویژگی‌های برگه به‌روزرسانی	درخواست حذف برگه
ابعاد (شامل محدوده ابعاد )	درخواست درج ابعاد درخواست افزودن ابعاد	درخواست به‌روزرسانی ویژگی‌های ابعاد درخواست MoveDimension درخواست تغییر اندازه خودکار ابعاد	درخواست حذف ابعاد
سلول‌ها (شامل مقادیر، قالب‌ها، اعتبارسنجی داده‌ها و غیره)		درخواست تکرارسلول درخواست به‌روزرسانی سلول‌ها درخواست افزودن سلول‌ها
محدوده‌های نامگذاری شده	درخواست AddNamedRange	درخواست به‌روزرسانی‌نام‌برد	درخواست حذف محدوده نام‌گذاری‌شده
مرزها		درخواست به‌روزرسانی مرزها
فیلترها (شامل نماهای فیلتر و فیلتر پایه )	درخواست AddFilterView درخواست نمایش فیلتر تکراری	درخواست به‌روزرسانیFilterView درخواست SetBasicFilter	درخواست فیلتر پاک‌کننده‌ی پایه
اعتبارسنجی داده‌ها		درخواست اعتبارسنجی تنظیم داده‌ها
قوانین قالب بندی شرطی	درخواست قالب شرطی را اضافه کنید	درخواست UpdateConditionalFormatRule	درخواست قالب شرطی حذف
محدوده‌های حفاظت‌شده	درخواست AddProtectedRange	درخواست به‌روزرسانی محدوده محافظت‌شده	درخواست حذف محدوده محافظت‌شده
اشیاء جاسازی‌شده (از جمله نمودارها )	درخواست افزودن نمودار	درخواست به‌روزرسانی مشخصات نمودار درخواست موقعیت شیء جاسازی‌شده (UpdateEmbeddedObjectPositionRequest)	درخواست حذف شیء جاسازی‌شده
ادغام‌ها	درخواست ادغام سلول‌ها		درخواست لغو ادغام سلول‌ها

همچنین برخی درخواست‌های اضافی وجود دارد که اقدامات کاربر را برای دستکاری داده‌ها تقلید می‌کنند:

• درخواست تکمیل خودکار
• درخواست برش و چسباندن
• درخواست کپی پیست
• درخواست جایگزینی را پیدا کنید
• درخواست چسباندن داده
• درخواست متن به ستون‌ها
• درخواست مرتب‌سازی

محدودیت‌ها

برای کسب اطلاعات بیشتر در مورد محدودیت‌های سلول و ردیف در Google Sheets، به فایل‌هایی که می‌توانید در Google Drive ذخیره کنید مراجعه کنید.

ماسک‌های صحرایی

بسیاری از درخواست‌های «به‌روزرسانی» نیاز به ماسک‌های فیلد دارند. این ماسک‌ها فهرستی از فیلدها هستند که با کاما از هم جدا شده‌اند تا فقط فیلدهای خاصی را در یک شیء به‌روزرسانی کنند و سایر فیلدها را بدون تغییر باقی بگذارند. ماسک فیلد * مانند یک کاراکتر جایگزین رفتار می‌کند و خلاصه‌ای از مشخص کردن هر فیلد در یک پیام است (به این معنی که اگر مقداری برای یک فیلد در درخواست مشخص نکنید، ممکن است به حالت پیش‌فرض خود بازگردد). برای اطلاعات بیشتر در مورد ماسک‌های فیلد، به بخش «استفاده از ماسک‌های فیلد» مراجعه کنید.

نمونه زیر از UpdateSpreadsheetPropertiesRequest برای به‌روزرسانی فقط عنوان یک صفحه گسترده استفاده می‌کند:

درخواست:

POST .../v4/spreadsheets/spreadsheetId:batchUpdate

متن درخواست:

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

TITLE با عنوان جدید صفحه گسترده جایگزین کنید.

پاسخ‌ها

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

معمولاً درخواست‌های «افزودن» پاسخ‌هایی دارند که اطلاعاتی مانند شناسه شیء اضافه شده را برمی‌گردانند. برای فهرست پاسخ‌های پشتیبانی‌شده، به بخش پاسخ‌ها مراجعه کنید.

مثال

نمونه کد زیر این اقدامات را انجام می‌دهد:

1. عنوان صفحه گسترده را با استفاده از متغیر title به‌روزرسانی می‌کند.
2. با استفاده از متغیرهای find و replacement مقادیر سلول‌ها را در صفحه گسترده پیدا و جایگزین می‌کند.

اسکریپت برنامه‌ها

sheets/api/spreadsheet_snippets.gs

مشاهده در گیت‌هاب

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

جاوا

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

مشاهده در گیت‌هاب

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

جاوا اسکریپت

sheets/snippets/sheets_batch_update.js

مشاهده در گیت‌هاب

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

نود جی اس

sheets/snippets/sheets_batch_update.js

مشاهده در گیت‌هاب

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

پی اچ پی

sheets/snippets/src/SpreadsheetBatchUpdate.php

مشاهده در گیت‌هاب

<?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();
      }
    }

پایتون

sheets/snippets/sheets_batch_update.py

مشاهده در گیت‌هاب

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")

روبی

sheets/snippets/lib/spreadsheet_snippets.rb

مشاهده در گیت‌هاب

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."