Mit der Google Ads API können Sie Offline-Klick-Conversions in Google Ads hochladen. So können Sie Anzeigen erfassen, die zu Offlineverkäufen geführt haben, beispielsweise telefonisch oder durch einen Vertriebsmitarbeiter.
Einrichtung
Damit Offline-Conversions funktionieren, müssen einige Voraussetzungen erfüllt sein. Prüfen Sie, ob alle Voraussetzungen erfüllt sind, bevor Sie mit der Implementierung fortfahren:
Aktivieren Sie Conversion-Tracking für Ihren Google Ads-Conversion-Kunden.
Tagging konfigurieren und Klick-IDs speichern
1. Conversion-Tracking für Google Ads-Conversion-Kunden aktivieren
Wenn Sie den Startleitfaden zu Conversions abgeschlossen und Conversion-Tracking aktiviert haben, können Sie mit Schritt 2: Tagging konfigurieren fortfahren.
Informationen zur Einrichtung des Conversion-Trackings abrufen
Sie können die Einrichtung des Conversion-Trackings in Ihrem Konto prüfen und bestätigen, dass Conversion-Tracking aktiviert ist. Fragen Sie dazu die Ressource Customer
für die ConversionTrackingSetting
ab.
Führen Sie die folgende Abfrage mit GoogleAdsService.SearchStream
aus:
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
Das Feld google_ads_conversion_customer
gibt das Google Ads-Konto an, in dem Conversions für diesen Kunden erstellt und verwaltet werden. Für Kunden, die kontoübergreifendes Conversion-Tracking verwenden, ist dies die ID eines Verwaltungskontos. Die Kundennummer der Google Ads-Conversion sollte in Google Ads API-Anfragen als customer_id
angegeben werden, um Conversions zu erstellen und zu verwalten.
Dieses Feld wird auch dann ausgefüllt, wenn Conversion-Tracking nicht aktiviert ist.
Im Feld conversion_tracking_status
wird angegeben, ob Conversion-Tracking aktiviert ist und ob für das Konto kontoübergreifendes Conversion-Tracking verwendet wird.
Conversion-Aktion unter dem Google Ads-Conversion-Kunden erstellen
Wenn der Wert von conversion_tracking_status
auf NOT_CONVERSION_TRACKED
gesetzt ist, ist Conversion-Tracking für das Konto nicht aktiviert. Aktivieren Sie Conversion-Tracking, indem Sie wie im folgenden Beispiel mindestens ein ConversionAction
im Google Ads-Conversion-Konto erstellen. Alternativ können Sie eine Conversion-Aktion in der Benutzeroberfläche erstellen. Folgen Sie dazu der Anleitung in der Hilfe für den Conversion-Typ, den Sie aktivieren möchten.
Erweiterte Conversions werden automatisch aktiviert, wenn sie über die Google Ads API gesendet werden. Sie können jedoch über die Google Ads-Benutzeroberfläche deaktiviert werden.
Codebeispiel
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.V17.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::V17::Resources::ConversionAction->new({ name => $conversion_action_name, category => DEFAULT, type => WEBPAGE, status => ENABLED, viewThroughLookbackWindowDays => 15, valueSettings => Google::Ads::GoogleAds::V17::Resources::ValueSettings->new({ defaultValue => 23.41, alwaysUseDefaultValue => "true" })}); # Create a conversion action operation. my $conversion_action_operation = Google::Ads::GoogleAds::V17::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; }
Achten Sie darauf, dass conversion_action_type
auf den richtigen ConversionActionType
-Wert festgelegt ist.
Weitere Informationen zum Erstellen von Conversion-Aktionen in der Google Ads API finden Sie unter Conversion-Aktionen erstellen.
Vorhandene Conversion-Aktion abrufen
Mit der folgenden Abfrage können Sie Details zu einer vorhandenen Conversion-Aktion abrufen. Achten Sie darauf, dass die Kundennummer in der Anfrage auf den oben angegebenen Google Ads-Conversion-Kunden und den Typ der Conversion-Aktion auf den richtigen ConversionActionType
-Wert festgelegt ist.
SELECT
conversion_action.resource_name,
conversion_action.name,
conversion_action.status
FROM conversion_action
WHERE conversion_action.type = 'INSERT_CONVERSION_ACTION_TYPE'
2. Tagging konfigurieren und Klick-IDs speichern
Prüfen Sie anhand instructions, ob das automatische Tagging aktiviert ist, und richten Sie Ihr Google Ads-Konto, Ihre Website und Ihr Lead-Tracking-System so ein, dass die GCLID, GBRAID oder WBRAID jeder Impression und jedem Klick für Ihre Anzeigen erfasst und gespeichert werden. Für neue Konten ist das automatische Tagging standardmäßig aktiviert.
Erstellen Sie die Anfrage
Folgen Sie der Anleitung unten, um den UploadClickConversionsRequest
zu erstellen und die Felder auf die entsprechenden Werte festzulegen.
customer_id
Das Google Ads-Konto des Uploads. Geben Sie hier den Google Ads-Conversion-Kunden des Kontos an, das die Quelle der Klicks ist.
job_id
Bietet einen Mechanismus zum Verknüpfen Ihrer Uploadanfragen mit den Informationen pro Job in der Offline-Datendiagnose.
Wenn Sie dieses Feld nicht festlegen, wird jeder Anfrage über die Google Ads API ein eindeutiger Wert im Bereich von
[2^31, 2^63)
zugewiesen. Wenn Sie mehrere Anfragen lieber in einem einzigen logischen Job gruppieren möchten, legen Sie dieses Feld bei jeder Anfrage in Ihrem Job auf denselben Wert im Bereich[0, 2^31)
fest.Die
job_id
in der Antwort enthält die Job-ID der Anfrage, unabhängig davon, ob Sie einen Wert angegeben haben oder über die Google Ads API einen Wert zuweisen lassen.partial_failure_enabled
Legt fest, wie die Google Ads API mit Fehlern bei Vorgängen umgeht.
Für dieses Feld muss
true
festgelegt werden. Beachten Sie beim Verarbeiten der Antwort die Richtlinien für partielle Fehler.debug_enabled
Legt das Verhalten bei Fehlerberichten für Uploads von erweiterten Conversions für Leads fest. Die Google Ads API ignoriert dieses Feld beim Verarbeiten von Uploads für Klick-Conversions mit
gclid
,gbraid
oderwbraid
.
Klick-Conversion-Vorgänge erstellen
Durch die Sammlung von ClickConversion
-Objekten in UploadClickConversionRequest
wird die Gruppe von Conversions definiert, die Sie hochladen möchten. Folgen Sie der Anleitung unten, um jede ClickConversion
zu erstellen und ihre Felder auf die entsprechenden Werte festzulegen.
Pflichtfelder für jeden Conversion-Vorgang festlegen
Folgen Sie der Anleitung unten, um die Pflichtfelder von ClickConversion
auf die entsprechenden Werte festzulegen.
gclid
,gbraid
,wbraid
- Die Kennung, die Sie beim Klick auf den Klick oder die Impression der Conversion erfasst haben. Legen Sie nur eines dieser Felder fest.
conversion_date_time
Datum und Uhrzeit der Conversion.
Für den Wert muss eine Zeitzone angegeben werden und das Format muss
yyyy-mm-dd HH:mm:ss+|-HH:mm
sein, z. B.2022-01-01 19:32:45-05:00
(ohne Sommerzeit).Die Zeitzone kann für einen beliebigen gültigen Wert verwendet werden: Sie muss nicht mit der Zeitzone des Kontos übereinstimmen. Wenn Sie jedoch Ihre hochgeladenen Conversion-Daten mit denen in der Google Ads-Benutzeroberfläche vergleichen möchten, sollten Sie dieselbe Zeitzone wie in Ihrem Google Ads-Konto verwenden, damit die Conversion-Zahlen übereinstimmen. Weitere Details und Beispiele finden Sie in der Hilfe. Unter Codes und Formate finden Sie eine Liste gültiger Zeitzonen-IDs.
user_identifiers
Legen Sie dieses Feld nicht fest, wenn Sie Conversions nur mit Klick-IDs hochladen. Wenn für dieses Feld ein Wert festgelegt wurde, wird der Upload in Google Ads als Upload für erweiterte Conversions für Leads behandelt.
conversion_action
Der Ressourcenname von
ConversionAction
für die Klick-Conversion.Für die Conversion-Aktion muss für
type
der WertUPLOAD_CLICKS
festgelegt sein und sie muss im Google Ads-Conversion-Kunden des Google Ads-Kontos vorhanden sein, das mit dem Klick verknüpft ist.conversion_value
Der Wert der Conversion.
currency_code
Der Währungscode von
conversion_value
.
Optionale Felder für jeden Konvertierungsvorgang festlegen
Sehen Sie sich die folgende Liste der optionalen Felder an und legen Sie sie nach Bedarf in Ihrem ClickConversion
fest.
order_id
- Die Transaktions-ID für die Conversion. Dieses Feld ist optional, wird aber dringend empfohlen. Wenn Sie es beim Upload festlegen, müssen Sie es für alle Anpassungen an der Conversion verwenden.
external_attribution_data
Wenn Sie für das Conversion-Tracking Drittanbieter-Tools oder selbst entwickelte Lösungen verwenden, können Sie Google Ads nur einen Teil der Conversion bzw. mehreren Klicks zuordnen. Wenn Sie extern zugeordnete Conversion-Importe verwenden, können Sie Conversions hochladen und jedem Klick einen anteiligen Beitrag zuordnen.
Wenn Sie eine Conversion hochladen möchten, legen Sie für dieses Feld ein
ExternalAttributionData
-Objekt mit Werten fürexternal_attribution_model
undexternal_attribution_credit
fest.custom_variables
Die Werte für benutzerdefinierte Conversion-Variablen.
In Google Ads werden in Kombination mit
wbraid
odergbraid
keine benutzerdefinierten Conversion-Variablen unterstützt.cart_data
Sie können Einkaufswagendaten für eine
ClickConversion
im Feldcart_data
angeben, das aus den folgenden Attributen besteht:merchant_id
: Die ID des verknüpften Merchant Center-Kontos.feed_country_code
: Der zweistellige Regionscode gemäß ISO 3166 des Merchant Center-Feeds.feed_language_code
: Der ISO 639-1-Sprachcode des Merchant Center-Feeds.local_transaction_cost
: Die Summe aller Rabatte auf Transaktionsebene incurrency_code
vonClickConversion
.items
: die Artikel im Einkaufswagen
Jedes Element in
items
besteht aus den folgenden Attributen:product_id
: Die ID des Produkts, manchmal auch als Angebots-ID oder Artikel-ID bezeichnet.quantity
: Die Menge des Artikels.unit_price
: Der Preis pro Einheit des Artikels.
conversion_environment
Gibt die Umgebung an, in der diese Konvertierung aufgezeichnet wurde. zum Beispiel App oder Web.
Codebeispiel
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.V17.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::V17::Services::ConversionUploadService::ClickConversion ->new({ conversionAction => Google::Ads::GoogleAds::V17::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::V17::Services::ConversionUploadService::CustomVariable ->new({ conversionCustomVariable => Google::Ads::GoogleAds::V17::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::V17::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; }
Fehlerbehebung
Die Offlinedatendiagnose stellt eine einzelne Ressource zur fortlaufenden Überprüfung des Gesamtzustands Ihrer Uploads bereit. Bei der Implementierung können Sie jedoch die Informationen in diesem Abschnitt verwenden, um Fehler zu untersuchen, die im Feld partial_failure_error
der Antwort gemeldet wurden.
Zu den häufigsten Fehlern beim Hochladen von Conversion-Aktionen gehören Autorisierungsfehler wie USER_PERMISSION_DENIED
. Prüfen Sie noch einmal, ob die Kundennummer in Ihrer Anfrage auf den Google Ads-Conversion-Kunden festgelegt ist, dem die Conversion-Aktion gehört. Weitere Informationen finden Sie in unserem Autorisierungsleitfaden. In unserem Leitfaden zu häufigen Fehlern finden Sie Tipps zum Beheben dieser verschiedenen Fehler.
Häufige Fehler beheben
Fehler | |
---|---|
ConversionUploadError.INVALID_CONVERSION_ACTION_TYPE
|
Der Typ der angegebenen Conversion-Aktion ist zum Hochladen von Klick-Conversions nicht zulässig. Der in Ihrer Uploadanfrage angegebene ConversionAction muss vom Typ UPLOAD_CLICKS sein.
|
ConversionUploadError.NO_CONVERSION_ACTION_FOUND
|
Die angegebene Conversion-Aktion ist entweder nicht aktiviert oder wurde im Upload-customer_id nicht gefunden. Die Conversion-Aktion im Upload muss aktiviert sein und zu customer_id der Uploadanfrage gehören.
|
ConversionUploadError.TOO_RECENT_CONVERSION_ACTION
|
Die Conversion-Aktion wird neu erstellt. Warten Sie nach dem Erstellen der Aktion mindestens 6 Stunden, bevor Sie die fehlgeschlagenen Conversions wiederholen. |
ConversionUploadError.INVALID_CUSTOMER_FOR_CLICK
|
Die customer_id der Anfrage entspricht nicht der Kundennummer des Google Ads-Conversion-Kunden zum Zeitpunkt des Klicks. Aktualisieren Sie customer_id der Anfrage auf den richtigen Kunden.
|
ConversionUploadError.EVENT_NOT_FOUND
|
In Google Ads wurde die Kombination aus Klick-ID und customer_id nicht gefunden. Lesen Sie die Anforderungen für customer_id und prüfen Sie, ob Sie die Daten mit dem richtigen Google Ads-Konto hochladen.
|
ConversionUploadError.DUPLICATE_CLICK_CONVERSION_IN_REQUEST
|
Mehrere Conversions in der Anfrage haben dieselbe Kombination aus Klick-ID, conversion_date_time und conversion_action . Entfernen Sie doppelte Conversions aus Ihrer Anfrage.
|
ConversionUploadError.CLICK_CONVERSION_ALREADY_EXISTS
|
Es wurde bereits eine Conversion mit derselben Kombination aus Klick-ID, conversion_date_time und conversion_action hochgeladen. Ignorieren Sie diesen Fehler, wenn Sie den Upload wiederholen wollten und diese Konvertierung zuvor erfolgreich war. Wenn Sie zusätzlich zur zuvor hochgeladenen Conversion eine weitere Conversion hinzufügen möchten, passen Sie den conversion_date_time von ClickConversion an, um eine Duplizierung der zuvor hochgeladenen Conversion zu vermeiden.
|
ConversionUploadError.EVENT_NOT_FOUND
|
In Google Ads wurde die Kombination aus Klick-ID und customer_id nicht gefunden. Lesen Sie die Anforderungen für customer_id und prüfen Sie, ob Sie die Daten mit dem richtigen Google Ads-Konto hochladen.
|
ConversionUploadError.EXPIRED_EVENT
|
Der importierte Klick ist vor dem im Feld click_through_lookback_window_days angegebenen Zeitraum erfolgt. Eine Änderung an click_through_lookback_window_days wirkt sich nur auf die nach der Änderung erfassten Klicks aus. Wenn Sie das Lookback-Window ändern, wird der Fehler für den jeweiligen Klick also nicht behoben. Ändern Sie gegebenenfalls conversion_action in eine andere Aktion mit einem längeren Lookback-Window. |
ConversionUploadError.CONVERSION_PRECEDES_GCLID
|
Der conversion_date_time liegt vor dem Datum und der Uhrzeit des Klicks. Aktualisieren Sie conversion_date_time auf einen späteren Wert.
|
ConversionUploadError.GBRAID_WBRAID_BOTH_SET
|
Für ClickConversion ist sowohl für gbraid als auch für wbraid ein Wert festgelegt. Ändern Sie die Conversion so, dass nur eine Klick-ID verwendet wird, und achten Sie darauf, dass nicht mehrere Klicks in derselben Conversion kombiniert werden. Jeder Klick hat nur eine Klick-ID.
|
FieldError.VALUE_MUST_BE_UNSET
|
Sehen Sie sich die location von GoogleAdsError an, um festzustellen, welche der folgenden Probleme zu dem Fehler geführt haben.
|
Conversions in Berichten
Hochgeladene Conversions sind in den Berichten für das Impressionsdatum des ursprünglichen Klicks zu sehen, nicht für das Datum der Uploadanfrage oder das Datum des conversion_date_time
der ClickConversion
.
Beim Attributionsmodell „Letzter Klick“ dauert es bis zu drei Stunden, bis importierte Conversion-Statistiken im Google Ads-Konto angezeigt werden. Bei anderen Attributionsmodellen für die Suche kann es länger als drei Stunden dauern. Weitere Informationen finden Sie im Leitfaden zur Datenaktualität.