Method: customers.searchAds360.search

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

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

HTTP-Anfrage

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

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,
  "pageToken": string,
  "pageSize": integer,
  "validateOnly": boolean,
  "returnTotalResultsCount": boolean,
  "summaryRowSetting": enum (SummaryRowSetting)
}
Felder
query

string

Erforderlich. Der Abfragestring.
pageToken

string

Token der abzurufenden Seite. Wenn keine Angabe erfolgt, wird die erste Ergebnisseite zurückgegeben. Verwenden Sie den Wert aus der vorherigen Antwort von nextPageToken, um die nächste Ergebnisseite anzufordern.
pageSize

integer

Anzahl der Elemente, die auf einer einzelnen Seite abgerufen werden sollen. Wenn eine zu große Seite angefordert wird, kann der Server die Anzahl der zurückgegebenen Ressourcen weiter einschränken.
validateOnly

boolean

Wenn „true“, wird die Anfrage validiert, aber nicht ausgeführt.
returnTotalResultsCount

boolean

Falls wahr, wird die Gesamtzahl der Ergebnisse, die mit der Abfrage übereinstimmen, ohne die LIMIT-Klausel zu berücksichtigen, in die Antwort aufgenommen. Der Standardwert ist "false".
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 SearchAds360Service.Search.

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

JSON-Darstellung 
{
  "results": [
    {
      object (SearchAds360Row)
    }
  ],
  "nextPageToken": string,
  "totalResultsCount": string,
  "fieldMask": string,
  "summaryRow": {
    object (SearchAds360Row)
  },
  "customColumnHeaders": [
    {
      object (CustomColumnHeader)
    }
  ],
  "conversionCustomMetricHeaders": [
    {
      object (ConversionCustomMetricHeader)
    }
  ],
  "conversionCustomDimensionHeaders": [
    {
      object (ConversionCustomDimensionHeader)
    }
  ],
  "rawEventConversionMetricHeaders": [
    {
      object (RawEventConversionMetricHeader)
    }
  ],
  "rawEventConversionDimensionHeaders": [
    {
      object (RawEventConversionDimensionHeader)
    }
  ]
}
Felder
results[]

object (SearchAds360Row)

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

string

Paginierungstoken, mit dem die nächste Ergebnisseite abgerufen wird. Übergeben Sie den Inhalt dieses Strings als pageToken-Attribut der nächsten Anfrage. Für die letzte Seite wird kein nextPageToken zurückgegeben.
totalResultsCount

string (int64 format)

Die Gesamtzahl der Ergebnisse, die mit der Abfrage übereinstimmen, ohne Berücksichtigung der LIMIT-Klausel.
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 von Messwerten“ bedeutet die Aggregation von Messwerten über alle Ergebnisse hinweg. Hier kann die Aggregation beispielsweise „Summe“, „Durchschnitt“ oder „Rate“ 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-Dimensionen in den Ergebnissen.
rawEventConversionMetricHeaders[]

object (RawEventConversionMetricHeader)

Die Überschriften der Rohmesswerte für Conversion-Ereignisse in den Ergebnissen.
rawEventConversionDimensionHeaders[]

object (RawEventConversionDimensionHeader)

Die Überschriften der Dimensionen für Rohdaten-Conversion-Ereignisse in den Ergebnissen.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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