フィールド マスクを使用すると、API 呼び出し元がリクエストで返すまたは更新するフィールドを一覧表示できます。FieldMask を使用すると、API で不要な処理を回避でき、パフォーマンスが向上します。フィールド マスクは、Google Sheets API の read メソッドと update メソッドの両方で使用されます。
フィールド マスクを使用して読み取る
スプレッドシートはサイズが大きい場合があり、読み取りリクエストで返される Spreadsheet
リソースのすべての部分が必要なわけではないため、fields
URL パラメータを使用すると、Sheets API レスポンスで返される内容を制限できます。最適なパフォーマンスを得るには、返信に必要なフィールドのみを明示的に列挙します。
fields パラメータの形式は、FieldMask の JSON エンコードと同じです。つまり、複数の異なるフィールドはカンマで区切り、サブフィールドはドットで区切ります。フィールド名は、camelCase または separate_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 } } } } } ] }