Package com.google.ads.googleads.v10.services

Class ConversionAdjustment

  • All Implemented Interfaces:
    ConversionAdjustmentOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class ConversionAdjustment
extends com.google.protobuf.GeneratedMessageV3
implements ConversionAdjustmentOrBuilder
     A conversion adjustment.
    Protobuf type google.ads.googleads.v10.services.ConversionAdjustment
    See Also:
    Serialized Form

    • Field Detail

      • GCLID_DATE_TIME_PAIR_FIELD_NUMBER

        public static final int GCLID_DATE_TIME_PAIR_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CONVERSION_ACTION_FIELD_NUMBER

        public static final int CONVERSION_ACTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ADJUSTMENT_DATE_TIME_FIELD_NUMBER

        public static final int ADJUSTMENT_DATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ADJUSTMENT_TYPE_FIELD_NUMBER

        public static final int ADJUSTMENT_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RESTATEMENT_VALUE_FIELD_NUMBER

        public static final int RESTATEMENT_VALUE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • USER_IDENTIFIERS_FIELD_NUMBER

        public static final int USER_IDENTIFIERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • USER_AGENT_FIELD_NUMBER

        public static final int USER_AGENT_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

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

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields 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

      • hasGclidDateTimePair

        public boolean hasGclidDateTimePair()
         For adjustments, uniquely identifies a conversion that was reported
 without an order ID specified. If the adjustment_type is ENHANCEMENT, this
 value is optional but may be set in addition to the order_id.
        .google.ads.googleads.v10.services.GclidDateTimePair gclid_date_time_pair = 12;
        Specified by:
        hasGclidDateTimePair in interface ConversionAdjustmentOrBuilder
        Returns:
        Whether the gclidDateTimePair field is set.

      • getGclidDateTimePair

        public GclidDateTimePair getGclidDateTimePair()
         For adjustments, uniquely identifies a conversion that was reported
 without an order ID specified. If the adjustment_type is ENHANCEMENT, this
 value is optional but may be set in addition to the order_id.
        .google.ads.googleads.v10.services.GclidDateTimePair gclid_date_time_pair = 12;
        Specified by:
        getGclidDateTimePair in interface ConversionAdjustmentOrBuilder
        Returns:
        The gclidDateTimePair.

      • getGclidDateTimePairOrBuilder

        public GclidDateTimePairOrBuilder getGclidDateTimePairOrBuilder()
         For adjustments, uniquely identifies a conversion that was reported
 without an order ID specified. If the adjustment_type is ENHANCEMENT, this
 value is optional but may be set in addition to the order_id.
        .google.ads.googleads.v10.services.GclidDateTimePair gclid_date_time_pair = 12;
        Specified by:
        getGclidDateTimePairOrBuilder in interface ConversionAdjustmentOrBuilder

      • hasOrderId

        public boolean hasOrderId()
         The order ID of the conversion to be adjusted. If the conversion was
 reported with an order ID specified, that order ID must be used as the
 identifier here. The order ID is required for enhancements.
        optional string order_id = 13;
        Specified by:
        hasOrderId in interface ConversionAdjustmentOrBuilder
        Returns:
        Whether the orderId field is set.

      • getOrderId

        public java.lang.String getOrderId()
         The order ID of the conversion to be adjusted. If the conversion was
 reported with an order ID specified, that order ID must be used as the
 identifier here. The order ID is required for enhancements.
        optional string order_id = 13;
        Specified by:
        getOrderId in interface ConversionAdjustmentOrBuilder
        Returns:
        The orderId.

      • getOrderIdBytes

        public com.google.protobuf.ByteString getOrderIdBytes()
         The order ID of the conversion to be adjusted. If the conversion was
 reported with an order ID specified, that order ID must be used as the
 identifier here. The order ID is required for enhancements.
        optional string order_id = 13;
        Specified by:
        getOrderIdBytes in interface ConversionAdjustmentOrBuilder
        Returns:
        The bytes for orderId.

      • hasConversionAction

        public boolean hasConversionAction()
         Resource name of the conversion action associated with this conversion
 adjustment. Note: Although this resource name consists of a customer id and
 a conversion action id, validation will ignore the customer id and use the
 conversion action id as the sole identifier of the conversion action.
        optional string conversion_action = 8;
        Specified by:
        hasConversionAction in interface ConversionAdjustmentOrBuilder
        Returns:
        Whether the conversionAction field is set.

      • getConversionAction

        public java.lang.String getConversionAction()
         Resource name of the conversion action associated with this conversion
 adjustment. Note: Although this resource name consists of a customer id and
 a conversion action id, validation will ignore the customer id and use the
 conversion action id as the sole identifier of the conversion action.
        optional string conversion_action = 8;
        Specified by:
        getConversionAction in interface ConversionAdjustmentOrBuilder
        Returns:
        The conversionAction.

      • getConversionActionBytes

        public com.google.protobuf.ByteString getConversionActionBytes()
         Resource name of the conversion action associated with this conversion
 adjustment. Note: Although this resource name consists of a customer id and
 a conversion action id, validation will ignore the customer id and use the
 conversion action id as the sole identifier of the conversion action.
        optional string conversion_action = 8;
        Specified by:
        getConversionActionBytes in interface ConversionAdjustmentOrBuilder
        Returns:
        The bytes for conversionAction.

      • hasAdjustmentDateTime

        public boolean hasAdjustmentDateTime()
         The date time at which the adjustment occurred. Must be after the
 conversion_date_time. The timezone must be specified. The format is
 "yyyy-mm-dd hh:mm:ss+|-hh:mm", e.g. "2019-01-01 12:32:45-08:00".
        optional string adjustment_date_time = 9;
        Specified by:
        hasAdjustmentDateTime in interface ConversionAdjustmentOrBuilder
        Returns:
        Whether the adjustmentDateTime field is set.

      • getAdjustmentDateTime

        public java.lang.String getAdjustmentDateTime()
         The date time at which the adjustment occurred. Must be after the
 conversion_date_time. The timezone must be specified. The format is
 "yyyy-mm-dd hh:mm:ss+|-hh:mm", e.g. "2019-01-01 12:32:45-08:00".
        optional string adjustment_date_time = 9;
        Specified by:
        getAdjustmentDateTime in interface ConversionAdjustmentOrBuilder
        Returns:
        The adjustmentDateTime.

      • getAdjustmentDateTimeBytes

        public com.google.protobuf.ByteString getAdjustmentDateTimeBytes()
         The date time at which the adjustment occurred. Must be after the
 conversion_date_time. The timezone must be specified. The format is
 "yyyy-mm-dd hh:mm:ss+|-hh:mm", e.g. "2019-01-01 12:32:45-08:00".
        optional string adjustment_date_time = 9;
        Specified by:
        getAdjustmentDateTimeBytes in interface ConversionAdjustmentOrBuilder
        Returns:
        The bytes for adjustmentDateTime.

      • getAdjustmentTypeValue

        public int getAdjustmentTypeValue()
         The adjustment type.
        .google.ads.googleads.v10.enums.ConversionAdjustmentTypeEnum.ConversionAdjustmentType adjustment_type = 5;
        Specified by:
        getAdjustmentTypeValue in interface ConversionAdjustmentOrBuilder
        Returns:
        The enum numeric value on the wire for adjustmentType.

      • hasRestatementValue

        public boolean hasRestatementValue()
         Information needed to restate the conversion's value.
 Required for restatements. Should not be supplied for retractions. An error
 will be returned if provided for a retraction.
 NOTE: If you want to upload a second restatement with a different adjusted
 value, it must have a new, more recent, adjustment occurrence time.
 Otherwise, it will be treated as a duplicate of the previous restatement
 and ignored.
        .google.ads.googleads.v10.services.RestatementValue restatement_value = 6;
        Specified by:
        hasRestatementValue in interface ConversionAdjustmentOrBuilder
        Returns:
        Whether the restatementValue field is set.

      • getRestatementValue

        public RestatementValue getRestatementValue()
         Information needed to restate the conversion's value.
 Required for restatements. Should not be supplied for retractions. An error
 will be returned if provided for a retraction.
 NOTE: If you want to upload a second restatement with a different adjusted
 value, it must have a new, more recent, adjustment occurrence time.
 Otherwise, it will be treated as a duplicate of the previous restatement
 and ignored.
        .google.ads.googleads.v10.services.RestatementValue restatement_value = 6;
        Specified by:
        getRestatementValue in interface ConversionAdjustmentOrBuilder
        Returns:
        The restatementValue.

      • getRestatementValueOrBuilder

        public RestatementValueOrBuilder getRestatementValueOrBuilder()
         Information needed to restate the conversion's value.
 Required for restatements. Should not be supplied for retractions. An error
 will be returned if provided for a retraction.
 NOTE: If you want to upload a second restatement with a different adjusted
 value, it must have a new, more recent, adjustment occurrence time.
 Otherwise, it will be treated as a duplicate of the previous restatement
 and ignored.
        .google.ads.googleads.v10.services.RestatementValue restatement_value = 6;
        Specified by:
        getRestatementValueOrBuilder in interface ConversionAdjustmentOrBuilder

      • getUserIdentifiersList

        public java.util.List<UserIdentifier> getUserIdentifiersList()
         The user identifiers to enhance the original conversion.
 ConversionAdjustmentUploadService only accepts user identifiers in
 enhancements. The maximum number of user identifiers for each
 enhancement is 5.
        repeated .google.ads.googleads.v10.common.UserIdentifier user_identifiers = 10;
        Specified by:
        getUserIdentifiersList in interface ConversionAdjustmentOrBuilder

      • getUserIdentifiersOrBuilderList

        public java.util.List<? extends UserIdentifierOrBuilder> getUserIdentifiersOrBuilderList()
         The user identifiers to enhance the original conversion.
 ConversionAdjustmentUploadService only accepts user identifiers in
 enhancements. The maximum number of user identifiers for each
 enhancement is 5.
        repeated .google.ads.googleads.v10.common.UserIdentifier user_identifiers = 10;
        Specified by:
        getUserIdentifiersOrBuilderList in interface ConversionAdjustmentOrBuilder

      • getUserIdentifiersCount

        public int getUserIdentifiersCount()
         The user identifiers to enhance the original conversion.
 ConversionAdjustmentUploadService only accepts user identifiers in
 enhancements. The maximum number of user identifiers for each
 enhancement is 5.
        repeated .google.ads.googleads.v10.common.UserIdentifier user_identifiers = 10;
        Specified by:
        getUserIdentifiersCount in interface ConversionAdjustmentOrBuilder

      • getUserIdentifiers

        public UserIdentifier getUserIdentifiers​(int index)
         The user identifiers to enhance the original conversion.
 ConversionAdjustmentUploadService only accepts user identifiers in
 enhancements. The maximum number of user identifiers for each
 enhancement is 5.
        repeated .google.ads.googleads.v10.common.UserIdentifier user_identifiers = 10;
        Specified by:
        getUserIdentifiers in interface ConversionAdjustmentOrBuilder

      • getUserIdentifiersOrBuilder

        public UserIdentifierOrBuilder getUserIdentifiersOrBuilder​(int index)
         The user identifiers to enhance the original conversion.
 ConversionAdjustmentUploadService only accepts user identifiers in
 enhancements. The maximum number of user identifiers for each
 enhancement is 5.
        repeated .google.ads.googleads.v10.common.UserIdentifier user_identifiers = 10;
        Specified by:
        getUserIdentifiersOrBuilder in interface ConversionAdjustmentOrBuilder

      • hasUserAgent

        public boolean hasUserAgent()
         The user agent to enhance the original conversion. This can be found in
 your user's HTTP request header when they convert on your web page.
 Example, "Mozilla/5.0 (iPhone; CPU iPhone OS 12_2 like Mac OS X)". User
 agent can only be specified in enhancements with user identifiers. This
 should match the user agent of the request that sent the original
 conversion so the conversion and its enhancement are either both attributed
 as same-device or both attributed as cross-device.
        optional string user_agent = 11;
        Specified by:
        hasUserAgent in interface ConversionAdjustmentOrBuilder
        Returns:
        Whether the userAgent field is set.

      • getUserAgent

        public java.lang.String getUserAgent()
         The user agent to enhance the original conversion. This can be found in
 your user's HTTP request header when they convert on your web page.
 Example, "Mozilla/5.0 (iPhone; CPU iPhone OS 12_2 like Mac OS X)". User
 agent can only be specified in enhancements with user identifiers. This
 should match the user agent of the request that sent the original
 conversion so the conversion and its enhancement are either both attributed
 as same-device or both attributed as cross-device.
        optional string user_agent = 11;
        Specified by:
        getUserAgent in interface ConversionAdjustmentOrBuilder
        Returns:
        The userAgent.

      • getUserAgentBytes

        public com.google.protobuf.ByteString getUserAgentBytes()
         The user agent to enhance the original conversion. This can be found in
 your user's HTTP request header when they convert on your web page.
 Example, "Mozilla/5.0 (iPhone; CPU iPhone OS 12_2 like Mac OS X)". User
 agent can only be specified in enhancements with user identifiers. This
 should match the user agent of the request that sent the original
 conversion so the conversion and its enhancement are either both attributed
 as same-device or both attributed as cross-device.
        optional string user_agent = 11;
        Specified by:
        getUserAgentBytes in interface ConversionAdjustmentOrBuilder
        Returns:
        The bytes for userAgent.

      • 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 ConversionAdjustment parseFrom​(java.nio.ByteBuffer data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<ConversionAdjustment> 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 ConversionAdjustment getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder