Method: customers.searchAds360.searchStream

Zwraca wszystkie wiersze pasujące do zapytania w strumieniu wyszukiwania.

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:searchStream

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,
  "batchSize": integer,
  "summaryRowSetting": enum (SummaryRowSetting)
}
Pola
query

string

Wymagane. Ciąg zapytania.
batchSize

integer

Liczba wierszy zwracanych w każdej partii odpowiedzi strumienia. Jeśli zostanie wysłana prośba o zbyt dużą partię, serwer może dodatkowo ograniczyć liczbę zwracanych wierszy.
summaryRowSetting

enum (SummaryRowSetting)

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

Treść odpowiedzi

Komunikat odpowiedzi na SearchAds360Service.SearchStream.

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

Zapis JSON 
{
  "results": [
    {
      object (SearchAds360Row)
    }
  ],
  "fieldMask": string,
  "summaryRow": {
    object (SearchAds360Row)
  },
  "customColumnHeaders": [
    {
      object (CustomColumnHeader)
    }
  ],
  "conversionCustomMetricHeaders": [
    {
      object (ConversionCustomMetricHeader)
    }
  ],
  "conversionCustomDimensionHeaders": [
    {
      object (ConversionCustomDimensionHeader)
    }
  ],
  "rawEventConversionMetricHeaders": [
    {
      object (RawEventConversionMetricHeader)
    }
  ],
  "rawEventConversionDimensionHeaders": [
    {
      object (RawEventConversionDimensionHeader)
    }
  ],
  "requestId": string
}
Pola
results[]

object (SearchAds360Row)

Lista wierszy pasujących do zapytania.
fieldMask

string (FieldMask format)

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

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

object (SearchAds360Row)

Wiersz podsumowania, który zawiera 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 wymiarów niestandardowych 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.
requestId

string

Unikalny identyfikator żądania używany do debugowania.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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