Method: mediaItems.list

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

โดยค่าเริ่มต้น listMediaItems จะแสดงประสบการณ์การใช้งานแบบแอมเบียนท์ ซึ่งจะแสดงรายการสื่อชุดที่ได้รับการดูแลจัดการจากแหล่งที่มาทั้งหมดที่ผู้ใช้กำหนดค่าไว้

คุณอาจใส่ mediaSourceId ในคำขอเพื่อเรียกข้อมูลรายการแบบแบ่งหน้าจากแหล่งสื่อที่เฉพาะเจาะจงได้ ซึ่งจะช่วยให้กรองข้อมูลแบบดั้งเดิมได้มากขึ้น

แอปพลิเคชันไคลเอ็นต์จะจำกัดคำขอไว้ที่ 240 รายการต่ออุปกรณ์ต่อวัน

ข้อผิดพลาด FAILED_PRECONDITION จะแสดงขึ้นหากผู้ใช้ไม่ได้กําหนดค่าแหล่งที่มาของสื่อ

คำขอ HTTP

GET https://photosambient.googleapis.com/v1/mediaItems

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์การค้นหา

พารามิเตอร์
deviceId

string

ต้องระบุ ตัวระบุที่ไม่ซ้ำกันสำหรับอุปกรณ์นี้
mediaSourceId

string

ไม่บังคับ สำหรับประสบการณ์การใช้งานแบบแอมเบียนท์ ให้ข้ามช่องนี้ ซึ่งจะแสดงรายการสื่อชุดที่ได้รับการดูแลจัดการจากแหล่งที่มาที่กำหนดค่าไว้ทั้งหมด จำนวนรายการที่แสดงจะเป็นไปตามคำขอ pageSize ของคุณ โดยไม่เกิน 100 รายการ หากระบุไว้ ระบบจะแสดงเฉพาะรายการจากแหล่งที่มาของสื่อที่ระบุเท่านั้น

id ต้องเป็นข้อมูลจากแหล่งที่มาที่ผู้ใช้เลือกสำหรับอุปกรณ์ที่ระบุ (เช่น หนึ่งใน AmbientDevice.media_sources.id)

โปรดทราบว่าระบบไม่รองรับ highlights แม้ว่าผู้ใช้จะเลือกแหล่งที่มานี้สำหรับอุปกรณ์นี้ก็ตาม การตั้งค่าช่องนี้เป็น highlights จะแสดงข้อผิดพลาด INVALID_ARGUMENT
pageSize

integer

ไม่บังคับ จำนวนรายการสื่อสูงสุดที่จะแสดง

บริการจะดำเนินการตามคำขอ pageSize ของคุณ แม้ว่าจะแสดงผลรายการน้อยกว่าที่ระบุ (รวมถึงแสดงผลเป็น 0) ก็ตาม

หากไม่ได้ระบุ pageSize หรือตั้งค่าเป็น 0 ระบบจะแสดงรายการสื่อไม่เกิน 50 รายการ ระบบจะบังคับให้ค่าที่มากกว่า 100 ลดลงเป็นค่าสูงสุดที่อนุญาตซึ่งเท่ากับ 100 การให้ค่าลบจะทำให้เกิดข้อผิดพลาด INVALID_ARGUMENT
pageToken

string

ไม่บังคับ โทเค็นหน้าเว็บที่ได้รับจากการเรียกใช้ mediaItems.list ก่อนหน้านี้ ระบุข้อมูลนี้เพื่อเรียกข้อมูลหน้าถัดไป

เนื้อความของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

การตอบสนองต่อเมธอด mediaItems.list

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "mediaItems": [
    {
      object (AmbientMediaItem)
    }
  ],
  "nextPageToken": string
}
ช่อง
mediaItems[]

object (AmbientMediaItem)

หน้ารายการสื่อพักหน้าจอสำหรับอุปกรณ์ที่จะแสดง
nextPageToken

string

หากตั้งค่าไว้ ช่องนี้จะใช้เป็น pageToken ในการเรียกใช้ mediaItems.list รายการถัดไปเพื่อดึงข้อมูลรายการในหน้าถัดไปได้

การละเว้นช่องนี้ไม่ได้หมายความว่าไม่มีเนื้อหาให้ดึงข้อมูลอีกต่อไป แต่หมายความว่าหน้าเนื้อหาถัดไปอาจมีรายการสื่อที่แสดงในหน้าก่อนหน้าแล้ว

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/photosambient.mediaitems