Method: properties.dataStreams.patch

  • Updates a DataStream associated with a Google Analytics 4 property using a PATCH request to the specified endpoint.

  • The request must include a dataStream.name path parameter to identify the DataStream and an updateMask query parameter indicating the fields to update.

  • The request body should contain a DataStream object with the updated values, and upon success, the response body will return the updated DataStream object.

  • Authorization requires the https://www.googleapis.com/auth/analytics.edit OAuth scope.

Updates a DataStream on a property.

HTTP request

PATCH https://analyticsadmin.googleapis.com/v1alpha/{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