Method: customers.googleAds.search

Zwraca wszystkie wiersze pasujące do wyszukiwanego hasła.

Lista zgłoszonych błędów: AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError HeaderError InternalError QueryError QuotaError RequestError

Żądanie HTTP

POST https://googleads.googleapis.com/v15/customers/{customerId}/googleAds:search

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
customerId

string

To pole jest wymagane. Identyfikator klienta, którego dotyczy zapytanie.

Treść żądania

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

Zapis JSON 
{
  "query": string,
  "pageToken": string,
  "pageSize": integer,
  "validateOnly": boolean,
  "returnTotalResultsCount": boolean,
  "summaryRowSetting": enum (SummaryRowSetting)
}
Pola
query

string

To pole jest wymagane. Ciąg zapytania.
pageToken

string

Token strony do pobrania. Jeśli nie podasz tych danych, zwracana jest pierwsza strona wyników. Użyj wartości uzyskanej z funkcji nextPageToken w poprzedniej odpowiedzi, aby zażądać następnej strony z wynikami.
pageSize

integer

Liczba elementów do pobrania na jednej stronie. W przypadku żądania zbyt dużej strony serwer może zdecydować się na dalsze ograniczenie liczby zwracanych zasobów.
validateOnly

boolean

Jeśli ma wartość true (prawda), żądanie jest sprawdzane, ale nie wykonywane.
returnTotalResultsCount

boolean

Jeśli ma wartość true (prawda), w odpowiedzi zostanie uwzględniona łączna liczba wyników zgodnych z zapytaniem ignorujących klauzulę LIMIT. Wartość domyślna to false (fałsz).
summaryRowSetting

enum (SummaryRowSetting)

Określa, czy wiersz podsumowania zostanie zwrócony. Domyślnie wiersz podsumowania nie jest zwracany. Na żądanie wiersz podsumowania zostanie wysłany w odpowiedzi po zwróceniu wszystkich pozostałych wyników zapytania.

Treść odpowiedzi

Wiadomość z odpowiedzią na temat: GoogleAdsService.Search.

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

Zapis JSON 
{
  "results": [
    {
      object (GoogleAdsRow)
    }
  ],
  "nextPageToken": string,
  "totalResultsCount": string,
  "fieldMask": string,
  "summaryRow": {
    object (GoogleAdsRow)
  },
  "queryResourceConsumption": string
}
Pola
results[]

object (GoogleAdsRow)

Lista wierszy pasujących do zapytania.
nextPageToken

string

Token podziału na strony używany do pobierania następnej strony wyników. Przekaż zawartość tego ciągu jako atrybut pageToken w następnym żądaniu. nextPageToken nie jest zwracany w przypadku ostatniej strony.
totalResultsCount

string (int64 format)

Łączna liczba wyników pasujących do zapytania i zignorowana na klauzulę LIMIT.
fieldMask

string (FieldMask format)

Maska FieldMask określająca pola wymagane przez użytkownika.

Jest to lista rozdzielonych przecinkami pełnych i jednoznacznych nazw pól. Przykład: "user.displayName,photo".
summaryRow

object (GoogleAdsRow)

Wiersz podsumowania zawierający podsumowanie danych w wynikach. Podsumowanie danych oznacza agregację danych ze wszystkich wyników. W tym przypadku agregacja może mieć postać sumy, średniej, współczynnika itp.
queryResourceConsumption

string (int64 format)

Ilość zasobów zużywanych na potrzeby zapytania.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

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