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: accounts.patch
Stay organized with collections
Save and categorize content based on your preferences.
Updates the specified business account. Personal accounts cannot be updated using this method.
HTTP request
PATCH https://mybusinessaccountmanagement.googleapis.com/v1/{account.name=accounts/*}
The URL uses gRPC Transcoding
syntax.
Path parameters
| Parameters |
account.name
|
string
Immutable. The resource name, in the format accounts/{account_id}
.
|
Query parameters
| Parameters |
updateMask
|
string ( FieldMask
format)
Required. The specific fields that should be updated. The only editable field is accountName
.
This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo"
.
|
validateOnly
|
boolean
Optional. If true, the request is validated without actually updating the account.
|
Request body
The request body contains an instance of Account
.
Response body
If successful, the response body contains an instance of Account
.
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 process for updating a specified business account using the \u003ccode\u003ePATCH\u003c/code\u003e method with the provided URL, specifically targeting the \u003ccode\u003eaccountName\u003c/code\u003e field.\u003c/p\u003e\n"],["\u003cp\u003eThe request necessitates specific path and query parameters, including \u003ccode\u003eaccount.name\u003c/code\u003e for account identification and \u003ccode\u003eupdateMask\u003c/code\u003e to specify the fields for modification.\u003c/p\u003e\n"],["\u003cp\u003eIt requires the use of an \u003ccode\u003eAccount\u003c/code\u003e object in both the request and response bodies, along with authorization using the \u003ccode\u003ehttps://www.googleapis.com/auth/business.manage\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eThis method is applicable to business accounts only; personal accounts cannot be updated using this approach, and a validation-only mode can be enabled by setting the \u003ccode\u003evalidateOnly\u003c/code\u003e query parameter.\u003c/p\u003e\n"]]],["This describes updating a business account via a `PATCH` request to `https://mybusinessaccountmanagement.googleapis.com/v1/{account.name=accounts/*}`. The `account.name` path parameter, using the format `accounts/{account_id}`, identifies the target account. The `updateMask` query parameter, which is required, specifies editable fields, with `accountName` as the only allowed field. You can also add the `validateOnly` parameter. The request and response bodies both contain an `Account` instance. The operation requires the `https://www.googleapis.com/auth/business.manage` authorization scope.\n"],null,["# Method: accounts.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 specified business account. Personal accounts cannot be updated using this method.\n\n### HTTP request\n\n`PATCH https://mybusinessaccountmanagement.googleapis.com/v1/{account.name=accounts/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------------|-------------------------------------------------------------------------------|\n| `account.name` | `string` Immutable. The resource name, in the format `accounts/{account_id}`. |\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 `accountName`. This is a comma-separated list of fully qualified names of fields. Example: `\"user.displayName,photo\"`. |\n| `validateOnly` | `boolean` Optional. If true, the request is validated without actually updating the account. |\n\n### Request body\n\nThe request body contains an instance of [Account](/my-business/reference/accountmanagement/rest/v1/accounts#Account).\n\n### Response body\n\nIf successful, the response body contains an instance of [Account](/my-business/reference/accountmanagement/rest/v1/accounts#Account).\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)."]]
