Package com.google.ads.googleads.v18.services

Class SuggestBrandsRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v18.services.SuggestBrandsRequest
All Implemented Interfaces:
SuggestBrandsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class SuggestBrandsRequest extends com.google.protobuf.GeneratedMessageV3 implements SuggestBrandsRequestOrBuilder
 Request message for
 [BrandSuggestionService.SuggestBrands][google.ads.googleads.v18.services.BrandSuggestionService.SuggestBrands].
Protobuf type google.ads.googleads.v18.services.SuggestBrandsRequest
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    SuggestBrandsRequest.Builder
    Request message for [BrandSuggestionService.SuggestBrands][google.ads.googleads.v18.services.BrandSuggestionService.SuggestBrands].

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    BRAND_PREFIX_FIELD_NUMBER
     
    static final int
    CUSTOMER_ID_FIELD_NUMBER
     
    static final int
    SELECTED_BRANDS_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    String
    getBrandPrefix()
    Required.
    com.google.protobuf.ByteString
    getBrandPrefixBytes()
    Required.
    String
    getCustomerId()
    Required.
    com.google.protobuf.ByteString
    getCustomerIdBytes()
    Required.
    static SuggestBrandsRequest
    getDefaultInstance()
     
    SuggestBrandsRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<SuggestBrandsRequest>
    getParserForType()
     
    String
    getSelectedBrands(int index)
    Optional.
    com.google.protobuf.ByteString
    getSelectedBrandsBytes(int index)
    Optional.
    int
    getSelectedBrandsCount()
    Optional.
    com.google.protobuf.ProtocolStringList
    getSelectedBrandsList()
    Optional.
    int
    getSerializedSize()
     
    boolean
    hasBrandPrefix()
    Required.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static SuggestBrandsRequest.Builder
    newBuilder()
     
    static SuggestBrandsRequest.Builder
    newBuilder(SuggestBrandsRequest prototype)
     
    SuggestBrandsRequest.Builder
    newBuilderForType()
     
    protected SuggestBrandsRequest.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static SuggestBrandsRequest
    parseDelimitedFrom(InputStream input)
     
    static SuggestBrandsRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SuggestBrandsRequest
    parseFrom(byte[] data)
     
    static SuggestBrandsRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SuggestBrandsRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static SuggestBrandsRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SuggestBrandsRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static SuggestBrandsRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SuggestBrandsRequest
    parseFrom(InputStream input)
     
    static SuggestBrandsRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SuggestBrandsRequest
    parseFrom(ByteBuffer data)
     
    static SuggestBrandsRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<SuggestBrandsRequest>
    parser()
     
    SuggestBrandsRequest.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • CUSTOMER_ID_FIELD_NUMBER

      public static final int CUSTOMER_ID_FIELD_NUMBER
      See Also:

    • BRAND_PREFIX_FIELD_NUMBER

      public static final int BRAND_PREFIX_FIELD_NUMBER
      See Also:

    • SELECTED_BRANDS_FIELD_NUMBER

      public static final int SELECTED_BRANDS_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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

    • getCustomerId

      public String getCustomerId()
       Required. The ID of the customer onto which to apply the brand suggestion
 operation.
      string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCustomerId in interface SuggestBrandsRequestOrBuilder
      Returns:
      The customerId.

    • getCustomerIdBytes

      public com.google.protobuf.ByteString getCustomerIdBytes()
       Required. The ID of the customer onto which to apply the brand suggestion
 operation.
      string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCustomerIdBytes in interface SuggestBrandsRequestOrBuilder
      Returns:
      The bytes for customerId.

    • hasBrandPrefix

      public boolean hasBrandPrefix()
       Required. The prefix of a brand name.
      optional string brand_prefix = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasBrandPrefix in interface SuggestBrandsRequestOrBuilder
      Returns:
      Whether the brandPrefix field is set.

    • getBrandPrefix

      public String getBrandPrefix()
       Required. The prefix of a brand name.
      optional string brand_prefix = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getBrandPrefix in interface SuggestBrandsRequestOrBuilder
      Returns:
      The brandPrefix.

    • getBrandPrefixBytes

      public com.google.protobuf.ByteString getBrandPrefixBytes()
       Required. The prefix of a brand name.
      optional string brand_prefix = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getBrandPrefixBytes in interface SuggestBrandsRequestOrBuilder
      Returns:
      The bytes for brandPrefix.

    • getSelectedBrandsList

      public com.google.protobuf.ProtocolStringList getSelectedBrandsList()
       Optional. Ids of the brands already selected by advertisers. They will be
 excluded in response. These are expected to be brand ids not brand names.
      repeated string selected_brands = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSelectedBrandsList in interface SuggestBrandsRequestOrBuilder
      Returns:
      A list containing the selectedBrands.

    • getSelectedBrandsCount

      public int getSelectedBrandsCount()
       Optional. Ids of the brands already selected by advertisers. They will be
 excluded in response. These are expected to be brand ids not brand names.
      repeated string selected_brands = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSelectedBrandsCount in interface SuggestBrandsRequestOrBuilder
      Returns:
      The count of selectedBrands.

    • getSelectedBrands

      public String getSelectedBrands(int index)
       Optional. Ids of the brands already selected by advertisers. They will be
 excluded in response. These are expected to be brand ids not brand names.
      repeated string selected_brands = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSelectedBrands in interface SuggestBrandsRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The selectedBrands at the given index.

    • getSelectedBrandsBytes

      public com.google.protobuf.ByteString getSelectedBrandsBytes(int index)
       Optional. Ids of the brands already selected by advertisers. They will be
 excluded in response. These are expected to be brand ids not brand names.
      repeated string selected_brands = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSelectedBrandsBytes in interface SuggestBrandsRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the selectedBrands at the given index.

    • 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      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(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 SuggestBrandsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SuggestBrandsRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static SuggestBrandsRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SuggestBrandsRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SuggestBrandsRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SuggestBrandsRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SuggestBrandsRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SuggestBrandsRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static SuggestBrandsRequest.Builder newBuilder()

    • newBuilder

      public static SuggestBrandsRequest.Builder newBuilder(SuggestBrandsRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static SuggestBrandsRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<SuggestBrandsRequest> 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 SuggestBrandsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder