Method: customers.searchAds360.searchStream

Zwraca wszystkie wiersze pasujące do zapytania dotyczącego strumienia 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

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 żądana partia jest zbyt duża, serwer może ograniczyć liczbę zwracanych wierszy.

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.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 użytkownik poprosił.

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 ich agregację we wszystkich wynikach. Dane mogą być sumowane, średnikowane, liczone jako wskaźnik 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.

rawEventConversionMetricHeaders[]

object (RawEventConversionMetricHeader)

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

rawEventConversionDimensionHeaders[]

object (RawEventConversionDimensionHeader)

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

requestId

string

Unikalny identyfikator żądania używany na potrzeby debugowania.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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