Package com.google.ads.googleads.v10.resources

Interface CustomerOrBuilder

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

    • Method Detail

      • getResourceName

        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) = { ... }
        Returns:
        The resourceName.

      • getResourceNameBytes

        com.google.protobuf.ByteString getResourceNameBytes()
         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) = { ... }
        Returns:
        The bytes for resourceName.

      • hasId

        boolean hasId()
         Output only. The ID of the customer.
        optional int64 id = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the id field is set.

      • getId

        long getId()
         Output only. The ID of the customer.
        optional int64 id = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The id.

      • hasDescriptiveName

        boolean hasDescriptiveName()
         Optional, non-unique descriptive name of the customer.
        optional string descriptive_name = 20;
        Returns:
        Whether the descriptiveName field is set.

      • getDescriptiveName

        java.lang.String getDescriptiveName()
         Optional, non-unique descriptive name of the customer.
        optional string descriptive_name = 20;
        Returns:
        The descriptiveName.

      • getDescriptiveNameBytes

        com.google.protobuf.ByteString getDescriptiveNameBytes()
         Optional, non-unique descriptive name of the customer.
        optional string descriptive_name = 20;
        Returns:
        The bytes for descriptiveName.

      • hasCurrencyCode

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

      • getCurrencyCode

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

      • getCurrencyCodeBytes

        com.google.protobuf.ByteString getCurrencyCodeBytes()
         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];
        Returns:
        The bytes for currencyCode.

      • hasTimeZone

        boolean hasTimeZone()
         Immutable. The local timezone ID of the customer.
        optional string time_zone = 22 [(.google.api.field_behavior) = IMMUTABLE];
        Returns:
        Whether the timeZone field is set.

      • getTimeZone

        java.lang.String getTimeZone()
         Immutable. The local timezone ID of the customer.
        optional string time_zone = 22 [(.google.api.field_behavior) = IMMUTABLE];
        Returns:
        The timeZone.

      • getTimeZoneBytes

        com.google.protobuf.ByteString getTimeZoneBytes()
         Immutable. The local timezone ID of the customer.
        optional string time_zone = 22 [(.google.api.field_behavior) = IMMUTABLE];
        Returns:
        The bytes for timeZone.

      • hasTrackingUrlTemplate

        boolean hasTrackingUrlTemplate()
         The URL template for constructing a tracking URL out of parameters.
        optional string tracking_url_template = 23;
        Returns:
        Whether the trackingUrlTemplate field is set.

      • getTrackingUrlTemplate

        java.lang.String getTrackingUrlTemplate()
         The URL template for constructing a tracking URL out of parameters.
        optional string tracking_url_template = 23;
        Returns:
        The trackingUrlTemplate.

      • getTrackingUrlTemplateBytes

        com.google.protobuf.ByteString getTrackingUrlTemplateBytes()
         The URL template for constructing a tracking URL out of parameters.
        optional string tracking_url_template = 23;
        Returns:
        The bytes for trackingUrlTemplate.

      • hasFinalUrlSuffix

        boolean hasFinalUrlSuffix()
         The URL template for appending params to the final URL
        optional string final_url_suffix = 24;
        Returns:
        Whether the finalUrlSuffix field is set.

      • getFinalUrlSuffix

        java.lang.String getFinalUrlSuffix()
         The URL template for appending params to the final URL
        optional string final_url_suffix = 24;
        Returns:
        The finalUrlSuffix.

      • getFinalUrlSuffixBytes

        com.google.protobuf.ByteString getFinalUrlSuffixBytes()
         The URL template for appending params to the final URL
        optional string final_url_suffix = 24;
        Returns:
        The bytes for finalUrlSuffix.

      • hasAutoTaggingEnabled

        boolean hasAutoTaggingEnabled()
         Whether auto-tagging is enabled for the customer.
        optional bool auto_tagging_enabled = 25;
        Returns:
        Whether the autoTaggingEnabled field is set.

      • getAutoTaggingEnabled

        boolean getAutoTaggingEnabled()
         Whether auto-tagging is enabled for the customer.
        optional bool auto_tagging_enabled = 25;
        Returns:
        The autoTaggingEnabled.

      • hasHasPartnersBadge

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

      • getHasPartnersBadge

        boolean getHasPartnersBadge()
         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];
        Returns:
        The hasPartnersBadge.

      • hasManager

        boolean hasManager()
         Output only. Whether the customer is a manager.
        optional bool manager = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the manager field is set.

      • getManager

        boolean getManager()
         Output only. Whether the customer is a manager.
        optional bool manager = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The manager.

      • hasTestAccount

        boolean hasTestAccount()
         Output only. Whether the customer is a test account.
        optional bool test_account = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the testAccount field is set.

      • getTestAccount

        boolean getTestAccount()
         Output only. Whether the customer is a test account.
        optional bool test_account = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The testAccount.

      • hasCallReportingSetting

        boolean hasCallReportingSetting()
         Call reporting setting for a customer.
        .google.ads.googleads.v10.resources.CallReportingSetting call_reporting_setting = 10;
        Returns:
        Whether the callReportingSetting field is set.

      • getCallReportingSetting

        CallReportingSetting getCallReportingSetting()
         Call reporting setting for a customer.
        .google.ads.googleads.v10.resources.CallReportingSetting call_reporting_setting = 10;
        Returns:
        The callReportingSetting.

      • getCallReportingSettingOrBuilder

        CallReportingSettingOrBuilder getCallReportingSettingOrBuilder()
         Call reporting setting for a customer.
        .google.ads.googleads.v10.resources.CallReportingSetting call_reporting_setting = 10;

      • hasConversionTrackingSetting

        boolean hasConversionTrackingSetting()
         Output only. Conversion tracking setting for a customer.
        .google.ads.googleads.v10.resources.ConversionTrackingSetting conversion_tracking_setting = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the conversionTrackingSetting field is set.

      • getConversionTrackingSetting

        ConversionTrackingSetting getConversionTrackingSetting()
         Output only. Conversion tracking setting for a customer.
        .google.ads.googleads.v10.resources.ConversionTrackingSetting conversion_tracking_setting = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The conversionTrackingSetting.

      • getConversionTrackingSettingOrBuilder

        ConversionTrackingSettingOrBuilder getConversionTrackingSettingOrBuilder()
         Output only. Conversion tracking setting for a customer.
        .google.ads.googleads.v10.resources.ConversionTrackingSetting conversion_tracking_setting = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasRemarketingSetting

        boolean hasRemarketingSetting()
         Output only. Remarketing setting for a customer.
        .google.ads.googleads.v10.resources.RemarketingSetting remarketing_setting = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the remarketingSetting field is set.

      • getRemarketingSetting

        RemarketingSetting getRemarketingSetting()
         Output only. Remarketing setting for a customer.
        .google.ads.googleads.v10.resources.RemarketingSetting remarketing_setting = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The remarketingSetting.

      • getRemarketingSettingOrBuilder

        RemarketingSettingOrBuilder getRemarketingSettingOrBuilder()
         Output only. Remarketing setting for a customer.
        .google.ads.googleads.v10.resources.RemarketingSetting remarketing_setting = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getPayPerConversionEligibilityFailureReasonsList

        java.util.List<CustomerPayPerConversionEligibilityFailureReasonEnum.CustomerPayPerConversionEligibilityFailureReason> 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.v10.enums.CustomerPayPerConversionEligibilityFailureReasonEnum.CustomerPayPerConversionEligibilityFailureReason pay_per_conversion_eligibility_failure_reasons = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        A list containing the payPerConversionEligibilityFailureReasons.

      • getPayPerConversionEligibilityFailureReasonsCount

        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.v10.enums.CustomerPayPerConversionEligibilityFailureReasonEnum.CustomerPayPerConversionEligibilityFailureReason pay_per_conversion_eligibility_failure_reasons = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The count of payPerConversionEligibilityFailureReasons.

      • getPayPerConversionEligibilityFailureReasons

        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.v10.enums.CustomerPayPerConversionEligibilityFailureReasonEnum.CustomerPayPerConversionEligibilityFailureReason pay_per_conversion_eligibility_failure_reasons = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        index - The index of the element to return.
        Returns:
        The payPerConversionEligibilityFailureReasons at the given index.

      • getPayPerConversionEligibilityFailureReasonsValueList

        java.util.List<java.lang.Integer> 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.v10.enums.CustomerPayPerConversionEligibilityFailureReasonEnum.CustomerPayPerConversionEligibilityFailureReason pay_per_conversion_eligibility_failure_reasons = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        A list containing the enum numeric values on the wire for payPerConversionEligibilityFailureReasons.

      • getPayPerConversionEligibilityFailureReasonsValue

        int getPayPerConversionEligibilityFailureReasonsValue​(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.v10.enums.CustomerPayPerConversionEligibilityFailureReasonEnum.CustomerPayPerConversionEligibilityFailureReason pay_per_conversion_eligibility_failure_reasons = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of payPerConversionEligibilityFailureReasons at the given index.

      • hasOptimizationScore

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

      • getOptimizationScore

        double getOptimizationScore()
         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];
        Returns:
        The optimizationScore.

      • getOptimizationScoreWeight

        double getOptimizationScoreWeight()
         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];
        Returns:
        The optimizationScoreWeight.

      • getStatusValue

        int getStatusValue()
         Output only. The status of the customer.
        .google.ads.googleads.v10.enums.CustomerStatusEnum.CustomerStatus status = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The enum numeric value on the wire for status.

      • getStatus

        CustomerStatusEnum.CustomerStatus getStatus()
         Output only. The status of the customer.
        .google.ads.googleads.v10.enums.CustomerStatusEnum.CustomerStatus status = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The status.