Method: customers.searchAds360.searchStream

Gibt alle Zeilen zurück, die der Suchstream-Abfrage entsprechen.

Liste der ausgelösten Fehler: AuthenticationError, AuthorizationError, ChangeEventError, ChangeStatusError, ClickViewError, HeaderError, InternalError, QueryError, QuotaError, RequestError

HTTP-Anfrage

POST https://searchads360.googleapis.com/v0/customers/{customerId}/searchAds360:searchStream

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
customerId

string

Erforderlich. Die ID des Kunden, für den die Abfrage ausgeführt wird.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

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

string

Erforderlich. Der Abfragestring.
batchSize

integer

Die Anzahl der Zeilen, die in jedem Stream-Antwortbatch zurückgegeben werden. Wenn ein zu großer Batch angefordert wird, kann der Server die Anzahl der zurückgegebenen Zeilen weiter begrenzen.
summaryRowSetting

enum (SummaryRowSetting)

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

Antworttext

Antwortnachricht für SearchAds360Service.SearchStream.

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

JSON-Darstellung 
{
  "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
}
Felder
results[]

object (SearchAds360Row)

Die Liste der Zeilen, die der Abfrage entsprechen.
fieldMask

string (FieldMask format)

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

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

object (SearchAds360Row)

Zusammenfassungszeile mit einer Zusammenfassung der Messwerte in den Ergebnissen. Die Zusammenfassung der Messwerte ist eine Aggregation der Messwerte über alle Ergebnisse hinweg. Hier kann die Aggregation Summe, Durchschnitt, Rate usw. sein.
customColumnHeaders[]

object (CustomColumnHeader)

Die Header der benutzerdefinierten Spalten in den Ergebnissen.
conversionCustomMetricHeaders[]

object (ConversionCustomMetricHeader)

Die Header der benutzerdefinierten Conversion-Messwerte in den Ergebnissen.
conversionCustomDimensionHeaders[]

object (ConversionCustomDimensionHeader)

Die Header der benutzerdefinierten Conversion-Dimension in den Ergebnissen.
rawEventConversionMetricHeaders[]

object (RawEventConversionMetricHeader)

Die Header der Conversion-Messwerte für Rohereignisse in den Ergebnissen.
rawEventConversionDimensionHeaders[]

object (RawEventConversionDimensionHeader)

Die Header der Conversion-Dimensionen für Rohereignisse in den Ergebnissen.
requestId

string

Die eindeutige ID der Anfrage, die zu Debugging-Zwecken verwendet wird.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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