Method: albums.list

यह उपयोगकर्ता को दिखाए जाने वाले सभी एल्बम, Google Photos ऐप्लिकेशन के एल्बम टैब में दिखाता है.

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

GET https://photoslibrary.googleapis.com/v1/albums

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

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

पैरामीटर
pageSize

integer

जवाब में लौटाए जाने वाले एल्बम की ज़्यादा से ज़्यादा संख्या. हो सकता है कि आपको तय की गई संख्या से कम एल्बम दिखें. pageSize की डिफ़ॉल्ट वैल्यू 20 है और ज़्यादा से ज़्यादा 50 हो सकती है.
pageToken

string

नतीजों का अगला पेज पाने के लिए, जारी रखने वाला टोकन. इसे अनुरोध में जोड़ने पर, pageToken के बाद की पंक्तियां दिखती हैं. pageToken की वैल्यू, listAlbums अनुरोध के रिस्पॉन्स में nextPageToken पैरामीटर में दिखाई गई वैल्यू होनी चाहिए.
excludeNonAppCreatedData

boolean

अगर यह नीति सेट की जाती है, तो नतीजों में वे मीडिया आइटम शामिल नहीं होंगे जिन्हें इस ऐप्लिकेशन से नहीं बनाया गया है. डिफ़ॉल्ट रूप से गलत पर सेट होती है (सभी एल्बम लौटाए जाते हैं). अगर photoslibrary.readonly.appcreateddata स्कोप का इस्तेमाल किया जाता है, तो इस फ़ील्ड को अनदेखा कर दिया जाता है.

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

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

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

जिन एल्बम के लिए अनुरोध किया गया है उनकी सूची.

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

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

object (Album)

सिर्फ़ आउटपुट के लिए. उपयोगकर्ता के Google Photos ऐप्लिकेशन के एल्बम टैब में दिखने वाले एल्बम की सूची.
nextPageToken

string

सिर्फ़ आउटपुट के लिए. एल्बम का अगला सेट पाने के लिए इस्तेमाल किया जाने वाला टोकन. इस अनुरोध के लिए, वापस पाने के लिए और एल्बम उपलब्ध होने पर यह जानकारी अपने-आप भर जाती है.

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

इसके लिए, OAuth के इनमें से किसी एक स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/photoslibrary
  • https://www.googleapis.com/auth/photoslibrary.readonly
  • https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata