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

Class UploadClickConversionsRequest

  • All Implemented Interfaces:
    UploadClickConversionsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class UploadClickConversionsRequest
extends com.google.protobuf.GeneratedMessageV3
implements UploadClickConversionsRequestOrBuilder
     Request message for
 [ConversionUploadService.UploadClickConversions][google.ads.googleads.v15.services.ConversionUploadService.UploadClickConversions].
    Protobuf type google.ads.googleads.v15.services.UploadClickConversionsRequest
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • 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

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

      • 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

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

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

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

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

      • isInitialized

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

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static UploadClickConversionsRequest parseFrom​(java.nio.ByteBuffer data)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UploadClickConversionsRequest parseFrom​(java.nio.ByteBuffer data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UploadClickConversionsRequest parseFrom​(com.google.protobuf.ByteString data)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UploadClickConversionsRequest parseFrom​(com.google.protobuf.ByteString data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UploadClickConversionsRequest parseFrom​(byte[] data)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UploadClickConversionsRequest parseFrom​(byte[] data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UploadClickConversionsRequest parseFrom​(java.io.InputStream input)
                                               throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static UploadClickConversionsRequest parseFrom​(java.io.InputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static UploadClickConversionsRequest parseDelimitedFrom​(java.io.InputStream input)
                                                        throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static UploadClickConversionsRequest parseDelimitedFrom​(java.io.InputStream input,
                                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                        throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static UploadClickConversionsRequest parseFrom​(com.google.protobuf.CodedInputStream input)
                                               throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static UploadClickConversionsRequest parseFrom​(com.google.protobuf.CodedInputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected UploadClickConversionsRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<UploadClickConversionsRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

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