Method: customers.searchAds360.search

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://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, zostanie zwrócona pierwsza strona wyników. Aby poprosić o następną stronę wyników, użyj wartości uzyskanej z parametru nextPageToken w poprzedniej odpowiedzi.
pageSize

integer

Liczba elementów do pobrania na jednej stronie. Gdy żądana jest zbyt duża strona, serwer może dodatkowo ograniczyć liczbę zwracanych zasobów.
validateOnly

boolean

Jeśli ma wartość true, żądanie jest weryfikowane, ale nie wykonywane.
returnTotalResultsCount

boolean

Jeśli ma wartość true, w odpowiedzi zostanie uwzględniona łączna liczba wyników pasujących do zapytania z pominięciem klauzuli LIMIT. Domyślnie ma wartość false.
summaryRowSetting

enum (SummaryRowSetting)

Określa, czy ma zostać zwrócony wiersz podsumowania. Domyślnie wiersz podsumowania nie jest zwracany. Jeśli zostanie o to poproszony, wiersz podsumowania zostanie wysłany w odpowiedzi osobno po zwróceniu wszystkich innych wyników zapytania.

Treść odpowiedzi

Wiadomość odpowiedzi na 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 paginacji używany do pobierania następnej strony wyników. Przekaż zawartość tego ciągu jako atrybut pageToken następnego żądania. W przypadku ostatniej strony parametr nextPageToken nie jest zwracany.
totalResultsCount

string (int64 format)

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

string (FieldMask format)

FieldMask, który reprezentuje pola, o które prosił użytkownik.

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

object (SearchAds360Row)

Wiersz podsumowania zawierający podsumowanie danych w wynikach. Podsumowanie danych oznacza agregację danych we wszystkich wynikach. Agregacja może być sumą, średnią, stawką 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 danych o konwersjach z surowych zdarzeń w wynikach.
rawEventConversionDimensionHeaders[]

object (RawEventConversionDimensionHeader)

Nagłówki wymiarów konwersji z surowych zdarzeń w wynikach.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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