Zwraca wszystkie wiersze pasujące do zapytania.
Lista wyrzucanych błędów: AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError
Żądanie HTTP
POST https://searchads360.googleapis.com/v0/customers/{customerId}/searchAds360: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 zostanie określony, zwrócona zostanie pierwsza strona wyników. Aby poprosić o wyświetlenie następnej strony wyników, użyj wartości uzyskanej z interfejsu |
pageSize |
Liczba elementów do pobrania w ramach jednej strony. Jeśli żądana strona jest zbyt duża, serwer może ograniczyć liczbę zwracanych zasobów. |
validateOnly |
Jeśli to prawda, żądanie jest sprawdzane, ale nie jest wykonywane. |
returnTotalResultsCount |
Jeśli wartość to „PRAWDA”, w odpowiedzi zostanie uwzględniona łączna liczba wyników pasujących do zapytania, z pominięciem klauzuli LIMIT. Wartość domyślna to 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 jako osobny wiersz po zwróceniu wszystkich innych wyników zapytania. |
Treść odpowiedzi
Wiadomość z odpowiedzią dotyczącą SearchAds360Service.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 strony do pobierania następnej strony wyników. Przekaż zawartość tego ciągu jako atrybut |
totalResultsCount |
Łączna liczba wyników pasujących do zapytania, z pominięciem klauzuli LIMIT. |
fieldMask |
Maska pola reprezentująca pola, których zażądał użytkownik. Jest to lista pełnych nazw pól rozdzielona przecinkami. Przykład: |
summaryRow |
Wiersz podsumowania zawierający podsumowanie danych w wynikach. Podsumowanie danych oznacza ich agregację we wszystkich wynikach. Dane mogą być sumowane, średnikowane, liczone jako wskaźnik itp. |
customColumnHeaders[] |
Nagłówki kolumn niestandardowych w wynikach. |
conversionCustomMetricHeaders[] |
Nagłówki niestandardowych danych o konwersjach w wynikach. |
conversionCustomDimensionHeaders[] |
Nagłówki niestandardowych wymiarów konwersji w wynikach. |
rawEventConversionMetricHeaders[] |
Nagłówki nieprzetworzonych danych o konwersjach zdarzeń w wynikach. |
rawEventConversionDimensionHeaders[] |
Nagłówki nieprzetworzonych wymiarów konwersji zdarzeń w wynikach. |
Zakresy autoryzacji
Wymaga następującego zakresu OAuth:
https://www.googleapis.com/auth/doubleclicksearch