REST Resource: sessions

Tài nguyên: PickingSession

Hình ảnh minh hoạ một phiên hoạt động của người dùng, trong đó người dùng có thể chọn ảnh và video bằng Google Photos.

Biểu diễn dưới dạng JSON
{
  "id": string,
  "pickerUri": string,
  "pollingConfig": {
    object (PollingConfig)
  },
  "expireTime": string,
  "pickingConfig": {
    object (PickingConfig)
  },
  "mediaItemsSet": boolean
}
Trường
id

string

Chỉ có đầu ra. Giá trị nhận dạng do Google tạo cho phiên này.

pickerUri

string

Chỉ có đầu ra. URI dùng để chuyển hướng người dùng đến Google Photos (trên web) để họ có thể chọn ảnh và video cho phiên hiện tại.

Để xem được trang này, người dùng phải đăng nhập vào Tài khoản Google sở hữu phiên này trong trình duyệt web của họ.

Không thể mở pickerUri trong một iframe do lý do bảo mật.

pollingConfig

object (PollingConfig)

Chỉ có đầu ra. Cấu hình đề xuất mà các ứng dụng nên sử dụng trong khi thăm dò ý kiến sessions.get.

Trường này chỉ được điền nếu bạn chưa chọn mục nội dung nghe nhìn cho phiên này (tức là mediaItemsSet là false).

expireTime

string (Timestamp format)

Chỉ có đầu ra. Thời điểm quyền truy cập vào phiên này (và các mục nội dung nghe nhìn đã chọn) sẽ hết hạn.

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo Z và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ dời khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".

pickingConfig

object (PickingConfig)

Không bắt buộc. Cấu hình chọn ảnh cho trải nghiệm chọn ảnh của người dùng trong phiên này.

Giá trị này do ứng dụng khách chỉ định khi gọi sessions.create và không thể sửa đổi sau khi thực hiện (mà không tạo phiên mới).

mediaItemsSet

boolean

Chỉ có đầu ra. Nếu được đặt thành true, các mục nội dung đa phương tiện đã được chọn cho phiên này và ứng dụng của bạn có thể yêu cầu danh sách các mục nội dung đa phương tiện đã chọn thông qua mediaItems.list.

PollingConfig

Cấu hình để thăm dò ý kiến API.

Biểu diễn dưới dạng JSON
{
  "pollInterval": string,
  "timeoutIn": string
}
Trường
pollInterval

string (Duration format)

Chỉ có đầu ra. Thời gian đề xuất giữa các yêu cầu thăm dò ý kiến.

Thời lượng tính bằng giây, có tối đa 9 chữ số thập phân, kết thúc bằng "s". Ví dụ: "3.5s".

timeoutIn

string (Duration format)

Chỉ có đầu ra. Khoảng thời gian mà sau đó ứng dụng sẽ ngừng thăm dò ý kiến.

Giá trị 0 cho biết ứng dụng phải ngừng thăm dò ý kiến nếu chưa dừng.

Thời lượng tính bằng giây, có tối đa 9 chữ số thập phân, kết thúc bằng "s". Ví dụ: "3.5s".

PickingConfig

Cấu hình do ứng dụng chỉ định cho trải nghiệm chọn của người dùng trong phiên này.

Biểu diễn dưới dạng JSON
{
  "maxItemCount": string
}
Trường
maxItemCount

string (int64 format)

Không bắt buộc. Số lượng mặt hàng tối đa mà người dùng có thể chọn trong phiên này. Giá trị mặc định là 2000 nếu không được chỉ định.

Nếu không chỉ định hoặc đặt thành 0, bạn chỉ có thể chọn tối đa 2.000 mục. Các giá trị trên 2000 sẽ được ép thành 2000. Giá trị âm sẽ dẫn đến lỗi INVALID_ARGUMENT.

Phương thức

create

Tạo một phiên mới, trong đó người dùng có thể chọn ảnh và video để bên thứ ba truy cập.

delete

Xoá phiên đã chỉ định.

get

Truy xuất thông tin về phiên được chỉ định.