מוצג לך תיעוד של הגרסה הקודמת של Google Photos Library API.
Method: albums.patch
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
מעדכנים את האלבום עם id
שצוין. רק השדות id
, title
ו-coverPhotoMediaItemId
של האלבום ייקראו. האלבום חייב להיות נוצר על ידי המפתח באמצעות ה-API, והוא חייב להיות בבעלותו של המשתמש.
בקשת HTTP
PATCH https://photoslibrary.googleapis.com/v1/albums/{album.id}
כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.
פרמטרים של נתיב
פרמטרים |
album.id |
string
המזהה של האלבום. זהו מזהה קבוע שאפשר להשתמש בו בין סשנים כדי לזהות את האלבום הזה.
|
פרמטרים של שאילתה
פרמטרים |
updateMask |
string (FieldMask format)
חובה. מציינים אילו שדות באלבום שסופק צריך לעדכן. הערכים החוקיים היחידים הם title ו-coverPhotoMediaItemId . זוהי רשימה מופרדת בפסיקים של שמות שדות מלאים. דוגמה: "user.displayName,photo"
|
גוף הבקשה
גוף הבקשה מכיל מופע של Album
.
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול מופע של Album
.
היקפי הרשאה
נדרש היקף הרשאות OAuth הבא:
https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-25 (שעון UTC).
[null,null,["עדכון אחרון: 2025-07-25 (שעון UTC)."],[[["\u003cp\u003eThis API updates an album with a specified ID, modifying only the title and cover photo, if provided in the request.\u003c/p\u003e\n"],["\u003cp\u003eThe album being updated must have been created by the developer via the API and be owned by the user.\u003c/p\u003e\n"],["\u003cp\u003eA \u003ccode\u003ePATCH\u003c/code\u003e request is used, targeting the album's ID in the URL.\u003c/p\u003e\n"],["\u003cp\u003eAn \u003ccode\u003eupdateMask\u003c/code\u003e query parameter is required to specify which album fields (title, coverPhotoMediaItemId) are being updated.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should contain an \u003ccode\u003eAlbum\u003c/code\u003e object with the updated fields, and the response, if successful, also contains an \u003ccode\u003eAlbum\u003c/code\u003e object.\u003c/p\u003e\n"]]],["This describes updating an album using a PATCH request to `https://photoslibrary.googleapis.com/v1/albums/{album.id}`. The `album.id` path parameter identifies the target album. The `updateMask` query parameter, with values `title` or `coverPhotoMediaItemId`, specifies which album fields to update. The request body contains the updated album information, while the successful response body returns the updated album. This operation requires the `https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata` authorization scope. Only albums created via the API and owned by the user can be modified.\n"],null,["# Method: albums.patch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nUpdate the album with the specified `id`. Only the `id`, `title` and `coverPhotoMediaItemId` fields of the album are read. The album must have been created by the developer via the API and must be owned by the user.\n\n### HTTP request\n\n`PATCH https://photoslibrary.googleapis.com/v1/albums/{album.id}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|------------------------------------------------------------------------------------------------------------------------------|\n| `album.id` | `string` Identifier for the album. This is a persistent identifier that can be used between sessions to identify this album. |\n\n### Query parameters\n\n| Parameters ||\n|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask)` format)` Required. Indicate what fields in the provided album to update. The only valid values are `title` and `coverPhotoMediaItemId`. This is a comma-separated list of fully qualified names of fields. Example: `\"user.displayName,photo\"`. |\n\n### Request body\n\nThe request body contains an instance of [Album](/photos/library/legacy/reference/rest/v1/albums#Album).\n\n### Response body\n\nIf successful, the response body contains an instance of [Album](/photos/library/legacy/reference/rest/v1/albums#Album).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata`"]]