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 ไม่ได้เนื่องด้วยเหตุผลด้านความปลอดภัย

สำหรับแอปพลิเคชันบนเว็บ คุณสามารถต่อท้าย /autoclose ไปยัง URI นี้ได้ จากนั้นหน้าต่างหรือแท็บ Google Photos จะปิดโดยอัตโนมัติหลังจากที่ผู้ใช้เลือกเสร็จแล้ว แทนที่จะแสดงหน้าจอ "เสร็จสิ้น"
pollingConfig

object (PollingConfig)

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

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

string (Timestamp format)

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

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ 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)

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

ระยะเวลาเป็นวินาทีที่มีเศษทศนิยมได้สูงสุด 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

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