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

Class CustomerClient

  • All Implemented Interfaces:
    CustomerClientOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class CustomerClient
extends com.google.protobuf.GeneratedMessageV3
implements CustomerClientOrBuilder
     A link between the given customer and a client customer. CustomerClients only
 exist for manager customers. All direct and indirect client customers are
 included, as well as the manager itself.
    Protobuf type google.ads.googleads.v10.resources.CustomerClient
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getResourceName

        public 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) = { ... }
        Specified by:
        getResourceName in interface CustomerClientOrBuilder
        Returns:
        The resourceName.

      • getResourceNameBytes

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

      • hasClientCustomer

        public 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) = { ... }
        Specified by:
        hasClientCustomer in interface CustomerClientOrBuilder
        Returns:
        Whether the clientCustomer field is set.

      • getClientCustomer

        public 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) = { ... }
        Specified by:
        getClientCustomer in interface CustomerClientOrBuilder
        Returns:
        The clientCustomer.

      • getClientCustomerBytes

        public com.google.protobuf.ByteString getClientCustomerBytes()
         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) = { ... }
        Specified by:
        getClientCustomerBytes in interface CustomerClientOrBuilder
        Returns:
        The bytes for clientCustomer.

      • hasHidden

        public 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];
        Specified by:
        hasHidden in interface CustomerClientOrBuilder
        Returns:
        Whether the hidden field is set.

      • getHidden

        public boolean getHidden()
         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];
        Specified by:
        getHidden in interface CustomerClientOrBuilder
        Returns:
        The hidden.

      • hasLevel

        public 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];
        Specified by:
        hasLevel in interface CustomerClientOrBuilder
        Returns:
        Whether the level field is set.

      • getLevel

        public long getLevel()
         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];
        Specified by:
        getLevel in interface CustomerClientOrBuilder
        Returns:
        The level.

      • hasTimeZone

        public boolean hasTimeZone()
         Output only. Common Locale Data Repository (CLDR) string representation of the
 time zone of the client, e.g. America/Los_Angeles. Read only.
        optional string time_zone = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasTimeZone in interface CustomerClientOrBuilder
        Returns:
        Whether the timeZone field is set.

      • getTimeZone

        public java.lang.String getTimeZone()
         Output only. Common Locale Data Repository (CLDR) string representation of the
 time zone of the client, e.g. America/Los_Angeles. Read only.
        optional string time_zone = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getTimeZone in interface CustomerClientOrBuilder
        Returns:
        The timeZone.

      • getTimeZoneBytes

        public com.google.protobuf.ByteString getTimeZoneBytes()
         Output only. Common Locale Data Repository (CLDR) string representation of the
 time zone of the client, e.g. America/Los_Angeles. Read only.
        optional string time_zone = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getTimeZoneBytes in interface CustomerClientOrBuilder
        Returns:
        The bytes for timeZone.

      • hasTestAccount

        public 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];
        Specified by:
        hasTestAccount in interface CustomerClientOrBuilder
        Returns:
        Whether the testAccount field is set.

      • getTestAccount

        public boolean getTestAccount()
         Output only. Identifies if the client is a test account. Read only.
        optional bool test_account = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getTestAccount in interface CustomerClientOrBuilder
        Returns:
        The testAccount.

      • hasManager

        public boolean hasManager()
         Output only. Identifies if the client is a manager. Read only.
        optional bool manager = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasManager in interface CustomerClientOrBuilder
        Returns:
        Whether the manager field is set.

      • getManager

        public boolean getManager()
         Output only. Identifies if the client is a manager. Read only.
        optional bool manager = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getManager in interface CustomerClientOrBuilder
        Returns:
        The manager.

      • hasDescriptiveName

        public boolean hasDescriptiveName()
         Output only. Descriptive name for the client. Read only.
        optional string descriptive_name = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasDescriptiveName in interface CustomerClientOrBuilder
        Returns:
        Whether the descriptiveName field is set.

      • getDescriptiveName

        public java.lang.String getDescriptiveName()
         Output only. Descriptive name for the client. Read only.
        optional string descriptive_name = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDescriptiveName in interface CustomerClientOrBuilder
        Returns:
        The descriptiveName.

      • getDescriptiveNameBytes

        public com.google.protobuf.ByteString getDescriptiveNameBytes()
         Output only. Descriptive name for the client. Read only.
        optional string descriptive_name = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDescriptiveNameBytes in interface CustomerClientOrBuilder
        Returns:
        The bytes for descriptiveName.

      • hasCurrencyCode

        public boolean hasCurrencyCode()
         Output only. Currency code (e.g. 'USD', 'EUR') for the client. Read only.
        optional string currency_code = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCurrencyCode in interface CustomerClientOrBuilder
        Returns:
        Whether the currencyCode field is set.

      • getCurrencyCode

        public java.lang.String getCurrencyCode()
         Output only. Currency code (e.g. 'USD', 'EUR') for the client. Read only.
        optional string currency_code = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCurrencyCode in interface CustomerClientOrBuilder
        Returns:
        The currencyCode.

      • getCurrencyCodeBytes

        public com.google.protobuf.ByteString getCurrencyCodeBytes()
         Output only. Currency code (e.g. 'USD', 'EUR') for the client. Read only.
        optional string currency_code = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCurrencyCodeBytes in interface CustomerClientOrBuilder
        Returns:
        The bytes for currencyCode.

      • hasId

        public boolean hasId()
         Output only. The ID of the client customer. Read only.
        optional int64 id = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasId in interface CustomerClientOrBuilder
        Returns:
        Whether the id field is set.

      • getId

        public long getId()
         Output only. The ID of the client customer. Read only.
        optional int64 id = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getId in interface CustomerClientOrBuilder
        Returns:
        The id.

      • getAppliedLabelsList

        public com.google.protobuf.ProtocolStringList 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) = { ... }
        Specified by:
        getAppliedLabelsList in interface CustomerClientOrBuilder
        Returns:
        A list containing the appliedLabels.

      • getAppliedLabelsCount

        public 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) = { ... }
        Specified by:
        getAppliedLabelsCount in interface CustomerClientOrBuilder
        Returns:
        The count of appliedLabels.

      • getAppliedLabels

        public 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) = { ... }
        Specified by:
        getAppliedLabels in interface CustomerClientOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The appliedLabels at the given index.

      • getAppliedLabelsBytes

        public com.google.protobuf.ByteString getAppliedLabelsBytes​(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) = { ... }
        Specified by:
        getAppliedLabelsBytes in interface CustomerClientOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the appliedLabels at the given index.

      • getStatusValue

        public int getStatusValue()
         Output only. The status of the client customer. Read only.
        .google.ads.googleads.v10.enums.CustomerStatusEnum.CustomerStatus status = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStatusValue in interface CustomerClientOrBuilder
        Returns:
        The enum numeric value on the wire for status.

      • getStatus

        public CustomerStatusEnum.CustomerStatus getStatus()
         Output only. The status of the client customer. Read only.
        .google.ads.googleads.v10.enums.CustomerStatusEnum.CustomerStatus status = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStatus in interface CustomerClientOrBuilder
        Returns:
        The status.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static CustomerClient parseFrom​(java.nio.ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CustomerClient parseFrom​(java.nio.ByteBuffer data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CustomerClient parseFrom​(com.google.protobuf.ByteString data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CustomerClient parseFrom​(com.google.protobuf.ByteString data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CustomerClient parseFrom​(byte[] data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CustomerClient parseFrom​(byte[] data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CustomerClient parseFrom​(java.io.InputStream input)
                                throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static CustomerClient parseFrom​(java.io.InputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static CustomerClient parseDelimitedFrom​(java.io.InputStream input)
                                         throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static CustomerClient parseDelimitedFrom​(java.io.InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static CustomerClient parseFrom​(com.google.protobuf.CodedInputStream input)
                                throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static CustomerClient parseFrom​(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

        public CustomerClient.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public CustomerClient.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected CustomerClient.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static CustomerClient getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<CustomerClient> parser()

      • getParserForType

        public com.google.protobuf.Parser<CustomerClient> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public CustomerClient getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder