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 代碼來追蹤任何一種您針對客戶收集的資料,例如客戶購買的電影類型、商品運達國家/地區等等。

Floodlight 自訂變數不得用於傳送任何可當做或視為個人識別資訊 (PII) 的資料。

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

可接受的鍵值為「U1」至「U100」之間 (含首尾)字串值的長度必須少於 64 個字元,而且不能包含下列字元:"<>。

activeViewConfig

object (ActiveViewVideoViewabilityMetricConfig)

Floodlight 群組的 Active View 影片可視度指標設定。

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

回溯期 (以天為單位),從特定使用者上次觀看您廣告的時間起算。

ActiveViewVideoViewabilityMetricConfig

Active View 影片可視度指標的設定。

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 播完四分之一。
VIDEO_DURATION_QUARTILE_SECOND 播完四分之二 (中點)。
VIDEO_DURATION_QUARTILE_THIRD 播完四分之三。
VIDEO_DURATION_QUARTILE_FOURTH 第四四分位數 (完成)。

方法

get

取得 Floodlight 群組。

patch

更新現有的 Floodlight 群組。