Package com.google.ads.googleads.v15.services

Class ListAudienceInsightsAttributesRequest

  • All Implemented Interfaces:
    ListAudienceInsightsAttributesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class ListAudienceInsightsAttributesRequest
extends com.google.protobuf.GeneratedMessageV3
implements ListAudienceInsightsAttributesRequestOrBuilder
     Request message for
 [AudienceInsightsService.ListAudienceInsightsAttributes][google.ads.googleads.v15.services.AudienceInsightsService.ListAudienceInsightsAttributes].
    Protobuf type google.ads.googleads.v15.services.ListAudienceInsightsAttributesRequest
    See Also:
    Serialized Form

    • Field Detail

      • CUSTOMER_ID_FIELD_NUMBER

        public static final int CUSTOMER_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DIMENSIONS_FIELD_NUMBER

        public static final int DIMENSIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • QUERY_TEXT_FIELD_NUMBER

        public static final int QUERY_TEXT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CUSTOMER_INSIGHTS_GROUP_FIELD_NUMBER

        public static final int CUSTOMER_INSIGHTS_GROUP_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LOCATION_COUNTRY_FILTERS_FIELD_NUMBER

        public static final int LOCATION_COUNTRY_FILTERS_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected java.lang.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

      • getDimensionsCount

        public 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];
        Specified by:
        getDimensionsCount in interface ListAudienceInsightsAttributesRequestOrBuilder
        Returns:
        The count of dimensions.

      • getDimensionsValueList

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

      • 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.v15.common.LocationInfo location_country_filters = 5;
        Specified by:
        getLocationCountryFiltersList 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.v15.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.v15.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.v15.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.v15.common.LocationInfo location_country_filters = 5;
        Specified by:
        getLocationCountryFiltersOrBuilder 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 java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.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​(java.lang.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​(java.nio.ByteBuffer data)
                                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListAudienceInsightsAttributesRequest parseFrom​(java.nio.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​(java.io.InputStream input,
                                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                       throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

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

      • parseFrom

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

      • newBuilderForType

        public ListAudienceInsightsAttributesRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType 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

      • 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