Method: accounts.reports.search

Pobiera raport zdefiniowany przez zapytanie. Odpowiedź może zawierać mniej wierszy niż określono w parametry pageSize. Aby określić, czy są jeszcze inne wiersze, na które można wysłać żądanie, użyj elementu nextPageToken.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
parent

string

Wymagane. Identyfikator konta nawiązującego połączenie. Musi to być samodzielne konto lub subkonto MCA. Format: accounts/{account}

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "query": string,
  "pageSize": integer,
  "pageToken": string
}
Pola
query

string

Wymagane. Zapytanie określające raport do pobrania.

Szczegółowe informacje o składaniu zapytań znajdziesz w przewodniku po języku zapytań. Pełną listę dostępnych tabel i pol znajdziesz w sekcji Dostępne pola.
pageSize

integer

Opcjonalnie: Liczba ReportRows do pobrania na jednej stronie. Domyślna wartość to 1000. Wartości powyżej 5000 są przymusowo ustawiane na 5000.
pageToken

string

Opcjonalnie: Token strony do pobrania. Jeśli nie określisz tej wartości, zwrócona zostanie pierwsza strona wyników. Aby zażądać następnej strony wyników, należy użyć wartości uzyskanej z nextPageToken w poprzedniej odpowiedzi.

Treść odpowiedzi

wiadomość z odpowiedzią dla metody ReportService.Search.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "results": [
    {
      object (ReportRow)
    }
  ],
  "nextPageToken": string
}
Pola
results[]

object (ReportRow)

Wiersze pasujące do zapytania.
nextPageToken

string

Token, który można wysłać jako pageToken, aby pobrać następną stronę. Jeśli pominiesz to pole, nie będzie kolejnych stron.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie OAuth 2.0.