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 变量传递任何可被用作或识别为个人身份信息 (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 活动组。