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 endpoint allows you to update an album's \u003ccode\u003etitle\u003c/code\u003e and \u003ccode\u003ecoverPhotoMediaItemId\u003c/code\u003e using a \u003ccode\u003ePATCH\u003c/code\u003e request to \u003ccode\u003ehttps://photoslibrary.googleapis.com/v1/albums/{album.id}\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe album must have been created by the developer via the API and be owned by the user.\u003c/p\u003e\n"],["\u003cp\u003eYou need to specify the fields to be updated using the \u003ccode\u003eupdateMask\u003c/code\u003e query parameter and provide the updated album data in the request body.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/photoslibrary.edit.appcreateddata\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["To update an album, use a `PATCH` request to the specified URL, including the `album.id` as a path parameter. The `updateMask` query parameter is required to specify fields to update, which can be `title` or `coverPhotoMediaItemId`. The request body contains the album data. The response body returns the updated album. Authorization requires the `https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata` scope. The provided album must have been created by the developer via the API and owned by the user.\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 app created 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.\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://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` 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/reference/rest/v1/albums#Album).\n\n### Response body\n\nIf successful, the response body contains an instance of [Album](/photos/library/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`"]]