CustomEvents: batchinsert

插入自定义事件。立即试用

请求

HTTP 请求

POST https://www.googleapis.com/dfareporting/v3.4/userprofiles/profileId/customEvents/batchinsert

参数

参数名称 说明
路径参数
profileId long 与此请求相关联的用户个人资料 ID。

授权

此请求需要获得以下范围的授权:

范围
https://www.googleapis.com/auth/ddmconversions

如需了解详情,请参阅身份验证和授权页面。

请求正文

在请求正文中,请按以下结构提供数据:

{
  "kind": "dfareporting#customEventsBatchInsertRequest",
  "customEvents": [
    {
      "kind": "dfareporting#customEvent",
      "floodlightConfigurationId": long,
      "customVariables": [
        {
          "kind": "dfareporting#customVariable",
          "index": long,
          "value": string
        }
      ],
      "timestampMicros": long,
      "ordinal": string,
      "eventType": string,
      "insertEvent": {
        "kind": "dfareporting#customEventInsert",
        "mobileDeviceId": string,
        "matchId": string,
        "cmDimensions": {
          "kind": "dfareporting#campaignManagerIds",
          "campaignId": long,
          "placementId": long,
          "adId": long,
          "creativeId": long,
          "siteId": long
        },
        "dv3Dimensions": {
          "kind": "dfareporting#dV3Ids",
          "dvCampaignId": long,
          "dvInsertionOrderId": long,
          "dvLineItemId": long,
          "dvCreativeId": long,
          "dvSiteId": long
        },
        "insertEventType": string
      },
      "annotateClickEvent": {
        "kind": "dfareporting#customEventClickAnnotation",
        "gclid": string
      },
      "annotateImpressionEvent": {
        "kind": "dfareporting#customEventImpressionAnnotation",
        "pathImpressionId": string
      }
    }
  ]
}
属性名称 说明 备注
kind string 标识所属资源种类。值:固定字符串 "dfareporting#customEventsBatchInsertRequest"
customEvents[] list 要插入的自定义事件集。
customEvents[].kind string 标识所属资源种类。值:固定字符串 "dfareporting#customEvent"
customEvents[].floodlightConfigurationId long 与事件相关联的广告客户的 Floodlight 配置 ID。此字段是必填字段。
customEvents[].customVariables[] list 与事件相关联的自定义变量。
customEvents[].customVariables[].kind string 标识所属资源种类。值:固定字符串 "dfareporting#customVariable"
customEvents[].customVariables[].index long 自定义变量的索引。
customEvents[].customVariables[].value string 自定义变量的值。此字符串的长度不得超过 50 个字符。
customEvents[].timestampMicros long 此自定义事件的时间戳(自 Unix 新纪元至今的时间,以微秒为单位)。此字段是必填字段。
customEvents[].ordinal string 此自定义事件的序数。此字段是必填字段。
customEvents[].eventType string 事件的类型。如果为 INSERT,则需要填充 insertEvent 中的字段。如果为 ANNOTATE,则需要填充 annotateClickEventannotateImpressionEvent 中的字段。

可接受的值包括:
  • ANNOTATE
  • INSERT
  • UNKNOWN
customEvents[].insertEvent nested object 插入自定义事件。此字段与 annotateClickEventannotateImpressionEvent 互斥。此字段或 annotateClickEventannotateImpressionEvent 为必填字段。
customEvents[].insertEvent.kind string 标识所属资源种类。值:固定字符串 "dfareporting#customEventInsert"
customEvents[].insertEvent.mobileDeviceId string 移动设备 ID。此字段与 matchId 互斥,且这两个字段中至少有一个为必填字段。
customEvents[].insertEvent.matchId string 匹配 ID 字段。匹配 ID 是您的第一方标识符,该标识符已通过 Floodlight 中的匹配 ID 功能与 Google 同步。此字段与 mobileDeviceId 互斥,且这两个字段中至少有一个为必填字段。
customEvents[].insertEvent.cmDimensions nested object 与事件相关联的 Campaign Manager 维度。
customEvents[].insertEvent.cmDimensions.kind string 标识所属资源种类。值:固定字符串 "dfareporting#campaignManagerIds"
customEvents[].insertEvent.cmDimensions.campaignId long Campaign Manager 的广告系列 ID。
customEvents[].insertEvent.cmDimensions.placementId long Campaign Manager 的展示位置 ID。
customEvents[].insertEvent.cmDimensions.adId long Campaign Manager 的广告 ID。
customEvents[].insertEvent.cmDimensions.creativeId long Campaign Manager 的广告素材 ID。
customEvents[].insertEvent.cmDimensions.siteId long Campaign Manager 的网站 ID。
customEvents[].insertEvent.dv3Dimensions nested object 与事件相关联的 DV360 维度。
customEvents[].insertEvent.dv3Dimensions.kind string 标识所属资源种类。值:固定字符串 "dfareporting#dV3Ids"
customEvents[].insertEvent.dv3Dimensions.dvCampaignId long DV360 的广告系列 ID。
customEvents[].insertEvent.dv3Dimensions.dvInsertionOrderId long DV360 的广告订单 ID。
customEvents[].insertEvent.dv3Dimensions.dvLineItemId long DV360 的订单项 ID。
customEvents[].insertEvent.dv3Dimensions.dvCreativeId long DV360 的广告素材 ID。
customEvents[].insertEvent.dv3Dimensions.dvSiteId long DV360 的网站 ID。
customEvents[].insertEvent.insertEventType string 要插入的事件类型。

