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

Class ListAudienceInsightsAttributesRequest

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

  • Field Details

    • CUSTOMER_ID_FIELD_NUMBER

      public static final int CUSTOMER_ID_FIELD_NUMBER
      See Also:

    • DIMENSIONS_FIELD_NUMBER

      public static final int DIMENSIONS_FIELD_NUMBER
      See Also:

    • QUERY_TEXT_FIELD_NUMBER

      public static final int QUERY_TEXT_FIELD_NUMBER
      See Also:

    • CUSTOMER_INSIGHTS_GROUP_FIELD_NUMBER

      public static final int CUSTOMER_INSIGHTS_GROUP_FIELD_NUMBER
      See Also:

    • LOCATION_COUNTRY_FILTERS_FIELD_NUMBER

      public static final int LOCATION_COUNTRY_FILTERS_FIELD_NUMBER
      See Also:

    • YOUTUBE_REACH_LOCATION_FIELD_NUMBER

      public static final int YOUTUBE_REACH_LOCATION_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.
      string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCustomerId in interface ListAudienceInsightsAttributesRequestOrBuilder
      Returns:
      The customerId.

    • getCustomerIdBytes

      public com.google.protobuf.ByteString getCustomerIdBytes()
       Required. The ID of the customer.
      string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCustomerIdBytes in interface ListAudienceInsightsAttributesRequestOrBuilder
      Returns:
      The bytes for customerId.

    • getDimensionsList

      public List<AudienceInsightsDimensionEnum.AudienceInsightsDimension> getDimensionsList()
       Required. The types of attributes to be returned. Supported
 dimensions are CATEGORY, KNOWLEDGE_GRAPH,
 GEO_TARGET_COUNTRY, SUB_COUNTRY_LOCATION, YOUTUBE_DYNAMIC_LINEUP,
 AFFINITY_USER_INTEREST, IN_MARKET_USER_INTEREST, PARENTAL_STATUS,
 INCOME_RANGE, AGE_RANGE, and GENDER.
      repeated .google.ads.googleads.v18.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDimensionsList in interface ListAudienceInsightsAttributesRequestOrBuilder
      Returns:
      A list containing the dimensions.

    • getDimensionsCount

      public int getDimensionsCount()
       Required. The types of attributes to be returned. Supported
 dimensions are CATEGORY, KNOWLEDGE_GRAPH,
 GEO_TARGET_COUNTRY, SUB_COUNTRY_LOCATION, YOUTUBE_DYNAMIC_LINEUP,
 AFFINITY_USER_INTEREST, IN_MARKET_USER_INTEREST, PARENTAL_STATUS,
 INCOME_RANGE, AGE_RANGE, and GENDER.
      repeated .google.ads.googleads.v18.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDimensionsCount in interface ListAudienceInsightsAttributesRequestOrBuilder
      Returns:
      The count of dimensions.

    • getDimensions

      public AudienceInsightsDimensionEnum.AudienceInsightsDimension getDimensions(int index)
       Required. The types of attributes to be returned. Supported
 dimensions are CATEGORY, KNOWLEDGE_GRAPH,
 GEO_TARGET_COUNTRY, SUB_COUNTRY_LOCATION, YOUTUBE_DYNAMIC_LINEUP,
 AFFINITY_USER_INTEREST, IN_MARKET_USER_INTEREST, PARENTAL_STATUS,
 INCOME_RANGE, AGE_RANGE, and GENDER.
      repeated .google.ads.googleads.v18.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDimensions in interface ListAudienceInsightsAttributesRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The dimensions at the given index.

    • getDimensionsValueList

      public List<Integer> getDimensionsValueList()
       Required. The types of attributes to be returned. Supported
 dimensions are CATEGORY, KNOWLEDGE_GRAPH,
 GEO_TARGET_COUNTRY, SUB_COUNTRY_LOCATION, YOUTUBE_DYNAMIC_LINEUP,
 AFFINITY_USER_INTEREST, IN_MARKET_USER_INTEREST, PARENTAL_STATUS,
 INCOME_RANGE, AGE_RANGE, and GENDER.
      repeated .google.ads.googleads.v18.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDimensionsValueList in interface ListAudienceInsightsAttributesRequestOrBuilder
      Returns:
      A list containing the enum numeric values on the wire for dimensions.

    • getDimensionsValue

      public int getDimensionsValue(int index)
       Required. The types of attributes to be returned. Supported
 dimensions are CATEGORY, KNOWLEDGE_GRAPH,
 GEO_TARGET_COUNTRY, SUB_COUNTRY_LOCATION, YOUTUBE_DYNAMIC_LINEUP,
 AFFINITY_USER_INTEREST, IN_MARKET_USER_INTEREST, PARENTAL_STATUS,
 INCOME_RANGE, AGE_RANGE, and GENDER.
      repeated .google.ads.googleads.v18.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDimensionsValue in interface ListAudienceInsightsAttributesRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of dimensions at the given index.

    • getQueryText

      public String getQueryText()
       Required. A free text query.  If the requested dimensions include
 Attributes CATEGORY or KNOWLEDGE_GRAPH, then the attributes returned for
 those dimensions will match or be related to this string.  For other
 dimensions, this field is ignored and all available attributes are
 returned.
      string query_text = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getQueryText in interface ListAudienceInsightsAttributesRequestOrBuilder
      Returns:
      The queryText.

    • getQueryTextBytes

      public com.google.protobuf.ByteString getQueryTextBytes()
       Required. A free text query.  If the requested dimensions include
 Attributes CATEGORY or KNOWLEDGE_GRAPH, then the attributes returned for
 those dimensions will match or be related to this string.  For other
 dimensions, this field is ignored and all available attributes are
 returned.
      string query_text = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getQueryTextBytes in interface ListAudienceInsightsAttributesRequestOrBuilder
      Returns:
      The bytes for queryText.

    • getCustomerInsightsGroup

      public String getCustomerInsightsGroup()
       The name of the customer being planned for.  This is a user-defined value.
      string customer_insights_group = 4;
      Specified by:
      getCustomerInsightsGroup in interface ListAudienceInsightsAttributesRequestOrBuilder
      Returns:
      The customerInsightsGroup.

    • getCustomerInsightsGroupBytes

      public com.google.protobuf.ByteString getCustomerInsightsGroupBytes()
       The name of the customer being planned for.  This is a user-defined value.
      string customer_insights_group = 4;
      Specified by:
      getCustomerInsightsGroupBytes in interface ListAudienceInsightsAttributesRequestOrBuilder
      Returns:
      The bytes for customerInsightsGroup.

    • getLocationCountryFiltersList

      public List<LocationInfo> getLocationCountryFiltersList()
       If SUB_COUNTRY_LOCATION attributes are one of the requested dimensions and
 this field is present, then the SUB_COUNTRY_LOCATION attributes returned
 will be located in these countries. If this field is absent, then location
 attributes are not filtered by country. Setting this field when
 SUB_COUNTRY_LOCATION attributes are not requested will return an error.
      repeated .google.ads.googleads.v18.common.LocationInfo location_country_filters = 5;
      Specified by:
      getLocationCountryFiltersList in interface ListAudienceInsightsAttributesRequestOrBuilder

    • getLocationCountryFiltersOrBuilderList

      public List<? extends LocationInfoOrBuilder> getLocationCountryFiltersOrBuilderList()
       If SUB_COUNTRY_LOCATION attributes are one of the requested dimensions and
 this field is present, then the SUB_COUNTRY_LOCATION attributes returned
 will be located in these countries. If this field is absent, then location
 attributes are not filtered by country. Setting this field when
 SUB_COUNTRY_LOCATION attributes are not requested will return an error.
      repeated .google.ads.googleads.v18.common.LocationInfo location_country_filters = 5;
      Specified by:
      getLocationCountryFiltersOrBuilderList in interface ListAudienceInsightsAttributesRequestOrBuilder

    • getLocationCountryFiltersCount

      public int getLocationCountryFiltersCount()
       If SUB_COUNTRY_LOCATION attributes are one of the requested dimensions and
 this field is present, then the SUB_COUNTRY_LOCATION attributes returned
 will be located in these countries. If this field is absent, then location
 attributes are not filtered by country. Setting this field when
 SUB_COUNTRY_LOCATION attributes are not requested will return an error.
      repeated .google.ads.googleads.v18.common.LocationInfo location_country_filters = 5;
      Specified by:
      getLocationCountryFiltersCount in interface ListAudienceInsightsAttributesRequestOrBuilder

    • getLocationCountryFilters

      public LocationInfo getLocationCountryFilters(int index)
       If SUB_COUNTRY_LOCATION attributes are one of the requested dimensions and
 this field is present, then the SUB_COUNTRY_LOCATION attributes returned
 will be located in these countries. If this field is absent, then location
 attributes are not filtered by country. Setting this field when
 SUB_COUNTRY_LOCATION attributes are not requested will return an error.
      repeated .google.ads.googleads.v18.common.LocationInfo location_country_filters = 5;
      Specified by:
      getLocationCountryFilters in interface ListAudienceInsightsAttributesRequestOrBuilder

    • getLocationCountryFiltersOrBuilder

      public LocationInfoOrBuilder getLocationCountryFiltersOrBuilder(int index)
       If SUB_COUNTRY_LOCATION attributes are one of the requested dimensions and
 this field is present, then the SUB_COUNTRY_LOCATION attributes returned
 will be located in these countries. If this field is absent, then location
 attributes are not filtered by country. Setting this field when
 SUB_COUNTRY_LOCATION attributes are not requested will return an error.
      repeated .google.ads.googleads.v18.common.LocationInfo location_country_filters = 5;
      Specified by:
      getLocationCountryFiltersOrBuilder in interface ListAudienceInsightsAttributesRequestOrBuilder

    • hasYoutubeReachLocation

      public boolean hasYoutubeReachLocation()
       If present, potential YouTube reach estimates within the specified market
 will be returned for attributes for which they are available.  Reach is
 only available for the AGE_RANGE, GENDER, AFFINITY_USER_INTEREST and
 IN_MARKET_USER_INTEREST dimensions, and may not be available for every
 attribute of those dimensions in every market.
      .google.ads.googleads.v18.common.LocationInfo youtube_reach_location = 6;
      Specified by:
      hasYoutubeReachLocation in interface ListAudienceInsightsAttributesRequestOrBuilder
      Returns:
      Whether the youtubeReachLocation field is set.

    • getYoutubeReachLocation

      public LocationInfo getYoutubeReachLocation()
       If present, potential YouTube reach estimates within the specified market
 will be returned for attributes for which they are available.  Reach is
 only available for the AGE_RANGE, GENDER, AFFINITY_USER_INTEREST and
 IN_MARKET_USER_INTEREST dimensions, and may not be available for every
 attribute of those dimensions in every market.
      .google.ads.googleads.v18.common.LocationInfo youtube_reach_location = 6;
      Specified by:
      getYoutubeReachLocation in interface ListAudienceInsightsAttributesRequestOrBuilder
      Returns:
      The youtubeReachLocation.

    • getYoutubeReachLocationOrBuilder

      public LocationInfoOrBuilder getYoutubeReachLocationOrBuilder()
       If present, potential YouTube reach estimates within the specified market
 will be returned for attributes for which they are available.  Reach is
 only available for the AGE_RANGE, GENDER, AFFINITY_USER_INTEREST and
 IN_MARKET_USER_INTEREST dimensions, and may not be available for every
 attribute of those dimensions in every market.
      .google.ads.googleads.v18.common.LocationInfo youtube_reach_location = 6;
      Specified by:
      getYoutubeReachLocationOrBuilder in interface ListAudienceInsightsAttributesRequestOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ListAudienceInsightsAttributesRequest.Builder newBuilder()

    • newBuilder

      public static ListAudienceInsightsAttributesRequest.Builder newBuilder(ListAudienceInsightsAttributesRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ListAudienceInsightsAttributesRequest getDefaultInstance()

    • parser

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

    • getParserForType

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