Method: customers.searchAds360.searchStream

Zwraca wszystkie wiersze pasujące do zapytania w strumieniu 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:searchStream

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
customerId

string

To pole jest 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

To pole jest wymagane. Ciąg zapytania.

batchSize

integer

Liczba wierszy zwracanych w każdej grupie odpowiedzi strumienia. W przypadku żądania zbyt dużego wsadu serwer może zdecydować się na dalsze ograniczenie liczby zwracanych wierszy.

summaryRowSetting

enum (SummaryRowSetting)

Określa, czy wiersz podsumowania zostanie zwrócony. Domyślnie wiersz podsumowania nie jest zwracany. Na żądanie wiersz podsumowania zostanie wysłany w odpowiedzi po zwróceniu wszystkich innych wyników zapytania.

Treść odpowiedzi

Odpowiedź na pytanie: 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)

Maska FieldMask określająca pola, których zażądał użytkownik.

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

summaryRow

object (SearchAds360Row)

Wiersz podsumowania zawierający podsumowanie danych w wynikach. Podsumowanie danych oznacza agregację danych ze wszystkich wyników. W tym przypadku agregacja może mieć postać sumę, średnią, współczynnik 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 niestandardowego wymiaru konwersji w wynikach wyszukiwania.

rawEventConversionMetricHeaders[]

object (RawEventConversionMetricHeader)

Nagłówki nieprzetworzonych danych o konwersjach zdarzenia w wynikach.

rawEventConversionDimensionHeaders[]

object (RawEventConversionDimensionHeader)

Nagłówki nieprzetworzonych wymiarów konwersji zdarzenia w wynikach.

requestId

string

Unikalny identyfikator żądania, który jest używany do debugowania.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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