Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
Method: properties.dataStreams.patch
Stay organized with collections
Save and categorize content based on your preferences.
Updates a DataStream on a property.
HTTP request
PATCH https://analyticsadmin.googleapis.com/v1beta/{dataStream.name=properties/*/dataStreams/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
dataStream.name |
string
Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000"
|
Query parameters
| Parameters |
updateMask |
string (FieldMask format)
Required. The list of fields to be updated. 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 DataStream.
Response body
If successful, the response body contains an instance of DataStream.
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 DataStream associated with a Google Analytics 4 property.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires specifying the DataStream name as a path parameter and an update mask as a query parameter.\u003c/p\u003e\n"],["\u003cp\u003eRequest and response bodies utilize the \u003ccode\u003eDataStream\u003c/code\u003e object structure for data exchange.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization necessitates the \u003ccode\u003eanalytics.edit\u003c/code\u003e scope for successful execution.\u003c/p\u003e\n"]]],["This outlines updating a DataStream using a PATCH request to a specified URL structure: `https://analyticsadmin.googleapis.com/v1beta/{dataStream.name=properties/*/dataStreams/*}`. The `dataStream.name` parameter in the path is required. Updates are defined in the `updateMask` query parameter using FieldMask format. The request and response bodies utilize the DataStream format. It also requires the `https://www.googleapis.com/auth/analytics.edit` authorization scope.\n"],null,["# Method: properties.dataStreams.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 DataStream on a property.\n\n### HTTP request\n\n`PATCH https://analyticsadmin.googleapis.com/v1beta/{dataStream.name=properties/*/dataStreams/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `dataStream.name` | `string` Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: \"properties/1000/dataStreams/2000\" |\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. 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 [DataStream](/analytics/devguides/config/admin/v1/rest/v1beta/properties.dataStreams#DataStream).\n\n### Response body\n\nIf successful, the response body contains an instance of [DataStream](/analytics/devguides/config/admin/v1/rest/v1beta/properties.dataStreams#DataStream).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/analytics.edit`"]]
