Method: accounts.reports.search

検索クエリで定義されたレポートを取得します。レスポンスには、pageSize で指定された行数よりも少ない行が含まれる場合があります。nextPageToken を使用して、リクエストする行が他にもあるかどうかを判断します。

HTTP リクエスト

POST https://merchantapi.googleapis.com/reports/v1beta/{parent=accounts/*}/reports:search

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

パスパラメータ

パラメータ
parent

string

必須。呼び出し元のアカウントの ID。単独のアカウントまたは MCA サブアカウントである必要があります。形式: accounts/{account}

リクエスト本文

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

JSON 表現 
{
  "query": string,
  "pageSize": integer,
  "pageToken": string
}
フィールド
query

string

必須。取得するレポートを定義するクエリ。

クエリの作成方法については、クエリ言語ガイドをご覧ください。使用可能なテーブルとフィールドの一覧については、使用可能なフィールドをご覧ください。
pageSize

integer

省略可。1 ページで取得する ReportRows の数。デフォルトは 1,000 です。5,000 を超える値は 5,000 に強制変換されます。
pageToken

string

省略可。取得するページのトークン。指定しない場合、結果の最初のページが返されます。次のページの結果をリクエストするには、前のレスポンスの nextPageToken から取得した値を使用する必要があります。

レスポンスの本文

ReportService.Search メソッドに対するレスポンス メッセージ。

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

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

object (ReportRow)

検索クエリに一致した行。
nextPageToken

string

次のページを取得するために pageToken として送信できるトークン。省略すると、後続のページはありません。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/content

詳しくは、OAuth 2.0 の概要をご覧ください。