繰り返しオーディエンス リスト

このドキュメントでは、繰り返しオーディエンス リストについて説明します。 Google Analytics Data API v1 の高度な機能です。 オーディエンスリストのエクスポート機能の概要については オーディエンスのエクスポートに関する基礎ガイドをご覧ください。

繰り返しオーディエンス リストを使用すると、 最新のデータで作業できるように、オーディエンスのメンバーシップが変更されます。

通常の（自動更新されない）オーディエンス リストは、オーディエンス内の静的なユーザーのリストです。 リストの生成時に有効になります。

新しいオーディエンス リストを毎日作成する

ある日のオーディエンス データを処理して更新を完了するまでにかかる時間は一定ではありません。 できます。オーディエンス リストのデータが 24 時間。

たとえば、オーディエンス リストを毎日同じ時間にリクエストしても、 オーディエンスリストがまったく変わらない日があり 他の日とは異なるオーディエンス リストが使われるため、 メンバーシップの変更の 1 日分が追加されます。

新しいオーディエンス リストを毎日作成する

オーディエンス リストは、直近の 1 日前のイベントデータに基づいています。 変更します。毎日のメンバーシップ登録前にオーディエンス リストを作成した場合 その前の 2 日間のデータが使用されます。新しい オーディエンス リストが毎日更新されると、次の期間のデータが使用されます: 。

定期的なオーディエンス リストを定期的にポーリングする

オーディエンス リストは、次の日付の場合にのみ 使用できます。これにより、推測に頼らずに オーディエンス リスト代わりに、低コストで繰り返しオーディエンス リストをポーリングできます。 追加のデータが利用可能かどうかを確認します。

日中に繰り返しオーディエンス リストを定期的にポーリングする

定期的なオーディエンス リストを作成する

定期的なオーディエンス リストを作成するには、 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 プロパティの定期的なオーディエンス リストの一覧を取得します。

Webhook を使用して、新しいオーディエンス リストに関する非同期通知を受け取る

特定のリソースに関する構成メタデータを定期的にポーリングし、 オーディエンスリストの作成、 recurringAudienceLists.get 場合、Webhook 通知を非同期で受信できます。 確認できるようになります。

Webhook 通知を構成するには、 webhookNotification 新しい繰り返しオーディエンス リストを作成するときに、このフィールドに値を設定する必要があります。

Async audience lists with webhooks ガイドに従う をご覧ください。

オーディエンスのエクスポートでユーザーを取得する

オーディエンスのエクスポートでユーザーを取得するには、 audienceExports.query メソッドを呼び出し、オーディエンスのエクスポート名を 構成メタデータから取得された、 recurringAudienceLists.get または recurringAudienceLists.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
}