Class SearchAudience

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.ads.googleads.v23.services.SearchAudience
All Implemented Interfaces:
SearchAudienceOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class SearchAudience extends com.google.protobuf.GeneratedMessage implements SearchAudienceOrBuilder
 A collection of audience attributes that describe an audience of viewers.
 This is used to search for topics trending for the defined audience.
 
Protobuf type google.ads.googleads.v23.services.SearchAudience
See Also:
  • Field Details

    • AUDIENCE_ATTRIBUTES_FIELD_NUMBER

      public static final int AUDIENCE_ATTRIBUTES_FIELD_NUMBER
      See Also:
    • AUDIENCE_COMBINATIONS_FIELD_NUMBER

      public static final int AUDIENCE_COMBINATIONS_FIELD_NUMBER
      See Also:
  • Method Details

    • getDescriptor

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

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • getAudienceAttributesList

      public List<AudienceInsightsAttribute> getAudienceAttributesList()
       Required. Audience attributes that describe an audience of viewers. This is
       used to search for topics trending for the defined audience. Attributes
       age_range, gender, user_interest, entity, category, parental_status, and
       income_range are supported. Attributes user_interest, entity, and category
       can only be set in audience_attributes when audience_combinations is
       unused.
       
      repeated .google.ads.googleads.v23.common.AudienceInsightsAttribute audience_attributes = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getAudienceAttributesList in interface SearchAudienceOrBuilder
    • getAudienceAttributesOrBuilderList

      public List<? extends AudienceInsightsAttributeOrBuilder> getAudienceAttributesOrBuilderList()
       Required. Audience attributes that describe an audience of viewers. This is
       used to search for topics trending for the defined audience. Attributes
       age_range, gender, user_interest, entity, category, parental_status, and
       income_range are supported. Attributes user_interest, entity, and category
       can only be set in audience_attributes when audience_combinations is
       unused.
       
      repeated .google.ads.googleads.v23.common.AudienceInsightsAttribute audience_attributes = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getAudienceAttributesOrBuilderList in interface SearchAudienceOrBuilder
    • getAudienceAttributesCount

      public int getAudienceAttributesCount()
       Required. Audience attributes that describe an audience of viewers. This is
       used to search for topics trending for the defined audience. Attributes
       age_range, gender, user_interest, entity, category, parental_status, and
       income_range are supported. Attributes user_interest, entity, and category
       can only be set in audience_attributes when audience_combinations is
       unused.
       
      repeated .google.ads.googleads.v23.common.AudienceInsightsAttribute audience_attributes = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getAudienceAttributesCount in interface SearchAudienceOrBuilder
    • getAudienceAttributes

      public AudienceInsightsAttribute getAudienceAttributes(int index)
       Required. Audience attributes that describe an audience of viewers. This is
       used to search for topics trending for the defined audience. Attributes
       age_range, gender, user_interest, entity, category, parental_status, and
       income_range are supported. Attributes user_interest, entity, and category
       can only be set in audience_attributes when audience_combinations is
       unused.
       
      repeated .google.ads.googleads.v23.common.AudienceInsightsAttribute audience_attributes = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getAudienceAttributes in interface SearchAudienceOrBuilder
    • getAudienceAttributesOrBuilder

      public AudienceInsightsAttributeOrBuilder getAudienceAttributesOrBuilder(int index)
       Required. Audience attributes that describe an audience of viewers. This is
       used to search for topics trending for the defined audience. Attributes
       age_range, gender, user_interest, entity, category, parental_status, and
       income_range are supported. Attributes user_interest, entity, and category
       can only be set in audience_attributes when audience_combinations is
       unused.
       
      repeated .google.ads.googleads.v23.common.AudienceInsightsAttribute audience_attributes = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getAudienceAttributesOrBuilder in interface SearchAudienceOrBuilder
    • getAudienceCombinationsList

      public List<InsightsAudienceAttributeGroup> getAudienceCombinationsList()
       Optional. A list of audience attribute groups consisting of one or more
       Knowledge Graph entities, Product & Service Categories and user interests
       that describes an audience. The groups have a logical AND-of-ORs structure:
      
       1. Attributes within each InsightsAudienceAttributeGroup are combined
       with OR.
      
       2. The groups themselves are combined together with AND.
      
       For example, an audience (Interest A OR Interest B) AND (Entity C) is
       represented using two groups. The first group contains the two interests
       and the second group contains the entity.
      
       This field cannot be set if any Knowledge Graph entities, Product &
       Service Categories, or user interests are specified in
       audience_attributes.
       
      repeated .google.ads.googleads.v23.common.InsightsAudienceAttributeGroup audience_combinations = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAudienceCombinationsList in interface SearchAudienceOrBuilder
    • getAudienceCombinationsOrBuilderList

      public List<? extends InsightsAudienceAttributeGroupOrBuilder> getAudienceCombinationsOrBuilderList()
       Optional. A list of audience attribute groups consisting of one or more
       Knowledge Graph entities, Product & Service Categories and user interests
       that describes an audience. The groups have a logical AND-of-ORs structure:
      
       1. Attributes within each InsightsAudienceAttributeGroup are combined
       with OR.
      
       2. The groups themselves are combined together with AND.
      
       For example, an audience (Interest A OR Interest B) AND (Entity C) is
       represented using two groups. The first group contains the two interests
       and the second group contains the entity.
      
       This field cannot be set if any Knowledge Graph entities, Product &
       Service Categories, or user interests are specified in
       audience_attributes.
       
      repeated .google.ads.googleads.v23.common.InsightsAudienceAttributeGroup audience_combinations = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAudienceCombinationsOrBuilderList in interface SearchAudienceOrBuilder
    • getAudienceCombinationsCount

      public int getAudienceCombinationsCount()
       Optional. A list of audience attribute groups consisting of one or more
       Knowledge Graph entities, Product & Service Categories and user interests
       that describes an audience. The groups have a logical AND-of-ORs structure:
      
       1. Attributes within each InsightsAudienceAttributeGroup are combined
       with OR.
      
       2. The groups themselves are combined together with AND.
      
       For example, an audience (Interest A OR Interest B) AND (Entity C) is
       represented using two groups. The first group contains the two interests
       and the second group contains the entity.
      
       This field cannot be set if any Knowledge Graph entities, Product &
       Service Categories, or user interests are specified in
       audience_attributes.
       
      repeated .google.ads.googleads.v23.common.InsightsAudienceAttributeGroup audience_combinations = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAudienceCombinationsCount in interface SearchAudienceOrBuilder
    • getAudienceCombinations

      public InsightsAudienceAttributeGroup getAudienceCombinations(int index)
       Optional. A list of audience attribute groups consisting of one or more
       Knowledge Graph entities, Product & Service Categories and user interests
       that describes an audience. The groups have a logical AND-of-ORs structure:
      
       1. Attributes within each InsightsAudienceAttributeGroup are combined
       with OR.
      
       2. The groups themselves are combined together with AND.
      
       For example, an audience (Interest A OR Interest B) AND (Entity C) is
       represented using two groups. The first group contains the two interests
       and the second group contains the entity.
      
       This field cannot be set if any Knowledge Graph entities, Product &
       Service Categories, or user interests are specified in
       audience_attributes.
       
      repeated .google.ads.googleads.v23.common.InsightsAudienceAttributeGroup audience_combinations = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAudienceCombinations in interface SearchAudienceOrBuilder
    • getAudienceCombinationsOrBuilder

      public InsightsAudienceAttributeGroupOrBuilder getAudienceCombinationsOrBuilder(int index)
       Optional. A list of audience attribute groups consisting of one or more
       Knowledge Graph entities, Product & Service Categories and user interests
       that describes an audience. The groups have a logical AND-of-ORs structure:
      
       1. Attributes within each InsightsAudienceAttributeGroup are combined
       with OR.
      
       2. The groups themselves are combined together with AND.
      
       For example, an audience (Interest A OR Interest B) AND (Entity C) is
       represented using two groups. The first group contains the two interests
       and the second group contains the entity.
      
       This field cannot be set if any Knowledge Graph entities, Product &
       Service Categories, or user interests are specified in
       audience_attributes.
       
      repeated .google.ads.googleads.v23.common.InsightsAudienceAttributeGroup audience_combinations = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAudienceCombinationsOrBuilder in interface SearchAudienceOrBuilder
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • 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.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • 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 SearchAudience parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

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

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

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

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

      public static SearchAudience parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

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

      public static SearchAudience parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

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

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

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

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

      public static SearchAudience.Builder newBuilder()
    • newBuilder

      public static SearchAudience.Builder newBuilder(SearchAudience prototype)
    • toBuilder

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

      protected SearchAudience.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static SearchAudience getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<SearchAudience> parser()
    • getParserForType

      public com.google.protobuf.Parser<SearchAudience> 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.GeneratedMessage
    • getDefaultInstanceForType

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