Class GenerateAudienceOverlapInsightsRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<GenerateAudienceOverlapInsightsRequest.Builder>
com.google.ads.googleads.v18.services.GenerateAudienceOverlapInsightsRequest.Builder
All Implemented Interfaces:
GenerateAudienceOverlapInsightsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
GenerateAudienceOverlapInsightsRequest

public static final class GenerateAudienceOverlapInsightsRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<GenerateAudienceOverlapInsightsRequest.Builder> implements GenerateAudienceOverlapInsightsRequestOrBuilder
 Request message for
 [AudienceInsightsService.GenerateAudienceOverlapInsights][google.ads.googleads.v18.services.AudienceInsightsService.GenerateAudienceOverlapInsights].
 
Protobuf type google.ads.googleads.v18.services.GenerateAudienceOverlapInsightsRequest
  • Method Details

    • 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<GenerateAudienceOverlapInsightsRequest.Builder>
    • clear

      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateAudienceOverlapInsightsRequest.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<GenerateAudienceOverlapInsightsRequest.Builder>
    • getDefaultInstanceForType

      public GenerateAudienceOverlapInsightsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
    • build

      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder
    • buildPartial

      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder
    • clone

      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateAudienceOverlapInsightsRequest.Builder>
    • setField

      public GenerateAudienceOverlapInsightsRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateAudienceOverlapInsightsRequest.Builder>
    • clearField

      public GenerateAudienceOverlapInsightsRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateAudienceOverlapInsightsRequest.Builder>
    • clearOneof

      public GenerateAudienceOverlapInsightsRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateAudienceOverlapInsightsRequest.Builder>
    • setRepeatedField

      public GenerateAudienceOverlapInsightsRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateAudienceOverlapInsightsRequest.Builder>
    • addRepeatedField

      public GenerateAudienceOverlapInsightsRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateAudienceOverlapInsightsRequest.Builder>
    • mergeFrom

      public GenerateAudienceOverlapInsightsRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GenerateAudienceOverlapInsightsRequest.Builder>
    • mergeFrom

    • isInitialized

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

      public GenerateAudienceOverlapInsightsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws 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<GenerateAudienceOverlapInsightsRequest.Builder>
      Throws:
      IOException
    • 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.
    • setCustomerId

       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

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

      public GenerateAudienceOverlapInsightsRequest.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.
    • 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.
    • setCountryLocation

       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];
    • setCountryLocation

      public GenerateAudienceOverlapInsightsRequest.Builder setCountryLocation(LocationInfo.Builder builderForValue)
       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];
    • mergeCountryLocation

      public GenerateAudienceOverlapInsightsRequest.Builder mergeCountryLocation(LocationInfo value)
       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];
    • clearCountryLocation

      public GenerateAudienceOverlapInsightsRequest.Builder clearCountryLocation()
       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];
    • getCountryLocationBuilder

      public LocationInfo.Builder getCountryLocationBuilder()
       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];
    • 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.
    • setPrimaryAttribute

       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];
    • setPrimaryAttribute

       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];
    • mergePrimaryAttribute

       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];
    • clearPrimaryAttribute

      public GenerateAudienceOverlapInsightsRequest.Builder clearPrimaryAttribute()
       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];
    • getPrimaryAttributeBuilder

      public AudienceInsightsAttribute.Builder getPrimaryAttributeBuilder()
       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];
    • 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

       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

       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.
    • setDimensions

       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];
      Parameters:
      index - The index to set the value at.
      value - The dimensions to set.
      Returns:
      This builder for chaining.
    • addDimensions

       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];
      Parameters:
      value - The dimensions to add.
      Returns:
      This builder for chaining.
    • addAllDimensions

       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];
      Parameters:
      values - The dimensions to add.
      Returns:
      This builder for chaining.
    • clearDimensions

       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];
      Returns:
      This builder for chaining.
    • 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.
    • setDimensionsValue

      public GenerateAudienceOverlapInsightsRequest.Builder setDimensionsValue(int index, int value)
       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];
      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 GenerateAudienceOverlapInsightsRequest.Builder addDimensionsValue(int value)
       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];
      Parameters:
      value - The enum numeric value on the wire for dimensions to add.
      Returns:
      This builder for chaining.
    • addAllDimensionsValue

      public GenerateAudienceOverlapInsightsRequest.Builder addAllDimensionsValue(Iterable<Integer> values)
       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];
      Parameters:
      values - The enum numeric values on the wire for dimensions to add.
      Returns:
      This builder for chaining.
    • 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.
    • setCustomerInsightsGroup

      public GenerateAudienceOverlapInsightsRequest.Builder setCustomerInsightsGroup(String value)
       The name of the customer being planned for.  This is a user-defined value.
       
      string customer_insights_group = 5;
      Parameters:
      value - The customerInsightsGroup to set.
      Returns:
      This builder for chaining.
    • clearCustomerInsightsGroup

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

      public GenerateAudienceOverlapInsightsRequest.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 = 5;
      Parameters:
      value - The bytes for customerInsightsGroup to set.
      Returns:
      This builder for chaining.
    • setUnknownFields

      public final GenerateAudienceOverlapInsightsRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateAudienceOverlapInsightsRequest.Builder>
    • mergeUnknownFields

      public final GenerateAudienceOverlapInsightsRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateAudienceOverlapInsightsRequest.Builder>