Method: properties.audienceExports.query

ユーザーのオーディエンス エクスポートを取得します。オーディエンスを作成した後で、そのオーディエンスをすぐにエクスポートすることはできません。まず、ユーザーのオーディエンスをエクスポートするために audienceExports.create へのリクエストが必要です。次に、このメソッドを使用してオーディエンスのエクスポートからユーザーを取得します。

オーディエンスのエクスポートの概要と例については、オーディエンスのエクスポートを作成するをご覧ください。

Google アナリティクス 4 のオーディエンスを使用すると、ビジネスの目的に合わせてユーザーをセグメント化できます。詳しくは、https://support.google.com/analytics/answer/9267572 をご覧ください。

Audience Export API には、アルファ版のメソッドとベータ版の安定版のメソッドがあります。フィードバックと導入を経て、ベータ版を安定させるための手法を進めることを目的としています。この API に関するフィードバックは、Google アナリティクス Audience Export API フィードバック フォームにご記入ください。

HTTP リクエスト

POST https://analyticsdata.googleapis.com/v1beta/{name=properties/*/audienceExports/*}:query

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
name

string

必須。ユーザーを取得するオーディエンスのエクスポートの名前。形式: properties/{property}/audienceExports/{audienceExport}

リクエスト本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "offset": string,
  "limit": string
}
フィールド
offset

string (int64 format)

省略可。開始行の行数。最初の行は行 0 としてカウントされます。

ページングの際に、最初のリクエストで offset が指定されていません。または、これと同等に、offset を 0 に設定します。最初のリクエストは、行の最初の limit を返します。2 番目のリクエストは、最初のリクエストの limit にオフセットを設定します。2 番目のリクエストは行の 2 番目の limit を返します。

このページ設定パラメータの詳細については、ページ設定をご覧ください。
limit

string (int64 format)

省略可。返される行数。指定しない場合は、10,000 行が返されます。API は、リクエストした数に関係なく、リクエストあたり最大 250,000 行を返します。limit は正数でなければなりません。

また、ディメンション値の数が limit より少ない場合、API はリクエストされた limit よりも少ない行を返すことがあります。

このページ設定パラメータの詳細については、ページ設定をご覧ください。

レスポンスの本文

オーディエンスのエクスポートに含まれるユーザーのリスト。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現 
{
  "audienceRows": [
    {
      object (AudienceRow)
    }
  ],
  "audienceExport": {
    object (AudienceExport)
  },
  "rowCount": integer
}
フィールド
audienceRows[]

object (AudienceRow)

オーディエンスのエクスポートに含まれる各ユーザーの行。このレスポンスの行数は、リクエストのページサイズ以下になります。
audienceExport

object (AudienceExport)

クエリされている AudienceExport に関する構成データ。このレスポンスのオーディエンス行の解釈のために返されます。たとえば、この AudienceExport のディメンションは AudienceRows の列に対応しています。
rowCount

integer

AudienceExport の結果の行の合計数。rowCount は、レスポンスで返される行数、limit リクエスト パラメータ、offset リクエスト パラメータに依存しません。たとえば、クエリが 175 行を返し、API リクエストに 50 の limit が含まれている場合、レスポンスの rowCount は 175 ですが、50 行しか含まれません。

このページ設定パラメータの詳細については、ページ設定をご覧ください。

承認スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

AudienceRow

オーディエンス ユーザー行のディメンション値属性。

JSON 表現 
{
  "dimensionValues": [
    {
      object (AudienceDimensionValue)
    }
  ]
}
フィールド
dimensionValues[]

object (AudienceDimensionValue)

オーディエンス ユーザーの各ディメンション値属性。リクエストされたディメンション列ごとに、ディメンション値が 1 つ追加されます。

AudienceDimensionValue

ディメンションの値。

JSON 表現 
{

  // Union field one_value can be only one of the following:
  "value": string
  // End of list of possible types for union field one_value.
}
フィールド
共用体フィールド one_value。ディメンション値の一種。one_value は次のいずれかになります。
value

string

ディメンション タイプが文字列の場合は、文字列の値。