可接受的值包括:
  • CLICK
  • IMPRESSION
  • UNKNOWN
customEvents[].annotateClickEvent nested object 为点击事件添加注释。此字段与 insertEventannotateImpressionEvent 互斥。此字段或 insertEventannotateImpressionEvent 为必填字段。
customEvents[].annotateClickEvent.kind string 标识所属资源种类。值:固定字符串 "dfareporting#customEventClickAnnotation"
customEvents[].annotateClickEvent.gclid string Google 点击 ID。使用此字段为与 gclid 相关联的点击添加注释。
customEvents[].annotateImpressionEvent nested object 为展示添加注释。此字段与 insertEventannotateClickEvent 互斥。此字段或 insertEventannotateClickEvent 为必填字段。
customEvents[].annotateImpressionEvent.kind string 标识所属资源种类。值:固定字符串 "dfareporting#customEventImpressionAnnotation"
customEvents[].annotateImpressionEvent.pathImpressionId string 路径展示 ID。使用此字段为与 pathImpressionId 相关联的展示添加注释。

响应

如果成功,此方法将返回具有以下结构的响应正文:

{
  "kind": "dfareporting#customEventsBatchInsertResponse",
  "hasFailures": boolean,
  "status": [
    {
      "kind": "dfareporting#customEventStatus",
      "customEvent": {
        "kind": "dfareporting#customEvent",
        "floodlightConfigurationId": long,
        "customVariables": [
          {
            "kind": "dfareporting#customVariable",
            "index": long,
            "value": string
          }
        ],
        "timestampMicros": long,
        "ordinal": string,
        "eventType": string,
        "insertEvent": {
          "kind": "dfareporting#customEventInsert",
          "mobileDeviceId": string,
          "matchId": string,
          "cmDimensions": {
            "kind": "dfareporting#campaignManagerIds",
            "campaignId": long,
            "placementId": long,
            "adId": long,
            "creativeId": long,
            "siteId": long
          },
          "dv3Dimensions": {
            "kind": "dfareporting#dV3Ids",
            "dvCampaignId": long,
            "dvInsertionOrderId": long,
            "dvLineItemId": long,
            "dvCreativeId": long,
            "dvSiteId": long
          },
          "insertEventType": string
        },
        "annotateClickEvent": {
          "kind": "dfareporting#customEventClickAnnotation",
          "gclid": string
        },
        "annotateImpressionEvent": {
          "kind": "dfareporting#customEventImpressionAnnotation",
          "pathImpressionId": string
        }
      },
      "errors": [
        {
          "kind": "dfareporting#customEventError",
          "code": string,
          "message": string
        }
      ]
    }
  ]
}
属性名称 说明 备注
kind string 标识所属资源种类。值:固定字符串 "dfareporting#customEventsBatchInsertResponse"
hasFailures boolean 表示无法插入部分或所有自定义事件。
status[] list 每个自定义事件的插入状态。状态的返回顺序与转化数据的插入顺序相同。
status[].customEvent nested object 插入的原始自定义事件。
status[].errors[] list 与此自定义事件相关的错误列表。
status[].errors[].kind string 标识所属资源种类。值:固定字符串 "dfareporting#customEventError"
status[].errors[].code string 错误代码。

可接受的值包括:
  • INTERNAL
  • INVALID_ARGUMENT
  • NOT_FOUND
  • PERMISSION_DENIED
  • UNKNOWN
