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

Interface ListAudienceInsightsAttributesRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ListAudienceInsightsAttributesRequest, ListAudienceInsightsAttributesRequest.Builder
public interface ListAudienceInsightsAttributesRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getCustomerId

      String getCustomerId()
       Required. The ID of the customer.
      string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The customerId.

    • getCustomerIdBytes

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

    • getDimensionsList

      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];
      Returns:
      A list containing the dimensions.

    • getDimensionsCount

      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];
      Returns:
      The count of dimensions.

    • getDimensions

      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];
      Parameters:
      index - The index of the element to return.
      Returns:
      The dimensions at the given index.

    • getDimensionsValueList

      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];
      Returns:
      A list containing the enum numeric values on the wire for dimensions.

    • getDimensionsValue

      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];
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of dimensions at the given index.

    • getQueryText

      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];
      Returns:
      The queryText.

    • getQueryTextBytes

      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];
      Returns:
      The bytes for queryText.

    • getCustomerInsightsGroup

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

    • getCustomerInsightsGroupBytes

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

    • getLocationCountryFiltersList

      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;

    • getLocationCountryFilters

      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;

    • getLocationCountryFiltersCount

      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;

    • getLocationCountryFiltersOrBuilderList

      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;

    • getLocationCountryFiltersOrBuilder

      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;

    • hasYoutubeReachLocation

      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;
      Returns:
      Whether the youtubeReachLocation field is set.

    • getYoutubeReachLocation

      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;
      Returns:
      The youtubeReachLocation.

    • getYoutubeReachLocationOrBuilder

      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;