Method: customers.googleAds.search

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

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

HTTP-Anfrage

POST https://googleads.googleapis.com/v16/customers/{customerId}/googleAds:search

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameters
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 nicht angegeben, wird die erste Ergebnisseite zurückgegeben. Verwenden Sie den Wert aus nextPageToken aus der vorherigen Antwort, 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, entscheidet der Server unter Umständen, die Anzahl der zurückgegebenen Ressourcen weiter zu begrenzen.
validateOnly

boolean

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

boolean

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

enum (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 GoogleAdsService.Search.

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

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

object (GoogleAdsRow)

Die Liste der Zeilen, die der Abfrage entsprechen.
nextPageToken

string

Das Paginierungstoken zum Abrufen der nächsten Ergebnisseite. Übergeben Sie den Inhalt dieses Strings als pageToken-Attribut der nächsten Anfrage. nextPageToken wird für die letzte Seite nicht zurückgegeben.
totalResultsCount

string (int64 format)

Gesamtzahl der Ergebnisse, die mit der Abfrage übereinstimmen, wobei die LIMIT-Klausel ignoriert wird.
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 (GoogleAdsRow)

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.
queryResourceConsumption

string (int64 format)

Die Menge der Ressourcen, die zum Ausführen der Abfrage verbraucht wurden.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.