Method: accounts.reports.search
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
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 unter OAuth 2.0 Overview.
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-01-23 (UTC).
[null,null,["Zuletzt aktualisiert: 2025-01-23 (UTC)."],[[["\u003cp\u003eRetrieves a report based on a search query, returning results potentially across multiple pages using pagination.\u003c/p\u003e\n"],["\u003cp\u003eRequires a search query in the request body and allows specifying the desired page size and page token.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes matching report rows and a token for retrieving the next page if available.\u003c/p\u003e\n"],["\u003cp\u003eThe API utilizes gRPC Transcoding syntax and needs authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/content\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eReport data is structured using \u003ccode\u003eReportRow\u003c/code\u003e objects within the response body.\u003c/p\u003e\n"]]],[],null,["# Method: accounts.reports.search\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.SearchResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nRetrieves a report defined by a search query. The response might contain fewer rows than specified by `pageSize`. Rely on `nextPageToken` to determine if there are more rows to be requested.\n\n### HTTP request\n\n`POST https://merchantapi.googleapis.com/reports/v1beta/{parent=accounts/*}/reports:search`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-------------------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. Id of the account making the call. Must be a standalone account or an MCA subaccount. Format: accounts/{account} |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------|\n| ``` { \"query\": string, \"pageSize\": integer, \"pageToken\": string } ``` |\n\n| Fields ||\n|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `query` | `string` Required. Query that defines a report to be retrieved. For details on how to construct your query, see the [Query Language guide](/merchant/api/guides/reports/query-language). For the full list of available tables and fields, see the [Available fields](/merchant/api/reference/rest/reports_{apiVersion}/accounts.reports). |\n| `pageSize` | `integer` Optional. Number of `ReportRows` to retrieve in a single page. Defaults to 1000. Values above 5000 are coerced to 5000. |\n| `pageToken` | `string` Optional. Token of the page to retrieve. If not specified, the first page of results is returned. In order to request the next page of results, the value obtained from `nextPageToken` in the previous response should be used. |\n\n### Response body\n\nResponse message for the `ReportService.Search` method.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"results\": [ { object (/merchant/api/reference/rest/reports_v1beta/accounts.reports#ReportRow) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|--------------------------------------------------------------------------------------------------------------------------------------|\n| `results[]` | `object (`[ReportRow](/merchant/api/reference/rest/reports_v1beta/accounts.reports#ReportRow)`)` Rows that matched the search query. |\n| `nextPageToken` | `string` Token which can be sent as `pageToken` to retrieve the next page. If omitted, there are no subsequent pages. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/content`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]
