Campaign Manager 360 API v3.4 已被弃用,并将于 2021 年 12 月 24 日停用。所有用户都必须在该截止日期之前迁移到新版 API。

FloodlightActivities

有关此类资源的方法列表,请参阅本页面的结尾部分。

资源表示形式

包含某项 Floodlight 活动的各个属性。

{
  "kind": "dfareporting#floodlightActivity",
  "id": long,
  "idDimensionValue": dimensionValues Resource,
  "name": string,
  "tagString": string,
  "expectedUrl": string,
  "secure": boolean,
  "status": string,
  "floodlightTagType": string,
  "countingMethod": string,
  "tagFormat": string,
  "cacheBustingType": string,
  "userDefinedVariableTypes": [
    string
  ],
  "notes": string,
  "defaultTags": [
    {
      "id": long,
      "name": string,
      "tag": string
    }
  ],
  "publisherTags": [
    {
      "dynamicTag": {
        "id": long,
        "name": string,
        "tag": string
      },
      "siteId": long,
      "siteIdDimensionValue": dimensionValues Resource,
      "directorySiteId": long,
      "clickThrough": boolean,
      "viewThrough": boolean
    }
  ],
  "floodlightActivityGroupId": long,
  "floodlightConfigurationId": long,
  "floodlightConfigurationIdDimensionValue": dimensionValues Resource,
  "advertiserId": long,
  "advertiserIdDimensionValue": dimensionValues Resource,
  "subaccountId": long,
  "accountId": long,
  "floodlightActivityGroupType": string,
  "floodlightActivityGroupTagString": string,
  "floodlightActivityGroupName": string,
  "sslCompliant": boolean,
  "sslRequired": boolean,
  "attributionEnabled": boolean
}
属性名称 说明 备注
accountId long 此 Floodlight 活动所对应的帐号 ID。此字段是只读字段,可以留空。
advertiserId long 此 Floodlight 活动所对应的广告客户 ID。如果将此字段留空,系统会复制活动组的广告客户的 ID 或现有活动的广告客户的 ID。
advertiserIdDimensionValue nested object 广告客户 ID 的维度值。此字段是自动生成的只读字段。
attributionEnabled boolean 表示是否为此活动启用了归因。
cacheBustingType string 生成的代码中用于缓存无效化的代码类型。仅当 floodlightActivityGroupTypeCOUNTERcountingMethodSTANDARD_COUNTINGUNIQUE_COUNTING 时适用。

可接受的值为:
  • ACTIVE_SERVER_PAGE
  • COLD_FUSION
  • JAVASCRIPT
  • JSP
  • PHP
countingMethod string 此 Floodlight 活动的转化次数统计方法。此字段是必填字段。

可接受的值为:
  • ITEMS_SOLD_COUNTING”:
    统计每次转化,以及售出商品总数和总销售收入
  • SESSION_COUNTING”:
    为每位用户的每次会话统计一次转化。会话长度由部署该 Floodlight 代码的网站设定。
  • STANDARD_COUNTING”:统计每次转化。
  • TRANSACTIONS_COUNTING”:
    统计所有转化,以及总交易次数和这些交易的总收入
  • UNIQUE_COUNTING”:
    统计每个唯一身份用户在每 24 小时(美国/纽约时间午夜至次日午夜)内的首次转化。
defaultTags[] list 动态 Floodlight 代码。
defaultTags[].id long 此动态代码的 ID。此字段是自动生成的只读字段。
defaultTags[].name string 此代码的名称。
defaultTags[].tag string 代码。
expectedUrl string 此代码将部署到的网址。如果指定,网址长度必须少于 256 个字符。
floodlightActivityGroupId long 此 Floodlight 活动的 Floodlight 活动组 ID。此字段是必填字段。
floodlightActivityGroupName string 关联的 Floodlight 活动组的名称。此字段是只读字段。
floodlightActivityGroupTagString string 关联的 Floodlight 活动组的代码字符串。此字段是只读字段。
floodlightActivityGroupType string 关联的 Floodlight 活动组的类型。此字段是只读字段。

可接受的值为:
  • COUNTER
  • SALE
