Method: customers.searchAds360.search

Zwraca wszystkie wiersze pasujące do zapytania wyszukiwania.

Lista zgłoszonych 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

string

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

Wymagane. Ciąg zapytania.
pageToken

string

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

integer

Liczba elementów do pobrania na jednej stronie. Po zażądaniu zbyt dużej strony serwer może jeszcze bardziej ograniczyć liczbę zwracanych zasobów.
validateOnly

boolean

Jeśli to prawda, żądanie jest sprawdzane, ale nie jest wykonywane.
returnTotalResultsCount

boolean

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 false (fałsz).
summaryRowSetting

enum (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 (SearchAds360Row)
    }
  ],
  "nextPageToken": string,
  "totalResultsCount": string,
  "fieldMask": string,
  "summaryRow": {
    object (SearchAds360Row)
  },
  "customColumnHeaders": [
    {
      object (CustomColumnHeader)
    }
  ],
  "conversionCustomMetricHeaders": [
    {
      object (ConversionCustomMetricHeader)
    }
  ],
  "conversionCustomDimensionHeaders": [
    {
      object (ConversionCustomDimensionHeader)
    }
  ],
  "rawEventConversionMetricHeaders": [
    {
      object (RawEventConversionMetricHeader)
    }
  ],
  "rawEventConversionDimensionHeaders": [
    {
      object (RawEventConversionDimensionHeader)
    }
  ]
}
Pola
results[]

object (SearchAds360Row)

Lista wierszy pasujących do zapytania.
nextPageToken

string

Token strony do pobierania następnej strony wyników. Przekaż zawartość tego ciągu znaków jako atrybut pageToken następnego żądania. Parametr nextPageToken nie jest zwracany dla ostatniej strony.
totalResultsCount

string (int64 format)

Łączna liczba wyników pasujących do zapytania, z pominięciem klauzuli LIMIT.
fieldMask

string (FieldMask format)

Maska pola reprezentująca pola, których zażądał użytkownik.

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

object (SearchAds360Row)

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.
customColumnHeaders[]

object (CustomColumnHeader)

Nagłówki kolumn niestandardowych w wynikach.
conversionCustomMetricHeaders[]

object (ConversionCustomMetricHeader)

Nagłówki niestandardowych danych o konwersjach w wynikach.
conversionCustomDimensionHeaders[]

object (ConversionCustomDimensionHeader)

Nagłówki niestandardowych wymiarów konwersji w wynikach.
rawEventConversionMetricHeaders[]

object (RawEventConversionMetricHeader)

Nagłówki nieprzetworzonych danych konwersji zdarzeń w wynikach.
rawEventConversionDimensionHeaders[]

object (RawEventConversionDimensionHeader)

Nagłówki nieprzetworzonych wymiarów konwersji zdarzeń w wynikach.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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