Method: customers.searchAds360.search

Gibt alle Zeilen zurück, die der Suchanfrage 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:search

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,
  "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 Seite der Ergebnisse zurückgegeben. Verwenden Sie den Wert von nextPageToken in der vorherigen Antwort, um die nächste Seite der Ergebnisse 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 begrenzen.
validateOnly

boolean

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

boolean

Wenn „true“, wird die Gesamtzahl der Ergebnisse, die der Abfrage entsprechen, ohne Berücksichtigung der LIMIT-Klausel 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. Wenn angefordert, wird die Zusammenfassungszeile in einer separaten 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 der Abfrage entsprechen.
nextPageToken

string

Paginierungstoken zum Abrufen der nächsten Seite der Ergebnisse. Übergeben Sie den Inhalt dieser String als Attribut pageToken der nächsten Anfrage. nextPageToken wird für die letzte Seite nicht zurückgegeben.
totalResultsCount

string (int64 format)

Gesamtzahl der Ergebnisse, die der Abfrage entsprechen, 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 voll qualifizierter Feldnamen. Beispiel: "user.displayName,photo".
summaryRow

object (SearchAds360Row)

Zusammenfassungszeile mit einer Zusammenfassung der Messwerte in den Ergebnissen. Die Zusammenfassung der Messwerte ist die 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-Dimensionen 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.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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