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 दायरे का इस्तेमाल करने पर इस फ़ील्ड को अनदेखा कर दिया जाता है.

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

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

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

अनुरोध किए गए एल्बम की सूची.

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

जेएसओएन के काेड में दिखाना
{
  "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