Package com.google.ads.googleads.v14.services

Class ListAudienceInsightsAttributesRequest.Builder

    • Method Detail

      • 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.Builder<ListAudienceInsightsAttributesRequest.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ListAudienceInsightsAttributesRequest.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ListAudienceInsightsAttributesRequest.Builder>

      • mergeFrom

        public ListAudienceInsightsAttributesRequest.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                        throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListAudienceInsightsAttributesRequest.Builder>
        Throws:
        java.io.IOException

      • setCustomerId

        public ListAudienceInsightsAttributesRequest.Builder setCustomerId​(java.lang.String value)
         Required. The ID of the customer.
        string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The customerId to set.
        Returns:
        This builder for chaining.

      • clearCustomerId

        public ListAudienceInsightsAttributesRequest.Builder clearCustomerId()
         Required. The ID of the customer.
        string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.

      • setCustomerIdBytes

        public ListAudienceInsightsAttributesRequest.Builder setCustomerIdBytes​(com.google.protobuf.ByteString value)
         Required. The ID of the customer.
        string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The bytes for customerId to set.
        Returns:
        This builder for chaining.

      • getDimensionsCount

        public int getDimensionsCount()
         Required. The types of attributes to be returned.
        repeated .google.ads.googleads.v14.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDimensionsCount in interface ListAudienceInsightsAttributesRequestOrBuilder
        Returns:
        The count of dimensions.

      • clearDimensions

        public ListAudienceInsightsAttributesRequest.Builder clearDimensions()
         Required. The types of attributes to be returned.
        repeated .google.ads.googleads.v14.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.

      • getDimensionsValueList

        public java.util.List<java.lang.Integer> getDimensionsValueList()
         Required. The types of attributes to be returned.
        repeated .google.ads.googleads.v14.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.
        repeated .google.ads.googleads.v14.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.

      • setDimensionsValue

        public ListAudienceInsightsAttributesRequest.Builder setDimensionsValue​(int index,
                                                                        int value)
         Required. The types of attributes to be returned.
        repeated .google.ads.googleads.v14.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        index - The index to set the value at.
        value - The enum numeric value on the wire for dimensions to set.
        Returns:
        This builder for chaining.

      • addDimensionsValue

        public ListAudienceInsightsAttributesRequest.Builder addDimensionsValue​(int value)
         Required. The types of attributes to be returned.
        repeated .google.ads.googleads.v14.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The enum numeric value on the wire for dimensions to add.
        Returns:
        This builder for chaining.

      • addAllDimensionsValue

        public ListAudienceInsightsAttributesRequest.Builder addAllDimensionsValue​(java.lang.Iterable<java.lang.Integer> values)
         Required. The types of attributes to be returned.
        repeated .google.ads.googleads.v14.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        values - The enum numeric values on the wire for dimensions to add.
        Returns:
        This builder for chaining.

      • getQueryText

        public 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];
        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.

      • setQueryText

        public ListAudienceInsightsAttributesRequest.Builder setQueryText​(java.lang.String value)
         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];
        Parameters:
        value - The queryText to set.
        Returns:
        This builder for chaining.

      • clearQueryText

        public ListAudienceInsightsAttributesRequest.Builder clearQueryText()
         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:
        This builder for chaining.

      • setQueryTextBytes

        public ListAudienceInsightsAttributesRequest.Builder setQueryTextBytes​(com.google.protobuf.ByteString value)
         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];
        Parameters:
        value - The bytes for queryText to set.
        Returns:
        This builder for chaining.

      • setCustomerInsightsGroup

        public ListAudienceInsightsAttributesRequest.Builder setCustomerInsightsGroup​(java.lang.String value)
         The name of the customer being planned for.  This is a user-defined value.
        string customer_insights_group = 4;
        Parameters:
        value - The customerInsightsGroup to set.
        Returns:
        This builder for chaining.

      • clearCustomerInsightsGroup

        public ListAudienceInsightsAttributesRequest.Builder clearCustomerInsightsGroup()
         The name of the customer being planned for.  This is a user-defined value.
        string customer_insights_group = 4;
        Returns:
        This builder for chaining.

      • setCustomerInsightsGroupBytes

        public ListAudienceInsightsAttributesRequest.Builder setCustomerInsightsGroupBytes​(com.google.protobuf.ByteString value)
         The name of the customer being planned for.  This is a user-defined value.
        string customer_insights_group = 4;
        Parameters:
        value - The bytes for customerInsightsGroup to set.
        Returns:
        This builder for chaining.

      • getLocationCountryFiltersList

        public 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.v14.common.LocationInfo location_country_filters = 5;
        Specified by:
        getLocationCountryFiltersList 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.v14.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.v14.common.LocationInfo location_country_filters = 5;
        Specified by:
        getLocationCountryFilters in interface ListAudienceInsightsAttributesRequestOrBuilder

      • setLocationCountryFilters

        public ListAudienceInsightsAttributesRequest.Builder setLocationCountryFilters​(int index,
                                                                               LocationInfo value)
         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.v14.common.LocationInfo location_country_filters = 5;

      • setLocationCountryFilters

        public ListAudienceInsightsAttributesRequest.Builder setLocationCountryFilters​(int index,
                                                                               LocationInfo.Builder builderForValue)
         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.v14.common.LocationInfo location_country_filters = 5;

      • addLocationCountryFilters

        public ListAudienceInsightsAttributesRequest.Builder addLocationCountryFilters​(LocationInfo value)
         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.v14.common.LocationInfo location_country_filters = 5;

      • addLocationCountryFilters

        public ListAudienceInsightsAttributesRequest.Builder addLocationCountryFilters​(int index,
                                                                               LocationInfo value)
         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.v14.common.LocationInfo location_country_filters = 5;

      • addLocationCountryFilters

        public ListAudienceInsightsAttributesRequest.Builder addLocationCountryFilters​(LocationInfo.Builder builderForValue)
         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.v14.common.LocationInfo location_country_filters = 5;

      • addLocationCountryFilters

        public ListAudienceInsightsAttributesRequest.Builder addLocationCountryFilters​(int index,
                                                                               LocationInfo.Builder builderForValue)
         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.v14.common.LocationInfo location_country_filters = 5;

      • addAllLocationCountryFilters

        public ListAudienceInsightsAttributesRequest.Builder addAllLocationCountryFilters​(java.lang.Iterable<? extends LocationInfo> values)
         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.v14.common.LocationInfo location_country_filters = 5;

      • clearLocationCountryFilters

        public ListAudienceInsightsAttributesRequest.Builder clearLocationCountryFilters()
         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.v14.common.LocationInfo location_country_filters = 5;

      • removeLocationCountryFilters

        public ListAudienceInsightsAttributesRequest.Builder removeLocationCountryFilters​(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.v14.common.LocationInfo location_country_filters = 5;

      • getLocationCountryFiltersBuilder

        public LocationInfo.Builder getLocationCountryFiltersBuilder​(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.v14.common.LocationInfo location_country_filters = 5;

      • 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.v14.common.LocationInfo location_country_filters = 5;
        Specified by:
        getLocationCountryFiltersOrBuilder in interface ListAudienceInsightsAttributesRequestOrBuilder

      • getLocationCountryFiltersOrBuilderList

        public 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.v14.common.LocationInfo location_country_filters = 5;
        Specified by:
        getLocationCountryFiltersOrBuilderList in interface ListAudienceInsightsAttributesRequestOrBuilder

      • addLocationCountryFiltersBuilder

        public LocationInfo.Builder addLocationCountryFiltersBuilder()
         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.v14.common.LocationInfo location_country_filters = 5;

      • addLocationCountryFiltersBuilder

        public LocationInfo.Builder addLocationCountryFiltersBuilder​(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.v14.common.LocationInfo location_country_filters = 5;

      • getLocationCountryFiltersBuilderList

        public java.util.List<LocationInfo.Builder> getLocationCountryFiltersBuilderList()
         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.v14.common.LocationInfo location_country_filters = 5;