Method: customers.googleAds.searchStream

Zwraca wszystkie wiersze pasujące do zapytania dotyczącego strumienia wyszukiwania.

Lista zgłaszanych błędów: AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError HeaderError InternalError QueryError QuotaError RequestError

Żądanie HTTP

POST https://googleads.googleapis.com/v19/customers/{customerId}/googleAds:searchStream

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
customerId

string

Wymagany. Identyfikator klienta, którego dotyczy zapytanie.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "query": string,
  "summaryRowSetting": enum (SummaryRowSetting)
}
Pola
query

string

Wymagany. Ciąg zapytania.
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

Odpowiedź na pytanie „GoogleAdsService.SearchStream”.

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

Zapis JSON 
{
  "results": [
    {
      object (GoogleAdsRow)
    }
  ],
  "fieldMask": string,
  "summaryRow": {
    object (GoogleAdsRow)
  },
  "requestId": string,
  "queryResourceConsumption": string
}
Pola
results[]

object (GoogleAdsRow)

Lista wierszy pasujących do zapytania.
fieldMask

string (FieldMask format)

FieldMask, który reprezentuje pola, których żądał użytkownik.

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

object (GoogleAdsRow)

Wiersz podsumowania, który zawiera podsumowanie danych w wynikach. Podsumowanie danych oznacza agregację danych ze wszystkich wyników. Agregacja może być sumą, średnią, współczynnikiem itp.
requestId

string

Unikalny identyfikator żądania używany do debugowania.
queryResourceConsumption

string (int64 format)

Ilość zasobów wykorzystanych do obsługi zapytania. Wartość queryResourceConsumption dla wiersza „Summary” i niebędących wierszami „Summary” odpowiedzi jest zwracana oddzielnie w odpowiednich wierszach. Wartość queryResourceConsumption dla odpowiedzi innych niż „Summary” jest zwracana w ostatniej partii wyników.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w OAuth 2.0 Overview.

SummaryRowSetting

Typ enumeracji opisujący ustawienia wiersza podsumowania zwrotu.

Wartości w polu enum
UNSPECIFIED Nie określono.
UNKNOWN Reprezentują nieznane wartości wiersza podsumowania zwrotu.
NO_SUMMARY_ROW Nie zwracaj wiersza podsumowania.
SUMMARY_ROW_WITH_RESULTS Zwraca wiersz podsumowania wraz z wynikami. Wiersz podsumowania zostanie zwrócony tylko w ostatniej partii (ostatnia partia nie będzie zawierać żadnych wyników).
SUMMARY_ROW_ONLY zwracać tylko wiersz podsumowania i nie zwracać żadnych wyników;