オーディエンスのエクスポートを作成する

Google アナリティクスのオーディエンス を使用すると、ビジネスに合わせてユーザーをセグメント化できます。あり サイトまたはアプリケーションのユーザーを、共通の関心や特定のトピックに基づいて 属性です。

ユーザーのスナップショットを含むオーディエンスをエクスポート: Data API。

オーディエンスのエクスポートにおけるデータの要件をご覧ください。 ガイドをご活用ください。

概要

オーディエンスのエクスポートを作成してクエリするには、次の Data API リクエストを行います。

  1. audienceExports.create を呼び出す メソッドを使用してオーディエンスのエクスポートを作成します。
  2. audienceExports.query を呼び出す メソッドを使用して、オーディエンス内のユーザーを取得します。

詳しくは、 audienceExports.get～ 特定のオーディエンスのエクスポートに関する構成メタデータを取得する audienceExports.list～ 特定のプロパティのすべてのオーディエンスのエクスポートを一覧表示できます。

レポート エンティティを選択

すべての Data API メソッドには、Google アナリティクス プロパティが必要です。 ID 識別子を URL リクエストパス内で指定します。 properties/GA_PROPERTY_ID の形式。次の例をご覧ください。

  POST  https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID/audienceExports

このレポートは、 指定した Google アナリティクスのプロパティ。

Data API クライアント ライブラリのいずれかを使用している場合は、 リクエスト URL パスを変更する必要はありません。ほとんどの API クライアントは property を提供します。 パラメータには properties/GA_PROPERTY_ID 形式の文字列が必要です。詳しくは、 クイック スタートガイド: クライアント ライブラリを使用します。

オーディエンスのエクスポートを作成する

オーディエンスのエクスポートを作成するには、audienceExports.create メソッドを呼び出します。 AudienceExport 渡します。次のパラメータを指定します。

  • audience に有効なオーディエンス名 フィールド（properties/{propertyId}/audiences/{audienceId} 形式）。Google Chat では 使用 audiences.list メソッドを使ってこの値を取得します。「 Audience.name フィールドに、オーディエンス名が含まれます。audiences.list
  • dimensions 内の有効なディメンションのリスト 表示されます。このメソッドでサポートされているディメンションの一覧については、 オーディエンスのエクスポート スキーマに関するドキュメント。 このフィールドで指定されたディメンションのデータがオーディエンスに含まれています エクスポートできます。

オーディエンスのエクスポートを作成するリクエストの例を次に示します。

HTTP リクエスト

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

audienceExports.create メソッドのレスポンスには、オーディエンスのエクスポートの name フィールドに入力します（例: properties/1234567/audienceExports/123）。 レスポンスの例を次に示します。

HTTP レスポンス

{
  "response": {
    "@type": "type.googleapis.com/google.analytics.data.v1alpha.AudienceExport",
    "name": "properties/1234567/audienceExports/123",
    "audience": "properties/1234567/audiences/12345",
    "audienceDisplayName": "Purchasers",
    "dimensions": [
      {
        "dimensionName": "deviceId"
      }
    ],
    "state": "CREATING",
    "beginCreatingTime": "2023-06-22T23:35:28.787910949Z"
  }
}

name を使用すると、オーディエンスのエクスポートからユーザーをクエリできます。

オーディエンスのエクスポートの準備状況をクエリする

エクスポート後、オーディエンスのエクスポートが生成されるまでに audienceExports.create あります。

オーディエンスのエクスポートの準備状況は、 audienceExports.get メソッドを使用します。

audienceExports.create レスポンスからのオーディエンスのエクスポート名を使用して、 リクエストでオーディエンスのエクスポートを指定します。

リクエストの例を次に示します。

HTTP リクエスト

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

オーディエンスのエクスポートの準備状況が state フィールドに返されます。 返されます。オーディエンスのエクスポートの生成が完了すると、そのステータスは CREATING から ACTIVE に変更。

レスポンスの例を次に示します。

HTTP レスポンス

{
  "name": "properties/1234567/audienceExports/123",
  "audience": "properties/1234567/audiences/12345",
  "audienceDisplayName": "Purchasers",
  "dimensions": [
    {
      "dimensionName": "deviceId"
    }
  ],
  "state": "CREATING",
  "beginCreatingTime": "2023-06-22T23:35:28.787910949Z"
}

すべてのオーディエンスのエクスポートの状態を取得するには、 audienceExports.list メソッドを呼び出します。

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

オーディエンスのエクスポートが生成されたら、audienceExports.query メソッドを呼び出し、 リクエストに含まれるオーディエンスのエクスポートの name。

リクエストの例を次に示します。

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
}