Package com.google.ads.googleads.v23.services

Class GenerateCreatorInsightsRequest.SearchAttributes

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.ads.googleads.v23.services.GenerateCreatorInsightsRequest.SearchAttributes
All Implemented Interfaces:
GenerateCreatorInsightsRequest.SearchAttributesOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
GenerateCreatorInsightsRequest
public static final class GenerateCreatorInsightsRequest.SearchAttributes extends com.google.protobuf.GeneratedMessage implements GenerateCreatorInsightsRequest.SearchAttributesOrBuilder
 The audience attributes (such as Age, Gender, Affinity, and In-Market) and
 creator attributes (such as creator's content topics) used to search
 for top creators. The returned creators are sorted based on likelihood that
 your audience watches the creator, relative to the general population (most
 likely is returned first).
Protobuf type google.ads.googleads.v23.services.GenerateCreatorInsightsRequest.SearchAttributes
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:

    • CREATOR_ATTRIBUTES_FIELD_NUMBER

      public static final int CREATOR_ATTRIBUTES_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()
       Optional. Audience attributes that describe an audience of viewers. This
 is used to search for creators whose own viewers match the input
 audience. Attributes age_range, gender, user_interest, entity, category,
 device, parental_status, and income_range are supported. Attribute
 location is not 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) = OPTIONAL];
      Specified by:
      getAudienceAttributesList in interface GenerateCreatorInsightsRequest.SearchAttributesOrBuilder

    • getAudienceAttributesOrBuilderList

      public List<? extends AudienceInsightsAttributeOrBuilder> getAudienceAttributesOrBuilderList()
       Optional. Audience attributes that describe an audience of viewers. This
 is used to search for creators whose own viewers match the input
 audience. Attributes age_range, gender, user_interest, entity, category,
 device, parental_status, and income_range are supported. Attribute
 location is not 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) = OPTIONAL];
      Specified by:
      getAudienceAttributesOrBuilderList in interface GenerateCreatorInsightsRequest.SearchAttributesOrBuilder

    • getAudienceAttributesCount

      public int getAudienceAttributesCount()
       Optional. Audience attributes that describe an audience of viewers. This
 is used to search for creators whose own viewers match the input
 audience. Attributes age_range, gender, user_interest, entity, category,
 device, parental_status, and income_range are supported. Attribute
 location is not 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) = OPTIONAL];
      Specified by:
      getAudienceAttributesCount in interface GenerateCreatorInsightsRequest.SearchAttributesOrBuilder

    • getAudienceAttributes

      public AudienceInsightsAttribute getAudienceAttributes(int index)
       Optional. Audience attributes that describe an audience of viewers. This
 is used to search for creators whose own viewers match the input
 audience. Attributes age_range, gender, user_interest, entity, category,
 device, parental_status, and income_range are supported. Attribute
 location is not 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) = OPTIONAL];
      Specified by:
      getAudienceAttributes in interface GenerateCreatorInsightsRequest.SearchAttributesOrBuilder

    • getAudienceAttributesOrBuilder

      public AudienceInsightsAttributeOrBuilder getAudienceAttributesOrBuilder(int index)
       Optional. Audience attributes that describe an audience of viewers. This
 is used to search for creators whose own viewers match the input
 audience. Attributes age_range, gender, user_interest, entity, category,
 device, parental_status, and income_range are supported. Attribute
 location is not 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) = OPTIONAL];
      Specified by:
      getAudienceAttributesOrBuilder in interface GenerateCreatorInsightsRequest.SearchAttributesOrBuilder

    • 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 = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAudienceCombinationsList in interface GenerateCreatorInsightsRequest.SearchAttributesOrBuilder

    • 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 = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAudienceCombinationsOrBuilderList in interface GenerateCreatorInsightsRequest.SearchAttributesOrBuilder

    • 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 = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAudienceCombinationsCount in interface GenerateCreatorInsightsRequest.SearchAttributesOrBuilder

    • 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 = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAudienceCombinations in interface GenerateCreatorInsightsRequest.SearchAttributesOrBuilder

    • 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 = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAudienceCombinationsOrBuilder in interface GenerateCreatorInsightsRequest.SearchAttributesOrBuilder

    • getCreatorAttributesList

      public List<AudienceInsightsAttribute> getCreatorAttributesList()
       Optional. Creator attributes that describe a collection of types of
 content. This is used to search for creators whose content matches the
 input creator attributes. Only Knowledge Graph Entities tagged with
 [CREATOR_ATTRIBUTE][google.ads.googleads.v23.enums.InsightsKnowledgeGraphEntityCapabilitiesEnum.InsightsKnowledgeGraphEntityCapabilities.CREATOR_ATTRIBUTE]
 are supported. Use
 [AudienceInsightsService.ListAudienceInsightsAttributes][google.ads.googleads.v23.services.AudienceInsightsService.ListAudienceInsightsAttributes]
 to get the list of supported entities. Other attributes including
 location are not supported.
      repeated .google.ads.googleads.v23.common.AudienceInsightsAttribute creator_attributes = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCreatorAttributesList in interface GenerateCreatorInsightsRequest.SearchAttributesOrBuilder

    • getCreatorAttributesOrBuilderList

      public List<? extends AudienceInsightsAttributeOrBuilder> getCreatorAttributesOrBuilderList()
       Optional. Creator attributes that describe a collection of types of
 content. This is used to search for creators whose content matches the
 input creator attributes. Only Knowledge Graph Entities tagged with
 [CREATOR_ATTRIBUTE][google.ads.googleads.v23.enums.InsightsKnowledgeGraphEntityCapabilitiesEnum.InsightsKnowledgeGraphEntityCapabilities.CREATOR_ATTRIBUTE]
 are supported. Use
 [AudienceInsightsService.ListAudienceInsightsAttributes][google.ads.googleads.v23.services.AudienceInsightsService.ListAudienceInsightsAttributes]
 to get the list of supported entities. Other attributes including
 location are not supported.
      repeated .google.ads.googleads.v23.common.AudienceInsightsAttribute creator_attributes = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCreatorAttributesOrBuilderList in interface GenerateCreatorInsightsRequest.SearchAttributesOrBuilder

    • getCreatorAttributesCount

      public int getCreatorAttributesCount()
       Optional. Creator attributes that describe a collection of types of
 content. This is used to search for creators whose content matches the
 input creator attributes. Only Knowledge Graph Entities tagged with
 [CREATOR_ATTRIBUTE][google.ads.googleads.v23.enums.InsightsKnowledgeGraphEntityCapabilitiesEnum.InsightsKnowledgeGraphEntityCapabilities.CREATOR_ATTRIBUTE]
 are supported. Use
 [AudienceInsightsService.ListAudienceInsightsAttributes][google.ads.googleads.v23.services.AudienceInsightsService.ListAudienceInsightsAttributes]
 to get the list of supported entities. Other attributes including
 location are not supported.
      repeated .google.ads.googleads.v23.common.AudienceInsightsAttribute creator_attributes = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCreatorAttributesCount in interface GenerateCreatorInsightsRequest.SearchAttributesOrBuilder

    • getCreatorAttributes

      public AudienceInsightsAttribute getCreatorAttributes(int index)
       Optional. Creator attributes that describe a collection of types of
 content. This is used to search for creators whose content matches the
 input creator attributes. Only Knowledge Graph Entities tagged with
 [CREATOR_ATTRIBUTE][google.ads.googleads.v23.enums.InsightsKnowledgeGraphEntityCapabilitiesEnum.InsightsKnowledgeGraphEntityCapabilities.CREATOR_ATTRIBUTE]
 are supported. Use
 [AudienceInsightsService.ListAudienceInsightsAttributes][google.ads.googleads.v23.services.AudienceInsightsService.ListAudienceInsightsAttributes]
 to get the list of supported entities. Other attributes including
 location are not supported.
      repeated .google.ads.googleads.v23.common.AudienceInsightsAttribute creator_attributes = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCreatorAttributes in interface GenerateCreatorInsightsRequest.SearchAttributesOrBuilder

    • getCreatorAttributesOrBuilder

      public AudienceInsightsAttributeOrBuilder getCreatorAttributesOrBuilder(int index)
       Optional. Creator attributes that describe a collection of types of
 content. This is used to search for creators whose content matches the
 input creator attributes. Only Knowledge Graph Entities tagged with
 [CREATOR_ATTRIBUTE][google.ads.googleads.v23.enums.InsightsKnowledgeGraphEntityCapabilitiesEnum.InsightsKnowledgeGraphEntityCapabilities.CREATOR_ATTRIBUTE]
 are supported. Use
 [AudienceInsightsService.ListAudienceInsightsAttributes][google.ads.googleads.v23.services.AudienceInsightsService.ListAudienceInsightsAttributes]
 to get the list of supported entities. Other attributes including
 location are not supported.
      repeated .google.ads.googleads.v23.common.AudienceInsightsAttribute creator_attributes = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCreatorAttributesOrBuilder in interface GenerateCreatorInsightsRequest.SearchAttributesOrBuilder

    • 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 GenerateCreatorInsightsRequest.SearchAttributes parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static GenerateCreatorInsightsRequest.SearchAttributes parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static GenerateCreatorInsightsRequest.SearchAttributes parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static GenerateCreatorInsightsRequest.SearchAttributes.Builder newBuilder()

    • newBuilder

      public static GenerateCreatorInsightsRequest.SearchAttributes.Builder newBuilder(GenerateCreatorInsightsRequest.SearchAttributes prototype)

    • toBuilder

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

    • newBuilderForType

      protected GenerateCreatorInsightsRequest.SearchAttributes.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static GenerateCreatorInsightsRequest.SearchAttributes getDefaultInstance()

    • parser

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

    • getParserForType

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