com.google.ads.googleads.v17.services.ConversionAdjustmentOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-ads-stubs-v17 Show documentation
Stubs for GAAPI version google-ads-stubs-v17
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/ads/googleads/v17/services/conversion_adjustment_upload_service.proto

// Protobuf Java Version: 3.25.3
package com.google.ads.googleads.v17.services;

public interface ConversionAdjustmentOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.ads.googleads.v17.services.ConversionAdjustment)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * 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.v17.services.GclidDateTimePair gclid_date_time_pair = 12;
   * @return Whether the gclidDateTimePair field is set.
   */
  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.v17.services.GclidDateTimePair gclid_date_time_pair = 12;
   * @return The gclidDateTimePair.
   */
  com.google.ads.googleads.v17.services.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.v17.services.GclidDateTimePair gclid_date_time_pair = 12;
   */
  com.google.ads.googleads.v17.services.GclidDateTimePairOrBuilder getGclidDateTimePairOrBuilder();

  /**
   *    * 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;
   * @return Whether the orderId field is set.
   */
  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;
   * @return The orderId.
   */
  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;
   * @return The bytes for orderId.
   */
  com.google.protobuf.ByteString
      getOrderIdBytes();

  /**
   *    * 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;
   * @return Whether the conversionAction field is set.
   */
  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;
   * @return The conversionAction.
   */
  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;
   * @return The bytes for conversionAction.
   */
  com.google.protobuf.ByteString
      getConversionActionBytes();

  /**
   *    * 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", for example, "2019-01-01 12:32:45-08:00".
   * 
   *
   * optional string adjustment_date_time = 9;
   * @return Whether the adjustmentDateTime field is set.
   */
  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", for example, "2019-01-01 12:32:45-08:00".
   * 
   *
   * optional string adjustment_date_time = 9;
   * @return The adjustmentDateTime.
   */
  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", for example, "2019-01-01 12:32:45-08:00".
   * 
   *
   * optional string adjustment_date_time = 9;
   * @return The bytes for adjustmentDateTime.
   */
  com.google.protobuf.ByteString
      getAdjustmentDateTimeBytes();

  /**
   *    * The adjustment type.
   * 
   *
   * .google.ads.googleads.v17.enums.ConversionAdjustmentTypeEnum.ConversionAdjustmentType adjustment_type = 5;
   * @return The enum numeric value on the wire for adjustmentType.
   */
  int getAdjustmentTypeValue();
  /**
   *    * The adjustment type.
   * 
   *
   * .google.ads.googleads.v17.enums.ConversionAdjustmentTypeEnum.ConversionAdjustmentType adjustment_type = 5;
   * @return The adjustmentType.
   */
  com.google.ads.googleads.v17.enums.ConversionAdjustmentTypeEnum.ConversionAdjustmentType getAdjustmentType();

  /**
   *    * 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.v17.services.RestatementValue restatement_value = 6;
   * @return Whether the restatementValue field is set.
   */
  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.v17.services.RestatementValue restatement_value = 6;
   * @return The restatementValue.
   */
  com.google.ads.googleads.v17.services.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.v17.services.RestatementValue restatement_value = 6;
   */
  com.google.ads.googleads.v17.services.RestatementValueOrBuilder getRestatementValueOrBuilder();

  /**
   *    * 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.v17.common.UserIdentifier user_identifiers = 10;
   */
  java.util.List 
      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.v17.common.UserIdentifier user_identifiers = 10;
   */
  com.google.ads.googleads.v17.common.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.v17.common.UserIdentifier user_identifiers = 10;
   */
  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.v17.common.UserIdentifier user_identifiers = 10;
   */
  java.util.List 
      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.v17.common.UserIdentifier user_identifiers = 10;
   */
  com.google.ads.googleads.v17.common.UserIdentifierOrBuilder getUserIdentifiersOrBuilder(
      int index);

  /**
   *    * 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;
   * @return Whether the userAgent field is set.
   */
  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;
   * @return The userAgent.
   */
  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;
   * @return The bytes for userAgent.
   */
  com.google.protobuf.ByteString
      getUserAgentBytes();
}