Method: properties.audienceExports.list

プロパティのすべてのオーディエンスのエクスポートを一覧表示します。この方法では、新しいオーディエンスのエクスポートを不必要に作成するのではなく、既存のオーディエンスのエクスポートを見つけて再利用できます。同じオーディエンスに対して、異なる日にオーディエンスに含まれていたユーザーのエクスポートを表す、オーディエンスのエクスポートを複数作成できます。

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

Audience Export API には、アルファ版のメソッドとベータ版の安定版のメソッドがあります。その目的は、ある程度のフィードバックと採用の後で手法をベータ版の安定性に進めることです。この API に関するフィードバックがございましたら、Google アナリティクスの Audience Export API に関するフィードバック フォームにご記入ください。

HTTP リクエスト

GET https://analyticsdata.googleapis.com/v1beta/{parent=properties/*}/audienceExports

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

パスパラメータ

パラメータ
parent

string

必須。このプロパティのすべてのオーディエンスのエクスポートがレスポンスに一覧表示されます。形式: properties/{property}

クエリ パラメータ

パラメータ
pageSize

integer

省略可。返されるオーディエンスのエクスポートの最大数。サービスが返す値はこれよりも少ないことがあります。指定しない場合、最大で 200 個のオーディエンスのエクスポートが返されます。最大値は 1,000 です（これより大きい値は最大値に強制変換されます）。
pageToken

string

省略可。前回の audienceExports.list 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、audienceExports.list に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

プロパティのすべてのオーディエンスのエクスポートのリスト。

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

JSON 表現 
{
  "audienceExports": [
    {
      object (AudienceExport)
    }
  ],
  "nextPageToken": string
}
フィールド
audienceExports[]

object (AudienceExport)

プロパティの各オーディエンスのエクスポート。
nextPageToken

string

次のページを取得するために pageToken として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics