REST Resource: sessions

ทรัพยากร: PickingSession

การนําเสนอเซสชันของผู้ใช้ในระหว่างที่ผู้ใช้สามารถเลือกรูปภาพและวิดีโอโดยใช้ Google Photos

การแสดง JSON
{
  "id": string,
  "pickerUri": string,
  "pollingConfig": {
    object (PollingConfig)
  },
  "expireTime": string,
  "pickingConfig": {
    object (PickingConfig)
  },
  "mediaItemsSet": boolean
}
ช่อง
id

string

เอาต์พุตเท่านั้น ตัวระบุที่ Google สร้างขึ้นสำหรับเซสชันนี้

pickerUri

string

เอาต์พุตเท่านั้น URI ที่ใช้เปลี่ยนเส้นทางผู้ใช้ไปยัง Google Photos (บนเว็บ) เพื่อให้ผู้ใช้เลือกรูปภาพและวิดีโอสำหรับเซสชันปัจจุบันได้

หากต้องการดูหน้านี้ให้สำเร็จ ผู้ใช้ต้องเข้าสู่ระบบบัญชี Google ที่เป็นเจ้าของเซสชันนี้ในเว็บเบราว์เซอร์

pickerUri เปิดใน iframe ไม่ได้เนื่องจากเหตุผลด้านความปลอดภัย

pollingConfig

object (PollingConfig)

เอาต์พุตเท่านั้น การกําหนดค่าที่แนะนําซึ่งแอปพลิเคชันควรใช้ขณะที่โพล sessions.get

ฟิลด์นี้จะแสดงขึ้นก็ต่อเมื่อยังไม่มีการเลือกรายการสื่อสำหรับเซสชันนี้ (เช่น mediaItemsSet เป็นเท็จ)

expireTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่จะหมดอายุของสิทธิ์เข้าถึงเซสชันนี้ (และรายการสื่อที่เลือก)

ใช้ RFC 3339 ซึ่งเอาต์พุตที่สร้างขึ้นจะเป็นรูปแบบ Z-normalized เสมอ และใช้ตัวเลขทศนิยม 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)

เอาต์พุตเท่านั้น ระยะเวลาที่แนะนำระหว่างคำขอแบบสำรวจ

ระยะเวลาเป็นวินาทีที่มีเศษทศนิยมได้สูงสุด 9 หลัก โดยลงท้ายด้วย s เช่น "3.5s"

timeoutIn

string (Duration format)

เอาต์พุตเท่านั้น ระยะเวลาที่ลูกค้าควรหยุดการโหวต

ค่า 0 บ่งบอกว่าไคลเอ็นต์ควรหยุดการโหวตหากยังไม่ได้ดำเนินการ

ระยะเวลาเป็นวินาทีที่มีเศษทศนิยมได้สูงสุด 9 หลัก โดยลงท้ายด้วย s เช่น "3.5s"

PickingConfig

การกําหนดค่าที่ไคลเอ็นต์ระบุสําหรับประสบการณ์การเลือกของผู้ใช้ในระหว่างเซสชันนี้

การแสดง JSON
{
  "maxItemCount": string
}
ช่อง
maxItemCount

string (int64 format)

ไม่บังคับ จำนวนสินค้าสูงสุดที่ผู้ใช้เลือกได้ในระหว่างเซสชันนี้ ค่าเริ่มต้นจะเป็น 2000 หากไม่ได้ระบุไว้

หากไม่ได้ระบุหรือตั้งค่าเป็น 0 ระบบจะเลือกรายการได้สูงสุด 2, 000 รายการ ค่าที่เกิน 2000 จะถูกเปลี่ยนเป็น 2000 ค่าลบจะทำให้เกิดข้อผิดพลาด INVALID_ARGUMENT

เมธอด

create

สร้างเซสชันใหม่ในระหว่างที่ผู้ใช้สามารถเลือกรูปภาพและวิดีโอเพื่อให้บุคคลที่สามเข้าถึงได้

delete

ลบเซสชันที่ระบุ

get

ดึงข้อมูลเกี่ยวกับเซสชันที่ระบุ