com.google.ads.googleads.v9.common.FrequencyCapKeyOrBuilder Maven / Gradle / Ivy

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

package com.google.ads.googleads.v9.common;

public interface FrequencyCapKeyOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.ads.googleads.v9.common.FrequencyCapKey)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * The level on which the cap is to be applied (e.g. ad group ad, ad group).
   * The cap is applied to all the entities of this level.
   * 
   *
   * .google.ads.googleads.v9.enums.FrequencyCapLevelEnum.FrequencyCapLevel level = 1;
   * @return The enum numeric value on the wire for level.
   */
  int getLevelValue();
  /**
   *    * The level on which the cap is to be applied (e.g. ad group ad, ad group).
   * The cap is applied to all the entities of this level.
   * 
   *
   * .google.ads.googleads.v9.enums.FrequencyCapLevelEnum.FrequencyCapLevel level = 1;
   * @return The level.
   */
  com.google.ads.googleads.v9.enums.FrequencyCapLevelEnum.FrequencyCapLevel getLevel();

  /**
   *    * The type of event that the cap applies to (e.g. impression).
   * 
   *
   * .google.ads.googleads.v9.enums.FrequencyCapEventTypeEnum.FrequencyCapEventType event_type = 3;
   * @return The enum numeric value on the wire for eventType.
   */
  int getEventTypeValue();
  /**
   *    * The type of event that the cap applies to (e.g. impression).
   * 
   *
   * .google.ads.googleads.v9.enums.FrequencyCapEventTypeEnum.FrequencyCapEventType event_type = 3;
   * @return The eventType.
   */
  com.google.ads.googleads.v9.enums.FrequencyCapEventTypeEnum.FrequencyCapEventType getEventType();

  /**
   *    * Unit of time the cap is defined at (e.g. day, week).
   * 
   *
   * .google.ads.googleads.v9.enums.FrequencyCapTimeUnitEnum.FrequencyCapTimeUnit time_unit = 2;
   * @return The enum numeric value on the wire for timeUnit.
   */
  int getTimeUnitValue();
  /**
   *    * Unit of time the cap is defined at (e.g. day, week).
   * 
   *
   * .google.ads.googleads.v9.enums.FrequencyCapTimeUnitEnum.FrequencyCapTimeUnit time_unit = 2;
   * @return The timeUnit.
   */
  com.google.ads.googleads.v9.enums.FrequencyCapTimeUnitEnum.FrequencyCapTimeUnit getTimeUnit();

  /**
   *    * Number of time units the cap lasts.
   * 
   *
   * optional int32 time_length = 5;
   * @return Whether the timeLength field is set.
   */
  boolean hasTimeLength();
  /**
   *    * Number of time units the cap lasts.
   * 
   *
   * optional int32 time_length = 5;
   * @return The timeLength.
   */
  int getTimeLength();
}