Method: customers.uploadClickConversions

Verarbeitet die angegebenen Klick-Conversions.

Liste der ausgelösten Fehler: AuthenticationError AuthorizationError ConversionUploadError HeaderError InternalError PartialFailureError QuotaError RequestError

HTTP-Anfrage

POST https://googleads.googleapis.com/v14/customers/{customerId}:uploadClickConversions

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
customerId

string

Erforderlich. Die ID des Kunden, der den Upload durchführt.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung
{
  "conversions": [
    {
      object (ClickConversion)
    }
  ],
  "partialFailure": boolean,
  "validateOnly": boolean,
  "debugEnabled": boolean
}
Felder
conversions[]

object (ClickConversion)

Erforderlich. Die Conversions, die hochgeladen werden.

partialFailure

boolean

Erforderlich. Bei Einstellung auf „true“ werden erfolgreiche Vorgänge ausgeführt und bei ungültigen Vorgängen werden Fehler zurückgegeben. Bei „false“ werden alle Vorgänge nur dann in einer Transaktion ausgeführt, wenn sie alle gültig sind. Dies sollte immer auf „true“ festgelegt sein. Weitere Informationen zu teilweisen Fehlern finden Sie unter https://developers.google.com/google-ads/api/docs/best-practices/partial-failures.

validateOnly

boolean

Falls wahr, wird die Anfrage validiert, aber nicht ausgeführt. Es werden nur Fehler zurückgegeben, keine Ergebnisse.

debugEnabled

boolean

Wenn „true“ festgelegt ist, führt die API alle Uploadprüfungen durch und gibt Fehler zurück, falls solche gefunden werden. Bei „false“ wird nur eine grundlegende Eingabevalidierung durchgeführt, nachfolgende Uploadprüfungen werden übersprungen und der Erfolg wird zurückgegeben, auch wenn für die angegebene userIdentifiers kein Klick gefunden wurde.

Diese Einstellung wirkt sich nur auf erweiterte Conversions für Lead-Uploads aus, in denen userIdentifiers statt GCLID, GBRAID oder WBRAID verwendet wird. Wenn Sie erweiterte Conversions für Leads hochladen, sollten Sie alle Conversion-Ereignisse in die API hochladen – auch solche, die nicht aus Google Ads-Kampagnen stammen. Wenn Sie ein Ereignis hochladen, das nicht aus einer Google Ads-Kampagne stammt, wird der Fehler CLICK_NOT_FOUND ausgegeben, wenn dieses Feld auf true gesetzt ist. Da diese Fehler für solche Ereignisse zu erwarten sind, legen Sie dieses Feld auf false fest. So können Sie prüfen, ob Ihre Uploads richtig formatiert sind, aber CLICK_NOT_FOUND-Fehler aus allen Conversions ignorieren, die nicht aus einer Google Ads-Kampagne stammen. So können Sie sich auf Fehler konzentrieren, die Sie beheben können.

Der Standardwert ist "false".

Antworttext

Antwortnachricht für ConversionUploadService.UploadClickConversions.

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

JSON-Darstellung
{
  "partialFailureError": {
    object (Status)
  },
  "results": [
    {
      object (ClickConversionResult)
    }
  ],
  "jobId": string
}
Felder
partialFailureError

object (Status)

Fehler, die sich auf Konvertierungsfehler im teilweisen Fehlermodus beziehen. Wird zurückgegeben, wenn alle Fehler innerhalb der Conversions auftreten. Wenn Fehler außerhalb der Conversions auftreten (z. B. Authentifizierungsfehler), wird ein Fehler auf RPC-Ebene zurückgegeben. Weitere Informationen zu teilweisen Fehlern finden Sie unter https://developers.google.com/google-ads/api/docs/best-practices/partial-failures.

results[]

object (ClickConversionResult)

Wird für erfolgreich verarbeitete Conversions zurückgegeben. Proto ist für Zeilen, in denen ein Fehler aufgetreten ist, leer. Es werden keine Ergebnisse zurückgegeben, wenn "validOnly" den Wert "true" hat.

jobId

string (int64 format)

Job-ID für den Upload-Batch.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

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

ClickConversion

Eine Klick-Conversion

JSON-Darstellung
{
  "gbraid": string,
  "wbraid": string,
  "externalAttributionData": {
    object (ExternalAttributionData)
  },
  "customVariables": [
    {
      object (CustomVariable)
    }
  ],
  "cartData": {
    object (CartData)
  },
  "userIdentifiers": [
    {
      object (UserIdentifier)
    }
  ],
  "conversionEnvironment": enum (ConversionEnvironment),
  "gclid": string,
  "conversionAction": string,
  "conversionDateTime": string,
  "conversionValue": number,
  "currencyCode": string,
  "orderId": string
}
Felder
gbraid

string

Die Klick-ID für Klicks, die mit App-Conversions verknüpft sind und von iOS-Geräten ab iOS 14 stammen.

wbraid

string

Die Klick-ID für Klicks, die mit Web-Conversions verknüpft sind und von iOS-Geräten ab iOS 14 stammen.

externalAttributionData

object (ExternalAttributionData)

Zusätzliche Daten zu extern zugeordneten Conversions. Dieses Feld ist für Conversions mit einer extern zugeordneten Conversion-Aktion erforderlich, sollte aber nicht anderweitig festgelegt werden.

customVariables[]

object (CustomVariable)

Die benutzerdefinierten Variablen, die mit dieser Conversion verknüpft sind.

cartData

