Package com.google.ads.googleads.v21.services

Interface GenerateAudienceOverlapInsightsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
GenerateAudienceOverlapInsightsRequest, GenerateAudienceOverlapInsightsRequest.Builder
public interface GenerateAudienceOverlapInsightsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getCustomerId

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

    • getCustomerIdBytes

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

    • hasCountryLocation

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

    • getCountryLocation

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

    • getCountryLocationOrBuilder

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

    • hasPrimaryAttribute

      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.v21.common.AudienceInsightsAttribute primary_attribute = 6 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      Whether the primaryAttribute field is set.

    • getPrimaryAttribute

      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.v21.common.AudienceInsightsAttribute primary_attribute = 6 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The primaryAttribute.

    • getPrimaryAttributeOrBuilder

      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.v21.common.AudienceInsightsAttribute primary_attribute = 6 [(.google.api.field_behavior) = REQUIRED];

    • getDimensionsList

      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.v21.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      A list containing the dimensions.

    • getDimensionsCount

      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.v21.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The count of dimensions.

    • getDimensions

      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.v21.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      index - The index of the element to return.
      Returns:
      The dimensions at the given index.

    • getDimensionsValueList

      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.v21.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      A list containing the enum numeric values on the wire for dimensions.

    • getDimensionsValue

      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.v21.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of dimensions at the given index.

    • getCustomerInsightsGroup

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

    • getCustomerInsightsGroupBytes

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

    • hasInsightsApplicationInfo

      boolean hasInsightsApplicationInfo()
       Optional. Additional information on the application issuing the request.
      .google.ads.googleads.v21.common.AdditionalApplicationInfo insights_application_info = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the insightsApplicationInfo field is set.

    • getInsightsApplicationInfo

      AdditionalApplicationInfo getInsightsApplicationInfo()
       Optional. Additional information on the application issuing the request.
      .google.ads.googleads.v21.common.AdditionalApplicationInfo insights_application_info = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The insightsApplicationInfo.

    • getInsightsApplicationInfoOrBuilder

      AdditionalApplicationInfoOrBuilder getInsightsApplicationInfoOrBuilder()
       Optional. Additional information on the application issuing the request.
      .google.ads.googleads.v21.common.AdditionalApplicationInfo insights_application_info = 7 [(.google.api.field_behavior) = OPTIONAL];