com.google.ads.googleads.v17.services.TargetingOrBuilder 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/reach_plan_service.proto

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

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

  /**
   *    * The ID of the selected location. Plannable location IDs can be
   * obtained from
   * [ReachPlanService.ListPlannableLocations][google.ads.googleads.v17.services.ReachPlanService.ListPlannableLocations].
   *
   * Requests must set either this field or `plannable_location_ids`.
   *
   * This field is deprecated as of V12 and will be removed in a future release.
   * Use `plannable_location_ids` instead.
   * 
   *
   * optional string plannable_location_id = 6;
   * @return Whether the plannableLocationId field is set.
   */
  boolean hasPlannableLocationId();
  /**
   *    * The ID of the selected location. Plannable location IDs can be
   * obtained from
   * [ReachPlanService.ListPlannableLocations][google.ads.googleads.v17.services.ReachPlanService.ListPlannableLocations].
   *
   * Requests must set either this field or `plannable_location_ids`.
   *
   * This field is deprecated as of V12 and will be removed in a future release.
   * Use `plannable_location_ids` instead.
   * 
   *
   * optional string plannable_location_id = 6;
   * @return The plannableLocationId.
   */
  java.lang.String getPlannableLocationId();
  /**
   *    * The ID of the selected location. Plannable location IDs can be
   * obtained from
   * [ReachPlanService.ListPlannableLocations][google.ads.googleads.v17.services.ReachPlanService.ListPlannableLocations].
   *
   * Requests must set either this field or `plannable_location_ids`.
   *
   * This field is deprecated as of V12 and will be removed in a future release.
   * Use `plannable_location_ids` instead.
   * 
   *
   * optional string plannable_location_id = 6;
   * @return The bytes for plannableLocationId.
   */
  com.google.protobuf.ByteString
      getPlannableLocationIdBytes();

  /**
   *    * The list of plannable location IDs to target with this forecast.
   *
   * If more than one ID is provided, all IDs must have the same
   * `parent_country_id`. Planning for more than `parent_county` is not
   * supported. Plannable location IDs and their `parent_country_id` can be
   * obtained from
   * [ReachPlanService.ListPlannableLocations][google.ads.googleads.v17.services.ReachPlanService.ListPlannableLocations].
   *
   * Requests must set either this field or `plannable_location_id`.
   * 
   *
   * repeated string plannable_location_ids = 8;
   * @return A list containing the plannableLocationIds.
   */
  java.util.List
      getPlannableLocationIdsList();
  /**
   *    * The list of plannable location IDs to target with this forecast.
   *
   * If more than one ID is provided, all IDs must have the same
   * `parent_country_id`. Planning for more than `parent_county` is not
   * supported. Plannable location IDs and their `parent_country_id` can be
   * obtained from
   * [ReachPlanService.ListPlannableLocations][google.ads.googleads.v17.services.ReachPlanService.ListPlannableLocations].
   *
   * Requests must set either this field or `plannable_location_id`.
   * 
   *
   * repeated string plannable_location_ids = 8;
   * @return The count of plannableLocationIds.
   */
  int getPlannableLocationIdsCount();
  /**
   *    * The list of plannable location IDs to target with this forecast.
   *
   * If more than one ID is provided, all IDs must have the same
   * `parent_country_id`. Planning for more than `parent_county` is not
   * supported. Plannable location IDs and their `parent_country_id` can be
   * obtained from
   * [ReachPlanService.ListPlannableLocations][google.ads.googleads.v17.services.ReachPlanService.ListPlannableLocations].
   *
   * Requests must set either this field or `plannable_location_id`.
   * 
   *
   * repeated string plannable_location_ids = 8;
   * @param index The index of the element to return.
   * @return The plannableLocationIds at the given index.
   */
  java.lang.String getPlannableLocationIds(int index);
  /**
   *    * The list of plannable location IDs to target with this forecast.
   *
   * If more than one ID is provided, all IDs must have the same
   * `parent_country_id`. Planning for more than `parent_county` is not
   * supported. Plannable location IDs and their `parent_country_id` can be
   * obtained from
   * [ReachPlanService.ListPlannableLocations][google.ads.googleads.v17.services.ReachPlanService.ListPlannableLocations].
   *
   * Requests must set either this field or `plannable_location_id`.
   * 
   *
   * repeated string plannable_location_ids = 8;
   * @param index The index of the value to return.
   * @return The bytes of the plannableLocationIds at the given index.
   */
  com.google.protobuf.ByteString
      getPlannableLocationIdsBytes(int index);

  /**
   *    * Targeted age range.
   * An unset value is equivalent to targeting all ages.
   * 
   *
   * .google.ads.googleads.v17.enums.ReachPlanAgeRangeEnum.ReachPlanAgeRange age_range = 2;
   * @return The enum numeric value on the wire for ageRange.
   */
  int getAgeRangeValue();
  /**
   *    * Targeted age range.
   * An unset value is equivalent to targeting all ages.
   * 
   *
   * .google.ads.googleads.v17.enums.ReachPlanAgeRangeEnum.ReachPlanAgeRange age_range = 2;
   * @return The ageRange.
   */
  com.google.ads.googleads.v17.enums.ReachPlanAgeRangeEnum.ReachPlanAgeRange getAgeRange();

  /**
   *    * Targeted genders.
   * An unset value is equivalent to targeting MALE and FEMALE.
   * 
   *
   * repeated .google.ads.googleads.v17.common.GenderInfo genders = 3;
   */
  java.util.List 
      getGendersList();
  /**
   *    * Targeted genders.
   * An unset value is equivalent to targeting MALE and FEMALE.
   * 
   *
   * repeated .google.ads.googleads.v17.common.GenderInfo genders = 3;
   */
  com.google.ads.googleads.v17.common.GenderInfo getGenders(int index);
  /**
   *    * Targeted genders.
   * An unset value is equivalent to targeting MALE and FEMALE.
   * 
   *
   * repeated .google.ads.googleads.v17.common.GenderInfo genders = 3;
   */
  int getGendersCount();
  /**
   *    * Targeted genders.
   * An unset value is equivalent to targeting MALE and FEMALE.
   * 
   *
   * repeated .google.ads.googleads.v17.common.GenderInfo genders = 3;
   */
  java.util.List 
      getGendersOrBuilderList();
  /**
   *    * Targeted genders.
   * An unset value is equivalent to targeting MALE and FEMALE.
   * 
   *
   * repeated .google.ads.googleads.v17.common.GenderInfo genders = 3;
   */
  com.google.ads.googleads.v17.common.GenderInfoOrBuilder getGendersOrBuilder(
      int index);

  /**
   *    * Targeted devices.
   * If not specified, targets all applicable devices. Applicable devices vary
   * by product and region and can be obtained from
   * [ReachPlanService.ListPlannableProducts][google.ads.googleads.v17.services.ReachPlanService.ListPlannableProducts].
   * 
   *
   * repeated .google.ads.googleads.v17.common.DeviceInfo devices = 4;
   */
  java.util.List 
      getDevicesList();
  /**
   *    * Targeted devices.
   * If not specified, targets all applicable devices. Applicable devices vary
   * by product and region and can be obtained from
   * [ReachPlanService.ListPlannableProducts][google.ads.googleads.v17.services.ReachPlanService.ListPlannableProducts].
   * 
   *
   * repeated .google.ads.googleads.v17.common.DeviceInfo devices = 4;
   */
  com.google.ads.googleads.v17.common.DeviceInfo getDevices(int index);
  /**
   *    * Targeted devices.
   * If not specified, targets all applicable devices. Applicable devices vary
   * by product and region and can be obtained from
   * [ReachPlanService.ListPlannableProducts][google.ads.googleads.v17.services.ReachPlanService.ListPlannableProducts].
   * 
   *
   * repeated .google.ads.googleads.v17.common.DeviceInfo devices = 4;
   */
  int getDevicesCount();
  /**
   *    * Targeted devices.
   * If not specified, targets all applicable devices. Applicable devices vary
   * by product and region and can be obtained from
   * [ReachPlanService.ListPlannableProducts][google.ads.googleads.v17.services.ReachPlanService.ListPlannableProducts].
   * 
   *
   * repeated .google.ads.googleads.v17.common.DeviceInfo devices = 4;
   */
  java.util.List 
      getDevicesOrBuilderList();
  /**
   *    * Targeted devices.
   * If not specified, targets all applicable devices. Applicable devices vary
   * by product and region and can be obtained from
   * [ReachPlanService.ListPlannableProducts][google.ads.googleads.v17.services.ReachPlanService.ListPlannableProducts].
   * 
   *
   * repeated .google.ads.googleads.v17.common.DeviceInfo devices = 4;
   */
  com.google.ads.googleads.v17.common.DeviceInfoOrBuilder getDevicesOrBuilder(
      int index);

  /**
   *    * Targetable network for the ad product.
   * If not specified, targets all applicable networks. Applicable networks vary
   * by product and region and can be obtained from
   * [ReachPlanService.ListPlannableProducts][google.ads.googleads.v17.services.ReachPlanService.ListPlannableProducts].
   * 
   *
   * .google.ads.googleads.v17.enums.ReachPlanNetworkEnum.ReachPlanNetwork network = 5;
   * @return The enum numeric value on the wire for network.
   */
  int getNetworkValue();
  /**
   *    * Targetable network for the ad product.
   * If not specified, targets all applicable networks. Applicable networks vary
   * by product and region and can be obtained from
   * [ReachPlanService.ListPlannableProducts][google.ads.googleads.v17.services.ReachPlanService.ListPlannableProducts].
   * 
   *
   * .google.ads.googleads.v17.enums.ReachPlanNetworkEnum.ReachPlanNetwork network = 5;
   * @return The network.
   */
  com.google.ads.googleads.v17.enums.ReachPlanNetworkEnum.ReachPlanNetwork getNetwork();

  /**
   *    * Targeted audiences.
   * If not specified, does not target any specific audience.
   * 
   *
   * .google.ads.googleads.v17.services.AudienceTargeting audience_targeting = 7;
   * @return Whether the audienceTargeting field is set.
   */
  boolean hasAudienceTargeting();
  /**
   *    * Targeted audiences.
   * If not specified, does not target any specific audience.
   * 
   *
   * .google.ads.googleads.v17.services.AudienceTargeting audience_targeting = 7;
   * @return The audienceTargeting.
   */
  com.google.ads.googleads.v17.services.AudienceTargeting getAudienceTargeting();
  /**
   *    * Targeted audiences.
   * If not specified, does not target any specific audience.
   * 
   *
   * .google.ads.googleads.v17.services.AudienceTargeting audience_targeting = 7;
   */
  com.google.ads.googleads.v17.services.AudienceTargetingOrBuilder getAudienceTargetingOrBuilder();
}