REST Resource: floodlightGroups

リソース: FloodlightGroup

単一の Floodlight グループ。

JSON 表現
{
  "name": string,
  "floodlightGroupId": string,
  "displayName": string,
  "webTagType": enum (WebTagType),
  "lookbackWindow": {
    object (LookbackWindow)
  },
  "customVariables": {
    object
  },
  "activeViewConfig": {
    object (ActiveViewVideoViewabilityMetricConfig)
  }
}
フィールド
name

string

出力専用。Floodlight グループのリソース名。

floodlightGroupId

string (int64 format)

出力専用。Floodlight グループの一意の ID。システムによって割り当てられます。

displayName

string

必須。Floodlight グループの表示名。

webTagType

enum (WebTagType)

必須。Floodlight グループで有効になっているウェブタグタイプ。

lookbackWindow

object (LookbackWindow)

必須。Floodlight グループのルックバック ウィンドウ。clickDays と impressionDays の両方が必要です。どちらの値も、0~90 の範囲で指定できます。

customVariables

object (Struct format)

Floodlight グループが所有するユーザー定義カスタム変数。カスタム Floodlight 変数を使用すると、ビジネスニーズに合わせてレポートデータを作成できます。カスタム Floodlight 変数は、キーとして U1=、U2= などを使用し、渡された任意の値を取り込むことができます。Floodlight 変数は、ユーザーに関して収集したあらゆるタイプのデータをトラッキングするために使用できる Key-Value です。データの例として、ユーザーが購入した映画のジャンル、商品の出荷先の国などが挙げられます。

カスタム Floodlight 変数を使用して、個人情報(PII)として使用または認識され得るデータを渡すことは禁止されています。

例: customVariables { fields { "U1": value { numberValue: 123.4 }, "U2": value { stringValue: "MyVariable2" }, "U3": value { stringValue: "MyVariable3" } } }

キーに指定できる値は「U1」~「U100」です。文字列値は 64 文字未満で指定します。次の文字を含めることはできません: "<>。

activeViewConfig

object (ActiveViewVideoViewabilityMetricConfig)

Floodlight グループのアクティブ ビュー動画視認性指標の設定。

WebTagType

Floodlight グループで使用できるウェブタグの種類。

列挙型
WEB_TAG_TYPE_UNSPECIFIED このバージョンでタイプ値が指定されていないか、不明です。
WEB_TAG_TYPE_NONE タグタイプなし。
WEB_TAG_TYPE_IMAGE 画像タグ。
WEB_TAG_TYPE_DYNAMIC ダイナミック タグ。

LookbackWindow

コンバージョンを記録するかどうかを判定する際に、確認のために遡る日数を指定します。

JSON 表現
{
  "clickDays": integer,
  "impressionDays": integer
}
フィールド
clickDays

integer

特定のユーザーがいずれかの広告を最後にクリックしたとき以降のルックバック ウィンドウ(日数)。

impressionDays

integer

特定のユーザーが広告の 1 つを最後に閲覧した日を起点とするルックバック ウィンドウ(日数)。

ActiveViewVideoViewabilityMetricConfig

カスタム アクティブ ビュー動画視認性指標の設定。

JSON 表現
{
  "displayName": string,
  "minimumViewability": enum (VideoViewabilityPercent),
  "minimumVolume": enum (VideoVolumePercent),
  "minimumDuration": enum (VideoDurationSeconds),
  "minimumQuartile": enum (VideoDurationQuartile)
}
フィールド
displayName

string

必須。カスタム指標の表示名。

minimumViewability

enum (VideoViewabilityPercent)

必須。インプレッションが記録されるために、画面に表示された動画広告のピクセルの最小割合。

minimumVolume

enum (VideoVolumePercent)

必須。インプレッションが記録されるために必要な動画広告の音量の最小割合。

minimumDuration

enum (VideoDurationSeconds)

インプレッションを記録するために必要な動画の表示時間(秒単位)。

minimumDuration または minimumQuartile のいずれか、または両方を指定する必要があります。両方の要件を選択した場合、いずれかの要件(早い方)を満たしたインプレッションがこの指標で記録されます。

minimumQuartile

enum (VideoDurationQuartile)

インプレッションを記録するために必要な、動画の四分位に基づく最低限必要な表示時間。

minimumDuration または minimumQuartile のいずれか、または両方を指定する必要があります。両方の要件を選択した場合、いずれかの要件(早い方)を満たしたインプレッションがこの指標で記録されます。

VideoViewabilityPercent

動画広告の表示ピクセルの割合の値。

列挙型
VIEWABILITY_PERCENT_UNSPECIFIED このバージョンでは値が指定されていないか、不明です。
VIEWABILITY_PERCENT_0 0% が視認可能。
VIEWABILITY_PERCENT_25 25% 視認可能。
VIEWABILITY_PERCENT_50 50% 視認可能。
VIEWABILITY_PERCENT_75 75% 視認可能。
VIEWABILITY_PERCENT_100 100% 視認可能。

VideoVolumePercent

動画広告の再生音量の有効な割合値。

列挙型
VIDEO_VOLUME_PERCENT_UNSPECIFIED このバージョンでは値が指定されていないか、不明です。
VIDEO_VOLUME_PERCENT_0 音量 0%
VIDEO_VOLUME_PERCENT_10 音量 10%

VideoDurationSeconds

動画広告の表示時間(秒単位)。指定できる値は次のとおりです。

列挙型
VIDEO_DURATION_UNSPECIFIED このバージョンでは値が指定されていないか、不明です。
VIDEO_DURATION_SECONDS_NONE 時間の値なし。
VIDEO_DURATION_SECONDS_0 0 秒。
VIDEO_DURATION_SECONDS_1 1 秒。
VIDEO_DURATION_SECONDS_2 2 秒。
VIDEO_DURATION_SECONDS_3 3 秒間。
VIDEO_DURATION_SECONDS_4 4 秒。
VIDEO_DURATION_SECONDS_5 5 秒。
VIDEO_DURATION_SECONDS_6 6 秒。
VIDEO_DURATION_SECONDS_7 7 秒。
VIDEO_DURATION_SECONDS_8 8 秒。
VIDEO_DURATION_SECONDS_9 9 秒。
VIDEO_DURATION_SECONDS_10 10 秒。
VIDEO_DURATION_SECONDS_11 11 秒。
VIDEO_DURATION_SECONDS_12 12 秒。
VIDEO_DURATION_SECONDS_13 13 秒。
VIDEO_DURATION_SECONDS_14 14 秒。
VIDEO_DURATION_SECONDS_15 15 秒。
VIDEO_DURATION_SECONDS_30 30 秒。
VIDEO_DURATION_SECONDS_45 45 秒。
VIDEO_DURATION_SECONDS_60 60 秒。

VideoDurationQuartile

動画広告の表示時間の四分位の値。

列挙型
VIDEO_DURATION_QUARTILE_UNSPECIFIED このバージョンでは値が指定されていないか、不明です。
VIDEO_DURATION_QUARTILE_NONE 四分位の値なし。
VIDEO_DURATION_QUARTILE_FIRST 第 1 四分位。
VIDEO_DURATION_QUARTILE_SECOND 第 2 四分位(中央値)。
VIDEO_DURATION_QUARTILE_THIRD 第 3 四分位。
VIDEO_DURATION_QUARTILE_FOURTH 第 4 四分位(完了)。

メソッド

get

Floodlight グループを取得します。

patch

既存の Floodlight グループを更新します。