Package com.google.ads.googleads.v15.services

Class UploadClickConversionsRequest.Builder

  • All Implemented Interfaces:
    UploadClickConversionsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable
    Enclosing class:
    UploadClickConversionsRequest
    public static final class UploadClickConversionsRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<UploadClickConversionsRequest.Builder>
implements UploadClickConversionsRequestOrBuilder
     Request message for
 [ConversionUploadService.UploadClickConversions][google.ads.googleads.v15.services.ConversionUploadService.UploadClickConversions].
    Protobuf type google.ads.googleads.v15.services.UploadClickConversionsRequest

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<UploadClickConversionsRequest.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<UploadClickConversionsRequest.Builder>

      • getDefaultInstanceForType

        public UploadClickConversionsRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public UploadClickConversionsRequest build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public UploadClickConversionsRequest buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • setRepeatedField

        public UploadClickConversionsRequest.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                              int index,
                                                              java.lang.Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<UploadClickConversionsRequest.Builder>

      • addRepeatedField

        public UploadClickConversionsRequest.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                              java.lang.Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<UploadClickConversionsRequest.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<UploadClickConversionsRequest.Builder>

      • mergeFrom

        public UploadClickConversionsRequest.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<UploadClickConversionsRequest.Builder>
        Throws:
        java.io.IOException

      • getCustomerId

        public java.lang.String getCustomerId()
         Required. The ID of the customer performing the upload.
        string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getCustomerId in interface UploadClickConversionsRequestOrBuilder
        Returns:
        The customerId.

      • getCustomerIdBytes

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

      • setCustomerId

        public UploadClickConversionsRequest.Builder setCustomerId​(java.lang.String value)
         Required. The ID of the customer performing the upload.
        string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The customerId to set.
        Returns:
        This builder for chaining.

      • clearCustomerId

        public UploadClickConversionsRequest.Builder clearCustomerId()
         Required. The ID of the customer performing the upload.
        string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.

      • setCustomerIdBytes

        public UploadClickConversionsRequest.Builder setCustomerIdBytes​(com.google.protobuf.ByteString value)
         Required. The ID of the customer performing the upload.
        string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The bytes for customerId to set.
        Returns:
        This builder for chaining.

      • getConversionsCount

        public int getConversionsCount()
         Required. The conversions that are being uploaded.
        repeated .google.ads.googleads.v15.services.ClickConversion conversions = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getConversionsCount in interface UploadClickConversionsRequestOrBuilder

      • setConversions

        public UploadClickConversionsRequest.Builder setConversions​(int index,
                                                            ClickConversion value)
         Required. The conversions that are being uploaded.
        repeated .google.ads.googleads.v15.services.ClickConversion conversions = 2 [(.google.api.field_behavior) = REQUIRED];

      • setConversions

        public UploadClickConversionsRequest.Builder setConversions​(int index,
                                                            ClickConversion.Builder builderForValue)
         Required. The conversions that are being uploaded.
        repeated .google.ads.googleads.v15.services.ClickConversion conversions = 2 [(.google.api.field_behavior) = REQUIRED];

      • addConversions

        public UploadClickConversionsRequest.Builder addConversions​(ClickConversion value)
         Required. The conversions that are being uploaded.
        repeated .google.ads.googleads.v15.services.ClickConversion conversions = 2 [(.google.api.field_behavior) = REQUIRED];

      • addConversions

        public UploadClickConversionsRequest.Builder addConversions​(int index,
                                                            ClickConversion value)
         Required. The conversions that are being uploaded.
        repeated .google.ads.googleads.v15.services.ClickConversion conversions = 2 [(.google.api.field_behavior) = REQUIRED];

      • addConversions

        public UploadClickConversionsRequest.Builder addConversions​(int index,
                                                            ClickConversion.Builder builderForValue)
         Required. The conversions that are being uploaded.
        repeated .google.ads.googleads.v15.services.ClickConversion conversions = 2 [(.google.api.field_behavior) = REQUIRED];

      • addAllConversions

        public UploadClickConversionsRequest.Builder addAllConversions​(java.lang.Iterable<? extends ClickConversion> values)
         Required. The conversions that are being uploaded.
        repeated .google.ads.googleads.v15.services.ClickConversion conversions = 2 [(.google.api.field_behavior) = REQUIRED];

      • clearConversions

        public UploadClickConversionsRequest.Builder clearConversions()
         Required. The conversions that are being uploaded.
        repeated .google.ads.googleads.v15.services.ClickConversion conversions = 2 [(.google.api.field_behavior) = REQUIRED];

      • removeConversions

        public UploadClickConversionsRequest.Builder removeConversions​(int index)
         Required. The conversions that are being uploaded.
        repeated .google.ads.googleads.v15.services.ClickConversion conversions = 2 [(.google.api.field_behavior) = REQUIRED];

      • getConversionsBuilder

        public ClickConversion.Builder getConversionsBuilder​(int index)
         Required. The conversions that are being uploaded.
        repeated .google.ads.googleads.v15.services.ClickConversion conversions = 2 [(.google.api.field_behavior) = REQUIRED];

      • addConversionsBuilder

        public ClickConversion.Builder addConversionsBuilder()
         Required. The conversions that are being uploaded.
        repeated .google.ads.googleads.v15.services.ClickConversion conversions = 2 [(.google.api.field_behavior) = REQUIRED];

      • addConversionsBuilder

        public ClickConversion.Builder addConversionsBuilder​(int index)
         Required. The conversions that are being uploaded.
        repeated .google.ads.googleads.v15.services.ClickConversion conversions = 2 [(.google.api.field_behavior) = REQUIRED];

      • getConversionsBuilderList

        public java.util.List<ClickConversion.Builder> getConversionsBuilderList()
         Required. The conversions that are being uploaded.
        repeated .google.ads.googleads.v15.services.ClickConversion conversions = 2 [(.google.api.field_behavior) = REQUIRED];

      • getPartialFailure

        public 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];
        Specified by:
        getPartialFailure in interface UploadClickConversionsRequestOrBuilder
        Returns:
        The partialFailure.

      • setPartialFailure

        public UploadClickConversionsRequest.Builder setPartialFailure​(boolean value)
         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];
        Parameters:
        value - The partialFailure to set.
        Returns:
        This builder for chaining.

      • clearPartialFailure

        public UploadClickConversionsRequest.Builder clearPartialFailure()
         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:
        This builder for chaining.

      • getValidateOnly

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

      • setValidateOnly

        public UploadClickConversionsRequest.Builder setValidateOnly​(boolean value)
         If true, the request is validated but not executed. Only errors are
 returned, not results.
        bool validate_only = 4;
        Parameters:
        value - The validateOnly to set.
        Returns:
        This builder for chaining.

      • clearValidateOnly

        public UploadClickConversionsRequest.Builder clearValidateOnly()
         If true, the request is validated but not executed. Only errors are
 returned, not results.
        bool validate_only = 4;
        Returns:
        This builder for chaining.

      • getDebugEnabled

        public 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;
        Specified by:
        getDebugEnabled in interface UploadClickConversionsRequestOrBuilder
        Returns:
        The debugEnabled.

      • setDebugEnabled

        public UploadClickConversionsRequest.Builder setDebugEnabled​(boolean value)
         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;
        Parameters:
        value - The debugEnabled to set.
        Returns:
        This builder for chaining.

      • clearDebugEnabled

        public UploadClickConversionsRequest.Builder clearDebugEnabled()
         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:
        This builder for chaining.

      • hasJobId

        public 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];
        Specified by:
        hasJobId in interface UploadClickConversionsRequestOrBuilder
        Returns:
        Whether the jobId field is set.

      • getJobId

        public 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];
        Specified by:
        getJobId in interface UploadClickConversionsRequestOrBuilder
        Returns:
        The jobId.

      • setJobId

        public UploadClickConversionsRequest.Builder setJobId​(int value)
         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];
        Parameters:
        value - The jobId to set.
        Returns:
        This builder for chaining.

      • clearJobId

        public UploadClickConversionsRequest.Builder clearJobId()
         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:
        This builder for chaining.