com.google.ads.googleads.v17.services.GenerateAudienceOverlapInsightsRequestOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-ads-stubs-v17 Show documentation
Stubs for GAAPI version google-ads-stubs-v17
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/ads/googleads/v17/services/audience_insights_service.proto

// Protobuf Java Version: 3.25.3
package com.google.ads.googleads.v17.services;

public interface GenerateAudienceOverlapInsightsRequestOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.ads.googleads.v17.services.GenerateAudienceOverlapInsightsRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Required. The ID of the customer.
   * 
   *
   * string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
   * @return The customerId.
   */
  java.lang.String getCustomerId();
  /**
   *    * Required. The ID of the customer.
   * 
   *
   * string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
   * @return The bytes for customerId.
   */
  com.google.protobuf.ByteString
      getCustomerIdBytes();

  /**
   *    * Required. The country in which to calculate the sizes and overlaps of
   * audiences.
   * 
   *
   * .google.ads.googleads.v17.common.LocationInfo country_location = 2 [(.google.api.field_behavior) = REQUIRED];
   * @return Whether the countryLocation field is set.
   */
  boolean hasCountryLocation();
  /**
   *    * Required. The country in which to calculate the sizes and overlaps of
   * audiences.
   * 
   *
   * .google.ads.googleads.v17.common.LocationInfo country_location = 2 [(.google.api.field_behavior) = REQUIRED];
   * @return The countryLocation.
   */
  com.google.ads.googleads.v17.common.LocationInfo getCountryLocation();
  /**
   *    * Required. The country in which to calculate the sizes and overlaps of
   * audiences.
   * 
   *
   * .google.ads.googleads.v17.common.LocationInfo country_location = 2 [(.google.api.field_behavior) = REQUIRED];
   */
  com.google.ads.googleads.v17.common.LocationInfoOrBuilder getCountryLocationOrBuilder();

  /**
   *    * 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.v17.services.AudienceInsightsAttribute primary_attribute = 3 [(.google.api.field_behavior) = REQUIRED];
   * @return Whether the primaryAttribute field is set.
   */
  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.v17.services.AudienceInsightsAttribute primary_attribute = 3 [(.google.api.field_behavior) = REQUIRED];
   * @return The primaryAttribute.
   */
  com.google.ads.googleads.v17.services.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.v17.services.AudienceInsightsAttribute primary_attribute = 3 [(.google.api.field_behavior) = REQUIRED];
   */
  com.google.ads.googleads.v17.services.AudienceInsightsAttributeOrBuilder getPrimaryAttributeOrBuilder();

  /**
   *    * 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.v17.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
   * @return A list containing the dimensions.
   */
  java.util.List 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.v17.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
   * @return The count of dimensions.
   */
  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.v17.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
   * @param index The index of the element to return.
   * @return The dimensions at the given index.
   */
  com.google.ads.googleads.v17.enums.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.v17.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
   * @return A list containing the enum numeric values on the wire for dimensions.
   */
  java.util.List
  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.v17.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
   * @param index The index of the value to return.
   * @return The enum numeric value on the wire of dimensions at the given index.
   */
  int getDimensionsValue(int index);

  /**
   *    * The name of the customer being planned for.  This is a user-defined value.
   * 
   *
   * string customer_insights_group = 5;
   * @return The customerInsightsGroup.
   */
  java.lang.String getCustomerInsightsGroup();
  /**
   *    * The name of the customer being planned for.  This is a user-defined value.
   * 
   *
   * string customer_insights_group = 5;
   * @return The bytes for customerInsightsGroup.
   */
  com.google.protobuf.ByteString
      getCustomerInsightsGroupBytes();
}