Method: customers.searchAds360.searchStream

Gibt alle Zeilen zurück, die der Suchstreamabfrage entsprechen.

Liste der ausgegebenen Fehler: AuthenticationError AuthorizationError 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. ID des abgefragten Kunden

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

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

string

Erforderlich. Abfragestring
batchSize

integer

Die Anzahl der Zeilen, die in jedem Streamantwortbatch 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. Auf Anforderung wird die Zusammenfassungszeile in einer 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 vollständig qualifizierter Feldnamen. Beispiel: "user.displayName,photo".
summaryRow

object (SearchAds360Row)

Zusammenfassungszeile, die eine Zusammenfassung der Messwerte in den Ergebnissen enthält. „Zusammenfassung der Messwerte“ bedeutet, dass die Messwerte über alle Ergebnisse hinweg aggregiert werden. Hier kann die Aggregation Summe, Durchschnitt, Rate usw. sein.
customColumnHeaders[]

object (CustomColumnHeader)

Die Überschriften der benutzerdefinierten Spalten in den Ergebnissen.
conversionCustomMetricHeaders[]

object (ConversionCustomMetricHeader)

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

object (ConversionCustomDimensionHeader)

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

object (RawEventConversionMetricHeader)

Die Überschriften der Rohdaten zu Ereignis-Conversions in den Ergebnissen.
rawEventConversionDimensionHeaders[]

object (RawEventConversionDimensionHeader)

Die Überschriften der Rohereignis-Conversion-Dimensionen in den Ergebnissen.
requestId

string

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

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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