フィールド マスクを使用する

フィールド マスクは、リクエストで返されるフィールドまたは更新されるフィールドを API 呼び出し元が一覧表示する方法です。FieldMaskフィールド マスクは、Google スプレッドシート API の読み取りメソッドと更新メソッドの両方で使用されます。

フィールド マスクを使用した読み取り

スプレッドシートは大きくなる可能性があり、読み取りリクエストによって返される Spreadsheet リソースのすべての部分が必要になるとは限りません。fields URL パラメータを使用すると、Sheets API レスポンスで返される内容を制限できます。最適なパフォーマンスを得るには、返信に必要なフィールドのみを明示的にリストします。

fields パラメータの形式は、FieldMask の JSON エンコードと同じです。 簡単に言うと、複数の異なるフィールドはカンマ区切りで、サブフィールドはドットで区切られます。フィールド名は、camelCase または separated_by_underscores で指定できます。便宜上、同じタイプの複数のサブフィールドをかっこで囲んでリストできます。

次の spreadsheets.get リクエストの例では、 sheets.properties(sheetId,title,sheetType,gridProperties)のフィールド マスクを使用して、スプレッドシート内のすべてのシートの SheetProperties オブジェクトの シート ID、タイトル、 SheetType、 および GridProperties のみを取得します。

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