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 を 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 を含む場合、レスポンスには 175 の rowCount が含まれますが、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。1 種類のディメンション値。one_value は次のいずれかになります。
value

string

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