lib/google_api/display_video/v1/model/active_view_video_viewability_metric_config.ex

# Copyright 2019 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.

# NOTE: This file is auto generated by the elixir code generator program.
# Do not edit this file manually.

defmodule GoogleApi.DisplayVideo.V1.Model.ActiveViewVideoViewabilityMetricConfig do
  @moduledoc """
  Configuration for custom Active View video viewability metrics.

  ## Attributes

  *   `displayName` (*type:* `String.t`, *default:* `nil`) - Required. The display name of the custom metric.
  *   `minimumDuration` (*type:* `String.t`, *default:* `nil`) - The minimum visible video duration required (in seconds) in order for an impression to be recorded. You must specify minimum_duration, minimum_quartile or both. If both are specified, an impression meets the metric criteria if either requirement is met (whichever happens first).
  *   `minimumQuartile` (*type:* `String.t`, *default:* `nil`) - The minimum visible video duration required, based on the video quartiles, in order for an impression to be recorded. You must specify minimum_duration, minimum_quartile or both. If both are specified, an impression meets the metric criteria if either requirement is met (whichever happens first).
  *   `minimumViewability` (*type:* `String.t`, *default:* `nil`) - Required. The minimum percentage of the video ad's pixels visible on the screen in order for an impression to be recorded.
  *   `minimumVolume` (*type:* `String.t`, *default:* `nil`) - Required. The minimum percentage of the video ad's volume required in order for an impression to be recorded.
  """

  use GoogleApi.Gax.ModelBase

  @type t :: %__MODULE__{
          :displayName => String.t() | nil,
          :minimumDuration => String.t() | nil,
          :minimumQuartile => String.t() | nil,
          :minimumViewability => String.t() | nil,
          :minimumVolume => String.t() | nil
        }

  field(:displayName)
  field(:minimumDuration)
  field(:minimumQuartile)
  field(:minimumViewability)
  field(:minimumVolume)
end

defimpl Poison.Decoder,
  for: GoogleApi.DisplayVideo.V1.Model.ActiveViewVideoViewabilityMetricConfig do
  def decode(value, options) do
    GoogleApi.DisplayVideo.V1.Model.ActiveViewVideoViewabilityMetricConfig.decode(value, options)
  end
end

defimpl Poison.Encoder,
  for: GoogleApi.DisplayVideo.V1.Model.ActiveViewVideoViewabilityMetricConfig do
  def encode(value, options) do
    GoogleApi.Gax.ModelBase.encode(value, options)
  end
end