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 Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.StringgetCustomerId()Required.com.google.protobuf.ByteStringgetCustomerIdBytes()Required.java.lang.StringgetCustomerInsightsGroup()The name of the customer being planned for.com.google.protobuf.ByteStringgetCustomerInsightsGroupBytes()The name of the customer being planned for.AudienceInsightsDimensionEnum.AudienceInsightsDimensiongetDimensions(int index)Required.intgetDimensionsCount()Required.java.util.List<AudienceInsightsDimensionEnum.AudienceInsightsDimension>getDimensionsList()Required.intgetDimensionsValue(int index)Required.java.util.List<java.lang.Integer>getDimensionsValueList()Required.LocationInfogetLocationCountryFilters(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.intgetLocationCountryFiltersCount()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.java.util.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.LocationInfoOrBuildergetLocationCountryFiltersOrBuilder(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.java.util.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.java.lang.StringgetQueryText()Required.com.google.protobuf.ByteStringgetQueryTextBytes()Required.-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
getCustomerId
java.lang.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
java.util.List<AudienceInsightsDimensionEnum.AudienceInsightsDimension> getDimensionsList()
Required. The types of attributes to be returned.
repeated .google.ads.googleads.v15.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.
repeated .google.ads.googleads.v15.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.
repeated .google.ads.googleads.v15.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
java.util.List<java.lang.Integer> getDimensionsValueList()
Required. The types of attributes to be returned.
repeated .google.ads.googleads.v15.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.
repeated .google.ads.googleads.v15.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
java.lang.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
java.lang.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
java.util.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.v15.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.v15.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.v15.common.LocationInfo location_country_filters = 5;
-
getLocationCountryFiltersOrBuilderList
java.util.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.v15.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.v15.common.LocationInfo location_country_filters = 5;
-
-