com.google.ads.googleads.v17.resources.CustomerOrBuilder 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/resources/customer.proto

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

public interface CustomerOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.ads.googleads.v17.resources.Customer)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Immutable. The resource name of the customer.
   * Customer resource names have the form:
   *
   * `customers/{customer_id}`
   * 
   *
   * string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return The resourceName.
   */
  java.lang.String getResourceName();
  /**
   *    * Immutable. The resource name of the customer.
   * Customer resource names have the form:
   *
   * `customers/{customer_id}`
   * 
   *
   * string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return The bytes for resourceName.
   */
  com.google.protobuf.ByteString
      getResourceNameBytes();

  /**
   *    * Output only. The ID of the customer.
   * 
   *
   * optional int64 id = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the id field is set.
   */
  boolean hasId();
  /**
   *    * Output only. The ID of the customer.
   * 
   *
   * optional int64 id = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The id.
   */
  long getId();

  /**
   *    * Optional, non-unique descriptive name of the customer.
   * 
   *
   * optional string descriptive_name = 20;
   * @return Whether the descriptiveName field is set.
   */
  boolean hasDescriptiveName();
  /**
   *    * Optional, non-unique descriptive name of the customer.
   * 
   *
   * optional string descriptive_name = 20;
   * @return The descriptiveName.
   */
  java.lang.String getDescriptiveName();
  /**
   *    * Optional, non-unique descriptive name of the customer.
   * 
   *
   * optional string descriptive_name = 20;
   * @return The bytes for descriptiveName.
   */
  com.google.protobuf.ByteString
      getDescriptiveNameBytes();

  /**
   *    * Immutable. The currency in which the account operates.
   * A subset of the currency codes from the ISO 4217 standard is
   * supported.
   * 
   *
   * optional string currency_code = 21 [(.google.api.field_behavior) = IMMUTABLE];
   * @return Whether the currencyCode field is set.
   */
  boolean hasCurrencyCode();
  /**
   *    * Immutable. The currency in which the account operates.
   * A subset of the currency codes from the ISO 4217 standard is
   * supported.
   * 
   *
   * optional string currency_code = 21 [(.google.api.field_behavior) = IMMUTABLE];
   * @return The currencyCode.
   */
  java.lang.String getCurrencyCode();
  /**
   *    * Immutable. The currency in which the account operates.
   * A subset of the currency codes from the ISO 4217 standard is
   * supported.
   * 
   *
   * optional string currency_code = 21 [(.google.api.field_behavior) = IMMUTABLE];
   * @return The bytes for currencyCode.
   */
  com.google.protobuf.ByteString
      getCurrencyCodeBytes();

  /**
   *    * Immutable. The local timezone ID of the customer.
   * 
   *
   * optional string time_zone = 22 [(.google.api.field_behavior) = IMMUTABLE];
   * @return Whether the timeZone field is set.
   */
  boolean hasTimeZone();
  /**
   *    * Immutable. The local timezone ID of the customer.
   * 
   *
   * optional string time_zone = 22 [(.google.api.field_behavior) = IMMUTABLE];
   * @return The timeZone.
   */
  java.lang.String getTimeZone();
  /**
   *    * Immutable. The local timezone ID of the customer.
   * 
   *
   * optional string time_zone = 22 [(.google.api.field_behavior) = IMMUTABLE];
   * @return The bytes for timeZone.
   */
  com.google.protobuf.ByteString
      getTimeZoneBytes();

  /**
   *    * The URL template for constructing a tracking URL out of parameters.
   * Only mutable in an `update` operation.
   * 
   *
   * optional string tracking_url_template = 23;
   * @return Whether the trackingUrlTemplate field is set.
   */
  boolean hasTrackingUrlTemplate();
  /**
   *    * The URL template for constructing a tracking URL out of parameters.
   * Only mutable in an `update` operation.
   * 
   *
   * optional string tracking_url_template = 23;
   * @return The trackingUrlTemplate.
   */
  java.lang.String getTrackingUrlTemplate();
  /**
   *    * The URL template for constructing a tracking URL out of parameters.
   * Only mutable in an `update` operation.
   * 
   *
   * optional string tracking_url_template = 23;
   * @return The bytes for trackingUrlTemplate.
   */
  com.google.protobuf.ByteString
      getTrackingUrlTemplateBytes();

  /**
   *    * The URL template for appending params to the final URL.
   * Only mutable in an `update` operation.
   * 
   *
   * optional string final_url_suffix = 24;
   * @return Whether the finalUrlSuffix field is set.
   */
  boolean hasFinalUrlSuffix();
  /**
   *    * The URL template for appending params to the final URL.
   * Only mutable in an `update` operation.
   * 
   *
   * optional string final_url_suffix = 24;
   * @return The finalUrlSuffix.
   */
  java.lang.String getFinalUrlSuffix();
  /**
   *    * The URL template for appending params to the final URL.
   * Only mutable in an `update` operation.
   * 
   *
   * optional string final_url_suffix = 24;
   * @return The bytes for finalUrlSuffix.
   */
  com.google.protobuf.ByteString
      getFinalUrlSuffixBytes();

  /**
   *    * Whether auto-tagging is enabled for the customer.
   * 
   *
   * optional bool auto_tagging_enabled = 25;
   * @return Whether the autoTaggingEnabled field is set.
   */
  boolean hasAutoTaggingEnabled();
  /**
   *    * Whether auto-tagging is enabled for the customer.
   * 
   *
   * optional bool auto_tagging_enabled = 25;
   * @return The autoTaggingEnabled.
   */
  boolean getAutoTaggingEnabled();

  /**
   *    * Output only. Whether the Customer has a Partners program badge. If the
   * Customer is not associated with the Partners program, this will be false.
   * For more information, see
   * https://support.google.com/partners/answer/3125774.
   * 
   *
   * optional bool has_partners_badge = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the hasPartnersBadge field is set.
   */
  boolean hasHasPartnersBadge();
  /**
   *    * Output only. Whether the Customer has a Partners program badge. If the
   * Customer is not associated with the Partners program, this will be false.
   * For more information, see
   * https://support.google.com/partners/answer/3125774.
   * 
   *
   * optional bool has_partners_badge = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The hasPartnersBadge.
   */
  boolean getHasPartnersBadge();

  /**
   *    * Output only. Whether the customer is a manager.
   * 
   *
   * optional bool manager = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the manager field is set.
   */
  boolean hasManager();
  /**
   *    * Output only. Whether the customer is a manager.
   * 
   *
   * optional bool manager = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The manager.
   */
  boolean getManager();

  /**
   *    * Output only. Whether the customer is a test account.
   * 
   *
   * optional bool test_account = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the testAccount field is set.
   */
  boolean hasTestAccount();
  /**
   *    * Output only. Whether the customer is a test account.
   * 
   *
   * optional bool test_account = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The testAccount.
   */
  boolean getTestAccount();

  /**
   *    * Call reporting setting for a customer. Only mutable in an `update`
   * operation.
   * 
   *
   * .google.ads.googleads.v17.resources.CallReportingSetting call_reporting_setting = 10;
   * @return Whether the callReportingSetting field is set.
   */
  boolean hasCallReportingSetting();
  /**
   *    * Call reporting setting for a customer. Only mutable in an `update`
   * operation.
   * 
   *
   * .google.ads.googleads.v17.resources.CallReportingSetting call_reporting_setting = 10;
   * @return The callReportingSetting.
   */
  com.google.ads.googleads.v17.resources.CallReportingSetting getCallReportingSetting();
  /**
   *    * Call reporting setting for a customer. Only mutable in an `update`
   * operation.
   * 
   *
   * .google.ads.googleads.v17.resources.CallReportingSetting call_reporting_setting = 10;
   */
  com.google.ads.googleads.v17.resources.CallReportingSettingOrBuilder getCallReportingSettingOrBuilder();

  /**
   *    * Output only. Conversion tracking setting for a customer.
   * 
   *
   * .google.ads.googleads.v17.resources.ConversionTrackingSetting conversion_tracking_setting = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the conversionTrackingSetting field is set.
   */
  boolean hasConversionTrackingSetting();
  /**
   *    * Output only. Conversion tracking setting for a customer.
   * 
   *
   * .google.ads.googleads.v17.resources.ConversionTrackingSetting conversion_tracking_setting = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The conversionTrackingSetting.
   */
  com.google.ads.googleads.v17.resources.ConversionTrackingSetting getConversionTrackingSetting();
  /**
   *    * Output only. Conversion tracking setting for a customer.
   * 
   *
   * .google.ads.googleads.v17.resources.ConversionTrackingSetting conversion_tracking_setting = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
   */
  com.google.ads.googleads.v17.resources.ConversionTrackingSettingOrBuilder getConversionTrackingSettingOrBuilder();

  /**
   *    * Output only. Remarketing setting for a customer.
   * 
   *
   * .google.ads.googleads.v17.resources.RemarketingSetting remarketing_setting = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the remarketingSetting field is set.
   */
  boolean hasRemarketingSetting();
  /**
   *    * Output only. Remarketing setting for a customer.
   * 
   *
   * .google.ads.googleads.v17.resources.RemarketingSetting remarketing_setting = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The remarketingSetting.
   */
  com.google.ads.googleads.v17.resources.RemarketingSetting getRemarketingSetting();
  /**
   *    * Output only. Remarketing setting for a customer.
   * 
   *
   * .google.ads.googleads.v17.resources.RemarketingSetting remarketing_setting = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
   */
  com.google.ads.googleads.v17.resources.RemarketingSettingOrBuilder getRemarketingSettingOrBuilder();

  /**
   *    * Output only. Reasons why the customer is not eligible to use
   * PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible.
   * This field is read-only.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.CustomerPayPerConversionEligibilityFailureReasonEnum.CustomerPayPerConversionEligibilityFailureReason pay_per_conversion_eligibility_failure_reasons = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return A list containing the payPerConversionEligibilityFailureReasons.
   */
  java.util.List getPayPerConversionEligibilityFailureReasonsList();
  /**
   *    * Output only. Reasons why the customer is not eligible to use
   * PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible.
   * This field is read-only.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.CustomerPayPerConversionEligibilityFailureReasonEnum.CustomerPayPerConversionEligibilityFailureReason pay_per_conversion_eligibility_failure_reasons = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The count of payPerConversionEligibilityFailureReasons.
   */
  int getPayPerConversionEligibilityFailureReasonsCount();
  /**
   *    * Output only. Reasons why the customer is not eligible to use
   * PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible.
   * This field is read-only.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.CustomerPayPerConversionEligibilityFailureReasonEnum.CustomerPayPerConversionEligibilityFailureReason pay_per_conversion_eligibility_failure_reasons = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @param index The index of the element to return.
   * @return The payPerConversionEligibilityFailureReasons at the given index.
   */
  com.google.ads.googleads.v17.enums.CustomerPayPerConversionEligibilityFailureReasonEnum.CustomerPayPerConversionEligibilityFailureReason getPayPerConversionEligibilityFailureReasons(int index);
  /**
   *    * Output only. Reasons why the customer is not eligible to use
   * PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible.
   * This field is read-only.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.CustomerPayPerConversionEligibilityFailureReasonEnum.CustomerPayPerConversionEligibilityFailureReason pay_per_conversion_eligibility_failure_reasons = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return A list containing the enum numeric values on the wire for payPerConversionEligibilityFailureReasons.
   */
  java.util.List
  getPayPerConversionEligibilityFailureReasonsValueList();
  /**
   *    * Output only. Reasons why the customer is not eligible to use
   * PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible.
   * This field is read-only.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.CustomerPayPerConversionEligibilityFailureReasonEnum.CustomerPayPerConversionEligibilityFailureReason pay_per_conversion_eligibility_failure_reasons = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @param index The index of the value to return.
   * @return The enum numeric value on the wire of payPerConversionEligibilityFailureReasons at the given index.
   */
  int getPayPerConversionEligibilityFailureReasonsValue(int index);

  /**
   *    * Output only. Optimization score of the customer.
   *
   * Optimization score is an estimate of how well a customer's campaigns are
   * set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null
   * for all manager customers, and for unscored non-manager customers.
   *
   * See "About optimization score" at
   * https://support.google.com/google-ads/answer/9061546.
   *
   * This field is read-only.
   * 
   *
   * optional double optimization_score = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the optimizationScore field is set.
   */
  boolean hasOptimizationScore();
  /**
   *    * Output only. Optimization score of the customer.
   *
   * Optimization score is an estimate of how well a customer's campaigns are
   * set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null
   * for all manager customers, and for unscored non-manager customers.
   *
   * See "About optimization score" at
   * https://support.google.com/google-ads/answer/9061546.
   *
   * This field is read-only.
   * 
   *
   * optional double optimization_score = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The optimizationScore.
   */
  double getOptimizationScore();

  /**
   *    * Output only. Optimization score weight of the customer.
   *
   * Optimization score weight can be used to compare/aggregate optimization
   * scores across multiple non-manager customers. The aggregate optimization
   * score of a manager is computed as the sum over all of their customers of
   * `Customer.optimization_score * Customer.optimization_score_weight`. This
   * field is 0 for all manager customers, and for unscored non-manager
   * customers.
   *
   * This field is read-only.
   * 
   *
   * double optimization_score_weight = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The optimizationScoreWeight.
   */
  double getOptimizationScoreWeight();

  /**
   *    * Output only. The status of the customer.
   * 
   *
   * .google.ads.googleads.v17.enums.CustomerStatusEnum.CustomerStatus status = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The enum numeric value on the wire for status.
   */
  int getStatusValue();
  /**
   *    * Output only. The status of the customer.
   * 
   *
   * .google.ads.googleads.v17.enums.CustomerStatusEnum.CustomerStatus status = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The status.
   */
  com.google.ads.googleads.v17.enums.CustomerStatusEnum.CustomerStatus getStatus();

  /**
   *    * Output only. True if feed based location has been migrated to asset based
   * location.
   * 
   *
   * optional bool location_asset_auto_migration_done = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the locationAssetAutoMigrationDone field is set.
   */
  boolean hasLocationAssetAutoMigrationDone();
  /**
   *    * Output only. True if feed based location has been migrated to asset based
   * location.
   * 
   *
   * optional bool location_asset_auto_migration_done = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The locationAssetAutoMigrationDone.
   */
  boolean getLocationAssetAutoMigrationDone();

  /**
   *    * Output only. True if feed based image has been migrated to asset based
   * image.
   * 
   *
   * optional bool image_asset_auto_migration_done = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the imageAssetAutoMigrationDone field is set.
   */
  boolean hasImageAssetAutoMigrationDone();
  /**
   *    * Output only. True if feed based image has been migrated to asset based
   * image.
   * 
   *
   * optional bool image_asset_auto_migration_done = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The imageAssetAutoMigrationDone.
   */
  boolean getImageAssetAutoMigrationDone();

  /**
   *    * Output only. Timestamp of migration from feed based location to asset base
   * location in yyyy-MM-dd HH:mm:ss format.
   * 
   *
   * optional string location_asset_auto_migration_done_date_time = 40 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the locationAssetAutoMigrationDoneDateTime field is set.
   */
  boolean hasLocationAssetAutoMigrationDoneDateTime();
  /**
   *    * Output only. Timestamp of migration from feed based location to asset base
   * location in yyyy-MM-dd HH:mm:ss format.
   * 
   *
   * optional string location_asset_auto_migration_done_date_time = 40 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The locationAssetAutoMigrationDoneDateTime.
   */
  java.lang.String getLocationAssetAutoMigrationDoneDateTime();
  /**
   *    * Output only. Timestamp of migration from feed based location to asset base
   * location in yyyy-MM-dd HH:mm:ss format.
   * 
   *
   * optional string location_asset_auto_migration_done_date_time = 40 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The bytes for locationAssetAutoMigrationDoneDateTime.
   */
  com.google.protobuf.ByteString
      getLocationAssetAutoMigrationDoneDateTimeBytes();

  /**
   *    * Output only. Timestamp of migration from feed based image to asset base
   * image in yyyy-MM-dd HH:mm:ss format.
   * 
   *
   * optional string image_asset_auto_migration_done_date_time = 41 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the imageAssetAutoMigrationDoneDateTime field is set.
   */
  boolean hasImageAssetAutoMigrationDoneDateTime();
  /**
   *    * Output only. Timestamp of migration from feed based image to asset base
   * image in yyyy-MM-dd HH:mm:ss format.
   * 
   *
   * optional string image_asset_auto_migration_done_date_time = 41 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The imageAssetAutoMigrationDoneDateTime.
   */
  java.lang.String getImageAssetAutoMigrationDoneDateTime();
  /**
   *    * Output only. Timestamp of migration from feed based image to asset base
   * image in yyyy-MM-dd HH:mm:ss format.
   * 
   *
   * optional string image_asset_auto_migration_done_date_time = 41 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The bytes for imageAssetAutoMigrationDoneDateTime.
   */
  com.google.protobuf.ByteString
      getImageAssetAutoMigrationDoneDateTimeBytes();

  /**
   *    * Output only. Customer Agreement Setting for a customer.
   * 
   *
   * .google.ads.googleads.v17.resources.CustomerAgreementSetting customer_agreement_setting = 44 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the customerAgreementSetting field is set.
   */
  boolean hasCustomerAgreementSetting();
  /**
   *    * Output only. Customer Agreement Setting for a customer.
   * 
   *
   * .google.ads.googleads.v17.resources.CustomerAgreementSetting customer_agreement_setting = 44 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The customerAgreementSetting.
   */
  com.google.ads.googleads.v17.resources.CustomerAgreementSetting getCustomerAgreementSetting();
  /**
   *    * Output only. Customer Agreement Setting for a customer.
   * 
   *
   * .google.ads.googleads.v17.resources.CustomerAgreementSetting customer_agreement_setting = 44 [(.google.api.field_behavior) = OUTPUT_ONLY];
   */
  com.google.ads.googleads.v17.resources.CustomerAgreementSettingOrBuilder getCustomerAgreementSettingOrBuilder();

  /**
   *    * Output only. Settings for Local Services customer.
   * 
   *
   * .google.ads.googleads.v17.resources.LocalServicesSettings local_services_settings = 45 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the localServicesSettings field is set.
   */
  boolean hasLocalServicesSettings();
  /**
   *    * Output only. Settings for Local Services customer.
   * 
   *
   * .google.ads.googleads.v17.resources.LocalServicesSettings local_services_settings = 45 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The localServicesSettings.
   */
  com.google.ads.googleads.v17.resources.LocalServicesSettings getLocalServicesSettings();
  /**
   *    * Output only. Settings for Local Services customer.
   * 
   *
   * .google.ads.googleads.v17.resources.LocalServicesSettings local_services_settings = 45 [(.google.api.field_behavior) = OUTPUT_ONLY];
   */
  com.google.ads.googleads.v17.resources.LocalServicesSettingsOrBuilder getLocalServicesSettingsOrBuilder();

  /**
   *    * Output only. Brand Safety setting at the account level. Allows for
   * selecting an inventory type to show your ads on content that is the right
   * fit for your brand. See
   * https://support.google.com/google-ads/answer/7515513.
   * 
   *
   * .google.ads.googleads.v17.enums.BrandSafetySuitabilityEnum.BrandSafetySuitability video_brand_safety_suitability = 46 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The enum numeric value on the wire for videoBrandSafetySuitability.
   */
  int getVideoBrandSafetySuitabilityValue();
  /**
   *    * Output only. Brand Safety setting at the account level. Allows for
   * selecting an inventory type to show your ads on content that is the right
   * fit for your brand. See
   * https://support.google.com/google-ads/answer/7515513.
   * 
   *
   * .google.ads.googleads.v17.enums.BrandSafetySuitabilityEnum.BrandSafetySuitability video_brand_safety_suitability = 46 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The videoBrandSafetySuitability.
   */
  com.google.ads.googleads.v17.enums.BrandSafetySuitabilityEnum.BrandSafetySuitability getVideoBrandSafetySuitability();
}