object (CartData)

Die mit dieser Conversion verknüpften Warenkorbdaten.

userIdentifiers[]

object (UserIdentifier)

Die Nutzerkennungen, die mit dieser Conversion verknüpft sind. Für Conversion-Uploads werden nur hashedEmail und hashedPhoneNumber unterstützt. Für jede Conversion sind maximal 5 Nutzerkennungen zulässig.

conversionEnvironment

enum (ConversionEnvironment)

Die Umgebung, in der diese Conversion erfasst wurde, z. B. App oder Web.

gclid

string

Die GCLID (Google Click ID), die dieser Conversion zugeordnet ist.

conversionAction

string

Ressourcenname der Conversion-Aktion, die mit dieser Conversion verknüpft ist. Hinweis: Obwohl dieser Ressourcenname aus einer Kundennummer und einer ID für die Conversion-Aktion besteht, wird die Kundennummer bei der Validierung ignoriert. Stattdessen wird die ID der Conversion-Aktion als einzige Kennung der Conversion-Aktion verwendet.

conversionDateTime

string

Datum und Uhrzeit der Conversion Muss nach dem Klickzeitpunkt liegen. Die Zeitzone muss angegeben werden. Das Format ist "jjjj-mm-tt hh:mm:ss+|-hh:mm", z. B. "2019-01-01 12:32:45-08:00".

conversionValue

number

Der Wert der Conversion für den Werbetreibenden.

currencyCode

string

Währung, die dem Conversion-Wert zugeordnet ist Dies ist der dreistellige Währungscode gemäß ISO 4217. Beispiel: USD, EUR.

orderId

string

Die Bestell-ID, die der Conversion zugeordnet ist. Eine Bestell-ID kann nur für eine Conversion pro Conversion-Aktion verwendet werden.

ExternalAttributionData

Enthält zusätzliche Informationen zu extern zugeordneten Conversions.

JSON-Darstellung
{
  "externalAttributionCredit": number,
  "externalAttributionModel": string
}
Felder
externalAttributionCredit

number

Anteil der Conversion, die auf den Google Ads-Klick zurückzuführen ist

externalAttributionModel

string

Gibt den Namen des Attributionsmodells an.

CartData

Enthält zusätzliche Informationen zu Warenkorbdaten.

JSON-Darstellung
{
  "merchantId": string,
  "feedCountryCode": string,
  "feedLanguageCode": string,
  "localTransactionCost": number,
  "items": [
    {
      object (Item)
    }
  ]
}
Felder
merchantId

string (int64 format)

Die Merchant Center-ID, in die die Artikel hochgeladen werden.

feedCountryCode

string

Der Ländercode, der mit dem Feed verknüpft ist, in den die Artikel hochgeladen werden.

feedLanguageCode

string

Der Sprachcode, der mit dem Feed verknüpft ist, in den die Artikel hochgeladen werden.

localTransactionCost

number

Summe aller Rabatte auf Transaktionsebene, z. B. kostenloser Versand und Gutscheinrabatte für den gesamten Einkaufswagen. Der Währungscode ist derselbe wie in der ClickConversion-Nachricht.

items[]

object (Item)

Daten zu den gekauften Artikeln.

Element

Enthält Daten zu den gekauften Artikeln.

JSON-Darstellung
{
  "productId": string,
  "quantity": integer,
  "unitPrice": number
}
Felder
productId

string

Die Shopping-ID des Artikels. Muss mit der Merchant Center-Produktkennzeichnung übereinstimmen.

quantity

integer

Anzahl verkaufter Artikel

unitPrice

number

Preis pro Einheit ohne Steuern, Versandkosten und Rabatte auf Transaktionsebene. Der Währungscode ist derselbe wie in der ClickConversion-Nachricht.

ConversionEnvironment

Conversion-Umgebung der hochgeladenen Conversion.

Enums
UNSPECIFIED Nicht angegeben.
UNKNOWN Wird nur für den Rückgabewert verwendet. Stellt den in dieser Version unbekannten Wert dar.
APP Die Conversion wurde in einer App erfasst.
WEB Die Conversion wurde auf einer Website erfasst.

ClickConversionResult

Identifizierungsinformationen für eine erfolgreich verarbeitete ClickConversion.

JSON-Darstellung
{
  "gbraid": string,
  "wbraid": string,
  "userIdentifiers": [
    {
      object (UserIdentifier)
    }
  ],
  "gclid": string,
  "conversionAction": string,
  "conversionDateTime": string
}
Felder
gbraid

string

Die Klick-ID für Klicks, die mit App-Conversions verknüpft sind und von iOS-Geräten ab iOS 14 stammen.

wbraid

string

Die Klick-ID für Klicks, die mit Web-Conversions verknüpft sind und von iOS-Geräten ab iOS 14 stammen.

userIdentifiers[]

object (UserIdentifier)

Die Nutzerkennungen, die mit dieser Conversion verknüpft sind. Für Conversion-Uploads werden nur hashedEmail und hashedPhoneNumber unterstützt. Für jede Conversion sind maximal 5 Nutzerkennungen zulässig.

gclid

string

Die mit dieser Conversion verknüpfte GCLID (Google Click ID).

conversionAction

string

Ressourcenname der Conversion-Aktion, die mit dieser Conversion verknüpft ist.

conversionDateTime

string

Datum und Uhrzeit der Conversion Das Format ist "jjjj-mm-tt hh:mm:ss+|-hh:mm", z. B. "2019-01-01 12:32:45-08:00".