Google Business Performance
API has a NEW
API method that allows fetching multiple `DailyMetrics` in a single API request. Review the deprecation schedule
and instructions to migrate over from v4 reportInsights API method to Google Business Profile Performance API.
Method: locations.admins.patch
Stay organized with collections
Save and categorize content based on your preferences.
Updates the Admin for the specified location. Only the AdminRole of the Admin can be updated.
HTTP request
PATCH https://mybusinessaccountmanagement.googleapis.com/v1/{locationAdmin.name=locations/*/admins/*}
The URL uses gRPC Transcoding
syntax.
Path parameters
| Parameters |
locationAdmin.name
|
string
Immutable. The resource name. For account admins, this is in the form: accounts/{account_id}/admins/{admin_id}
For location admins, this is in the form: locations/{locationId}/admins/{admin_id}
This field will be ignored if set during admin creation.
|
Query parameters
| Parameters |
updateMask
|
string ( FieldMask
format)
Required. The specific fields that should be updated. The only editable field is role.
This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo"
.
|
Request body
The request body contains an instance of Admin
.
Response body
If successful, the response body contains an instance of Admin
.
Authorization scopes
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/business.manage
For more information, see the OAuth 2.0 Overview
.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-16 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-16 UTC."],[[["\u003cp\u003eThis document details the \u003ccode\u003ePATCH\u003c/code\u003e request to update an Admin for a specific location within a Google My Business account.\u003c/p\u003e\n"],["\u003cp\u003eOnly the AdminRole of the Admin can be updated using the \u003ccode\u003eupdateMask\u003c/code\u003e query parameter.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires authorization using the \u003ccode\u003ehttps://www.googleapis.com/auth/business.manage\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eBoth the request and response bodies utilize the \u003ccode\u003eAdmin\u003c/code\u003e object for data transfer.\u003c/p\u003e\n"],["\u003cp\u003eLocation admins are identified using the \u003ccode\u003elocations/{locationId}/admins/{admin_id}\u003c/code\u003e path parameter format.\u003c/p\u003e\n"]]],["This documentation outlines how to update an Admin for a specified location via a PATCH request to the given URL. The `locationAdmin.name` path parameter identifies the admin to be updated. The `updateMask` query parameter specifies the field to modify, with only the admin's role being editable. The request body must contain an Admin instance, and the response body also returns an Admin instance if successful. The operation requires the `business.manage` OAuth scope for authorization.\n"],null,["# Method: locations.admins.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\nUpdates the Admin for the specified location. Only the AdminRole of the Admin can be updated.\n\n### HTTP request\n\n`PATCH https://mybusinessaccountmanagement.googleapis.com/v1/{locationAdmin.name=locations/*/admins/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `locationAdmin.name` | `string` Immutable. The resource name. For account admins, this is in the form: `accounts/{account_id}/admins/{admin_id}` For location admins, this is in the form: `locations/{locationId}/admins/{admin_id}` This field will be ignored if set during admin creation. |\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. The specific fields that should be updated. The only editable field is role. 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 [Admin](/my-business/reference/accountmanagement/rest/v1/accounts.admins#Admin).\n\n### Response body\n\nIf successful, the response body contains an instance of [Admin](/my-business/reference/accountmanagement/rest/v1/accounts.admins#Admin).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/business.manage`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2)."]]
