Method: customers.uploadClickConversions

Traite les conversions après clic données.

Liste des erreurs générées: AuthenticationError AuthorizationError ConversionUploadError HeaderError InternalError PartialFailureError QuotaError RequestError

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
customerId

string

Obligatoire. Identifiant du client effectuant l'importation.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "conversions": [
    {
      object (ClickConversion)
    }
  ],
  "partialFailure": boolean,
  "validateOnly": boolean,
  "debugEnabled": boolean,
  "jobId": integer
}
Champs
conversions[]

object (ClickConversion)

Obligatoire. Conversions en cours d'importation.
partialFailure

boolean

Obligatoire. Si la valeur est "true", les opérations réussies sont effectuées et les opérations non valides renvoient des erreurs. Si la valeur est "false", toutes les opérations seront effectuées en une seule transaction si et seulement si elles sont toutes valides. Doit toujours être défini sur "true". Pour en savoir plus sur les échecs partiels, consultez la page https://developers.google.com/google-ads/api/docs/best-practices/partial-failures.
validateOnly

boolean

Si la valeur est "true", la requête est validée, mais pas exécutée. Seules les erreurs sont renvoyées, pas les résultats.
debugEnabled

boolean

Si la valeur est "true", l'API effectue toutes les vérifications d'importation et renvoie des erreurs le cas échéant. Si la valeur est "false", il n'effectuera que la validation de base des entrées, ignorera les vérifications d'importation ultérieures et renverra un message de réussite même si aucun clic n'a été trouvé pour le userIdentifiers fourni.

Ce paramètre n'a d'incidence que sur le suivi avancé des conversions pour les importations de prospects qui utilisent userIdentifiers au lieu de GCLID, GBRAID ou WBRAID. Lorsque vous importez le suivi avancé des conversions pour les prospects, vous devez importer tous les événements de conversion dans l'API, y compris ceux qui ne proviennent peut-être pas de campagnes Google Ads. L'importation d'un événement qui ne provient pas d'une campagne Google Ads génère une erreur CLICK_NOT_FOUND si ce champ est défini sur true. Étant donné que ces erreurs sont attendues pour ce type d'événements, définissez ce champ sur false pour vérifier que vos importations sont correctement formatées, mais ignorer les erreurs CLICK_NOT_FOUND de toutes les conversions qui ne proviennent pas d'une campagne Google Ads. Cela vous permettra de vous concentrer uniquement sur les erreurs que vous pouvez corriger.

La valeur par défaut est "false".
jobId

integer

Facultatif. Entrée facultative permettant de définir l'ID du job. Doit être un nombre non négatif inférieur à 2^31, le cas échéant. Si ce champ n'est pas fourni, l'API génère un ID de job compris dans la plage [2^31, (2^63)-1]. L'API renvoie la valeur de cette requête dans le champ jobId de UploadClickConversionsResponse.

Corps de la réponse

Message de réponse pour ConversionUploadService.UploadClickConversions.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "partialFailureError": {
    object (Status)
  },
  "results": [
    {
      object (ClickConversionResult)
    }
  ],
  "jobId": string
}
Champs
partialFailureError

object (Status)

Erreurs liées aux échecs de conversion en mode d'échec partiel. Est renvoyé lorsque toutes les erreurs se produisent dans les conversions. Si des erreurs se produisent en dehors des conversions (erreurs d'authentification, par exemple), nous renvoyons une erreur au niveau du RPC. Pour en savoir plus sur les échecs partiels, consultez la page https://developers.google.com/google-ads/api/docs/best-practices/partial-failures.
results[]

object (ClickConversionResult)

Est renvoyé pour les conversions traitées. Proto sera vide pour les lignes qui ont reçu une erreur. Les résultats ne sont pas renvoyés lorsque validateOnly est défini sur true.
jobId

string (int64 format)

ID du job du lot d'importation.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour en savoir plus, consultez la présentation d'OAuth 2.0.

ClickConversion

Conversion après clic.

Représentation JSON 
{
  "gbraid": string,
  "wbraid": string,
  "externalAttributionData": {
    object (ExternalAttributionData)
  },
  "customVariables": [
    {
      object (CustomVariable)
    }
  ],
  "cartData": {
    object (CartData)
  },
  "userIdentifiers": [
    {
      object (UserIdentifier)
    }
  ],
  "conversionEnvironment": enum (ConversionEnvironment),
  "consent": {
    object (Consent)
  },
  "gclid": string,
  "conversionAction": string,
  "conversionDateTime": string,
  "conversionValue": number,
  "currencyCode": string,
  "orderId": string
}
Champs
gbraid

string

Identifiant de clic pour les clics associés aux conversions d'application et provenant d'appareils iOS à partir d'iOS 14.
wbraid

string

Identifiant de clic pour les clics associés à des conversions Web et provenant d'appareils iOS à partir d'iOS 14.
externalAttributionData

object (ExternalAttributionData)

Données supplémentaires sur les conversions attribuées de façon externe. Ce champ est obligatoire pour les conversions associées à une action de conversion attribuée de façon externe, mais vous ne devez pas le définir autrement.
customVariables[]

