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

این سند اصول اولیه استفاده از متد spreadsheets.batchUpdate را در منبع spreadsheets شرح می‌دهد.

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

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

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

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

انواع عملیات

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

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

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

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

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

شیء اضافه کردن / کپی کردن به‌روزرسانی / تنظیم حذف
BandedRange درخواست افزودن درخواست به‌روزرسانی درخواست حذف باندینگ
Borders درخواست به‌روزرسانی مرزها
Cells (شامل مقادیر، قالب‌ها، اعتبارسنجی داده‌ها و غیره) درخواست درج محدوده درخواست تکرارسلول
درخواست به‌روزرسانی سلول‌ها
درخواست افزودن سلول‌ها
درخواست حذف محدوده
ConditionalFormatRule درخواست قالب شرطی را اضافه کنید درخواست UpdateConditionalFormatRule درخواست قالب شرطی حذف
DataSource درخواست منبع داده را اضافه کنید درخواست به‌روزرسانی منبع داده
درخواست تازه‌سازی منبع داده
لغو منبع دادهدرخواست تازه کردن
درخواست حذف منبع داده
DataValidationRule درخواست اعتبارسنجی تنظیم داده‌ها
developerMetadata درخواست ایجادفرادادهتوسعه‌دهنده درخواست به‌روزرسانیتوسعه‌دهندهفراداده درخواست حذف توسعه‌دهندهفراداده
Dimension (شامل DimensionRange ) درخواست درج ابعاد
درخواست افزودن ابعاد
درخواست به‌روزرسانی ویژگی‌های ابعاد
درخواست MoveDimension
درخواست تغییر اندازه خودکار ابعاد
درخواست حذف ابعاد
DimensionGroup درخواست افزودن ابعاد به گروه درخواست گروه ابعاد به‌روزرسانی درخواست گروه ابعاد حذف
EmbeddedChart درخواست افزودن نمودار درخواست به‌روزرسانی مشخصات نمودار
درخواست موقعیت شیء جاسازی‌شده (UpdateEmbeddedObjectPositionRequest)
درخواست به‌روزرسانی شیء مرزی
درخواست حذف شیء جاسازی‌شده
FilterView (شامل BasicFilter ) درخواست AddFilterView
درخواست نمایش فیلتر تکراری
درخواست به‌روزرسانیFilterView
درخواست SetBasicFilter
درخواست فیلتر پاک‌کننده‌ی پایه
درخواست حذف فیلتر ویو
ادغام سلول ها (از جمله MergeType ) درخواست ادغام سلول‌ها درخواست لغو ادغام سلول‌ها
NamedRange درخواست AddNamedRange درخواست به‌روزرسانی‌نام‌برد درخواست حذف محدوده نام‌گذاری‌شده
ProtectedRange درخواست AddProtectedRange درخواست به‌روزرسانی محدوده محافظت‌شده درخواست حذف محدوده محافظت‌شده
Sheets درخواست افزودن برگه
درخواست برگه تکراری
درخواست ویژگی‌های برگه به‌روزرسانی درخواست حذف برگه
Slicer درخواست AddSlicer درخواست UpdateSlicerSpec
SpreadsheetProperties درخواست به‌روزرسانی ویژگی‌های صفحه‌گسترده
Table درخواست اضافه کردن جدول درخواست به‌روزرسانی جدول درخواست حذف جدول

درخواست‌های دستکاری داده‌ها

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

درخواست توضیحات
AutoFillRequest به طور خودکار داده‌های بیشتری را بر اساس داده‌های موجود پر می‌کند.
CopyPasteRequest داده‌ها را از یک ناحیه کپی کرده و در ناحیه دیگر جایگذاری می‌کند.
CutPasteRequest داده‌ها را از یک ناحیه برش داده و در ناحیه دیگری جایگذاری می‌کند.
DeleteDuplicatesRequest ردیف‌های حاوی مقادیر تکراری را در ستون‌های مشخص‌شده از یک محدوده سلولی حذف می‌کند.
FindReplaceRequest موارد تکرار یک متن را پیدا کرده و با متن دیگری جایگزین می‌کند.
PasteDataRequest داده‌ها (HTML یا جدا شده) را در یک برگه جایگذاری می‌کند.
RandomizeRangeRequest ترتیب ردیف‌ها را در یک محدوده تصادفی می‌کند.
SortRangeRequest داده‌ها را در یک محدوده مرتب می‌کند.
TextToColumnsRequest یک ستون متن را به چندین ستون متن تبدیل می‌کند.
TrimWhitespaceRequest سلول‌های دارای فضای خالی (مانند فاصله، تب یا خط جدید) را حذف می‌کند.

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

استفاده از ماسک‌های فیلد برای به‌روزرسانی فیلدهای خاص

بسیاری از درخواست‌های به‌روزرسانی نیاز به FieldMask دارند. Field Mask فهرستی از فیلدها است که با کاما از هم جدا شده و برای نشان دادن فیلدهایی در یک شیء که باید به‌روزرسانی شوند، استفاده می‌شود، در حالی که سایر فیلدها بدون تغییر باقی می‌مانند. استفاده از Field Mask از رونویسی تصادفی فیلدهایی که در درخواست مشخص نشده‌اند، جلوگیری می‌کند.

برای اطلاعات بیشتر در مورد ماسک‌های میدانی، به به‌روزرسانی با ماسک میدانی مراجعه کنید.

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

درخواست

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

درخواست بدنه

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

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

به‌روزرسانی دسته‌ای پاسخ‌ها

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

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

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

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

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