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 群組的回溯期。clickDaysimpressionDays 皆為必要欄位。兩者可接受的值為 090 (含頭尾)。

customVariables

object (Struct format)

Floodlight 群組擁有的使用者定義自訂變數。Floodlight 自訂變數可用來建立符合獨特業務需求的報表資料。Floodlight 自訂變數使用 U1=U2= 等鍵,也可接受任何您選擇傳送的值。可用來追蹤您針對顧客收集的任何類型資料,例如客戶購買的電影類型、商品運達國家/地區等。

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 群組。