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

Class InsightsAudience

  • All Implemented Interfaces:
    InsightsAudienceOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class InsightsAudience
extends com.google.protobuf.GeneratedMessageV3
implements InsightsAudienceOrBuilder
     A set of users, defined by various characteristics, for which insights can
 be requested in AudienceInsightsService.
    Protobuf type google.ads.googleads.v14.services.InsightsAudience
    See Also:
    Serialized Form

    • Field Detail

      • COUNTRY_LOCATIONS_FIELD_NUMBER

        public static final int COUNTRY_LOCATIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SUB_COUNTRY_LOCATIONS_FIELD_NUMBER

        public static final int SUB_COUNTRY_LOCATIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • AGE_RANGES_FIELD_NUMBER

        public static final int AGE_RANGES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PARENTAL_STATUS_FIELD_NUMBER

        public static final int PARENTAL_STATUS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INCOME_RANGES_FIELD_NUMBER

        public static final int INCOME_RANGES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DYNAMIC_LINEUPS_FIELD_NUMBER

        public static final int DYNAMIC_LINEUPS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TOPIC_AUDIENCE_COMBINATIONS_FIELD_NUMBER

        public static final int TOPIC_AUDIENCE_COMBINATIONS_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

      • getCountryLocationsList

        public java.util.List<LocationInfo> getCountryLocationsList()
         Required. The countries for the audience.
        repeated .google.ads.googleads.v14.common.LocationInfo country_locations = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getCountryLocationsList in interface InsightsAudienceOrBuilder

      • getCountryLocationsCount

        public int getCountryLocationsCount()
         Required. The countries for the audience.
        repeated .google.ads.googleads.v14.common.LocationInfo country_locations = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getCountryLocationsCount in interface InsightsAudienceOrBuilder

      • getCountryLocations

        public LocationInfo getCountryLocations​(int index)
         Required. The countries for the audience.
        repeated .google.ads.googleads.v14.common.LocationInfo country_locations = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getCountryLocations in interface InsightsAudienceOrBuilder

      • getSubCountryLocationsList

        public java.util.List<LocationInfo> getSubCountryLocationsList()
         Sub-country geographic location attributes.  If present, each of these
 must be contained in one of the countries in this audience.  If absent, the
 audience is geographically to the country_locations and no further.
        repeated .google.ads.googleads.v14.common.LocationInfo sub_country_locations = 2;
        Specified by:
        getSubCountryLocationsList in interface InsightsAudienceOrBuilder

      • getSubCountryLocationsOrBuilderList

        public java.util.List<? extends LocationInfoOrBuilder> getSubCountryLocationsOrBuilderList()
         Sub-country geographic location attributes.  If present, each of these
 must be contained in one of the countries in this audience.  If absent, the
 audience is geographically to the country_locations and no further.
        repeated .google.ads.googleads.v14.common.LocationInfo sub_country_locations = 2;
        Specified by:
        getSubCountryLocationsOrBuilderList in interface InsightsAudienceOrBuilder

      • getSubCountryLocationsCount

        public int getSubCountryLocationsCount()
         Sub-country geographic location attributes.  If present, each of these
 must be contained in one of the countries in this audience.  If absent, the
 audience is geographically to the country_locations and no further.
        repeated .google.ads.googleads.v14.common.LocationInfo sub_country_locations = 2;
        Specified by:
        getSubCountryLocationsCount in interface InsightsAudienceOrBuilder

      • getSubCountryLocations

        public LocationInfo getSubCountryLocations​(int index)
         Sub-country geographic location attributes.  If present, each of these
 must be contained in one of the countries in this audience.  If absent, the
 audience is geographically to the country_locations and no further.
        repeated .google.ads.googleads.v14.common.LocationInfo sub_country_locations = 2;
        Specified by:
        getSubCountryLocations in interface InsightsAudienceOrBuilder

      • getSubCountryLocationsOrBuilder

        public LocationInfoOrBuilder getSubCountryLocationsOrBuilder​(int index)
         Sub-country geographic location attributes.  If present, each of these
 must be contained in one of the countries in this audience.  If absent, the
 audience is geographically to the country_locations and no further.
        repeated .google.ads.googleads.v14.common.LocationInfo sub_country_locations = 2;
        Specified by:
        getSubCountryLocationsOrBuilder in interface InsightsAudienceOrBuilder

      • hasGender

        public boolean hasGender()
         Gender for the audience.  If absent, the audience does not restrict by
 gender.
        .google.ads.googleads.v14.common.GenderInfo gender = 3;
        Specified by:
        hasGender in interface InsightsAudienceOrBuilder
        Returns:
        Whether the gender field is set.

      • getGender

        public GenderInfo getGender()
         Gender for the audience.  If absent, the audience does not restrict by
 gender.
        .google.ads.googleads.v14.common.GenderInfo gender = 3;
        Specified by:
        getGender in interface InsightsAudienceOrBuilder
        Returns:
        The gender.

      • getAgeRangesList

        public java.util.List<AgeRangeInfo> getAgeRangesList()
         Age ranges for the audience.  If absent, the audience represents all people
 over 18 that match the other attributes.
        repeated .google.ads.googleads.v14.common.AgeRangeInfo age_ranges = 4;
        Specified by:
        getAgeRangesList in interface InsightsAudienceOrBuilder

      • getAgeRangesOrBuilderList

        public java.util.List<? extends AgeRangeInfoOrBuilder> getAgeRangesOrBuilderList()
         Age ranges for the audience.  If absent, the audience represents all people
 over 18 that match the other attributes.
        repeated .google.ads.googleads.v14.common.AgeRangeInfo age_ranges = 4;
        Specified by:
        getAgeRangesOrBuilderList in interface InsightsAudienceOrBuilder

      • getAgeRangesCount

        public int getAgeRangesCount()
         Age ranges for the audience.  If absent, the audience represents all people
 over 18 that match the other attributes.
        repeated .google.ads.googleads.v14.common.AgeRangeInfo age_ranges = 4;
        Specified by:
        getAgeRangesCount in interface InsightsAudienceOrBuilder

      • getAgeRanges

        public AgeRangeInfo getAgeRanges​(int index)
         Age ranges for the audience.  If absent, the audience represents all people
 over 18 that match the other attributes.
        repeated .google.ads.googleads.v14.common.AgeRangeInfo age_ranges = 4;
        Specified by:
        getAgeRanges in interface InsightsAudienceOrBuilder

      • getAgeRangesOrBuilder

        public AgeRangeInfoOrBuilder getAgeRangesOrBuilder​(int index)
         Age ranges for the audience.  If absent, the audience represents all people
 over 18 that match the other attributes.
        repeated .google.ads.googleads.v14.common.AgeRangeInfo age_ranges = 4;
        Specified by:
        getAgeRangesOrBuilder in interface InsightsAudienceOrBuilder

      • hasParentalStatus

        public boolean hasParentalStatus()
         Parental status for the audience.  If absent, the audience does not
 restrict by parental status.
        .google.ads.googleads.v14.common.ParentalStatusInfo parental_status = 5;
        Specified by:
        hasParentalStatus in interface InsightsAudienceOrBuilder
        Returns:
        Whether the parentalStatus field is set.

      • getParentalStatus

        public ParentalStatusInfo getParentalStatus()
         Parental status for the audience.  If absent, the audience does not
 restrict by parental status.
        .google.ads.googleads.v14.common.ParentalStatusInfo parental_status = 5;
        Specified by:
        getParentalStatus in interface InsightsAudienceOrBuilder
        Returns:
        The parentalStatus.

      • getIncomeRangesList

        public java.util.List<IncomeRangeInfo> getIncomeRangesList()
         Household income percentile ranges for the audience.  If absent, the
 audience does not restrict by household income range.
        repeated .google.ads.googleads.v14.common.IncomeRangeInfo income_ranges = 6;
        Specified by:
        getIncomeRangesList in interface InsightsAudienceOrBuilder

      • getIncomeRangesOrBuilderList

        public java.util.List<? extends IncomeRangeInfoOrBuilder> getIncomeRangesOrBuilderList()
         Household income percentile ranges for the audience.  If absent, the
 audience does not restrict by household income range.
        repeated .google.ads.googleads.v14.common.IncomeRangeInfo income_ranges = 6;
        Specified by:
        getIncomeRangesOrBuilderList in interface InsightsAudienceOrBuilder

      • getIncomeRangesCount

        public int getIncomeRangesCount()
         Household income percentile ranges for the audience.  If absent, the
 audience does not restrict by household income range.
        repeated .google.ads.googleads.v14.common.IncomeRangeInfo income_ranges = 6;
        Specified by:
        getIncomeRangesCount in interface InsightsAudienceOrBuilder

      • getIncomeRanges

        public IncomeRangeInfo getIncomeRanges​(int index)
         Household income percentile ranges for the audience.  If absent, the
 audience does not restrict by household income range.
        repeated .google.ads.googleads.v14.common.IncomeRangeInfo income_ranges = 6;
        Specified by:
        getIncomeRanges in interface InsightsAudienceOrBuilder

      • getIncomeRangesOrBuilder

        public IncomeRangeInfoOrBuilder getIncomeRangesOrBuilder​(int index)
         Household income percentile ranges for the audience.  If absent, the
 audience does not restrict by household income range.
        repeated .google.ads.googleads.v14.common.IncomeRangeInfo income_ranges = 6;
        Specified by:
        getIncomeRangesOrBuilder in interface InsightsAudienceOrBuilder

      • getDynamicLineupsCount

        public int getDynamicLineupsCount()
         Dynamic lineups representing the YouTube content viewed by the audience.
        repeated .google.ads.googleads.v14.services.AudienceInsightsDynamicLineup dynamic_lineups = 7;
        Specified by:
        getDynamicLineupsCount in interface InsightsAudienceOrBuilder

      • getTopicAudienceCombinationsList

        public java.util.List<InsightsAudienceAttributeGroup> getTopicAudienceCombinationsList()
         A combination of entity, category and user interest attributes defining the
 audience. The combination has a logical AND-of-ORs structure: Attributes
 within each InsightsAudienceAttributeGroup are combined with OR, and
 the combinations themselves are combined together with AND.  For example,
 the expression (Entity OR Affinity) AND (In-Market OR Category) can be
 formed using two InsightsAudienceAttributeGroups with two Attributes
 each.
        repeated .google.ads.googleads.v14.services.InsightsAudienceAttributeGroup topic_audience_combinations = 8;
        Specified by:
        getTopicAudienceCombinationsList in interface InsightsAudienceOrBuilder

      • getTopicAudienceCombinationsOrBuilderList

        public java.util.List<? extends InsightsAudienceAttributeGroupOrBuilder> getTopicAudienceCombinationsOrBuilderList()
         A combination of entity, category and user interest attributes defining the
 audience. The combination has a logical AND-of-ORs structure: Attributes
 within each InsightsAudienceAttributeGroup are combined with OR, and
 the combinations themselves are combined together with AND.  For example,
 the expression (Entity OR Affinity) AND (In-Market OR Category) can be
 formed using two InsightsAudienceAttributeGroups with two Attributes
 each.
        repeated .google.ads.googleads.v14.services.InsightsAudienceAttributeGroup topic_audience_combinations = 8;
        Specified by:
        getTopicAudienceCombinationsOrBuilderList in interface InsightsAudienceOrBuilder

      • getTopicAudienceCombinationsCount

        public int getTopicAudienceCombinationsCount()
         A combination of entity, category and user interest attributes defining the
 audience. The combination has a logical AND-of-ORs structure: Attributes
 within each InsightsAudienceAttributeGroup are combined with OR, and
 the combinations themselves are combined together with AND.  For example,
 the expression (Entity OR Affinity) AND (In-Market OR Category) can be
 formed using two InsightsAudienceAttributeGroups with two Attributes
 each.
        repeated .google.ads.googleads.v14.services.InsightsAudienceAttributeGroup topic_audience_combinations = 8;
        Specified by:
        getTopicAudienceCombinationsCount in interface InsightsAudienceOrBuilder

      • getTopicAudienceCombinations

        public InsightsAudienceAttributeGroup getTopicAudienceCombinations​(int index)
         A combination of entity, category and user interest attributes defining the
 audience. The combination has a logical AND-of-ORs structure: Attributes
 within each InsightsAudienceAttributeGroup are combined with OR, and
 the combinations themselves are combined together with AND.  For example,
 the expression (Entity OR Affinity) AND (In-Market OR Category) can be
 formed using two InsightsAudienceAttributeGroups with two Attributes
 each.
        repeated .google.ads.googleads.v14.services.InsightsAudienceAttributeGroup topic_audience_combinations = 8;
        Specified by:
        getTopicAudienceCombinations in interface InsightsAudienceOrBuilder

      • getTopicAudienceCombinationsOrBuilder

        public InsightsAudienceAttributeGroupOrBuilder getTopicAudienceCombinationsOrBuilder​(int index)
         A combination of entity, category and user interest attributes defining the
 audience. The combination has a logical AND-of-ORs structure: Attributes
 within each InsightsAudienceAttributeGroup are combined with OR, and
 the combinations themselves are combined together with AND.  For example,
 the expression (Entity OR Affinity) AND (In-Market OR Category) can be
 formed using two InsightsAudienceAttributeGroups with two Attributes
 each.
        repeated .google.ads.googleads.v14.services.InsightsAudienceAttributeGroup topic_audience_combinations = 8;
        Specified by:
        getTopicAudienceCombinationsOrBuilder in interface InsightsAudienceOrBuilder

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

      • parseFrom

        public static InsightsAudience parseFrom​(java.nio.ByteBuffer data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static InsightsAudience parseFrom​(java.io.InputStream input)
                                  throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • parseDelimitedFrom

        public static InsightsAudience parseDelimitedFrom​(java.io.InputStream input)
                                           throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

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

      • parseFrom

        public static InsightsAudience parseFrom​(com.google.protobuf.CodedInputStream input)
                                  throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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