Package com.google.ads.googleads.v18.services

Interface UploadClickConversionsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
UploadClickConversionsRequest, UploadClickConversionsRequest.Builder
public interface UploadClickConversionsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getCustomerId

      String getCustomerId()
       Required. The ID of the customer performing the upload.
      string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The customerId.

    • getCustomerIdBytes

      com.google.protobuf.ByteString getCustomerIdBytes()
       Required. The ID of the customer performing the upload.
      string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for customerId.

    • getConversionsList

      List<ClickConversion> getConversionsList()
       Required. The conversions that are being uploaded.
      repeated .google.ads.googleads.v18.services.ClickConversion conversions = 2 [(.google.api.field_behavior) = REQUIRED];

    • getConversions

      ClickConversion getConversions(int index)
       Required. The conversions that are being uploaded.
      repeated .google.ads.googleads.v18.services.ClickConversion conversions = 2 [(.google.api.field_behavior) = REQUIRED];

    • getConversionsCount

      int getConversionsCount()
       Required. The conversions that are being uploaded.
      repeated .google.ads.googleads.v18.services.ClickConversion conversions = 2 [(.google.api.field_behavior) = REQUIRED];

    • getConversionsOrBuilderList

      List<? extends ClickConversionOrBuilder> getConversionsOrBuilderList()
       Required. The conversions that are being uploaded.
      repeated .google.ads.googleads.v18.services.ClickConversion conversions = 2 [(.google.api.field_behavior) = REQUIRED];

    • getConversionsOrBuilder

      ClickConversionOrBuilder getConversionsOrBuilder(int index)
       Required. The conversions that are being uploaded.
      repeated .google.ads.googleads.v18.services.ClickConversion conversions = 2 [(.google.api.field_behavior) = REQUIRED];

    • getPartialFailure

      boolean getPartialFailure()
       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
 https://developers.google.com/google-ads/api/docs/best-practices/partial-failures
 for more information about partial failure.
      bool partial_failure = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The partialFailure.

    • getValidateOnly

      boolean getValidateOnly()
       If true, the request is validated but not executed. Only errors are
 returned, not results.
      bool validate_only = 4;
      Returns:
      The validateOnly.

    • getDebugEnabled

      boolean getDebugEnabled()
       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`, `GBRAID`, or `WBRAID`. 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.
      bool debug_enabled = 5;
      Returns:
      The debugEnabled.

    • hasJobId

      boolean hasJobId()
       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`.
      optional int32 job_id = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the jobId field is set.

    • getJobId

      int getJobId()
       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`.
      optional int32 job_id = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The jobId.