ユーザーのオーディエンス リストを取得します。オーディエンスを作成した後で、すぐにユーザーを一覧表示できるわけではありません。まず、ユーザーのオーディエンス リストを作成するには audienceLists.create
へのリクエストが必要です。次に、このメソッドを使用してオーディエンス リストのユーザーを取得します。
オーディエンス リストの概要と例については、オーディエンス リストを作成するをご覧ください。
Google アナリティクス 4 のオーディエンスを使用すると、ビジネスの目的に合わせてユーザーをセグメント化できます。詳しくは、https://support.google.com/analytics/answer/9267572 をご覧ください。
この方法は、ベータ版の安定版として audienceExports.query で使用できます。この API に関するフィードバックは、Google アナリティクス Audience Export API フィードバック フォームにご記入ください。
HTTP リクエスト
POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/audienceLists/*}:query
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
name |
必須。ユーザーを取得するオーディエンス リストの名前。形式: |
リクエスト本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
---|
{ "offset": string, "limit": string } |
フィールド | |
---|---|
offset |
省略可。開始行の行数。最初の行は行 0 としてカウントされます。 ページングの際に、最初のリクエストで offset が指定されていません。または、これと同等に、offset を 0 に設定します。最初のリクエストは、行の最初の このページ設定パラメータの詳細については、ページ設定をご覧ください。 |
limit |
省略可。返される行数。指定しない場合は、10,000 行が返されます。API は、リクエストした数に関係なく、リクエストあたり最大 250,000 行を返します。 また、ディメンション値の数が このページ設定パラメータの詳細については、ページ設定をご覧ください。 |
レスポンスの本文
オーディエンス リストのユーザーのリスト。
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
---|
{ "audienceRows": [ { object ( |
フィールド | |
---|---|
audienceRows[] |
オーディエンス リストに含まれる各ユーザーの行。このレスポンスの行数は、リクエストのページサイズ以下になります。 |
audienceList |
クエリ対象の AudienceList に関する構成データ。このレスポンスのオーディエンス行の解釈のために返されます。たとえば、この AudienceList のディメンションは、AudienceRows の列に対応しています。 |
rowCount |
AudienceList の結果の総行数。 このページ設定パラメータの詳細については、ページ設定をご覧ください。 |
承認スコープ
次の OAuth スコープのいずれかが必要です。
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
AudienceRow
オーディエンス ユーザー行のディメンション値属性。
JSON 表現 |
---|
{
"dimensionValues": [
{
object ( |
フィールド | |
---|---|
dimensionValues[] |
オーディエンス ユーザーの各ディメンション値属性。リクエストされたディメンション列ごとに、ディメンション値が 1 つ追加されます。 |
AudienceDimensionValue
ディメンションの値。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド one_value 。ディメンション値の一種。one_value は次のいずれかになります。 |
|
value |
ディメンション タイプが文字列の場合は、文字列の値。 |