周期性受众群体名单

本文档介绍了周期性受众群体名单, Google Analytics Data API v1 的高级功能。 如需简要了解受众群体名单导出功能 请参阅受众群体导出基础知识指南

定期生成的受众群体名单会每天生成受众群体名单 受众群体成员资格会发生变化,以确保您使用的是最新数据。

常规(非周期性)受众群体名单是相应受众群体中所含用户的静态名单 。

每天创建一个新的受众群体名单

处理一天的受众群体数据并更新所需时间并不固定 会员资格。系统无法在 24 小时。

例如,即使您在每天的同一时间请求受众群体名单, 有时,受众群体名单会保持不变 而在其他日期,受众群体名单会有所不同 包含额外一天的成员资格变更。

每天创建新的受众群体名单

受众群体名单是根据最近一天事件数据生成的 成员资格变更。如果您在成为每日会员之前创建受众群体名单 更新时,将使用两天前的数据。如果您创建 受众群体名单之后,它会使用来自以下来源的数据: 。

定期轮询周期性受众群体名单

定期生成的受众群体名单仅会在额外一天的投放前生成 数据可用。这样,您无需猜测何时创建新 受众群体名单。您可以低成本对定期重复的受众群体名单进行轮询, 看看是否有其他数据可用。

在一天中定期轮询周期性受众群体名单

创建周期性受众群体名单

要创建周期性受众群体名单,请调用 recurringAudienceLists.create 方法使用 RecurringAudienceList 对象。以下是必填参数:

  • 必须填写 audience 字段,格式为 properties/{propertyId}/audiences/{audienceId}。 您可以使用 audiences.list 方法获取此值。通过 Audience.name audiences.list响应的 字段包含受众群体名称。
  • 有效维度列表 dimensions 字段。此方法支持的维度列表可在 受众群体导出架构文档。 只有与此字段提及的维度对应的数据才会纳入到 受众群体名单

以下是周期性受众群体名单创建请求的示例:

HTTP 请求

POST https://analyticsdata.googleapis.com/v1alpha/properties/1234567/recurringAudienceLists
{
  "audience": "properties/1234567/audiences/12345",
  "dimensions": [
    {
      "dimensionName": "deviceId"
    }
  ]
}

recurringAudienceLists.create 方法的响应包含 name 字段中的名称(例如 properties/1234567/recurringAudienceLists/123),后者可用于 用于检索配置元数据的后续查询 此周期性受众群体名单此外,配置元数据包含 受众群体名单实例的资源名称 此周期性受众群体名单

HTTP 响应

{
  "name": "properties/1234567/recurringAudienceLists/123",
  "audience": "properties/1234567/audiences/12345",
  "audienceDisplayName": "Purchasers",
  "dimensions": [
    {
      "dimensionName": "deviceId"
    }
  ],
  "activeDaysRemaining": 180,
  "audienceLists": [
    "properties/1234567/audienceLists/45678"
  ]
}

投票配置元数据

使用 recurringAudienceLists.get 方法来检索特定资源的配置元数据 周期性受众群体名单配置元数据包含 受众群体名单实例的资源名称 此周期性受众群体名单

示例如下:

HTTP 请求

GET https://analyticsdata.googleapis.com/v1alpha/properties/1234567/recurringAudienceLists/123

RecurringAudienceList 的实例 返回的值。它包含配置元数据,其中包括 受众群体名单实例的资源名称 此周期性受众群体名单

HTTP 响应

{
  "name": "properties/1234567/recurringAudienceLists/123",
  "audience": "properties/1234567/audiences/12345",
  "audienceDisplayName": "Purchasers",
  "dimensions": [
    {
      "dimensionName": "deviceId"
    }
  ],
  "activeDaysRemaining": 180,
  "audienceLists": [
    "properties/1234567/audienceLists/45678"
  ]
}

您可以使用 recurringAudienceLists.list 来列出媒体资源的所有周期性受众群体名单。

使用网络钩子接收有关新受众群体名单的异步通知

您不必定期轮询特定资源的配置元数据 使用 recurringAudienceLists.get 方法时,您可以在有事件发生时异步接收网络钩子通知 列表可用。

如需配置网络钩子通知,请指定 webhookNotification 字段。

按照 Async audience lists with webhooks 指南执行操作 。

检索受众群体导出中的用户

要在受众群体导出中检索用户,请调用 audienceExports.query 方法并指定受众群体导出名称 检索自该 API 提供的配置元数据, recurringAudienceLists.getrecurringAudienceLists.list

HTTP 请求

POST https://analyticsdata.googleapis.com/v1beta/properties/1234567/audienceExports/123:query

如果受众群体导出功能已准备就绪,系统将返回一个包含 返回受众群体中的用户:

HTTP 响应

{
  "audienceExport": {
    "name": "properties/1234567/audienceExports/123",
    "audience": "properties/1234567/audiences/12345",
    "audienceDisplayName": "Purchasers",
    "dimensions": [
      {
        "dimensionName": "deviceId"
      }
    ],
    "state": "ACTIVE",
    "beginCreatingTime": "2023-06-22T23:35:28.787910949Z"
  },
  "audienceRows": [
    {
      "dimensionValues": [
        {
          "value": "1000276123.1681742376"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1000374452.1668627377"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1000391956.1652750758"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1000410539.1682018694"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1000703969.1666725875"
        }
      ]
    }
  ],
  "rowCount": 5
}