Method: albums.list
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
تعرض هذه السمة قائمة بجميع الألبومات التي أنشأها تطبيقك.
طلب HTTP
GET https://photoslibrary.googleapis.com/v1/albums
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
مَعلمات طلب البحث
المعلمات |
pageSize |
integer
الحد الأقصى لعدد الألبومات التي سيتم عرضها في الردّ قد يتم عرض عدد ألبومات أقل من العدد المحدّد. القيمة التلقائية pageSize هي 20، والحد الأقصى هو 50.
|
pageToken |
string
رمز استمرارية للحصول على الصفحة التالية من النتائج تؤدي إضافة هذا إلى الطلب إلى عرض الصفوف بعد pageToken . يجب أن تكون pageToken هي القيمة المعروضة في المَعلمة nextPageToken في الاستجابة لطلب listAlbums .
|
excludeNonAppCreatedData |
boolean
في حال ضبط هذا الخيار، تستبعد النتائج عناصر الوسائط التي لم ينشئها هذا التطبيق. الإعداد التلقائي هو خطأ (يتم عرض كل الألبومات). يتم تجاهل هذا الحقل في حال استخدام النطاق photoslibrary.readonly.appcreateddata.
|
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
قائمة بالألبومات المطلوبة
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
تمثيل JSON |
{
"albums": [
{
object (Album )
}
],
"nextPageToken": string
} |
الحقول |
albums[] |
object (Album )
النتائج فقط. قائمة الألبومات المعروضة في علامة التبويب "الألبومات" في تطبيق "صور Google" الخاص بالمستخدم
|
nextPageToken |
string
النتائج فقط. الرمز المميّز الذي سيتم استخدامه للحصول على المجموعة التالية من الألبومات يتمّ تعبئته إذا كان هناك المزيد من الألبومات التي يجب استرجاعها لهذا الطلب.
|
نطاقات التفويض
يتطلب أحد نطاقات OAuth التالية:
https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2025-07-25 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-07-25 (حسب التوقيت العالمي المتفَّق عليه)"],[[["\u003cp\u003eLists all albums displayed in the user's Google Photos Albums tab.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by page size, page token, and excluding non-app created data.\u003c/p\u003e\n"],["\u003cp\u003eResponses include an array of albums and a token for retrieving further pages.\u003c/p\u003e\n"],["\u003cp\u003eRequires specific authorization scopes for access, with some legacy scopes being phased out.\u003c/p\u003e\n"],["\u003cp\u003eFunctionality will be limited to app-created media starting March 31, 2025.\u003c/p\u003e\n"]]],["This document details how to retrieve a list of albums from the Google Photos app using the `GET https://photoslibrary.googleapis.com/v1/albums` request. The request requires no body but accepts `pageSize`, `pageToken`, and `excludeNonAppCreatedData` as query parameters. The response includes an array of albums and an optional `nextPageToken` for pagination. It also outlines the required authorization scopes and indicates that certain scopes will limit functionality to app-created content after March 31, 2025.\n"],null,["# Method: albums.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListAlbumsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists all albums created by your app.\n\n### HTTP request\n\n`GET https://photoslibrary.googleapis.com/v1/albums`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Maximum number of albums to return in the response. Fewer albums might be returned than the specified number. The default `pageSize` is 20, the maximum is 50. |\n| `pageToken` | `string` A continuation token to get the next page of the results. Adding this to the request returns the rows after the `pageToken`. The `pageToken` should be the value returned in the `nextPageToken` parameter in the response to the `listAlbums` request. |\n| `excludeNonAppCreatedData` | `boolean` If set, the results exclude media items that were not created by this app. Defaults to false (all albums are returned). This field is ignored if the photoslibrary.readonly.appcreateddata scope is used. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nList of albums requested.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------|\n| ``` { \"albums\": [ { object (/photos/library/reference/rest/v1/albums#Album) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `albums[]` | `object (`[Album](/photos/library/reference/rest/v1/albums#Album)`)` Output only. List of albums shown in the Albums tab of the user's Google Photos app. |\n| `nextPageToken` | `string` Output only. Token to use to get the next set of albums. Populated if there are more albums to retrieve for this request. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `\n https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata`"]]