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

フィールド マスクは、API 呼び出し元がリクエストで返すまたは更新するフィールドを一覧表示する方法です。FieldMask を使用すると、API で不要な処理を回避し、パフォーマンスを向上させることができます。フィールドマスクは、Google Slides API の読み取りメソッドと更新メソッドの両方に使用されます。

フィールドマスクを使用しない場合と使用した場合にレスポンス本文で返される内容の比較については、部分リソースの操作をご覧ください。

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

プレゼンテーションはサイズが大きい場合があり、読み取りリクエストによって返される presentations リソースのすべての部分が必要ない場合もあります。fields URL パラメータを使用して、Slides API レスポンスで返される内容を制限できます。パフォーマンスを最適にするには、必要なフィールドのみを明示的にリストします。

fields パラメータの形式は、FieldMask の JSON エンコードと同じです。簡単に説明すると、複数のフィールドはカンマで区切り、サブフィールドはドットで区切ります。フィールド名は camelCase または separated_by_underscores で指定できます。便宜上、同じタイプの複数のサブフィールドを括弧内に指定できます。

次の presentations.get メソッド リクエストの例では、slides.pageElements(objectId,size,transform) のフィールドマスクを使用して、プレゼンテーションのすべてのスライドにある pageElement オブジェクトのオブジェクト ID（Size）と変換のみを取得します。

GET https://slides.googleapis.com/v1/presentations/presentationId?fields=slides.pageElements(objectId,size,transform)

このメソッド呼び出しのレスポンスは、フィールドマスクでリクエストされたコンポーネントを含む presentations オブジェクトです。

{
  "slides": [
    {
      "pageElements": [
        {
          "objectId": "OBJECT_ID",
          "size": {
            "width": {
              "magnitude": 3000000,
              "unit": "EMU"
            },
            "height": {
              "magnitude": 3000000,
              "unit": "EMU"
            }
          },
          "transform": {
            "scaleX": 1,
            "scaleY": 1
            "translateX": 311708,
            "translateY": 744575,
            "unit": "EMU"
          }
        },
        {
          "objectId": "OBJECT_ID",
          "size": {
            "width": {
              "magnitude": 3000000,
              "unit": "EMU"
            },
            "height": {
              "magnitude": 3000000,
              "unit": "EMU"
            }
          },
          "transform": {
            "scaleX": 1,
            "scaleY": 1
            "translateX": 311700,
            "translateY": 2834125,
            "unit": "EMU"
          }
        }
     ]
    }
  ]
}

フィールド マスクを使用して更新する

オブジェクト内の特定のフィールドのみを更新し、他のフィールドは変更しない場合があります。presentations.batchUpdate メソッド内の更新リクエストでは、フィールド マスクを使用して、変更対象のフィールドを API に指定します。更新リクエストは、フィールド マスクで指定されていないフィールドを無視し、現在の値をそのまま使用します。

更新されたメッセージでフィールドを指定しないようにし、フィールドをマスクに追加することで、フィールドの設定を解除することもできます。これにより、フィールドに以前設定されていた値がすべて消去されます。

更新フィールド マスクの構文は、読み取りフィールド マスクと同じです。

次の例では、UpdateShapePropertiesRequest メソッドを使用して、シェイプの塗りつぶし色を DARK1 テーマカラーに変更し、シェイプの輪郭を設定解除します。

POST https://slides.googleapis.com/v1/presentations/presentationId:batchUpdate
 
{
  "requests": [
    {
      "updateShapeProperties": {
        "objectId": OBJECT_ID,
        "shapeProperties": {
          "shapeBackgroundFill": {
            "solidFill": {
              "color": {
                "themeColor": "DARK1"
              }
            }
          }
        },
        "fields": "shapeBackgroundFill.solidFill.color,outline"
      }
    }
  ]
}