status[].errors[].message string 错误的说明。
status[].kind string 标识所属资源种类。值:固定字符串 "dfareporting#customEventStatus"
status[].customEvent.kind string 标识所属资源种类。值:固定字符串 "dfareporting#customEvent"
status[].customEvent.floodlightConfigurationId long 与事件相关联的广告客户的 Floodlight 配置 ID。此字段是必填字段。
status[].customEvent.customVariables[] list 与事件相关联的自定义变量。
status[].customEvent.customVariables[].kind string 标识所属资源种类。值:固定字符串 "dfareporting#customVariable"
status[].customEvent.customVariables[].index long 自定义变量的索引。
status[].customEvent.customVariables[].value string 自定义变量的值。此字符串的长度不得超过 50 个字符。
status[].customEvent.timestampMicros long 此自定义事件的时间戳(自 Unix 新纪元至今的时间,以微秒为单位)。此字段是必填字段。
status[].customEvent.ordinal string 此自定义事件的序数。此字段是必填字段。
status[].customEvent.eventType string 事件的类型。如果为 INSERT,则需要填充 insertEvent 中的字段。如果为 ANNOTATE,则需要填充 annotateClickEventannotateImpressionEvent 中的字段。

可接受的值包括:
  • ANNOTATE
  • INSERT
  • UNKNOWN
status[].customEvent.insertEvent nested object 插入自定义事件。此字段与 annotateClickEventannotateImpressionEvent 互斥。此字段或 annotateClickEventannotateImpressionEvent 为必填字段。
status[].customEvent.insertEvent.kind string 标识所属资源种类。值:固定字符串 "dfareporting#customEventInsert"
status[].customEvent.insertEvent.mobileDeviceId string 移动设备 ID。此字段与 matchId 互斥,且这两个字段中至少有一个为必填字段。
status[].customEvent.insertEvent.matchId string 匹配 ID 字段。匹配 ID 是您的第一方标识符,该标识符已通过 Floodlight 中的匹配 ID 功能与 Google 同步。此字段与 mobileDeviceId 互斥,且这两个字段中至少有一个为必填字段。
status[].customEvent.insertEvent.cmDimensions nested object 与事件相关联的 Campaign Manager 维度。
status[].customEvent.insertEvent.cmDimensions.kind string 标识所属资源种类。值:固定字符串 "dfareporting#campaignManagerIds"
status[].customEvent.insertEvent.cmDimensions.campaignId long Campaign Manager 的广告系列 ID。
status[].customEvent.insertEvent.cmDimensions.placementId long Campaign Manager 的展示位置 ID。
status[].customEvent.insertEvent.cmDimensions.adId long Campaign Manager 的广告 ID。
status[].customEvent.insertEvent.cmDimensions.creativeId long Campaign Manager 的广告素材 ID。
status[].customEvent.insertEvent.cmDimensions.siteId long Campaign Manager 的网站 ID。
status[].customEvent.insertEvent.dv3Dimensions nested object 与事件相关联的 DV360 维度。
status[].customEvent.insertEvent.dv3Dimensions.kind string 标识所属资源种类。值:固定字符串 "dfareporting#dV3Ids"
status[].customEvent.insertEvent.dv3Dimensions.dvCampaignId long DV360 的广告系列 ID。
status[].customEvent.insertEvent.dv3Dimensions.dvInsertionOrderId long DV360 的广告订单 ID。
status[].customEvent.insertEvent.dv3Dimensions.dvLineItemId long DV360 的订单项 ID。
status[].customEvent.insertEvent.dv3Dimensions.dvCreativeId long DV360 的广告素材 ID。
status[].customEvent.insertEvent.dv3Dimensions.dvSiteId long DV360 的网站 ID。
status[].customEvent.insertEvent.insertEventType string 要插入的事件类型。

可接受的值包括:
  • CLICK
  • IMPRESSION
  • UNKNOWN
status[].customEvent.annotateClickEvent nested object 为点击事件添加注释。此字段与 insertEventannotateImpressionEvent 互斥。此字段或 insertEventannotateImpressionEvent 为必填字段。
status[].customEvent.annotateClickEvent.kind string 标识所属资源种类。值:固定字符串 "dfareporting#customEventClickAnnotation"
status[].customEvent.annotateClickEvent.gclid string Google 点击 ID。使用此字段为与 gclid 相关联的点击添加注释。
status[].customEvent.annotateImpressionEvent nested object 为展示添加注释。此字段与 insertEventannotateClickEvent 互斥。此字段或 insertEventannotateClickEvent 为必填字段。
status[].customEvent.annotateImpressionEvent.kind string 标识所属资源种类。值:固定字符串 "dfareporting#customEventImpressionAnnotation"
status[].customEvent.annotateImpressionEvent.pathImpressionId string 路径展示 ID。使用此字段为与 pathImpressionId 相关联的展示添加注释。

试试看!

使用下面的 API Explorer 对实际数据调用此方法,然后查看响应。