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”(含 [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 活动组。