Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
Method: properties.googleAdsLinks.patch
Stay organized with collections
Save and categorize content based on your preferences.
Updates a GoogleAdsLink on a property
HTTP request
PATCH https://analyticsadmin.googleapis.com/v1alpha/{googleAdsLink.name=properties/*/googleAdsLinks/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
googleAdsLink.name |
string
Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.
|
Query parameters
| Parameters |
updateMask |
string (FieldMask format)
Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. 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 GoogleAdsLink.
Response body
If successful, the response body contains an instance of GoogleAdsLink.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/analytics.edit
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 2025-04-02 UTC.
[null,null,["Last updated 2025-04-02 UTC."],[[["\u003cp\u003eUpdates a GoogleAdsLink on a specified Google Analytics 4 property.\u003c/p\u003e\n"],["\u003cp\u003eThe request must include an update mask specifying the fields to be updated.\u003c/p\u003e\n"],["\u003cp\u003eRequires \u003ccode\u003eanalytics.edit\u003c/code\u003e scope for authorization.\u003c/p\u003e\n"],["\u003cp\u003eThe API uses PATCH method and gRPC Transcoding syntax for the request URL.\u003c/p\u003e\n"],["\u003cp\u003eBoth request and response bodies utilize the \u003ccode\u003eGoogleAdsLink\u003c/code\u003e object.\u003c/p\u003e\n"]]],["This document details updating a GoogleAdsLink on a property using a PATCH HTTP request to `https://analyticsadmin.googleapis.com/v1alpha/{googleAdsLink.name=properties/*/googleAdsLinks/*}`. The `googleAdsLink.name` path parameter specifies the target link. The `updateMask` query parameter, using a FieldMask format, dictates which fields to modify. The request body contains the `GoogleAdsLink` instance, and a successful response also returns a `GoogleAdsLink` instance. Editing requires `https://www.googleapis.com/auth/analytics.edit` authorization scope.\n"],null,["# Method: properties.googleAdsLinks.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\nUpdates a GoogleAdsLink on a property\n\n### HTTP request\n\n`PATCH https://analyticsadmin.googleapis.com/v1alpha/{googleAdsLink.name=properties/*/googleAdsLinks/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|\n| `googleAdsLink.name` | `string` Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. |\n\n### Query parameters\n\n| Parameters ||\n|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` format)` Required. The list of fields to be updated. Field names must be in snake case (e.g., \"field_to_update\"). Omitted fields will not be updated. To replace the entire entity, use one path with the string \"\\*\" to match all fields. 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 [GoogleAdsLink](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.googleAdsLinks#GoogleAdsLink).\n\n### Response body\n\nIf successful, the response body contains an instance of [GoogleAdsLink](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.googleAdsLinks#GoogleAdsLink).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/analytics.edit`"]]
