使用字段掩码

API 调用方可通过字段掩码列出请求应返回或更新的字段。使用 FieldMask 可让 API 避免不必要的工作,并提高性能。Google 幻灯片 API 中的读取和更新方法会使用字段掩码。

使用字段掩码进行读取

演示文稿可能很大,并且通常并不需要读取请求返回的 Presentation 资源的每个部分。您可以使用 fields 网址参数限制在 Slides API 响应中返回的内容。为获得最佳性能,请在回复中仅明确列出您需要的字段

字段参数的格式与 FieldMask 的 JSON 编码相同。简单地说,多个不同字段用英文逗号分隔,子字段用英文句点分隔。字段名称可以使用 camelCasecontinue_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)

此方法调用的响应是一个 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"
      }
    }
  ]
}