com.google.ads.googleads.v17.resources.CustomerClientOrBuilder 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_client.proto

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

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

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

  /**
   *    * Output only. The resource name of the client-customer which is linked to
   * the given customer. Read only.
   * 
   *
   * optional string client_customer = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * @return Whether the clientCustomer field is set.
   */
  boolean hasClientCustomer();
  /**
   *    * Output only. The resource name of the client-customer which is linked to
   * the given customer. Read only.
   * 
   *
   * optional string client_customer = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * @return The clientCustomer.
   */
  java.lang.String getClientCustomer();
  /**
   *    * Output only. The resource name of the client-customer which is linked to
   * the given customer. Read only.
   * 
   *
   * optional string client_customer = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * @return The bytes for clientCustomer.
   */
  com.google.protobuf.ByteString
      getClientCustomerBytes();

  /**
   *    * Output only. Specifies whether this is a
   * [hidden account](https://support.google.com/google-ads/answer/7519830).
   * Read only.
   * 
   *
   * optional bool hidden = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the hidden field is set.
   */
  boolean hasHidden();
  /**
   *    * Output only. Specifies whether this is a
   * [hidden account](https://support.google.com/google-ads/answer/7519830).
   * Read only.
   * 
   *
   * optional bool hidden = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The hidden.
   */
  boolean getHidden();

  /**
   *    * Output only. Distance between given customer and client. For self link, the
   * level value will be 0. Read only.
   * 
   *
   * optional int64 level = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the level field is set.
   */
  boolean hasLevel();
  /**
   *    * Output only. Distance between given customer and client. For self link, the
   * level value will be 0. Read only.
   * 
   *
   * optional int64 level = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The level.
   */
  long getLevel();

  /**
   *    * Output only. Common Locale Data Repository (CLDR) string representation of
   * the time zone of the client, for example, America/Los_Angeles. Read only.
   * 
   *
   * optional string time_zone = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the timeZone field is set.
   */
  boolean hasTimeZone();
  /**
   *    * Output only. Common Locale Data Repository (CLDR) string representation of
   * the time zone of the client, for example, America/Los_Angeles. Read only.
   * 
   *
   * optional string time_zone = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The timeZone.
   */
  java.lang.String getTimeZone();
  /**
   *    * Output only. Common Locale Data Repository (CLDR) string representation of
   * the time zone of the client, for example, America/Los_Angeles. Read only.
   * 
   *
   * optional string time_zone = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The bytes for timeZone.
   */
  com.google.protobuf.ByteString
      getTimeZoneBytes();

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

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

  /**
   *    * Output only. Descriptive name for the client. Read only.
   * 
   *
   * optional string descriptive_name = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the descriptiveName field is set.
   */
  boolean hasDescriptiveName();
  /**
   *    * Output only. Descriptive name for the client. Read only.
   * 
   *
   * optional string descriptive_name = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The descriptiveName.
   */
  java.lang.String getDescriptiveName();
  /**
   *    * Output only. Descriptive name for the client. Read only.
   * 
   *
   * optional string descriptive_name = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The bytes for descriptiveName.
   */
  com.google.protobuf.ByteString
      getDescriptiveNameBytes();

  /**
   *    * Output only. Currency code (for example, 'USD', 'EUR') for the client. Read
   * only.
   * 
   *
   * optional string currency_code = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the currencyCode field is set.
   */
  boolean hasCurrencyCode();
  /**
   *    * Output only. Currency code (for example, 'USD', 'EUR') for the client. Read
   * only.
   * 
   *
   * optional string currency_code = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The currencyCode.
   */
  java.lang.String getCurrencyCode();
  /**
   *    * Output only. Currency code (for example, 'USD', 'EUR') for the client. Read
   * only.
   * 
   *
   * optional string currency_code = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The bytes for currencyCode.
   */
  com.google.protobuf.ByteString
      getCurrencyCodeBytes();

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

  /**
   *    * Output only. The resource names of the labels owned by the requesting
   * customer that are applied to the client customer. Label resource names have
   * the form:
   *
   * `customers/{customer_id}/labels/{label_id}`
   * 
   *
   * repeated string applied_labels = 21 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * @return A list containing the appliedLabels.
   */
  java.util.List
      getAppliedLabelsList();
  /**
   *    * Output only. The resource names of the labels owned by the requesting
   * customer that are applied to the client customer. Label resource names have
   * the form:
   *
   * `customers/{customer_id}/labels/{label_id}`
   * 
   *
   * repeated string applied_labels = 21 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * @return The count of appliedLabels.
   */
  int getAppliedLabelsCount();
  /**
   *    * Output only. The resource names of the labels owned by the requesting
   * customer that are applied to the client customer. Label resource names have
   * the form:
   *
   * `customers/{customer_id}/labels/{label_id}`
   * 
   *
   * repeated string applied_labels = 21 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * @param index The index of the element to return.
   * @return The appliedLabels at the given index.
   */
  java.lang.String getAppliedLabels(int index);
  /**
   *    * Output only. The resource names of the labels owned by the requesting
   * customer that are applied to the client customer. Label resource names have
   * the form:
   *
   * `customers/{customer_id}/labels/{label_id}`
   * 
   *
   * repeated string applied_labels = 21 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * @param index The index of the value to return.
   * @return The bytes of the appliedLabels at the given index.
   */
  com.google.protobuf.ByteString
      getAppliedLabelsBytes(int index);

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