ユーザーのオーディエンス リストを Google スプレッドシートにエクスポートします。オーディエンスを作成した後で、すぐにユーザーを一覧表示できるわけではありません。まず、ユーザーのオーディエンス リストを作成するには audienceLists.create
へのリクエストが必要です。次に、このメソッドを使用してオーディエンス リスト内のユーザーを Google スプレッドシートにエクスポートします。
オーディエンス リストの概要と例については、オーディエンス リストを作成するをご覧ください。
Google アナリティクス 4 のオーディエンスを使用すると、ビジネスの目的に合わせてユーザーをセグメント化できます。詳しくは、https://support.google.com/analytics/answer/9267572 をご覧ください。
この方法は、ベータ版に入る前に構文や機能に関するフィードバックを収集する目的で、アルファ版(安定版)で導入されています。この API に関するフィードバックは、Google アナリティクス Audience Export API フィードバック フォームにご記入ください。
HTTP リクエスト
POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/audienceLists/*}:exportSheet
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
name |
必須。ユーザーを取得するオーディエンス リストの名前。形式: |
リクエスト本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
---|
{ "offset": string, "limit": string } |
フィールド | |
---|---|
offset |
省略可。開始行の行数。最初の行は行 0 としてカウントされます。 ページングの際に、最初のリクエストで offset が指定されていません。または、これと同等に、offset を 0 に設定します。最初のリクエストは、行の最初の このページ設定パラメータの詳細については、ページ設定をご覧ください。 |
limit |
省略可。返される行数。指定しない場合は、10,000 行が返されます。API は、リクエストした数に関係なく、リクエストあたり最大 250,000 行を返します。 また、ディメンション値の数が このページ設定パラメータの詳細については、ページ設定をご覧ください。 |
レスポンスの本文
作成された Google スプレッドシートとオーディエンス リストのユーザーのリスト。
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
---|
{
"spreadsheetUri": string,
"spreadsheetId": string,
"rowCount": integer,
"audienceList": {
object ( |
フィールド | |
---|---|
spreadsheetUri |
Google スプレッドシートを表示するためにブラウザでアクセスするための URI。 |
spreadsheetId |
作成された Google スプレッドシート リソースを識別する ID。 |
rowCount |
AudienceList の結果の総行数。 このページ設定パラメータの詳細については、ページ設定をご覧ください。 |
audienceList |
エクスポートする AudienceList に関する構成データ。このレスポンスの Google スプレッドシートの AudienceList の解釈のために戻されました。 たとえば、AudienceList に Google スプレッドシートよりも多くの行が含まれている場合、別の |
承認スコープ
次の OAuth スコープのいずれかが必要です。
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.file
https://www.googleapis.com/auth/spreadsheets