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

Interface ConversionAdjustmentOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ConversionAdjustment, ConversionAdjustment.Builder
    public interface ConversionAdjustmentOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • hasGclidDateTimePair

        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;
        Returns:
        Whether the gclidDateTimePair field is set.

      • getGclidDateTimePair

        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;
        Returns:
        The gclidDateTimePair.

      • getGclidDateTimePairOrBuilder

        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;

      • hasOrderId

        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;
        Returns:
        Whether the orderId field is set.

      • getOrderId

        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;
        Returns:
        The orderId.

      • getOrderIdBytes

        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;
        Returns:
        The bytes for orderId.

      • hasConversionAction

        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;
        Returns:
        Whether the conversionAction field is set.

      • getConversionAction

        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;
        Returns:
        The conversionAction.

      • getConversionActionBytes

        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;
        Returns:
        The bytes for conversionAction.

      • hasAdjustmentDateTime

        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;
        Returns:
        Whether the adjustmentDateTime field is set.

      • getAdjustmentDateTime

        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;
        Returns:
        The adjustmentDateTime.

      • getAdjustmentDateTimeBytes

        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;
        Returns:
        The bytes for adjustmentDateTime.

      • getAdjustmentTypeValue

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

      • hasRestatementValue

        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;
        Returns:
        Whether the restatementValue field is set.

      • getRestatementValue

        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;
        Returns:
        The restatementValue.

      • getRestatementValueOrBuilder

        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;

      • getUserIdentifiersList

        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;

      • getUserIdentifiers

        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;

      • getUserIdentifiersCount

        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;

      • getUserIdentifiersOrBuilderList

        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;

      • getUserIdentifiersOrBuilder

        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;

      • hasUserAgent

        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;
        Returns:
        Whether the userAgent field is set.

      • getUserAgent

        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;
        Returns:
        The userAgent.

      • getUserAgentBytes

        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;
        Returns:
        The bytes for userAgent.