google/ads/admanager/v1/frequency_cap.proto

// Copyright 2023 Google LLC
//
// 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.

syntax = "proto3";

package google.ads.admanager.v1;

option csharp_namespace = "Google.Ads.AdManager.V1";
option go_package = "google.golang.org/genproto/googleapis/ads/admanager/v1;admanager";
option java_multiple_files = true;
option java_outer_classname = "FrequencyCapProto";
option java_package = "com.google.ads.admanager.v1";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\AdManager\\V1";

// Represents a Frequency Cap that can be applied to an entity.
message FrequencyCap {
  // The maximum number of impressions for this frequency cap.
  optional int64 max_impressions = 1;

  // The number of time units over which the frequency cap is effective.
  optional int64 time_amount = 2;

  // The units of time of this frequency cap.
  optional TimeUnitEnum.TimeUnit time_unit = 3;
}

// Wrapper message for TimeUnit.
message TimeUnitEnum {
  // Unit of time for the frequency cap.
  enum TimeUnit {
    // Default value. This value is unused.
    TIME_UNIT_UNSPECIFIED = 0;

    // Minute
    MINUTE = 1;

    // Hour
    HOUR = 2;

    // Day
    DAY = 3;

    // Week
    WEEK = 4;

    // Month
    MONTH = 5;

    // Lifetime
    LIFETIME = 6;

    // Per pod of ads in a video stream. Only valid for entities in a
    // VIDEO_PLAYER environment.
    POD = 7;

    // Per video stream. Only valid for entities in a VIDEO_PLAYER environment.
    STREAM = 8;
  }
}