Gibt alle Zeilen zurück, die mit der Suchanfrage übereinstimmen.
Liste der ausgelösten 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
Parameters | |
---|---|
customerId |
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 ( |
Felder | |
---|---|
query |
Erforderlich. Der Abfragestring. |
pageToken |
Token der abzurufenden Seite. Wenn nicht angegeben, wird die erste Ergebnisseite zurückgegeben. Verwenden Sie den Wert aus |
pageSize |
Anzahl der Elemente, die auf einer einzelnen Seite abgerufen werden sollen. Wenn eine zu große Seite angefordert wird, entscheidet der Server unter Umständen, die Anzahl der zurückgegebenen Ressourcen weiter zu begrenzen. |
validateOnly |
Bei „true“ wird die Anfrage validiert, aber nicht ausgeführt. |
returnTotalResultsCount |
Bei „true“ wird die Gesamtzahl der Ergebnisse, die der Abfrage entsprechen und die LIMIT-Klausel ignorieren, in die Antwort aufgenommen. Der Standardwert ist "false". |
summaryRowSetting |
Bestimmt, ob eine Zusammenfassungszeile zurückgegeben wird. Standardmäßig wird keine Zusammenfassungszeile zurückgegeben. Bei 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 ( |
Felder | |
---|---|
results[] |
Die Liste der Zeilen, die der Abfrage entsprechen. |
nextPageToken |
Das Paginierungstoken zum Abrufen der nächsten Ergebnisseite. Übergeben Sie den Inhalt dieses Strings als |
totalResultsCount |
Gesamtzahl der Ergebnisse, die mit der Abfrage übereinstimmen, wobei die LIMIT-Klausel ignoriert wird. |
fieldMask |
FieldMask, die angibt, welche Felder vom Nutzer angefordert wurden. Dies ist eine durch Kommas getrennte Liste voll qualifizierter Feldnamen. Beispiel: |
summaryRow |
Zusammenfassungszeile mit einer Zusammenfassung der Messwerte in den Ergebnissen. Bei der Zusammenfassung der Messwerte werden die Messwerte für alle Ergebnisse zusammengefasst. Die Aggregation kann in diesem Fall Summe, Durchschnitt, Rate usw. sein. |
customColumnHeaders[] |
Die Überschriften der benutzerdefinierten Spalten in den Ergebnissen. |
conversionCustomMetricHeaders[] |
Die Header der benutzerdefinierten Conversion-Messwerte in den Ergebnissen. |
conversionCustomDimensionHeaders[] |
Die Überschriften der benutzerdefinierten Conversion-Dimensionen in den Ergebnissen. |
rawEventConversionMetricHeaders[] |
Die Header der Rohdaten zu Ereignis-Conversions in den Ergebnissen. |
rawEventConversionDimensionHeaders[] |
Die Header der Conversion-Dimensionen von Rohereignissen in den Ergebnissen. |
Autorisierungsbereiche
Erfordert den folgenden OAuth-Bereich:
https://www.googleapis.com/auth/doubleclicksearch