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

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

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

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

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

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

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

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

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