Method: properties.dataStreams.patch

  • The PATCH request updates a DataStream on a property.

  • The URL uses gRPC Transcoding syntax and requires a dataStream.name path parameter in the format properties/{property_id}/dataStreams/{stream_id}.

  • The updateMask query parameter is required to specify the fields to be updated using a comma-separated list of fully qualified names.

  • The request and response bodies both contain an instance of DataStream.

  • This operation requires the https://www.googleapis.com/auth/analytics.edit OAuth scope for authorization.

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