object (CustomVariable)

Variables personnalisées associées à cette conversion.
cartData

object (CartData)

Données du panier associées à cette conversion.
userIdentifiers[]

object (UserIdentifier)

Identifiants utilisateur associés à cette conversion. L'importation des conversions n'est possible que pour hashedEmail et hashedPhoneNumber. Le nombre maximal d'identifiants utilisateur pour chaque conversion est de cinq.
conversionEnvironment

enum (ConversionEnvironment)

Environnement dans lequel cette conversion a été enregistrée (application ou Web, par exemple).
consent

object (Consent)

Paramètre de consentement pour l'événement.
gclid

string

ID de clic Google (GCLID) associé à cette conversion.
conversionAction

string

Nom de ressource de l'action de conversion associée à cette conversion. Remarque: Bien que ce nom de ressource se compose d'un numéro client et d'un ID d'action de conversion, la validation ignorera le numéro client et utilisera l'ID de l'action de conversion comme unique identifiant de l'action de conversion.
conversionDateTime

string

Il s'agit de la date et de l'heure auxquelles la conversion s'est produite. Doit être postérieure à l'heure du clic. Vous devez indiquer le fuseau horaire. Le format est "aaaa-mm-jj hh:mm:ss+|-hh:mm" (par exemple, "2019-01-01 12:32:45-08:00").
conversionValue

number

Valeur de la conversion pour l'annonceur.
currencyCode

string

Devise associée à la valeur de conversion. Il s'agit du code de devise ISO 4217 à trois caractères. Par exemple: USD, EUR.
orderId

string

ID de commande associé à la conversion. Un ID de commande ne peut être utilisé que pour une seule conversion par action de conversion.

ExternalAttributionData

Contient des informations supplémentaires sur les conversions attribuées de façon externe.

Représentation JSON 
{
  "externalAttributionCredit": number,
  "externalAttributionModel": string
}
Champs
externalAttributionCredit

number

Représente la fraction de la conversion attribuée au clic Google Ads.
externalAttributionModel

string

Spécifie le nom du modèle d'attribution.

CartData

Contient des informations supplémentaires sur les données du panier.

Représentation JSON 
{
  "merchantId": string,
  "feedCountryCode": string,
  "feedLanguageCode": string,
  "localTransactionCost": number,
  "items": [
    {
      object (Item)
    }
  ]
}
Champs
merchantId

string (int64 format)

ID Merchant Center dans lequel les articles sont importés.
feedCountryCode

string

Code pays associé au flux dans lequel les articles sont importés.
feedLanguageCode

string

Code de langue associé au flux dans lequel les articles sont importés.
localTransactionCost

number

Somme de toutes les remises appliquées aux transactions, comme la livraison sans frais et les bons de réduction applicables à l'ensemble du panier. Le code de devise est le même que celui du message ClickConversion.
items[]

object (Item)

Données des articles achetés.

Article

Contient des données sur les articles achetés.

Représentation JSON 
{
  "productId": string,
  "quantity": integer,
  "unitPrice": number
}
Champs
productId

string

Identifiant Shopping de l'article. Doit correspondre au code produit Merchant Center.
quantity

integer

Nombre d'articles vendus.
unitPrice

number

Prix unitaire hors taxes, frais de livraison et éventuelles remises au niveau des transactions. Le code de devise est le même que celui du message ClickConversion.

ConversionEnvironment

Environnement de la conversion importée.

Enums
UNSPECIFIED Non spécifié.
UNKNOWN Utilisé pour la valeur renvoyée uniquement. Représente une valeur inconnue dans cette version.
APP La conversion a été enregistrée dans une application.
WEB La conversion a été enregistrée sur un site Web.

ClickConversionResult

Informations d'identification pour une conversion de clic correctement traitée.

Représentation JSON 
{
  "gbraid": string,
  "wbraid": string,
  "userIdentifiers": [
    {
      object (UserIdentifier)
    }
  ],
  "gclid": string,
  "conversionAction": string,
  "conversionDateTime": string
}
Champs
gbraid

string

Identifiant de clic pour les clics associés aux conversions d'application et provenant d'appareils iOS à partir d'iOS 14.
wbraid

string

Identifiant de clic pour les clics associés à des conversions Web et provenant d'appareils iOS à partir d'iOS 14.
userIdentifiers[]

object (UserIdentifier)

Identifiants utilisateur associés à cette conversion. L'importation des conversions n'est possible que pour hashedEmail et hashedPhoneNumber. Le nombre maximal d'identifiants utilisateur pour chaque conversion est de cinq.
gclid

string

ID de clic Google (gclid) associé à cette conversion.
conversionAction

string

Nom de ressource de l'action de conversion associée à cette conversion.
conversionDateTime

string

Il s'agit de la date et de l'heure auxquelles la conversion s'est produite. Le format est "aaaa-mm-jj hh:mm:ss+|-hh:mm" (par exemple, "2019-01-01 12:32:45-08:00").