Method: customers.googleAds.searchStream

Gibt alle Zeilen zurück, die mit der Suchstreamabfrage übereinstimmen.

Liste der geworfenen Fehler: AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError HeaderError InternalError QueryError QuotaError RequestError

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
customerId

string

Erforderlich. Die ID des abgefragten Kunden.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "query": string,
  "summaryRowSetting": enum (SummaryRowSetting)
}
Felder
query

string

Erforderlich. Der Abfragestring.
summaryRowSetting

enum (SummaryRowSetting)

Bestimmt, ob eine Zusammenfassungszeile zurückgegeben wird. Standardmäßig wird keine Zusammenfassungszeile zurückgegeben. Auf Anfrage wird die Zusammenfassungszeile in einer Antwort gesendet, nachdem alle anderen Abfrageergebnisse zurückgegeben wurden.

Antworttext

Antwortnachricht für GoogleAdsService.SearchStream.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "results": [
    {
      object (GoogleAdsRow)
    }
  ],
  "fieldMask": string,
  "summaryRow": {
    object (GoogleAdsRow)
  },
  "requestId": string,
  "queryResourceConsumption": string
}
Felder
results[]

object (GoogleAdsRow)

Die Liste der Zeilen, die mit der Abfrage übereinstimmen.
fieldMask

string (FieldMask format)

FieldMask, die angibt, welche Felder vom Nutzer angefordert wurden.

Dies ist eine durch Kommas getrennte Liste vollständig qualifizierter Feldnamen. Beispiel: "user.displayName,photo".
summaryRow

object (GoogleAdsRow)

Zusammenfassungszeile mit einer Zusammenfassung der Messwerte in den Ergebnissen. Die Zusammenfassung von Messwerten bedeutet die Aggregation von Messwerten über alle Ergebnisse hinweg. Hier kann die Aggregation beispielsweise „Summe“, „Durchschnitt“ oder „Rate“ sein.
requestId

string

Die eindeutige ID der Anfrage, die zum Debugging verwendet wird.
queryResourceConsumption

string (int64 format)

Die Menge der Ressourcen, die für die Ausführung der Abfrage verbraucht wurden. „queryResourceConsumption“ für die Zusammenfassungszeile und Antworten, die keine Zusammenfassung sind, werden in den jeweiligen Zeilen separat zurückgegeben. „queryResourceConsumption“ für Antworten, die keine Zusammenfassung sind, wird im letzten Batch von Ergebnissen zurückgegeben.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie unter OAuth 2.0 Overview.

SummaryRowSetting

Aufzählung, die die Einstellungen für Zeilen in der Rückgabeübersicht beschreibt.

Enums
UNSPECIFIED Nicht angegeben.
UNKNOWN Stellt unbekannte Werte in der Zeile „Zusammenfassung der Rückgabe“ dar.
NO_SUMMARY_ROW Gibt keine Summenzeile zurück.
SUMMARY_ROW_WITH_RESULTS Gibt eine Zusammenfassungszeile zusammen mit den Ergebnissen zurück. Die Zusammenfassungszeile wird nur im letzten Batch zurückgegeben (der letzte Batch enthält keine Ergebnisse).
SUMMARY_ROW_ONLY Nur eine Zusammenfassungszeile zurückgeben und keine Ergebnisse zurückgeben.