Method: properties.conversionEvents.patch

  • This document describes how to update a conversion event using the PATCH method, although this method is deprecated in favor of UpdateKeyEvent.

  • The HTTP request uses gRPC Transcoding syntax and includes a path parameter for the conversionEvent.name.

  • A required updateMask query parameter is used to specify which fields of the ConversionEvent should be updated.

  • Both the request and response bodies contain an instance of a ConversionEvent.

  • The method requires the https://www.googleapis.com/auth/analytics.edit authorization scope.

Deprecated: Use UpdateKeyEvent instead. Updates a conversion event with the specified attributes.

HTTP request

PATCH https://analyticsadmin.googleapis.com/v1beta/{conversionEvent.name=properties/*/conversionEvents/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
conversionEvent.name

string

Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversionEvent}

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 ConversionEvent.

Response body

If successful, the response body contains an instance of ConversionEvent.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit