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 としてカウントされます。

ページングを行う場合、最初のリクエストではオフセットを指定しません。つまり、オフセットを 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 リクエストに limit が 50 含まれている場合、レスポンスには 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 表現 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "value": string
  // End of mutually exclusive fields.
}
フィールド
1 種類のディメンション値。以下は、相互に排他的なフィールドのリストです。レスポンスで設定されるフィールドは最大で 1 つです。
value

string

ディメンションの型が文字列の場合の値（文字列）。
相互に排他的なフィールドの終了。