使用欄位遮罩

欄位遮罩是 API 呼叫端用來列出要求應傳回或更新的欄位。使用 FieldMask 可讓 API 避免不必要的工作,並提升效能。欄位遮罩可用於 Google Slides API 中的讀取和更新方法。

使用欄位遮罩讀取

簡報檔案可能很大,而且您通常不需要讀取要求傳回的 Presentation 資源的每個部分。您可以使用 fields 網址參數,限制 Google 簡報 API 回應中傳回的內容。為求最佳效能,請在回覆中明確列出您需要的欄位

fields 參數的格式與 FieldMask 的 JSON 編碼相同。簡單來說,多個不同的欄位以半形逗號分隔,子欄位則以點號分隔。您可以使用 大寫字母與小寫字母混合以底線分隔的方式指定欄位名稱。為了方便起見,您可以將同類型中的多個子欄位列在括號內。

以下 presentations.get 要求範例使用 slides.pageElements(objectId,size,transform) 的欄位遮罩,只擷取簡報中所有投影片的 pageElement 物件物件 ID、Size轉換

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