Method: accounts.reports.search

Ruft einen Bericht ab, der durch eine Suchanfrage definiert ist. Die Antwort kann weniger Zeilen enthalten als in pageSize angegeben. Anhand von nextPageToken können Sie feststellen, ob weitere Zeilen angefordert werden müssen.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. ID des Kontos, das den Aufruf ausführt. Es muss sich um ein eigenständiges Konto oder ein Unterkonto eines Mehrfachkundenkontos handeln. Format: accounts/{account}

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "query": string,
  "pageSize": integer,
  "pageToken": string
}
Felder
query

string

Erforderlich. Abfrage, die einen abzurufenden Bericht definiert.

Weitere Informationen zum Erstellen von Abfragen finden Sie im Leitfaden zur Abfragesprache. Eine vollständige Liste der verfügbaren Tabellen und Felder finden Sie unter „Verfügbare Felder“.
pageSize

integer

Optional. Anzahl der ReportRows, die auf einer einzelnen Seite abgerufen werden sollen. Standardeinstellung ist 1.000. Werte über 5.000 werden auf 5.000 festgelegt.
pageToken

string

Optional. Token der Seite, die abgerufen werden soll. Wenn keine Angabe erfolgt, wird die erste Ergebnisseite zurückgegeben. Um die nächste Ergebnisseite anzufordern, sollte der Wert verwendet werden, der in der vorherigen Antwort von nextPageToken abgerufen wurde.

Antworttext

Antwortnachricht für die Methode ReportService.Search.

Wenn der Vorgang erfolgreich ist, enthält der Antworttext Daten mit folgender Struktur:

JSON-Darstellung 
{
  "results": [
    {
      object (ReportRow)
    }
  ],
  "nextPageToken": string
}
Felder
results[]

object (ReportRow)

Zeilen, die mit der Suchanfrage übereinstimmen.
nextPageToken

string

Token, das als pageToken gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie in der OAuth 2.0-Übersicht.