View Source GoogleApi.DisplayVideo.V3.Model.Kpi (google_api_display_video v0.37.2)

Settings that control the key performance indicator, or KPI, of an insertion order.

Attributes

  • kpiAlgorithmId (type: String.t, default: nil) - Optional. Custom Bidding Algorithm ID associated with KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST. This field is ignored if the proper KPI is not selected.
  • kpiAmountMicros (type: String.t, default: nil) - The goal amount, in micros of the advertiser's currency. Applicable when kpi_type is one of: KPI_TYPE_CPM KPI_TYPE_CPC KPI_TYPE_CPA KPI_TYPE_CPIAVC * KPI_TYPE_VCPM For example: 1500000 represents 1.5 standard units of the currency.
  • kpiPercentageMicros (type: String.t, default: nil) - The decimal representation of the goal percentage in micros. Applicable when kpi_type is one of: KPI_TYPE_CTR KPI_TYPE_VIEWABILITY KPI_TYPE_CLICK_CVR KPI_TYPE_IMPRESSION_CVR KPI_TYPE_VTR KPI_TYPE_AUDIO_COMPLETION_RATE * KPI_TYPE_VIDEO_COMPLETION_RATE For example: 70000 represents 7% (decimal 0.07).
  • kpiString (type: String.t, default: nil) - A KPI string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when kpi_type is KPI_TYPE_OTHER.
  • kpiType (type: String.t, default: nil) - Required. The type of KPI.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() :: %GoogleApi.DisplayVideo.V3.Model.Kpi{
  kpiAlgorithmId: String.t() | nil,
  kpiAmountMicros: String.t() | nil,
  kpiPercentageMicros: String.t() | nil,
  kpiString: String.t() | nil,
  kpiType: String.t() | nil
}

Functions

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.