REST Resource: sessions

资源：PickingSession

用户可以使用 Google 相册选择照片和视频的用户会话的表示形式。

JSON 表示法 
{
  "id": string,
  "pickerUri": string,
  "pollingConfig": {
    object (PollingConfig)
  },
  "expireTime": string,
  "pickingConfig": {
    object (PickingConfig)
  },
  "mediaItemsSet": boolean
}
字段
id

string

仅限输出。Google 为相应会话生成的标识符。
pickerUri

string

仅限输出。用于将用户重定向到 Google 相册（网页版）的 URI，以便用户可以选择当前会话的照片和视频。

如需成功查看此页面，用户必须在网络浏览器中登录拥有相应会话的 Google 账号。

出于安全原因，无法在 iframe 中打开 pickerUri。

对于基于 Web 的应用，您可以将 /autoclose 附加到此 URI。然后，Google 相册窗口或标签页会在用户完成选择后自动关闭，而不是显示“完成”界面。
pollingConfig

object (PollingConfig)

仅限输出。应用在轮询 sessions.get 时应使用的推荐配置。

只有当相应会话尚未选择媒体项时，系统才会填充此字段（即 mediaItemsSet 为 false）。
expireTime

string (Timestamp format)

仅限输出。相应会话（及其所选媒体项）的访问权限的过期时间。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"
pickingConfig

object (PickingConfig)

可选。用户在此会话期间选择照片的配置。

这是由客户端应用在调用 sessions.create 时指定的，事后无法修改（除非创建新会话）。
mediaItemsSet

boolean

仅限输出。如果设置为 true，则表示已为此会话选择媒体项，并且您的应用可以通过 mediaItems.list 请求所选媒体项的列表。

PollingConfig

用于轮询 API 的配置。

JSON 表示法 
{
  "pollInterval": string,
  "timeoutIn": string
}
字段
pollInterval

string (Duration format)

仅限输出。建议的轮询请求之间的时间间隔。

该时长以秒为单位，最多包含九个小数位，以“s”结尾。示例："3.5s"。
timeoutIn

string (Duration format)

仅限输出。客户端应停止轮询的时间长度。

值为 0 表示客户端应停止轮询（如果尚未停止）。

该时长以秒为单位，最多包含九个小数位，以“s”结尾。示例："3.5s"。

PickingConfig

用户在此会话期间的拣货体验的客户端指定配置。

JSON 表示法 
{
  "maxItemCount": string
}
字段
maxItemCount

string (int64 format)

可选。用户在此会话期间可选择的商品数量上限。如果未指定，则默认为 2000。

如果未指定或设为 0，则最多可以选择 2, 000 个商品。大于 2000 的值将强制转换为 2000。负值会导致 INVALID_ARGUMENT 错误。

方法

create

 生成一个新会话，用户可以在该会话期间选择照片和视频以供第三方访问。

delete

 删除指定的会话。

get

 检索指定会话的相关信息。