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

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

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

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

プレゼンテーションは大きくなることがあり、読み取りリクエストで返される presentations リソースのすべての部分が必要になることはほとんどありません。fields URL パラメータを使用すると、スライド API レスポンスで返される内容を制限できます。パフォーマンスを最大限に高めるには、返信で必要なフィールドのみを明示的にリストします。

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

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

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