REST Resource: sessions

Tài nguyên: PickingSession

Biểu thị 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 trang này thành công, 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 iframe vì lý do bảo mật.

Đối với các ứng dụng dựa trên web, bạn có thể thêm /autoclose vào URI này. Sau đó, cửa sổ hoặc thẻ Google Photos sẽ tự động đóng sau khi người dùng chọn xong, thay vì hiển thị màn hình "Xong".

pollingConfig

object (PollingConfig)

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

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

expireTime

string (Timestamp format)

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

Hãy dùng RFC 3339, trong đó dữ liệu đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các khoảng lệch 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.

Tham số này do ứng dụng khách chỉ định khi gọi sessions.create và không thể sửa đổi sau đó (nếu không tạo một phiên mới).

mediaItemsSet

boolean

Chỉ có đầu ra. Nếu được đặt thành true, các mục nội dung nghe nhì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 nghe nhìn đã chọn thông qua mediaItems.list.

PollingConfig

Cấu hình để thăm dò 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 đó máy khách sẽ ngừng thăm dò.

Giá trị 0 cho biết rằng ứng dụng nên ngừng thăm dò 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 khách hà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 bạn không chỉ định hoặc đặt thành 0, thì bạn có thể chọn tối đa 2.000 mặt hàng. Các giá trị trên 2000 sẽ bị ép thành 2000. Các giá trị âm sẽ dẫn đến lỗi INVALID_ARGUMENT.

Phương thức

create

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

delete

Xoá phiên được chỉ định.

get

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