Vous pouvez utiliser l'API Google Ads pour importer des conversions par clic hors connexion dans Google Ads afin de suivre les annonces ayant généré des ventes dans le monde hors connexion, par exemple par téléphone ou via un représentant commercial.
Configuration
Pour que la configuration des conversions hors connexion fonctionne, vous devez remplir quelques conditions préalables. Assurez-vous que toutes les conditions préalables sont remplies avant de procéder à l'implémentation:
Activez le suivi des conversions dans votre client de conversion Google Ads.
Configurez le taggage et stockez les ID de clic.
1. Activer le suivi des conversions dans votre client de conversion Google Ads
Si vous avez suivi le guide de démarrage sur les conversions et que le suivi des conversions est activé, vous pouvez passer à l'étape 2: configurer le taggage.
Récupérer des informations sur la configuration de votre suivi des conversions
Vous pouvez vérifier la configuration du suivi des conversions de votre compte et vous assurer qu'il est activé en interrogeant la ressource Customer
pour ConversionTrackingSetting
.
Exécutez la requête suivante avec GoogleAdsService.SearchStream
:
SELECT
customer.conversion_tracking_setting.google_ads_conversion_customer,
customer.conversion_tracking_setting.conversion_tracking_status,
customer.conversion_tracking_setting.conversion_tracking_id,
customer.conversion_tracking_setting.cross_account_conversion_tracking_id
FROM customer
Le champ google_ads_conversion_customer
indique le compte Google Ads qui crée et gère les conversions pour ce client. Pour les clients qui utilisent le suivi des conversions multicomptes, il s'agit de l'ID d'un compte administrateur. L'ID client de la conversion Google Ads doit être indiqué comme customer_id
dans les requêtes de l'API Google Ads pour créer et gérer des conversions.
Notez que ce champ est renseigné même si le suivi des conversions n'est pas activé.
Le champ conversion_tracking_status
indique si le suivi des conversions est activé et si le compte utilise le suivi des conversions multicomptes.
Créez une action de conversion sous le client de conversion Google Ads.
Si la valeur conversion_tracking_status
est NOT_CONVERSION_TRACKED
, le suivi des conversions n'est pas activé pour le compte. Activez le suivi des conversions en créant au moins un ConversionAction
dans le compte de conversion Google Ads, comme dans l'exemple suivant. Vous pouvez également créer une action de conversion dans l'UI en suivant les instructions du Centre d'aide pour le type de conversion que vous souhaitez activer.
Notez que le suivi avancé des conversions est activé automatiquement lorsqu'il est envoyé via l'API Google Ads, mais qu'il peut être désactivé via l'UI Google Ads.
Exemple de code
Java
private void runExample(GoogleAdsClient googleAdsClient, long customerId) { // Creates a ConversionAction. ConversionAction conversionAction = ConversionAction.newBuilder() // Note that conversion action names must be unique. If a conversion action already // exists with the specified conversion_action_name the create operation will fail with // a ConversionActionError.DUPLICATE_NAME error. .setName("Earth to Mars Cruises Conversion #" + getPrintableDateTime()) .setCategory(ConversionActionCategory.DEFAULT) .setType(ConversionActionType.WEBPAGE) .setStatus(ConversionActionStatus.ENABLED) .setViewThroughLookbackWindowDays(15L) .setValueSettings( ValueSettings.newBuilder() .setDefaultValue(23.41) .setAlwaysUseDefaultValue(true) .build()) .build(); // Creates the operation. ConversionActionOperation operation = ConversionActionOperation.newBuilder().setCreate(conversionAction).build(); try (ConversionActionServiceClient conversionActionServiceClient = googleAdsClient.getLatestVersion().createConversionActionServiceClient()) { MutateConversionActionsResponse response = conversionActionServiceClient.mutateConversionActions( Long.toString(customerId), Collections.singletonList(operation)); System.out.printf("Added %d conversion actions:%n", response.getResultsCount()); for (MutateConversionActionResult result : response.getResultsList()) { System.out.printf( "New conversion action added with resource name: '%s'%n", result.getResourceName()); } } }
C#
public void Run(GoogleAdsClient client, long customerId) { // Get the ConversionActionService. ConversionActionServiceClient conversionActionService = client.GetService(Services.V18.ConversionActionService); // Note that conversion action names must be unique. // If a conversion action already exists with the specified name the create operation // will fail with a ConversionAction.DUPLICATE_NAME error. string ConversionActionName = "Earth to Mars Cruises Conversion #" + ExampleUtilities.GetRandomString(); // Add a conversion action. ConversionAction conversionAction = new ConversionAction() { Name = ConversionActionName, Category = ConversionActionCategory.Default, Type = ConversionActionType.Webpage, Status = ConversionActionStatus.Enabled, ViewThroughLookbackWindowDays = 15, ValueSettings = new ConversionAction.Types.ValueSettings() { DefaultValue = 23.41, AlwaysUseDefaultValue = true } }; // Create the operation. ConversionActionOperation operation = new ConversionActionOperation() { Create = conversionAction }; try { // Create the conversion action. MutateConversionActionsResponse response = conversionActionService.MutateConversionActions(customerId.ToString(), new ConversionActionOperation[] { operation }); // Display the results. foreach (MutateConversionActionResult newConversionAction in response.Results) { Console.WriteLine($"New conversion action with resource name = " + $"'{newConversionAction.ResourceName}' was added."); } } catch (GoogleAdsException e) { Console.WriteLine("Failure:"); Console.WriteLine($"Message: {e.Message}"); Console.WriteLine($"Failure: {e.Failure}"); Console.WriteLine($"Request ID: {e.RequestId}"); throw; } }
PHP
public static function runExample(GoogleAdsClient $googleAdsClient, int $customerId) { // Creates a conversion action. $conversionAction = new ConversionAction([ // Note that conversion action names must be unique. // If a conversion action already exists with the specified conversion_action_name // the create operation will fail with a ConversionActionError.DUPLICATE_NAME error. 'name' => 'Earth to Mars Cruises Conversion #' . Helper::getPrintableDatetime(), 'category' => ConversionActionCategory::PBDEFAULT, 'type' => ConversionActionType::WEBPAGE, 'status' => ConversionActionStatus::ENABLED, 'view_through_lookback_window_days' => 15, 'value_settings' => new ValueSettings([ 'default_value' => 23.41, 'always_use_default_value' => true ]) ]); // Creates a conversion action operation. $conversionActionOperation = new ConversionActionOperation(); $conversionActionOperation->setCreate($conversionAction); // Issues a mutate request to add the conversion action. $conversionActionServiceClient = $googleAdsClient->getConversionActionServiceClient(); $response = $conversionActionServiceClient->mutateConversionActions( MutateConversionActionsRequest::build($customerId, [$conversionActionOperation]) ); printf("Added %d conversion actions:%s", $response->getResults()->count(), PHP_EOL); foreach ($response->getResults() as $addedConversionAction) { /** @var ConversionAction $addedConversionAction */ printf( "New conversion action added with resource name: '%s'%s", $addedConversionAction->getResourceName(), PHP_EOL ); } }
Python
def main(client, customer_id): conversion_action_service = client.get_service("ConversionActionService") # Create the operation. conversion_action_operation = client.get_type("ConversionActionOperation") # Create conversion action. conversion_action = conversion_action_operation.create # Note that conversion action names must be unique. If a conversion action # already exists with the specified conversion_action_name, the create # operation will fail with a ConversionActionError.DUPLICATE_NAME error. conversion_action.name = f"Earth to Mars Cruises Conversion {uuid.uuid4()}" conversion_action.type_ = ( client.enums.ConversionActionTypeEnum.UPLOAD_CLICKS ) conversion_action.category = ( client.enums.ConversionActionCategoryEnum.DEFAULT ) conversion_action.status = client.enums.ConversionActionStatusEnum.ENABLED conversion_action.view_through_lookback_window_days = 15 # Create a value settings object. value_settings = conversion_action.value_settings value_settings.default_value = 15.0 value_settings.always_use_default_value = True # Add the conversion action. conversion_action_response = ( conversion_action_service.mutate_conversion_actions( customer_id=customer_id, operations=[conversion_action_operation], ) ) print( "Created conversion action " f'"{conversion_action_response.results[0].resource_name}".' )
Ruby
def add_conversion_action(customer_id) # GoogleAdsClient will read a config file from # ENV['HOME']/google_ads_config.rb when called without parameters client = Google::Ads::GoogleAds::GoogleAdsClient.new # Add a conversion action. conversion_action = client.resource.conversion_action do |ca| ca.name = "Earth to Mars Cruises Conversion #{(Time.new.to_f * 100).to_i}" ca.type = :UPLOAD_CLICKS ca.category = :DEFAULT ca.status = :ENABLED ca.view_through_lookback_window_days = 15 # Create a value settings object. ca.value_settings = client.resource.value_settings do |vs| vs.default_value = 15 vs.always_use_default_value = true end end # Create the operation. conversion_action_operation = client.operation.create_resource.conversion_action(conversion_action) # Add the ad group ad. response = client.service.conversion_action.mutate_conversion_actions( customer_id: customer_id, operations: [conversion_action_operation], ) puts "New conversion action with resource name = #{response.results.first.resource_name}." end
Perl
sub add_conversion_action { my ($api_client, $customer_id) = @_; # Note that conversion action names must be unique. # If a conversion action already exists with the specified conversion_action_name, # the create operation fails with error ConversionActionError.DUPLICATE_NAME. my $conversion_action_name = "Earth to Mars Cruises Conversion #" . uniqid(); # Create a conversion action. my $conversion_action = Google::Ads::GoogleAds::V18::Resources::ConversionAction->new({ name => $conversion_action_name, category => DEFAULT, type => WEBPAGE, status => ENABLED, viewThroughLookbackWindowDays => 15, valueSettings => Google::Ads::GoogleAds::V18::Resources::ValueSettings->new({ defaultValue => 23.41, alwaysUseDefaultValue => "true" })}); # Create a conversion action operation. my $conversion_action_operation = Google::Ads::GoogleAds::V18::Services::ConversionActionService::ConversionActionOperation ->new({create => $conversion_action}); # Add the conversion action. my $conversion_actions_response = $api_client->ConversionActionService()->mutate({ customerId => $customer_id, operations => [$conversion_action_operation]}); printf "New conversion action added with resource name: '%s'.\n", $conversion_actions_response->{results}[0]{resourceName}; return 1; }
Assurez-vous que conversion_action_type
est défini sur la valeur ConversionActionType
appropriée.
Pour en savoir plus sur la création d'actions de conversion dans l'API Google Ads, consultez Créer des actions de conversion.
Récupérer une action de conversion existante
Vous pouvez récupérer les détails d'une action de conversion existante en exécutant la requête suivante. Assurez-vous que le numéro client de la requête est défini sur le client de conversion Google Ads que vous avez identifié ci-dessus et que le type d'action de conversion est défini sur la valeur ConversionActionType
appropriée.
SELECT
conversion_action.resource_name,
conversion_action.name,
conversion_action.status
FROM conversion_action
WHERE conversion_action.type = 'INSERT_CONVERSION_ACTION_TYPE'
2. Configurer l'ajout de balises et stocker les ID de clic
Suivez les instructions pour vérifier que le taggage automatique est activé, puis configurez votre compte Google Ads, votre site Web et votre système de suivi des prospects afin de capturer et de stocker le GCLID, le GBRAID ou le WBRAID de chaque impression et clic pour vos annonces. Le taggage automatique est activé par défaut pour les nouveaux comptes.
Créer la requête
Suivez les instructions ci-dessous pour créer votre UploadClickConversionsRequest
et définir ses champs sur des valeurs appropriées.
customer_id
Identifie le compte Google Ads de votre importation. Définissez-le sur le client de conversion Google Ads du compte à l'origine des clics.
job_id
Fournit un mécanisme permettant d'associer vos requêtes d'importation aux informations par tâche dans les diagnostics de données hors connexion.
Si vous ne définissez pas ce champ, l'API Google Ads attribue à chaque requête une valeur unique comprise dans la plage
[2^31, 2^63)
. Si vous préférez regrouper plusieurs requêtes dans une seule tâche logique, définissez ce champ sur la même valeur de la plage[0, 2^31)
pour chaque requête de votre tâche.job_id
dans la réponse contient l'ID de tâche de la requête, que vous ayez spécifié une valeur ou laissé l'API Google Ads en attribuer une.partial_failure_enabled
Détermine la manière dont l'API Google Ads gère les erreurs des opérations.
Ce champ doit être défini sur
true
. Suivez les consignes concernant les échecs partiels lors du traitement de la réponse.debug_enabled
Détermine le comportement de création de rapports d'erreur pour les importations de suivi avancé des conversions pour les prospects. L'API Google Ads ignore ce champ lors de la gestion des importations pour les conversions par clic à l'aide de
gclid
,gbraid
ouwbraid
.
Créer des opérations de conversion par clic
La collection d'objets ClickConversion
de votre UploadClickConversionRequest
définit l'ensemble de conversions que vous souhaitez importer. Suivez les instructions ci-dessous pour créer chaque ClickConversion
et définir ses champs sur des valeurs appropriées.
Définir les champs obligatoires de chaque opération de conversion
Suivez les instructions ci-dessous pour définir les champs obligatoires de ClickConversion
sur des valeurs appropriées.
gclid
,gbraid
,wbraid
- Identifiant que vous avez capturé au moment du clic pour le clic ou l'impression de la conversion. Définissez uniquement un de ces champs.
conversion_date_time
Date et heure de la conversion.
La valeur doit comporter un fuseau horaire et le format doit être
yyyy-mm-dd HH:mm:ss+|-HH:mm
, par exemple:2022-01-01 19:32:45-05:00
(ignore l'heure d'été).Le fuseau horaire peut être une valeur valide quelconque. Il ne doit pas correspondre au fuseau horaire du compte. Toutefois, si vous prévoyez de comparer les données de conversion importées avec celles de l'interface utilisateur de Google Ads, nous vous recommandons d'utiliser le même fuseau horaire que celui de votre compte Google Ads afin que le nombre de conversions corresponde. Pour en savoir plus et obtenir des exemples, consultez le Centre d'aide. Vous trouverez la liste des ID de fuseau horaire valides dans la section Codes et formats.
user_identifiers
Ne définissez pas ce champ lorsque vous importez des conversions à l'aide d'ID de clic uniquement. Si ce champ est défini, Google Ads considère l'opération d'importation comme une importation pour le suivi avancé des conversions pour les prospects.
conversion_action
Nom de ressource de l'
ConversionAction
pour la conversion par clic.L'action de conversion doit avoir une valeur
type
deUPLOAD_CLICKS
et doit exister dans le client de conversion Google Ads du compte Google Ads associé au clic.conversion_value
Valeur de la conversion.
currency_code
Code de devise de l'
conversion_value
.
Définir les champs facultatifs de chaque opération de conversion
Consultez la liste des champs facultatifs ci-dessous et définissez-les sur votre ClickConversion
si nécessaire.
order_id
- ID de la transaction pour la conversion. Ce champ est facultatif, mais vivement recommandé. Si vous le définissez lors de l'importation, vous devez l'utiliser pour tous les ajustements apportés à la conversion.
external_attribution_data
Si vous utilisez des outils tiers ou des solutions internes pour suivre les conversions, vous pouvez attribuer à Google Ads une partie seulement du crédit de la conversion ou répartir le crédit d'une conversion entre plusieurs clics. Les importations de conversions attribuées de façon externe vous permettent d'importer des conversions avec un crédit partiel attribué à chaque clic.
Pour importer des crédits fractionnaires, définissez ce champ sur un objet
ExternalAttributionData
avec des valeurs pourexternal_attribution_model
etexternal_attribution_credit
.custom_variables
Valeurs des variables de conversion personnalisées.
Google Ads n'est pas compatible avec les variables de conversion personnalisées associées à
wbraid
ougbraid
.cart_data
Vous pouvez inclure des informations sur le panier pour un
ClickConversion
dans le champcart_data
, qui se compose des attributs suivants:merchant_id
: ID du compte Merchant Center associé.feed_country_code
: code de région ISO 3166 à deux caractères du flux Merchant Center.feed_language_code
: code de langue ISO 639-1 du flux Merchant Center.local_transaction_cost
: somme de toutes les remises appliquées aux transactions, dans lecurrency_code
de laClickConversion
.items
: les articles du panier.
Chaque élément de
items
comprend les attributs suivants:product_id
: ID du produit, parfois appelé ID de l'offre ou ID de l'article.quantity
: quantité de l'article.unit_price
: prix unitaire de l'article.
conversion_environment
Indique l'environnement dans lequel cette conversion a été enregistrée. (par exemple, application ou Web).
Exemple de code
Java
private void runExample( GoogleAdsClient googleAdsClient, long customerId, long conversionActionId, String gclid, String gbraid, String wbraid, String conversionDateTime, Double conversionValue, Long conversionCustomVariableId, String conversionCustomVariableValue, String orderId, ConsentStatus adUserDataConsent) throws InvalidProtocolBufferException { // Verifies that exactly one of gclid, gbraid, and wbraid is specified, as required. // See https://developers.google.com/google-ads/api/docs/conversions/upload-clicks for details. long numberOfIdsSpecified = Arrays.asList(gclid, gbraid, wbraid).stream().filter(idField -> idField != null).count(); if (numberOfIdsSpecified != 1) { throw new IllegalArgumentException( "Exactly 1 of gclid, gbraid, or wbraid is required, but " + numberOfIdsSpecified + " ID values were provided"); } // Constructs the conversion action resource name from the customer and conversion action IDs. String conversionActionResourceName = ResourceNames.conversionAction(customerId, conversionActionId); // Creates the click conversion. ClickConversion.Builder clickConversionBuilder = ClickConversion.newBuilder() .setConversionAction(conversionActionResourceName) .setConversionDateTime(conversionDateTime) .setConversionValue(conversionValue) .setCurrencyCode("USD"); // Sets the single specified ID field. if (gclid != null) { clickConversionBuilder.setGclid(gclid); } else if (gbraid != null) { clickConversionBuilder.setGbraid(gbraid); } else { clickConversionBuilder.setWbraid(wbraid); } if (conversionCustomVariableId != null && conversionCustomVariableValue != null) { // Sets the custom variable and value, if provided. clickConversionBuilder.addCustomVariables( CustomVariable.newBuilder() .setConversionCustomVariable( ResourceNames.conversionCustomVariable(customerId, conversionCustomVariableId)) .setValue(conversionCustomVariableValue)); } if (orderId != null) { // Sets the order ID (unique transaction ID), if provided. clickConversionBuilder.setOrderId(orderId); } // Sets the consent information, if provided. if (adUserDataConsent != null) { // Specifies whether user consent was obtained for the data you are uploading. See // https://www.google.com/about/company/user-consent-policy for details. clickConversionBuilder.setConsent(Consent.newBuilder().setAdUserData(adUserDataConsent)); } ClickConversion clickConversion = clickConversionBuilder.build(); // Creates the conversion upload service client. try (ConversionUploadServiceClient conversionUploadServiceClient = googleAdsClient.getLatestVersion().createConversionUploadServiceClient()) { // Uploads the click conversion. Partial failure should always be set to true. // NOTE: This request contains a single conversion as a demonstration. However, if you have // multiple conversions to upload, it's best to upload multiple conversions per request // instead of sending a separate request per conversion. See the following for per-request // limits: // https://developers.google.com/google-ads/api/docs/best-practices/quotas#conversion_upload_service UploadClickConversionsResponse response = conversionUploadServiceClient.uploadClickConversions( UploadClickConversionsRequest.newBuilder() .setCustomerId(Long.toString(customerId)) .addConversions(clickConversion) // Enables partial failure (must be true). .setPartialFailure(true) .build()); // Prints any partial errors returned. if (response.hasPartialFailureError()) { GoogleAdsFailure googleAdsFailure = ErrorUtils.getInstance().getGoogleAdsFailure(response.getPartialFailureError()); // Constructs a protocol buffer printer that will print error details in a concise format. Printer errorPrinter = JsonFormat.printer().omittingInsignificantWhitespace(); for (int operationIndex = 0; operationIndex < response.getResultsCount(); operationIndex++) { ClickConversionResult conversionResult = response.getResults(operationIndex); if (ErrorUtils.getInstance().isPartialFailureResult(conversionResult)) { // Prints the errors for the failed operation. System.out.printf("Operation %d failed with the following errors:%n", operationIndex); for (GoogleAdsError resultError : ErrorUtils.getInstance().getGoogleAdsErrors(operationIndex, googleAdsFailure)) { // Prints the error with newlines and extra spaces removed. System.out.printf(" %s%n", errorPrinter.print(resultError)); } } else { // Prints the information about the successful operation. StringBuilder clickInfoBuilder = new StringBuilder("conversion that occurred at ") .append(String.format("'%s' ", conversionResult.getConversionDateTime())) .append("with "); if (conversionResult.hasGclid()) { clickInfoBuilder.append(String.format("gclid '%s'", conversionResult.getGclid())); } else if (!conversionResult.getGbraid().isEmpty()) { clickInfoBuilder.append(String.format("gbraid '%s'", conversionResult.getGbraid())); } else if (!conversionResult.getWbraid().isEmpty()) { clickInfoBuilder.append(String.format("wbraid '%s'", conversionResult.getWbraid())); } else { clickInfoBuilder.append("no click ID"); } System.out.printf("Operation %d for %s succeeded.%n", operationIndex, clickInfoBuilder); } } } } }
C#
public void Run(GoogleAdsClient client, long customerId, long conversionActionId, string gclid, string gbraid, string wbraid, string conversionTime, double conversionValue, ConsentStatus? adUserDataConsent) { // Get the ConversionActionService. ConversionUploadServiceClient conversionUploadService = client.GetService(Services.V18.ConversionUploadService); // Creates a click conversion by specifying currency as USD. ClickConversion clickConversion = new ClickConversion() { ConversionAction = ResourceNames.ConversionAction(customerId, conversionActionId), ConversionValue = conversionValue, ConversionDateTime = conversionTime, CurrencyCode = "USD", }; // Sets the consent information, if provided. if (adUserDataConsent != null) { // Specifies whether user consent was obtained for the data you are uploading. See // https://www.google.com/about/company/user-consent-policy // for details. clickConversion.Consent = new Consent() { AdUserData = (ConsentStatus)adUserDataConsent }; } // Verifies that exactly one of gclid, gbraid, and wbraid is specified, as required. // See https://developers.google.com/google-ads/api/docs/conversions/upload-clicks // for details. string[] ids = { gclid, gbraid, wbraid }; int idCount = ids.Where(id => !string.IsNullOrEmpty(id)).Count(); if (idCount != 1) { throw new ArgumentException($"Exactly 1 of gclid, gbraid, or wbraid is " + $"required, but {idCount} ID values were provided"); } // Sets the single specified ID field. if (!string.IsNullOrEmpty(gclid)) { clickConversion.Gclid = gclid; } else if (!string.IsNullOrEmpty(wbraid)) { clickConversion.Wbraid = wbraid; } else if (!string.IsNullOrEmpty(gbraid)) { clickConversion.Gbraid = gbraid; } try { // Issues a request to upload the click conversion. UploadClickConversionsResponse response = conversionUploadService.UploadClickConversions( new UploadClickConversionsRequest() { CustomerId = customerId.ToString(), Conversions = { clickConversion }, PartialFailure = true, ValidateOnly = false }); // Prints the result. ClickConversionResult uploadedClickConversion = response.Results[0]; Console.WriteLine($"Uploaded conversion that occurred at " + $"'{uploadedClickConversion.ConversionDateTime}' from Google " + $"Click ID '{uploadedClickConversion.Gclid}' to " + $"'{uploadedClickConversion.ConversionAction}'."); } catch (GoogleAdsException e) { Console.WriteLine("Failure:"); Console.WriteLine($"Message: {e.Message}"); Console.WriteLine($"Failure: {e.Failure}"); Console.WriteLine($"Request ID: {e.RequestId}"); throw; } }
PHP
public static function runExample( GoogleAdsClient $googleAdsClient, int $customerId, int $conversionActionId, ?string $gclid, ?string $gbraid, ?string $wbraid, ?string $orderId, string $conversionDateTime, float $conversionValue, ?string $conversionCustomVariableId, ?string $conversionCustomVariableValue, ?int $adUserDataConsent ) { // Verifies that exactly one of gclid, gbraid, and wbraid is specified, as required. // See https://developers.google.com/google-ads/api/docs/conversions/upload-clicks for details. $nonNullFields = array_filter( [$gclid, $gbraid, $wbraid], function ($field) { return !is_null($field); } ); if (count($nonNullFields) !== 1) { throw new \UnexpectedValueException( sprintf( "Exactly 1 of gclid, gbraid or wbraid is required, but %d ID values were " . "provided", count($nonNullFields) ) ); } // Creates a click conversion by specifying currency as USD. $clickConversion = new ClickConversion([ 'conversion_action' => ResourceNames::forConversionAction($customerId, $conversionActionId), 'conversion_value' => $conversionValue, 'conversion_date_time' => $conversionDateTime, 'currency_code' => 'USD' ]); // Sets the single specified ID field. if (!is_null($gclid)) { $clickConversion->setGclid($gclid); } elseif (!is_null($gbraid)) { $clickConversion->setGbraid($gbraid); } else { $clickConversion->setWbraid($wbraid); } if (!is_null($conversionCustomVariableId) && !is_null($conversionCustomVariableValue)) { $clickConversion->setCustomVariables([new CustomVariable([ 'conversion_custom_variable' => ResourceNames::forConversionCustomVariable( $customerId, $conversionCustomVariableId ), 'value' => $conversionCustomVariableValue ])]); } // Sets the consent information, if provided. if (!empty($adUserDataConsent)) { // Specifies whether user consent was obtained for the data you are uploading. See // https://www.google.com/about/company/user-consent-policy for details. $clickConversion->setConsent(new Consent(['ad_user_data' => $adUserDataConsent])); } if (!empty($orderId)) { // Sets the order ID (unique transaction ID), if provided. $clickConversion->setOrderId($orderId); } // Issues a request to upload the click conversion. $conversionUploadServiceClient = $googleAdsClient->getConversionUploadServiceClient(); /** @var UploadClickConversionsResponse $response */ // NOTE: This request contains a single conversion as a demonstration. However, if you have // multiple conversions to upload, it's best to upload multiple conversions per request // instead of sending a separate request per conversion. See the following for per-request // limits: // https://developers.google.com/google-ads/api/docs/best-practices/quotas#conversion_upload_service $response = $conversionUploadServiceClient->uploadClickConversions( // Uploads the click conversion. Partial failure should always be set to true. UploadClickConversionsRequest::build($customerId, [$clickConversion], true) ); // Prints the status message if any partial failure error is returned. // Note: The details of each partial failure error are not printed here, you can refer to // the example HandlePartialFailure.php to learn more. if ($response->hasPartialFailureError()) { printf( "Partial failures occurred: '%s'.%s", $response->getPartialFailureError()->getMessage(), PHP_EOL ); } else { // Prints the result if exists. /** @var ClickConversionResult $uploadedClickConversion */ $uploadedClickConversion = $response->getResults()[0]; printf( "Uploaded click conversion that occurred at '%s' from Google Click ID '%s' " . "to '%s'.%s", $uploadedClickConversion->getConversionDateTime(), $uploadedClickConversion->getGclid(), $uploadedClickConversion->getConversionAction(), PHP_EOL ); } }
Python
def main( client, customer_id, conversion_action_id, gclid, conversion_date_time, conversion_value, conversion_custom_variable_id, conversion_custom_variable_value, gbraid, wbraid, order_id, ad_user_data_consent, ): """Creates a click conversion with a default currency of USD. Args: client: An initialized GoogleAdsClient instance. customer_id: The client customer ID string. conversion_action_id: The ID of the conversion action to upload to. gclid: The Google Click Identifier ID. If set, the wbraid and gbraid parameters must be None. conversion_date_time: The the date and time of the conversion (should be after the click time). The format is 'yyyy-mm-dd hh:mm:ss+|-hh:mm', e.g. '2021-01-01 12:32:45-08:00'. conversion_value: The conversion value in the desired currency. conversion_custom_variable_id: The ID of the conversion custom variable to associate with the upload. conversion_custom_variable_value: The str value of the conversion custom variable to associate with the upload. gbraid: The GBRAID for the iOS app conversion. If set, the gclid and wbraid parameters must be None. wbraid: The WBRAID for the iOS app conversion. If set, the gclid and gbraid parameters must be None. order_id: The order ID for the click conversion. ad_user_data_consent: The ad user data consent for the click. """ click_conversion = client.get_type("ClickConversion") conversion_upload_service = client.get_service("ConversionUploadService") conversion_action_service = client.get_service("ConversionActionService") click_conversion.conversion_action = ( conversion_action_service.conversion_action_path( customer_id, conversion_action_id ) ) # Sets the single specified ID field. if gclid: click_conversion.gclid = gclid elif gbraid: click_conversion.gbraid = gbraid else: click_conversion.wbraid = wbraid click_conversion.conversion_value = float(conversion_value) click_conversion.conversion_date_time = conversion_date_time click_conversion.currency_code = "USD" if conversion_custom_variable_id and conversion_custom_variable_value: conversion_custom_variable = client.get_type("CustomVariable") conversion_custom_variable.conversion_custom_variable = ( conversion_upload_service.conversion_custom_variable_path( customer_id, conversion_custom_variable_id ) ) conversion_custom_variable.value = conversion_custom_variable_value click_conversion.custom_variables.append(conversion_custom_variable) if order_id: click_conversion.order_id = order_id # Sets the consent information, if provided. if ad_user_data_consent: # Specifies whether user consent was obtained for the data you are # uploading. For more details, see: # https://www.google.com/about/company/user-consent-policy click_conversion.consent.ad_user_data = client.enums.ConsentStatusEnum[ ad_user_data_consent ] # Uploads the click conversion. Partial failure must be set to True here. # # NOTE: This request only uploads a single conversion, but if you have # multiple conversions to upload, it's most efficient to upload them in a # single request. See the following for per-request limits for reference: # https://developers.google.com/google-ads/api/docs/best-practices/quotas#conversion_upload_service request = client.get_type("UploadClickConversionsRequest") request.customer_id = customer_id request.conversions.append(click_conversion) request.partial_failure = True conversion_upload_response = ( conversion_upload_service.upload_click_conversions( request=request, ) ) uploaded_click_conversion = conversion_upload_response.results[0] print( f"Uploaded conversion that occurred at " f'"{uploaded_click_conversion.conversion_date_time}" from ' f'Google Click ID "{uploaded_click_conversion.gclid}" ' f'to "{uploaded_click_conversion.conversion_action}"' )
Ruby
def upload_offline_conversion( customer_id, conversion_action_id, gclid, gbraid, wbraid, conversion_date_time, conversion_value, conversion_custom_variable_id, conversion_custom_variable_value, ad_user_data_consent) # GoogleAdsClient will read a config file from # ENV['HOME']/google_ads_config.rb when called without parameters client = Google::Ads::GoogleAds::GoogleAdsClient.new # Verifies that exactly one of gclid, gbraid, and wbraid is specified, as required. # See https://developers.google.com/google-ads/api/docs/conversions/upload-clicks for details. identifiers_specified = [gclid, gbraid, wbraid].reject {|v| v.nil?}.count if identifiers_specified != 1 raise "Must specify exactly one of GCLID, GBRAID, and WBRAID. " \ "#{identifiers_specified} values were provided." end click_conversion = client.resource.click_conversion do |cc| cc.conversion_action = client.path.conversion_action(customer_id, conversion_action_id) # Sets the single specified ID field. if !gclid.nil? cc.gclid = gclid elsif !gbraid.nil? cc.gbraid = gbraid else cc.wbraid = wbraid end cc.conversion_value = conversion_value.to_f cc.conversion_date_time = conversion_date_time cc.currency_code = 'USD' if conversion_custom_variable_id && conversion_custom_variable_value cc.custom_variables << client.resource.custom_variable do |cv| cv.conversion_custom_variable = client.path.conversion_custom_variable( customer_id, conversion_custom_variable_id) cv.value = conversion_custom_variable_value end end # Sets the consent information, if provided. unless ad_user_data_consent.nil? cc.consent = client.resource.consent do |c| # Specifies whether user consent was obtained for the data you are # uploading. For more details, see: # https://www.google.com/about/company/user-consent-policy c.ad_user_data = ad_user_data_consent end end end response = client.service.conversion_upload.upload_click_conversions( customer_id: customer_id, # NOTE: This request contains a single conversion as a demonstration. # However, if you have multiple conversions to upload, it's best to upload # multiple conversions per request instead of sending a separate request per # conversion. See the following for per-request limits: # https://developers.google.com/google-ads/api/docs/best-practices/quotas#conversion_upload_service conversions: [click_conversion], partial_failure: true, ) if response.partial_failure_error.nil? result = response.results.first puts "Uploaded conversion that occurred at #{result.conversion_date_time} " \ "from Google Click ID #{result.gclid} to #{result.conversion_action}." else failures = client.decode_partial_failure_error(response.partial_failure_error) puts "Request failed. Failure details:" failures.each do |failure| failure.errors.each do |error| puts "\t#{error.error_code.error_code}: #{error.message}" end end end end
Perl
sub upload_offline_conversion { my ( $api_client, $customer_id, $conversion_action_id, $gclid, $gbraid, $wbraid, $conversion_date_time, $conversion_value, $conversion_custom_variable_id, $conversion_custom_variable_value, $order_id, $ad_user_data_consent ) = @_; # Verify that exactly one of gclid, gbraid, and wbraid is specified, as required. # See https://developers.google.com/google-ads/api/docs/conversions/upload-clicks for details. my $number_of_ids_specified = grep { defined $_ } ($gclid, $gbraid, $wbraid); if ($number_of_ids_specified != 1) { die sprintf "Exactly 1 of gclid, gbraid, or wbraid is required, " . "but %d ID values were provided.\n", $number_of_ids_specified; } # Create a click conversion by specifying currency as USD. my $click_conversion = Google::Ads::GoogleAds::V18::Services::ConversionUploadService::ClickConversion ->new({ conversionAction => Google::Ads::GoogleAds::V18::Utils::ResourceNames::conversion_action( $customer_id, $conversion_action_id ), conversionDateTime => $conversion_date_time, conversionValue => $conversion_value, currencyCode => "USD" }); # Set the single specified ID field. if (defined $gclid) { $click_conversion->{gclid} = $gclid; } elsif (defined $gbraid) { $click_conversion->{gbraid} = $gbraid; } else { $click_conversion->{wbraid} = $wbraid; } if ($conversion_custom_variable_id && $conversion_custom_variable_value) { $click_conversion->{customVariables} = [ Google::Ads::GoogleAds::V18::Services::ConversionUploadService::CustomVariable ->new({ conversionCustomVariable => Google::Ads::GoogleAds::V18::Utils::ResourceNames::conversion_custom_variable( $customer_id, $conversion_custom_variable_id ), value => $conversion_custom_variable_value })]; } if (defined $order_id) { # Set the order ID (unique transaction ID), if provided. $click_conversion->{orderId} = $order_id; } # Set the consent information, if provided. if ($ad_user_data_consent) { # Specify whether user consent was obtained for the data you are uploading. # See https://www.google.com/about/company/user-consent-policy for details. $click_conversion->{consent} = Google::Ads::GoogleAds::V18::Common::Consent->new({ adUserData => $ad_user_data_consent }); } # Issue a request to upload the click conversion. Partial failure should # always be set to true. # # NOTE: This request contains a single conversion as a demonstration. # However, if you have multiple conversions to upload, it's best to # upload multiple conversions per request instead of sending a separate # request per conversion. See the following for per-request limits: # https://developers.google.com/google-ads/api/docs/best-practices/quotas#conversion_upload_service my $upload_click_conversions_response = $api_client->ConversionUploadService()->upload_click_conversions({ customerId => $customer_id, conversions => [$click_conversion], partialFailure => "true" }); # Print any partial errors returned. if ($upload_click_conversions_response->{partialFailureError}) { printf "Partial error encountered: '%s'.\n", $upload_click_conversions_response->{partialFailureError}{message}; } # Print the result if valid. my $uploaded_click_conversion = $upload_click_conversions_response->{results}[0]; if (%$uploaded_click_conversion) { printf "Uploaded conversion that occurred at '%s' from Google Click ID '%s' " . "to the conversion action with resource name '%s'.\n", $uploaded_click_conversion->{conversionDateTime}, $uploaded_click_conversion->{gclid}, $uploaded_click_conversion->{conversionAction}; } return 1; }
Résoudre les problèmes
Les diagnostics des données hors ligne constituent une ressource unique pour examiner l'état général de vos importations de manière continue. Toutefois, lors de l'implémentation, vous pouvez utiliser les informations de cette section pour examiner les erreurs signalées dans le champ partial_failure_error
de la réponse.
Les erreurs d'autorisation, telles que USER_PERMISSION_DENIED
, sont parmi les plus courantes lors de l'importation d'actions de conversion. Vérifiez que l'ID client de votre requête est défini sur le client de conversion Google Ads auquel l'action de conversion appartient. Pour en savoir plus, consultez notre guide d'autorisation et notre guide des erreurs courantes pour obtenir des conseils sur le débogage de ces différentes erreurs.
Déboguer les erreurs courantes
Erreur | |
---|---|
ConversionUploadError.INVALID_CONVERSION_ACTION_TYPE
|
Le type de l'action de conversion spécifiée n'est pas valide pour importer des conversions générées par des clics. Assurez-vous que le ConversionAction spécifié dans votre demande d'importation est de type UPLOAD_CLICKS .
|
ConversionUploadError.NO_CONVERSION_ACTION_FOUND
|
L'action de conversion spécifiée n'est pas activée ou ne peut pas être trouvée dans le customer_id d'importation. Assurez-vous que l'action de conversion de votre importation est activée et appartient à l'customer_id de la demande d'importation.
|
ConversionUploadError.TOO_RECENT_CONVERSION_ACTION
|
L'action de conversion vient d'être créée. Attendez au moins six heures après la création de l'action avant de réessayer les conversions ayant échoué. |
ConversionUploadError.INVALID_CUSTOMER_FOR_CLICK
|
Le customer_id de la requête ne correspond pas au numéro client qui était le compte de conversion de l'API Google Ads au moment du clic. Mettez à jour le customer_id de la requête avec le bon client.
|
ConversionUploadError.EVENT_NOT_FOUND
|
Google Ads ne trouve pas la combinaison de l'ID de clic et de customer_id . Consultez les exigences concernant customer_id et vérifiez que vous importez les données à l'aide du bon compte Google Ads.
|
ConversionUploadError.DUPLICATE_CLICK_CONVERSION_IN_REQUEST
|
Plusieurs conversions de la demande ont la même combinaison d'ID de clic, conversion_date_time et conversion_action . Supprimez les conversions en double de votre requête.
|
ConversionUploadError.CLICK_CONVERSION_ALREADY_EXISTS
|
Une conversion associée à la même combinaison d'ID de clic, conversion_date_time et conversion_action a déjà été importée. Ignorez cette erreur si vous essayez de réimporter la conversion et que cette conversion a déjà réussi. Si vous souhaitez ajouter une autre conversion en plus de celle importée précédemment, ajustez le conversion_date_time de l'ClickConversion pour éviter de dupliquer la conversion importée précédemment.
|
ConversionUploadError.EVENT_NOT_FOUND
|
Google Ads ne trouve pas la combinaison de l'ID de clic et de customer_id . Consultez les exigences concernant customer_id et vérifiez que vous importez les données à l'aide du bon compte Google Ads.
|
ConversionUploadError.EXPIRED_EVENT
|
Le clic importé s'est produit avant la période spécifiée dans le champ click_through_lookback_window_days . Une modification de click_through_lookback_window_days n'affecte que les clics enregistrés après la modification. Par conséquent, modifier la période d'analyse ne résout pas cette erreur pour le clic en question. Le cas échéant, remplacez conversion_action par une autre action avec une période d'analyse plus longue. |
ConversionUploadError.CONVERSION_PRECEDES_EVENT
|
La valeur conversion_date_time est antérieure à la date et à l'heure du clic. Remplacez conversion_date_time par une valeur ultérieure.
|
ConversionUploadError.GBRAID_WBRAID_BOTH_SET
|
La valeur ClickConversion est définie pour gbraid et wbraid . Modifiez la conversion pour qu'elle n'utilise qu'un seul ID de clic et assurez-vous de ne pas combiner plusieurs clics dans la même conversion. Chaque clic ne possède qu'un seul ID.
|
FieldError.VALUE_MUST_BE_UNSET
|
Vérifiez le location de l'GoogleAdsError pour déterminer lequel des problèmes suivants a entraîné l'erreur.
|
Conversions dans les rapports
Les conversions importées sont reflétées dans les rapports pour la date d'impression du clic d'origine, et non pour la date de la demande d'importation ni pour la date de l'conversion_date_time
de l'ClickConversion
.
Il peut s'écouler jusqu'à trois heures avant que les statistiques sur les conversions importées ne s'affichent dans votre compte Google Ads pour l'attribution au dernier clic. Pour les autres modèles d'attribution des recherches, cela peut prendre plus de trois heures. Pour en savoir plus, consultez le guide sur la fraîcheur des données.