أنت تعرض المستندات القديمة لواجهة برمجة التطبيقات Google Photos Library API.
Method: albums.list
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
يسرد هذا الحقل جميع الألبومات المعروضة للمستخدم في علامة التبويب "الألبومات" في تطبيق "صور Google".
طلب 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.app منشئ البيانات.
|
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
قائمة الألبومات المطلوبة
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
| تمثيل JSON |
{
"albums": [
{
object (Album)
}
],
"nextPageToken": string
} |
| الحقول |
albums[] |
object (Album)
النتائج فقط. قائمة الألبومات المعروضة في علامة التبويب "الألبومات" في تطبيق "صور Google" لدى المستخدم
|
nextPageToken |
string
النتائج فقط. رمز مميز لاستخدامه للحصول على المجموعة التالية من الألبومات. يتمّ تعبئته إذا كان هناك المزيد من الألبومات التي يجب استرجاعها لهذا الطلب.
|
نطاقات التفويض
يتطلب أحد نطاقات OAuth التالية:
https://www.googleapis.com/auth/photoslibrary
https://www.googleapis.com/auth/photoslibrary.readonly
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 using the \u003ccode\u003eGET https://photoslibrary.googleapis.com/v1/albums\u003c/code\u003e request.\u003c/p\u003e\n"],["\u003cp\u003eAllows pagination with \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e query parameters to control the number of albums returned and retrieve subsequent pages.\u003c/p\u003e\n"],["\u003cp\u003eThe response provides a list of \u003ccode\u003ealbums\u003c/code\u003e and a \u003ccode\u003enextPageToken\u003c/code\u003e for further navigation if available.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with one of the specified OAuth scopes, such as \u003ccode\u003ehttps://www.googleapis.com/auth/photoslibrary\u003c/code\u003e, for access.\u003c/p\u003e\n"],["\u003cp\u003eCan exclude non-app created data using the \u003ccode\u003eexcludeNonAppCreatedData\u003c/code\u003e parameter or the \u003ccode\u003ephotoslibrary.readonly.appcreateddata\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["To retrieve a user's albums from Google Photos, send a `GET` request to `https://photoslibrary.googleapis.com/v1/albums`. The request body must be empty. Optional query parameters include `pageSize` (default 20, max 50), `pageToken` for pagination, and `excludeNonAppCreatedData`. The response contains an array of album objects and `nextPageToken` for subsequent requests. Authorization requires one of three specified OAuth scopes.\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 shown to a user in the Albums tab of the Google Photos 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/legacy/reference/rest/v1/albums#Album) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `albums[]` | `object (`[Album](/photos/library/legacy/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- `https://www.googleapis.com/auth/photoslibrary`\n- `\n https://www.googleapis.com/auth/photoslibrary.readonly`\n- `\n https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata`"]]
