com.google.ads.googleads.v17.common.UserAttributeOrBuilder 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/common/offline_user_data.proto

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

public interface UserAttributeOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.ads.googleads.v17.common.UserAttribute)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Advertiser defined lifetime value for the user.
   * 
   *
   * optional int64 lifetime_value_micros = 1;
   * @return Whether the lifetimeValueMicros field is set.
   */
  boolean hasLifetimeValueMicros();
  /**
   *    * Advertiser defined lifetime value for the user.
   * 
   *
   * optional int64 lifetime_value_micros = 1;
   * @return The lifetimeValueMicros.
   */
  long getLifetimeValueMicros();

  /**
   *    * Advertiser defined lifetime value bucket for the user. The valid range for
   * a lifetime value bucket is from 1 (low) to 10 (high), except for remove
   * operation where 0 will also be accepted.
   * 
   *
   * optional int32 lifetime_value_bucket = 2;
   * @return Whether the lifetimeValueBucket field is set.
   */
  boolean hasLifetimeValueBucket();
  /**
   *    * Advertiser defined lifetime value bucket for the user. The valid range for
   * a lifetime value bucket is from 1 (low) to 10 (high), except for remove
   * operation where 0 will also be accepted.
   * 
   *
   * optional int32 lifetime_value_bucket = 2;
   * @return The lifetimeValueBucket.
   */
  int getLifetimeValueBucket();

  /**
   *    * Timestamp of the last purchase made by the user.
   * The format is YYYY-MM-DD HH:MM:SS[+/-HH:MM], where [+/-HH:MM] is an
   * optional timezone offset from UTC. If the offset is absent, the API will
   * use the account's timezone as default.
   * 
   *
   * string last_purchase_date_time = 3;
   * @return The lastPurchaseDateTime.
   */
  java.lang.String getLastPurchaseDateTime();
  /**
   *    * Timestamp of the last purchase made by the user.
   * The format is YYYY-MM-DD HH:MM:SS[+/-HH:MM], where [+/-HH:MM] is an
   * optional timezone offset from UTC. If the offset is absent, the API will
   * use the account's timezone as default.
   * 
   *
   * string last_purchase_date_time = 3;
   * @return The bytes for lastPurchaseDateTime.
   */
  com.google.protobuf.ByteString
      getLastPurchaseDateTimeBytes();

  /**
   *    * Advertiser defined average number of purchases that are made by the user in
   * a 30 day period.
   * 
   *
   * int32 average_purchase_count = 4;
   * @return The averagePurchaseCount.
   */
  int getAveragePurchaseCount();

  /**
   *    * Advertiser defined average purchase value in micros for the user.
   * 
   *
   * int64 average_purchase_value_micros = 5;
   * @return The averagePurchaseValueMicros.
   */
  long getAveragePurchaseValueMicros();

  /**
   *    * Timestamp when the user was acquired.
   * The format is YYYY-MM-DD HH:MM:SS[+/-HH:MM], where [+/-HH:MM] is an
   * optional timezone offset from UTC. If the offset is absent, the API will
   * use the account's timezone as default.
   * 
   *
   * string acquisition_date_time = 6;
   * @return The acquisitionDateTime.
   */
  java.lang.String getAcquisitionDateTime();
  /**
   *    * Timestamp when the user was acquired.
   * The format is YYYY-MM-DD HH:MM:SS[+/-HH:MM], where [+/-HH:MM] is an
   * optional timezone offset from UTC. If the offset is absent, the API will
   * use the account's timezone as default.
   * 
   *
   * string acquisition_date_time = 6;
   * @return The bytes for acquisitionDateTime.
   */
  com.google.protobuf.ByteString
      getAcquisitionDateTimeBytes();

  /**
   *    * The shopping loyalty related data. Shopping utilizes this data to provide
   * users with a better experience. Accessible only to merchants on the
   * allow-list with the user's consent.
   * 
   *
   * optional .google.ads.googleads.v17.common.ShoppingLoyalty shopping_loyalty = 7;
   * @return Whether the shoppingLoyalty field is set.
   */
  boolean hasShoppingLoyalty();
  /**
   *    * The shopping loyalty related data. Shopping utilizes this data to provide
   * users with a better experience. Accessible only to merchants on the
   * allow-list with the user's consent.
   * 
   *
   * optional .google.ads.googleads.v17.common.ShoppingLoyalty shopping_loyalty = 7;
   * @return The shoppingLoyalty.
   */
  com.google.ads.googleads.v17.common.ShoppingLoyalty getShoppingLoyalty();
  /**
   *    * The shopping loyalty related data. Shopping utilizes this data to provide
   * users with a better experience. Accessible only to merchants on the
   * allow-list with the user's consent.
   * 
   *
   * optional .google.ads.googleads.v17.common.ShoppingLoyalty shopping_loyalty = 7;
   */
  com.google.ads.googleads.v17.common.ShoppingLoyaltyOrBuilder getShoppingLoyaltyOrBuilder();

  /**
   *    * Optional. Advertiser defined lifecycle stage for the user. The accepted
   * values are "Lead", "Active" and "Churned".
   * 
   *
   * string lifecycle_stage = 8 [(.google.api.field_behavior) = OPTIONAL];
   * @return The lifecycleStage.
   */
  java.lang.String getLifecycleStage();
  /**
   *    * Optional. Advertiser defined lifecycle stage for the user. The accepted
   * values are "Lead", "Active" and "Churned".
   * 
   *
   * string lifecycle_stage = 8 [(.google.api.field_behavior) = OPTIONAL];
   * @return The bytes for lifecycleStage.
   */
  com.google.protobuf.ByteString
      getLifecycleStageBytes();

  /**
   *    * Optional. Timestamp of the first purchase made by the user.
   * The format is YYYY-MM-DD HH:MM:SS[+/-HH:MM], where [+/-HH:MM] is an
   * optional timezone offset from UTC. If the offset is absent, the API will
   * use the account's timezone as default.
   * 
   *
   * string first_purchase_date_time = 9 [(.google.api.field_behavior) = OPTIONAL];
   * @return The firstPurchaseDateTime.
   */
  java.lang.String getFirstPurchaseDateTime();
  /**
   *    * Optional. Timestamp of the first purchase made by the user.
   * The format is YYYY-MM-DD HH:MM:SS[+/-HH:MM], where [+/-HH:MM] is an
   * optional timezone offset from UTC. If the offset is absent, the API will
   * use the account's timezone as default.
   * 
   *
   * string first_purchase_date_time = 9 [(.google.api.field_behavior) = OPTIONAL];
   * @return The bytes for firstPurchaseDateTime.
   */
  com.google.protobuf.ByteString
      getFirstPurchaseDateTimeBytes();

  /**
   *    * Optional. Advertiser defined events and their attributes. All the values in
   * the nested fields are required. Currently this field is in beta.
   * 
   *
   * repeated .google.ads.googleads.v17.common.EventAttribute event_attribute = 10 [(.google.api.field_behavior) = OPTIONAL];
   */
  java.util.List 
      getEventAttributeList();
  /**
   *    * Optional. Advertiser defined events and their attributes. All the values in
   * the nested fields are required. Currently this field is in beta.
   * 
   *
   * repeated .google.ads.googleads.v17.common.EventAttribute event_attribute = 10 [(.google.api.field_behavior) = OPTIONAL];
   */
  com.google.ads.googleads.v17.common.EventAttribute getEventAttribute(int index);
  /**
   *    * Optional. Advertiser defined events and their attributes. All the values in
   * the nested fields are required. Currently this field is in beta.
   * 
   *
   * repeated .google.ads.googleads.v17.common.EventAttribute event_attribute = 10 [(.google.api.field_behavior) = OPTIONAL];
   */
  int getEventAttributeCount();
  /**
   *    * Optional. Advertiser defined events and their attributes. All the values in
   * the nested fields are required. Currently this field is in beta.
   * 
   *
   * repeated .google.ads.googleads.v17.common.EventAttribute event_attribute = 10 [(.google.api.field_behavior) = OPTIONAL];
   */
  java.util.List 
      getEventAttributeOrBuilderList();
  /**
   *    * Optional. Advertiser defined events and their attributes. All the values in
   * the nested fields are required. Currently this field is in beta.
   * 
   *
   * repeated .google.ads.googleads.v17.common.EventAttribute event_attribute = 10 [(.google.api.field_behavior) = OPTIONAL];
   */
  com.google.ads.googleads.v17.common.EventAttributeOrBuilder getEventAttributeOrBuilder(
      int index);
}