از ماسک های میدانی استفاده کنید، از ماسک های میدانی استفاده کنید

فیلد ماسک راهی برای تماس‌گیرندگان API برای فهرست کردن فیلدهایی است که درخواست باید برگرداند یا به‌روزرسانی کند. استفاده از FieldMask به API اجازه می دهد تا از کارهای غیر ضروری جلوگیری کند و عملکرد را بهبود بخشد. یک فیلد ماسک برای هر دو روش خواندن و به‌روزرسانی در Google Sheets API استفاده می‌شود.

با ماسک میدانی بخوانید

صفحه‌گسترده‌ها می‌توانند بزرگ باشند، و اغلب شما نیازی ندارید که همه بخش‌های منبع Spreadsheet با درخواست خواندن بازگردانده شود. می‌توانید با استفاده از پارامتر URL fields ، آنچه را که در پاسخ Sheets API بازگردانده می‌شود، محدود کنید. برای بهترین عملکرد، فقط فیلدهایی را که در پاسخ نیاز دارید به صراحت فهرست کنید .

فرمت پارامتر فیلدها مانند رمزگذاری JSON یک FieldMask است. به طور خلاصه، چندین فیلد مختلف با کاما و زیر فیلدها با نقطه جدا می شوند. نام فیلدها را می توان در camelCase یا جداگانه_by_underscores مشخص کرد. برای راحتی، چندین زیرفیلد از یک نوع را می توان در داخل پرانتز فهرست کرد.

مثال درخواست spreadsheets.get زیر از یک ماسک فیلد sheets.properties(sheetId,title,sheetType,gridProperties) استفاده می‌کند تا فقط شناسه برگه، عنوان، SheetType و GridProperties یک شی SheetProperties را در همه برگه‌های یک صفحه گسترده واکشی کند:

GET https://sheets.googleapis.com/v4/spreadsheets/spreadsheetId?fields=sheets.properties(sheetId,title,sheetType,gridProperties)

پاسخ به این فراخوانی متد یک شیء Spreadsheet حاوی اجزای درخواست شده در فیلد ماسک است. توجه داشته باشید که sheetType=OBJECT حاوی gridProperties نیست:

{
  "sheets": [
    {
      "properties": {
        "sheetId": SHEET_ID,
        "title": "TITLE",
        "sheetType": "GRID",
        "gridProperties": {
          "rowCount": 1000,
          "columnCount": 25
        }
      }
    },
    {
      "properties": {
        "sheetId": SHEET_ID,
        "title": "TITLE",
        "sheetType": "OBJECT"
      }
    }
  ]
}

به روز رسانی با ماسک فیلد

گاهی اوقات شما نیاز دارید که فقط فیلدهای خاصی را در یک شی به روز کنید در حالی که فیلدهای دیگر را بدون تغییر رها کنید. درخواست‌های به‌روزرسانی در یک عملیات spreadsheets.batchUpdate از ماسک‌های فیلد استفاده می‌کند تا به API بگوید کدام فیلدها در حال تغییر هستند. درخواست به‌روزرسانی، فیلدی‌هایی را که در فیلد ماسک مشخص نشده‌اند نادیده می‌گیرد و مقادیر فعلی‌شان را باقی می‌گذارد.

همچنین می‌توانید یک فیلد را با مشخص نکردن آن در پیام به‌روزرسانی شده، اما افزودن فیلد به ماسک، لغو تنظیم کنید. این هر مقداری را که فیلد قبلاً داشته است پاک می کند.

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

مثال زیر از AddSheetRequest برای اضافه کردن یک برگه جدید از نوع Grid ، ثابت کردن ردیف اول و رنگ قرمز برگه برگه جدید استفاده می کند:

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

{
  "spreadsheetId": "SPREADSHEET_ID",
  "replies": [
    {
      "addSheet": {
        "properties": {
          "sheetId": SHEET_ID,
          "title": "TITLE",
          "index": 6,
          "sheetType": "GRID",
          "gridProperties": {
            "rowCount": 1000,
            "columnCount": 26,
            "frozenRowCount": 1
          },
          "tabColor": {
            "red": 0.003921569
          },
          "tabColorStyle": {
            "rgbColor": {
              "red": 0.003921569
            }
          }
        }
      }
    }
  ]
}