‫Google משתמשת בטכנולוגיית AI כדי לתרגם תוכן לשפה המועדפת עליך. בתרגומים כאלו עשויות להיות שגיאות.

עדכון גיליונות אלקטרוניים

במאמר הזה מוסבר איך משתמשים בשיטה spreadsheets.batchUpdate במשאב spreadsheets.

בנוסף לנתוני הערכים שבתאים, גיליון אלקטרוני כולל סוגים רבים אחרים של נתונים, כמו:

מידות
פורמטים וגבולות של תאים
טווחים בעלי שם
טווחים מוגנים
עיצוב מותנה

אלה רק חלק מסוגי הנתונים הרבים ששולטים במראה ובפעולה של גיליון אלקטרוני. השיטה spreadsheets.batchUpdate מאפשרת לכם לעדכן את כל הפרטים האלה בגיליון האלקטרוני. השינויים מקובצים בחבילה, כך שאם בקשה אחת לא מצליחה, אף אחד מהשינויים האחרים (שיכול להיות שהם תלויים בה) לא נכתב.

אם אתם צריכים לקרוא ולכתוב נתונים של ערכי תאים, אתם יכולים גם להשתמש במשאב spreadsheets.values, כפי שמתואר במאמר קריאה וכתיבה של ערכי תאים.

סוגי פעולות

אפשר לקבץ את הפעולות הספציפיות שנתמכות על ידי השיטה spreadsheets.batchUpdate לסוגי הפעולות הרחבים הבאים:

קטגוריה	תיאור
הוספה (ושכפול)	הוספת אובייקטים חדשים (לפעמים על סמך אובייקטים ישנים, כמו בבקשות לשכפול).
עדכון (והגדרה)	עדכון של מאפיינים מסוימים של אובייקט, בדרך כלל בלי לשנות את המאפיינים הקודמים (לעומת בקשת Set שדורסת את הנתונים הקודמים).
מחיקה	הסרת אובייקטים.

הקטגוריות האלה משמשות בקטע הבא לתיאור ההתנהגות של פעולות ספציפיות.

פעולות של חבילת עדכונים

השיטה spreadsheets.batchUpdate פועלת על ידי קבלת אובייקט 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 Sheets זמין במאמר קבצים שאפשר לאחסן ב-Google Drive.

שימוש באנונימיזציה של שדות לעדכון שדות ספציפיים

הרבה בקשות עדכון דורשות FieldMask. מסכת שדות היא רשימה של שדות שמופרדים באמצעות פסיקים, ומשמשת לציון השדות באובייקט שצריך לעדכן, בלי לשנות את כל השדות האחרים. שימוש במסכת שדות מונע החלפות בטעות של שדות שלא צוינו בבקשה.

מידע נוסף על מסכות שדות מופיע במאמר עדכון באמצעות מסכת שדות.

בדוגמת הקוד הבאה אפשר לראות איך משתמשים ב-UpdateSpreadsheetPropertiesRequest כדי לעדכן רק את השם של גיליון אלקטרוני:

בקשה

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

גוף הבקשה

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

מחליפים את TITLE בשם החדש של הגיליון האלקטרוני.

עדכון תשובות בכמות גדולה

כשמעדכנים גיליון אלקטרוני, יכול להיות שסוגים מסוימים של בקשות יחזירו תשובות. התשובות מוחזרות במערך, וכל תשובה תופסת את אותו אינדקס כמו הבקשה התואמת. יש בקשות שלא מתקבלות עליהן תשובות, ובמקרים כאלה התשובה ריקה.

בדרך כלל, בקשות מסוג add (הוספה) מקבלות תגובות שמחזירות מידע כמו המזהה של האובייקט שנוסף. רשימת התגובות הנתמכות מופיעה במאמר Responses.

דוגמת קוד: חבילת עדכונים של גיליון אלקטרוני

בדוגמת הקוד הבאה אפשר לראות איך לבצע את הפעולות האלה:

מעדכנים את שם הגיליון האלקטרוני באמצעות המשתנה title.
מחפשים ומחליפים ערכים של תאים בגיליון האלקטרוני באמצעות המשתנים 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."

עדכון גיליונות אלקטרוניים קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.

סוגי פעולות

פעולות של חבילת עדכונים

בקשות לטיפול בנתונים

שימוש באנונימיזציה של שדות לעדכון שדות ספציפיים

עדכון תשובות בכמות גדולה

דוגמת קוד: חבילת עדכונים של גיליון אלקטרוני

Apps Script

Java

JavaScript

Node.js

PHP

Python

Ruby

עדכון גיליונות אלקטרוניים