Zwraca wszystkie wiersze pasujące do zapytania.
Lista zgłoszonych błędów: AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError HeaderError InternalError QueryError QuotaError RequestError
Żądanie HTTP
POST https://googleads.googleapis.com/v17/customers/{customerId}/googleAds:search
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
Parametry | |
---|---|
customerId |
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 ( |
Pola | |
---|---|
query |
Wymagane. Ciąg zapytania. |
pageToken |
Token strony do pobrania. Jeśli nie określono tego ustawienia, zostanie zwrócona pierwsza strona wyników. Użyj wartości uzyskanej z interfejsu |
pageSize |
Liczba elementów do pobrania w ramach jednej strony. Gdy żądanie dotyczy zbyt dużej strony, serwer może jeszcze bardziej ograniczyć liczbę zwracanych zasobów. |
validateOnly |
Jeśli ma wartość true (prawda), żądanie jest weryfikowane, ale nie jest wykonywane. |
returnTotalResultsCount |
Jeśli zasada ma wartość prawda, w odpowiedzi zostanie uwzględniona łączna liczba wyników pasujących do zapytania z ignorowaniem klauzuli LIMIT. Wartość domyślna to false (fałsz). |
summaryRowSetting |
Określa, czy zostanie zwrócony wiersz podsumowania. Domyślnie wiersz podsumowania nie jest zwracany. W razie potrzeby wiersz podsumowania zostanie wysłany w odpowiedzi samodzielnie po zwróceniu wszystkich wyników zapytania. |
Treść odpowiedzi
Wiadomość z odpowiedzią dla: GoogleAdsService.Search
.
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{ "results": [ { object ( |
Pola | |
---|---|
results[] |
Lista wierszy pasujących do zapytania. |
nextPageToken |
Token podziału na strony używany do pobierania następnej strony wyników. Przekaż zawartość tego ciągu znaków jako atrybut |
totalResultsCount |
Łączna liczba wyników pasujących do zapytania z ignorowaniem klauzuli LIMIT. |
fieldMask |
Maska pola reprezentująca pola, których żądanie zażądał użytkownik. Jest to rozdzielana przecinkami lista w pełni kwalifikowanych nazw pól. Przykład: |
summaryRow |
Wiersz podsumowania zawierający podsumowanie danych w wynikach. Podsumowanie danych oznacza, że agregacja danych ze wszystkich wyników może obejmować: suma, średnia, stawka itp. |
queryResourceConsumption |
Ilość zasobów zużywanych do obsługi 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.