UploadClickConversionsRequest

  • The UploadClickConversions request message is used to upload click conversions for a customer.

  • It requires the customer_id and an array of ClickConversion objects to be uploaded.

  • Setting partial_failure to true allows successful operations to be carried out even if some operations are invalid.

  • The request can be validated without execution by setting validate_only to true.

  • The debug_enabled field affects validation for enhanced conversions using user_identifiers.

Request message for ConversionUploadService.UploadClickConversions.

Proto definition GitHub

Fields

conversions[]

ClickConversion

Required. The conversions that are being uploaded.

customer_id

string

Required. The ID of the customer performing the upload.

debug_enabled

bool

If true, the API will perform all upload checks and return errors if any are found. If false, it will perform only basic input validation, skip subsequent upload checks, and return success even if no click was found for the provided user_identifiers.

This setting only affects Enhanced conversions for leads uploads that use user_identifiers instead of GCLID, or the GBRAID or WBRAID URL parameters. When uploading enhanced conversions for leads, you should upload all conversion events to the API, including those that may not come from Google Ads campaigns. The upload of an event that is not from a Google Ads campaign will result in a CLICK_NOT_FOUND error if this field is set to true. Since these errors are expected for such events, set this field to false so you can confirm your uploads are properly formatted but ignore CLICK_NOT_FOUND errors from all of the conversions that are not from a Google Ads campaign. This will allow you to focus only on errors that you can address.

Default is false.

job_id

int32

Optional. Optional input to set job ID. Must be a non-negative number that is less than 2^31 if provided. If this field is not provided, the API will generate a job ID in the range [2^31, (2^63)-1]. The API will return the value for this request in the job_id field of the UploadClickConversionsResponse.

partial_failure

bool

Required. If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. This should always be set to true.

See Best practices for partial failures.

validate_only

bool

If true, the request is validated but not executed. Only errors are returned, not results.