Method: properties.audienceLists.query

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

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

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

このメソッドは、audienceExports.query でベータ版（安定版）で利用できます。この API に関するフィードバックをお寄せいただくには、Google Analytics Audience Export API のフィードバック フォームにご記入ください。

HTTP リクエスト

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/audienceLists/*}:query

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

パスパラメータ

パラメータ
name

string

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

リクエスト本文

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

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)
    }
  ],
  "audienceList": {
    object (AudienceList)
  },
  "rowCount": integer
}
フィールド
audienceRows[]

object (AudienceRow)

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

object (AudienceList)

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

integer

AudienceList の結果の行の合計数。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。ディメンション値の一種。one_value は次のいずれかになります。
value

string

ディメンションのタイプが文字列の場合、文字列として値を指定します。