floodlightConfigurationId long 此 Floodlight 活动的 Floodlight 配置 ID。如果将此字段留空,系统会复制活动组的 Floodlight 配置的 ID 或现有活动的 Floodlight 配置的 ID。
floodlightConfigurationIdDimensionValue nested object Floodlight 配置的 ID 的维度值。此字段是自动生成的只读字段。
floodlightTagType string 此活动将生成的 Floodlight 代码的类型。此字段是必填字段。

可接受的值为:
  • GLOBAL_SITE_TAG
  • IFRAME
  • IMAGE
id long 此 Floodlight 活动的 ID。此字段是自动生成的只读字段。
idDimensionValue nested object 此 Floodlight 活动的 ID 的维度值。此字段是自动生成的只读字段。
kind string 表明这是哪类资源。值:固定字符串 "dfareporting#floodlightActivity"
name string 此 Floodlight 活动的名称。此字段是必填字段。长度必须少于 129 个字符,且不得包含引号。
notes string 对此代码的一般备注或实现说明。
publisherTags[] list 发布商的动态 Floodlight 代码。
publisherTags[].clickThrough boolean 此代码是否仅适用于点击型转化。
publisherTags[].directorySiteId long 此动态代码的目录网站 ID。此字段是只写字段,可用作 siteId 字段的替代字段。当检索此资源时,系统仅会填充 siteId 字段。
publisherTags[].dynamicTag nested object 动态 Floodlight 代码。
publisherTags[].dynamicTag.id long 此动态代码的 ID。此字段是自动生成的只读字段。
publisherTags[].dynamicTag.name string 此代码的名称。
publisherTags[].dynamicTag.tag string 代码。
publisherTags[].siteId long 此动态代码的网站 ID。
publisherTags[].siteIdDimensionValue nested object 网站的 ID 的维度值。此字段是自动生成的只读字段。
publisherTags[].viewThrough boolean 此代码是否仅适用于浏览型转化。
secure boolean 此代码是否应使用 SSL。
sslCompliant boolean 此 Floodlight 活动是否符合 SSL 规范。此字段是只读字段,系统会通过 Floodlight 代码检测其值。
sslRequired boolean 此 Floodlight 活动是否必须符合 SSL 规范。
status string 此活动的状态。此值只能设置为 ACTIVEARCHIVED_AND_DISABLEDARCHIVED 状态不再受支持,因而无法为 Floodlight 活动设置这种状态。DISABLED_POLICY 状态指示 Floodlight 活动违反了 Google 政策。如需了解详情,请与您的客户经理联系。

可接受的值为:
  • ACTIVE
  • ARCHIVED
  • ARCHIVED_AND_DISABLED
  • DISABLED_POLICY
subaccountId long 此 Floodlight 活动所对应的子帐号 ID。此字段是只读字段,可以留空。
tagFormat string 此 Floodlight 活动的代码格式类型。如果留空,代码格式将默认为 HTML

可接受的值为:
  • HTML
  • XHTML
tagString string Floodlight 代码中的 cat= 参数的值,供广告服务器用于标识活动。此字段是选填字段:如果将此字段留空,系统会为您生成一个新的代码字符串。此字符串的长度必须介于 1 到 8 个字符之间,可以使用的有效字符为:[a-z][A-Z][0-9][-][ _ ]。此代码字符串在同一活动组的活动中必须是唯一的。在插入后,此字段是只读字段。
userDefinedVariableTypes[] list 此转化代码使用的用户定义的变量列表。这些变量对应于代码中的“u[1-100]=”。其中的每个变量都可以有一种用户定义的类型。

可接受的值为 U1U100(含)。

方法

delete
用于删除现有的 Floodlight 活动。
generatetag
用于为 Floodlight 活动生成代码。
get
用于根据 ID 获取一项 Floodlight 活动。
insert
用于插入新的 Floodlight 活动。
list
用于检索 Floodlight 活动的列表,检索到的可能是经过了过滤的列表。此方法支持分页
patch
用于更新现有的 Floodlight 活动。此方法支持修补语义
update
用于更新现有的 Floodlight 活动。