Kpi

import type { Kpi } from "https://googleapis.deno.dev/v1/displayvideo:v3.ts";

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

interface Kpi {

kpiAlgorithmId?: bigint;

kpiAmountMicros?: bigint;

kpiPercentageMicros?: bigint;

kpiString?: string;

kpiType?:

| "KPI_TYPE_UNSPECIFIED"

| "KPI_TYPE_CPM"

| "KPI_TYPE_CPC"

| "KPI_TYPE_CPA"

| "KPI_TYPE_CTR"

| "KPI_TYPE_VIEWABILITY"

| "KPI_TYPE_CPIAVC"

| "KPI_TYPE_CPE"

| "KPI_TYPE_CPV"

| "KPI_TYPE_CLICK_CVR"

| "KPI_TYPE_IMPRESSION_CVR"

| "KPI_TYPE_VCPM"

| "KPI_TYPE_VTR"

| "KPI_TYPE_AUDIO_COMPLETION_RATE"

| "KPI_TYPE_VIDEO_COMPLETION_RATE"

| "KPI_TYPE_CPCL"

| "KPI_TYPE_CPCV"

| "KPI_TYPE_TOS10"

| "KPI_TYPE_MAXIMIZE_PACING"

| "KPI_TYPE_CUSTOM_IMPRESSION_VALUE_OVER_COST"

| "KPI_TYPE_OTHER";

}

§Properties

kpiAlgorithmId?: bigint

[src]

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?: bigint

[src]

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?: bigint

[src]

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?: string

[src]

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.

[src]

Required. The type of KPI.