Method: mediaItems.list

यह फ़ंक्शन, किसी डिवाइस के लिए उपयोगकर्ता के कॉन्फ़िगर किए गए मीडिया सोर्स से, ऐंबियंट मीडिया आइटम की सूची दिखाता है.

डिफ़ॉल्ट रूप से, listMediaItems ऐंबियंट मोड का अनुभव देता है. इसमें, उपयोगकर्ता के कॉन्फ़िगर किए गए सभी सोर्स से, मीडिया आइटम का चुना गया सेट दिखाया जाता है.

इसके अलावा, किसी मीडिया सोर्स से आइटम की पेज की गई सूची को वापस पाने के लिए, अनुरोध में mediaSourceId शामिल किया जा सकता है. इससे, आइटम को ज़्यादा पारंपरिक तरीके से फ़िल्टर किया जा सकता है.

क्लाइंट ऐप्लिकेशन, हर डिवाइस के लिए हर दिन 240 अनुरोध कर सकते हैं.

अगर उपयोगकर्ता ने कोई मीडिया सोर्स कॉन्फ़िगर नहीं किया है, तो FAILED_PRECONDITION गड़बड़ी दिखती है.

एचटीटीपी अनुरोध

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

यूआरएल में gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल किया गया है.

क्वेरी पैरामीटर

पैरामीटर
deviceId

string

ज़रूरी है. इस डिवाइस का यूनीक आइडेंटिफ़ायर.
mediaSourceId

string

ज़रूरी नहीं. ऐंबियंट अनुभव के लिए, इस फ़ील्ड को शामिल न करें. इससे, कॉन्फ़िगर किए गए सभी सोर्स से, मीडिया आइटम का चुना गया सेट दिखेगा. लौटाए गए आइटम की संख्या, आपके pageSize अनुरोध के हिसाब से होगी. हालांकि, ज़्यादा से ज़्यादा 100 आइटम लौटाए जा सकते हैं. अगर मीडिया सोर्स की जानकारी दी जाती है, तो सिर्फ़ उस सोर्स के आइटम दिखाए जाएंगे.

id, किसी ऐसे सोर्स का होना चाहिए जिसे उपयोगकर्ता ने चुने गए डिवाइस के लिए चुना हो. जैसे, AmbientDevice.media_sources.id में से कोई एक.

ध्यान दें, highlights कार्ड का इस्तेमाल नहीं किया जा सकता. भले ही, उपयोगकर्ता ने इस डिवाइस के लिए इसे सोर्स के तौर पर चुना हो. इस फ़ील्ड को highlights पर सेट करने पर, INVALID_ARGUMENT गड़बड़ी दिखेगी.
pageSize

integer

ज़रूरी नहीं. मीडिया आइटम की ज़्यादा से ज़्यादा संख्या.

यह सेवा आपके pageSize अनुरोध को पूरा करेगी. हालांकि, हो सकता है कि यह तय किए गए आइटम से कम आइटम दिखाए. इसमें शून्य आइटम भी शामिल हैं.

अगर pageSize की वैल्यू नहीं दी गई है या उसे 0 पर सेट किया गया है, तो ज़्यादा से ज़्यादा 50 मीडिया आइटम दिखाए जाएंगे. 100 से ज़्यादा वैल्यू को 100 तक घटा दिया जाएगा. नेगेटिव वैल्यू देने पर, INVALID_ARGUMENT गड़बड़ी का मैसेज दिखेगा.
pageToken

string

ज़रूरी नहीं. पेज टोकन, जो पिछले mediaItems.list कॉल से मिला था. अगला पेज देखने के लिए, यह डालें.

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य भाग

mediaItems.list तरीके का जवाब.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

JSON के काेड में दिखाना 
{
  "mediaItems": [
    {
      object (AmbientMediaItem)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
mediaItems[]

object (AmbientMediaItem)

डिवाइस पर दिखाने के लिए, ऐंबियंट मीडिया आइटम का पेज.
nextPageToken

string

अगर यह फ़ील्ड सेट है, तो आइटम के अगले पेज को वापस पाने के लिए, अगले mediaItems.list कॉल में इस फ़ील्ड का इस्तेमाल pageToken के तौर पर किया जा सकता है.

अगर इस फ़ील्ड को छोड़ दिया जाता है, तो इसका मतलब यह नहीं है कि फ़ेच करने के लिए कोई और कॉन्टेंट उपलब्ध नहीं है. इसका मतलब यह है कि कॉन्टेंट के अगले पेज में ऐसे मीडिया आइटम हो सकते हैं जो पहले के पेजों में पहले ही दिखाए जा चुके हैं.

अनुमति के दायरे

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

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