Method: properties.audienceLists.exportSheet

ユーザーのオーディエンス リストを 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

string

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

リクエスト本文

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

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 よりも少ない行を返すこともあります。

ページ分けパラメータの詳細については、ページ分けをご覧ください。

レスポンスの本文

オーディエンス リスト内のユーザーのリストを含む作成された Google スプレッドシート。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "spreadsheetUri": string,
  "spreadsheetId": string,
  "rowCount": integer,
  "audienceList": {
    object (AudienceList)
  }
}
フィールド
spreadsheetUri

string

Google スプレッドシートを表示するためにブラウザでアクセスする URI。
spreadsheetId

string

作成された Google スプレッドシート リソースを識別する ID。
rowCount

integer

AudienceList の結果の行の合計数。rowCount は、レスポンスで返される行数、limit リクエスト パラメータ、offset リクエスト パラメータに依存しません。たとえば、175 行を返すクエリが API リクエストに 50 の limit を含む場合、レスポンスには 175 の rowCount が含まれますが、50 行のみが含まれます。

ページ分けパラメータの詳細については、ページ分けをご覧ください。
audienceList

object (AudienceList)

エクスポートする AudienceList に関する構成データ。このレスポンスの Google スプレッドシートの AudienceList を解釈するために返されます。

たとえば、AudienceList に Google スプレッドシートよりも多くの行が含まれていることがあります。その場合は、別の offset 値を使用して追加のシート エクスポート リクエストを送信して、別の 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