com.google.api.services.adexchangebuyer2.v2beta1.model.FrequencyCap Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-adexchangebuyer2 Show documentation
There is a newer version: v2beta1-rev20241002-2.0.0
Show newest version
/*
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
/*
 * This code was generated by https://github.com/googleapis/google-api-java-client-services/
 * Modify at your own risk.
 */

package com.google.api.services.adexchangebuyer2.v2beta1.model;

/**
 * Frequency cap.
 *
 *  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 * transmitted over HTTP when working with the Ad Exchange Buyer API II. For a detailed explanation
 * see:
 * https://developers.google.com/api-client-library/java/google-http-java-client/json
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class FrequencyCap extends com.google.api.client.json.GenericJson {

  /**
   * The maximum number of impressions that can be served to a user within the specified time
   * period.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer maxImpressions;

  /**
   * The amount of time, in the units specified by time_unit_type. Defines the amount of time over
   * which impressions per user are counted and capped.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer numTimeUnits;

  /**
   * The time unit. Along with num_time_units defines the amount of time over which impressions per
   * user are counted and capped.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String timeUnitType;

  /**
   * The maximum number of impressions that can be served to a user within the specified time
   * period.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getMaxImpressions() {
    return maxImpressions;
  }

  /**
   * The maximum number of impressions that can be served to a user within the specified time
   * period.
   * @param maxImpressions maxImpressions or {@code null} for none
   */
  public FrequencyCap setMaxImpressions(java.lang.Integer maxImpressions) {
    this.maxImpressions = maxImpressions;
    return this;
  }

  /**
   * The amount of time, in the units specified by time_unit_type. Defines the amount of time over
   * which impressions per user are counted and capped.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getNumTimeUnits() {
    return numTimeUnits;
  }

  /**
   * The amount of time, in the units specified by time_unit_type. Defines the amount of time over
   * which impressions per user are counted and capped.
   * @param numTimeUnits numTimeUnits or {@code null} for none
   */
  public FrequencyCap setNumTimeUnits(java.lang.Integer numTimeUnits) {
    this.numTimeUnits = numTimeUnits;
    return this;
  }

  /**
   * The time unit. Along with num_time_units defines the amount of time over which impressions per
   * user are counted and capped.
   * @return value or {@code null} for none
   */
  public java.lang.String getTimeUnitType() {
    return timeUnitType;
  }

  /**
   * The time unit. Along with num_time_units defines the amount of time over which impressions per
   * user are counted and capped.
   * @param timeUnitType timeUnitType or {@code null} for none
   */
  public FrequencyCap setTimeUnitType(java.lang.String timeUnitType) {
    this.timeUnitType = timeUnitType;
    return this;
  }

  @Override
  public FrequencyCap set(String fieldName, Object value) {
    return (FrequencyCap) super.set(fieldName, value);
  }

  @Override
  public FrequencyCap clone() {
    return (FrequencyCap) super.clone();
  }

}