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

Class GenerateAudienceOverlapInsightsRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v18.services.GenerateAudienceOverlapInsightsRequest
All Implemented Interfaces:
GenerateAudienceOverlapInsightsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class GenerateAudienceOverlapInsightsRequest extends com.google.protobuf.GeneratedMessageV3 implements GenerateAudienceOverlapInsightsRequestOrBuilder
 Request message for
 [AudienceInsightsService.GenerateAudienceOverlapInsights][google.ads.googleads.v18.services.AudienceInsightsService.GenerateAudienceOverlapInsights].
Protobuf type google.ads.googleads.v18.services.GenerateAudienceOverlapInsightsRequest
See Also:

  • Field Details

    • CUSTOMER_ID_FIELD_NUMBER

      public static final int CUSTOMER_ID_FIELD_NUMBER
      See Also:

    • COUNTRY_LOCATION_FIELD_NUMBER

      public static final int COUNTRY_LOCATION_FIELD_NUMBER
      See Also:

    • PRIMARY_ATTRIBUTE_FIELD_NUMBER

      public static final int PRIMARY_ATTRIBUTE_FIELD_NUMBER
      See Also:

    • DIMENSIONS_FIELD_NUMBER

      public static final int DIMENSIONS_FIELD_NUMBER
      See Also:

    • CUSTOMER_INSIGHTS_GROUP_FIELD_NUMBER

      public static final int CUSTOMER_INSIGHTS_GROUP_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected 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

    • getCustomerId

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

    • getCustomerIdBytes

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

    • hasCountryLocation

      public boolean hasCountryLocation()
       Required. The country in which to calculate the sizes and overlaps of
 audiences.
      .google.ads.googleads.v18.common.LocationInfo country_location = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasCountryLocation in interface GenerateAudienceOverlapInsightsRequestOrBuilder
      Returns:
      Whether the countryLocation field is set.

    • getCountryLocation

      public LocationInfo getCountryLocation()
       Required. The country in which to calculate the sizes and overlaps of
 audiences.
      .google.ads.googleads.v18.common.LocationInfo country_location = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCountryLocation in interface GenerateAudienceOverlapInsightsRequestOrBuilder
      Returns:
      The countryLocation.

    • getCountryLocationOrBuilder

      public LocationInfoOrBuilder getCountryLocationOrBuilder()
       Required. The country in which to calculate the sizes and overlaps of
 audiences.
      .google.ads.googleads.v18.common.LocationInfo country_location = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCountryLocationOrBuilder in interface GenerateAudienceOverlapInsightsRequestOrBuilder

    • hasPrimaryAttribute

      public boolean hasPrimaryAttribute()
       Required. The audience attribute that should be intersected with all other
 eligible audiences.  This must be an Affinity or In-Market UserInterest, an
 AgeRange or a Gender.
      .google.ads.googleads.v18.services.AudienceInsightsAttribute primary_attribute = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasPrimaryAttribute in interface GenerateAudienceOverlapInsightsRequestOrBuilder
      Returns:
      Whether the primaryAttribute field is set.

    • getPrimaryAttribute

      public AudienceInsightsAttribute getPrimaryAttribute()
       Required. The audience attribute that should be intersected with all other
 eligible audiences.  This must be an Affinity or In-Market UserInterest, an
 AgeRange or a Gender.
      .google.ads.googleads.v18.services.AudienceInsightsAttribute primary_attribute = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getPrimaryAttribute in interface GenerateAudienceOverlapInsightsRequestOrBuilder
      Returns:
      The primaryAttribute.

    • getPrimaryAttributeOrBuilder

      public AudienceInsightsAttributeOrBuilder getPrimaryAttributeOrBuilder()
       Required. The audience attribute that should be intersected with all other
 eligible audiences.  This must be an Affinity or In-Market UserInterest, an
 AgeRange or a Gender.
      .google.ads.googleads.v18.services.AudienceInsightsAttribute primary_attribute = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getPrimaryAttributeOrBuilder in interface GenerateAudienceOverlapInsightsRequestOrBuilder

    • getDimensionsList

      public List<AudienceInsightsDimensionEnum.AudienceInsightsDimension> getDimensionsList()
       Required. The types of attributes of which to calculate the overlap with
 the primary_attribute. The values must be a subset of
 AFFINITY_USER_INTEREST, IN_MARKET_USER_INTEREST, AGE_RANGE and GENDER.
      repeated .google.ads.googleads.v18.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDimensionsList in interface GenerateAudienceOverlapInsightsRequestOrBuilder
      Returns:
      A list containing the dimensions.

    • getDimensionsCount

      public int getDimensionsCount()
       Required. The types of attributes of which to calculate the overlap with
 the primary_attribute. The values must be a subset of
 AFFINITY_USER_INTEREST, IN_MARKET_USER_INTEREST, AGE_RANGE and GENDER.
      repeated .google.ads.googleads.v18.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDimensionsCount in interface GenerateAudienceOverlapInsightsRequestOrBuilder
      Returns:
      The count of dimensions.

    • getDimensions

      public AudienceInsightsDimensionEnum.AudienceInsightsDimension getDimensions(int index)
       Required. The types of attributes of which to calculate the overlap with
 the primary_attribute. The values must be a subset of
 AFFINITY_USER_INTEREST, IN_MARKET_USER_INTEREST, AGE_RANGE and GENDER.
      repeated .google.ads.googleads.v18.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDimensions in interface GenerateAudienceOverlapInsightsRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The dimensions at the given index.

    • getDimensionsValueList

      public List<Integer> getDimensionsValueList()
       Required. The types of attributes of which to calculate the overlap with
 the primary_attribute. The values must be a subset of
 AFFINITY_USER_INTEREST, IN_MARKET_USER_INTEREST, AGE_RANGE and GENDER.
      repeated .google.ads.googleads.v18.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDimensionsValueList in interface GenerateAudienceOverlapInsightsRequestOrBuilder
      Returns:
      A list containing the enum numeric values on the wire for dimensions.

    • getDimensionsValue

      public int getDimensionsValue(int index)
       Required. The types of attributes of which to calculate the overlap with
 the primary_attribute. The values must be a subset of
 AFFINITY_USER_INTEREST, IN_MARKET_USER_INTEREST, AGE_RANGE and GENDER.
      repeated .google.ads.googleads.v18.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDimensionsValue in interface GenerateAudienceOverlapInsightsRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of dimensions at the given index.

    • getCustomerInsightsGroup

      public String getCustomerInsightsGroup()
       The name of the customer being planned for.  This is a user-defined value.
      string customer_insights_group = 5;
      Specified by:
      getCustomerInsightsGroup in interface GenerateAudienceOverlapInsightsRequestOrBuilder
      Returns:
      The customerInsightsGroup.

    • getCustomerInsightsGroupBytes

      public com.google.protobuf.ByteString getCustomerInsightsGroupBytes()
       The name of the customer being planned for.  This is a user-defined value.
      string customer_insights_group = 5;
      Specified by:
      getCustomerInsightsGroupBytes in interface GenerateAudienceOverlapInsightsRequestOrBuilder
      Returns:
      The bytes for customerInsightsGroup.

    • 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      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(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 GenerateAudienceOverlapInsightsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GenerateAudienceOverlapInsightsRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static GenerateAudienceOverlapInsightsRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static GenerateAudienceOverlapInsightsRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static GenerateAudienceOverlapInsightsRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static GenerateAudienceOverlapInsightsRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static GenerateAudienceOverlapInsightsRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static GenerateAudienceOverlapInsightsRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static GenerateAudienceOverlapInsightsRequest.Builder newBuilder()

    • newBuilder

      public static GenerateAudienceOverlapInsightsRequest.Builder newBuilder(GenerateAudienceOverlapInsightsRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static GenerateAudienceOverlapInsightsRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<GenerateAudienceOverlapInsightsRequest> parser()

    • getParserForType

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