Interfejsu Google Ads API możesz używać do przesyłania do Google Ads konwersji offline po kliknięciu, aby śledzić reklamy, które doprowadziły do sprzedaży w świecie offline, np. przez telefon lub za pośrednictwem przedstawiciela handlowego.
Konfiguracja
Aby skonfigurować konwersje offline, musisz spełnić kilka wymagań wstępnych. Zanim przejdziesz do implementacji, upewnij się, że spełniasz wszystkie wymagania wstępne:
Włącz śledzenie konwersji w Google Ads.
Skonfiguruj tagowanie i przechowuj identyfikatory kliknięć.
1. Włączanie śledzenia konwersji z reklam w Google Ads na koncie klienta konwersji
Jeśli masz już za sobą przewodnik dla początkujących i masz włączone śledzenie konwersji, możesz przejść do kroku 2: skonfiguruj tagowanie.
pobieranie informacji o konfiguracji śledzenia konwersji,
Aby sprawdzić konfigurację śledzenia konwersji na koncie i potwierdzić, że śledzenie konwersji jest włączone, wyślij zapytanie do zasobu Customer o ConversionTrackingSetting.
Wyślij to zapytanie za pomocą 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
Pole google_ads_conversion_customer wskazuje konto Google Ads, które tworzy konwersje dla tego klienta i nimi zarządza. W przypadku klientów korzystających ze śledzenia konwersji dla wielu kont jest to identyfikator konta menedżera. Identyfikator klienta konwersji Google Ads powinien być podawany jako customer_id w żądaniach do interfejsu Google Ads API, aby można było tworzyć konwersje i nimi zarządzać. Pamiętaj, że to pole jest wypełniane nawet wtedy, gdy śledzenie konwersji nie jest włączone.
Pole conversion_tracking_status wskazuje, czy śledzenie konwersji jest włączone i czy konto korzysta ze śledzenia konwersji dla wielu kont.
Utwórz działanie powodujące konwersję w ramach klienta konwersji Google Ads.
Jeśli wartość conversion_tracking_status to NOT_CONVERSION_TRACKED, śledzenie konwersji nie jest włączone na koncie. Włącz śledzenie konwersji, tworząc co najmniej 1 ConversionAction na koncie konwersji Google Ads, jak w przykładzie poniżej. Możesz też utworzyć działanie powodujące konwersję w interfejsie, postępując zgodnie z instrukcjami w artykule w Centrum pomocy Google Ads na temat konfigurowania śledzenia konwersji dla typu konwersji, który chcesz włączyć.
Pamiętaj, że konwersje rozszerzone są włączane automatycznie, gdy są wysyłane przez interfejs Google Ads API, ale można je wyłączyć w interfejsie Google Ads.
Przykładowy kod
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.V26.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: GoogleAdsClient, customer_id: str) -> None: conversion_action_service: ConversionActionServiceClient = ( client.get_service("ConversionActionService") ) # Create the operation. conversion_action_operation: ConversionActionOperation = client.get_type( "ConversionActionOperation" ) # Create conversion action. conversion_action: ConversionAction = 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: ConversionAction.ValueSettings = ( conversion_action.value_settings ) value_settings.default_value = 15.0 value_settings.always_use_default_value = True # Add the conversion action. conversion_action_response: MutateConversionActionsResponse = ( 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::V26::Resources::ConversionAction->new({ name => $conversion_action_name, category => DEFAULT, type => WEBPAGE, status => ENABLED, viewThroughLookbackWindowDays => 15, valueSettings => Google::Ads::GoogleAds::V26::Resources::ValueSettings->new({ defaultValue => 23.41, alwaysUseDefaultValue => "true" })}); # Create a conversion action operation. my $conversion_action_operation = Google::Ads::GoogleAds::V26::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; }
curl
Sprawdź, czy właściwość type ma ustawioną prawidłową wartość ConversionActionType. Więcej wskazówek dotyczących tworzenia działań powodujących konwersję w interfejsie Google Ads API znajdziesz w artykule Tworzenie działań powodujących konwersję.
Pobieranie istniejącego działania powodującego konwersję
Aby pobrać szczegóły istniejącego działania powodującego konwersję, wyślij to zapytanie. Upewnij się, że identyfikator klienta w żądaniu jest ustawiony na klienta konwersji Google Ads, który został wcześniej zidentyfikowany, a typ działania powodującego konwersję jest ustawiony na prawidłową wartość ConversionActionType.
SELECT
conversion_action.id,
conversion_action.resource_name,
conversion_action.name,
conversion_action.type,
conversion_action.category,
conversion_action.status
FROM conversion_action
WHERE conversion_action.type = 'UPLOAD_CLICKS'
2. Konfigurowanie tagowania i przechowywanie identyfikatorów kliknięć
Postępuj zgodnie z instrukcjami dotyczącymi automatycznego tagowania, aby sprawdzić, czy automatyczne tagowanie jest włączone. Skonfiguruj konto Google Ads, witrynę i system śledzenia potencjalnej sprzedaży, aby rejestrować i zapisywać identyfikator kliknięcia Google w przypadku każdego wyświetlenia, a także parametry adresu URL GBRAID lub WBRAID w przypadku reklam. Automatyczne tagowanie jest domyślnie włączone na nowych kontach.
Tworzenie żądania
Postępuj zgodnie z tymi wskazówkami, aby utworzyć obiekt UploadClickConversionsRequest i ustawić jego pola na odpowiednie wartości.
customer_idIdentyfikuje konto Google Ads, na które przesyłasz dane. Ustaw tę wartość na klienta konwersji z reklam Google Ads konta, które jest źródłem kliknięć.
job_idUdostępnia mechanizm powiązania żądań przesyłania z informacjami o poszczególnych zadaniach w diagnostyce danych offline.
Jeśli nie ustawisz tego pola, interfejs Google Ads API przypisze każdemu żądaniu unikalną wartość z zakresu
[2^31, 2^63). Jeśli chcesz pogrupować wiele żądań w jedno logiczne zadanie, ustaw to pole na tę samą wartość z zakresu[1, 2^31)w każdym żądaniu w zadaniu.Pole
job_idw odpowiedzi zawiera identyfikator zadania dla żądania, niezależnie od tego, czy podasz wartość, czy pozwolisz interfejsowi Google Ads API na przypisanie wartości.partial_failureOkreśla, jak interfejs Google Ads API obsługuje błędy operacji.
To pole musi mieć wartość
true. Podczas przetwarzania odpowiedzi postępuj zgodnie ze wskazówkami dotyczącymi częściowych niepowodzeń.
Tworzenie operacji konwersji po kliknięciu
Kolekcja obiektów ClickConversion w UploadClickConversionsRequest definiuje zestaw konwersji, które chcesz przesłać. Postępuj zgodnie z tymi wskazówkami, aby utworzyć każdy obiekt ClickConversion i ustawić jego pola na odpowiednie wartości.
Ustawianie wymaganych pól każdej operacji konwersji
Postępuj zgodnie z tymi instrukcjami, aby ustawić odpowiednie wartości w wymaganych polach ClickConversion.
gclid,gbraid,wbraidIdentyfikator kliknięcia Google lub parametry adresu URL, które rejestrujesz, gdy użytkownik trafia do Twojej witryny lub aplikacji po kliknięciu reklamy. Wymagane jest co najmniej jedno z tych pól:
gclidgbraidwbraid
Uwzględnij każdy identyfikator kliknięcia zarejestrowany dla konwersji w tym samym obiekcie
ClickConversion. Jeśli dostępnych jest kilka identyfikatorów, Google Ads używa ich w następującej kolejności:gclid,wbraid,gbraid.conversion_date_timeData i godzina konwersji.
Wartość musi mieć określoną strefę czasową, a format musi być następujący:
yyyy-mm-dd HH:mm:ss+|-HH:mm, na przykład:2022-01-01 19:32:45-05:00(ignorując czas letni) .Strefa czasowa może mieć dowolną prawidłową wartość – nie musi być zgodna ze strefą czasową konta. Jeśli jednak planujesz porównywać przesłane dane o konwersjach z danymi w interfejsie Google Ads, zalecamy używanie tej samej strefy czasowej co na koncie Google Ads, aby liczby konwersji były zgodne. Więcej informacji i przykładów znajdziesz w artykule Przygotowywanie danych do importu. Listę prawidłowych identyfikatorów stref czasowych znajdziesz w artykule Kody i formaty.
user_identifiersNie ustawiaj tego pola, jeśli przesyłasz konwersje, używając tylko identyfikatorów kliknięć. Jeśli to pole jest ustawione, Google Ads traktuje operację przesyłania jako przesyłanie konwersji rozszerzonych dotyczących potencjalnych klientów.
conversion_actionNazwa zasobu
ConversionActionkonwersji po kliknięciu.Działanie powodujące konwersję musi mieć wartość
typerównąUPLOAD_CLICKSi musi istnieć na koncie klienta Google Ads, który dokonuje konwersji, na koncie Google Ads powiązanym z kliknięciem.conversion_valueWartość konwersji.
currency_codeKod waluty dla
conversion_value.
Ustawianie opcjonalnych pól każdej operacji konwersji
Przejrzyj poniższą listę pól opcjonalnych i w razie potrzeby ustaw je w ClickConversion.
order_id- Identyfikator transakcji w przypadku konwersji. To pole jest opcjonalne, ale zdecydowanie zalecane. Jeśli dołączysz identyfikator zamówienia do przesyłanych danych, musisz go używać w przypadku wszystkich korekt wprowadzanych w konwersji. Więcej informacji o używaniu identyfikatora transakcji do ograniczania liczby zduplikowanych konwersji znajdziesz w artykule Używanie identyfikatora transakcji do ograniczania liczby zduplikowanych konwersji.
external_attribution_dataJeśli do śledzenia konwersji używasz narzędzi innych firm lub własnych rozwiązań, możesz przypisać Google Ads tylko część udziału w konwersji lub rozdzielić udział w konwersji między wiele kliknięć. Importowanie konwersji przypisanych zewnętrznie umożliwia przesyłanie konwersji z częściowym udziałem przypisanym do każdego kliknięcia.
Aby przesłać częściowe udziały w konwersji, ustaw w tym polu obiekt
ExternalAttributionDataz wartościamiexternal_attribution_modeliexternal_attribution_credit.custom_variablesWartości niestandardowych zmiennych konwersji.
Google Ads nie obsługuje niestandardowych zmiennych konwersji, gdy parametr
wbraidlubgbraidjest używany bez parametrugclid.cart_dataMożesz uwzględnić dane koszyka dla
ClickConversionw polucart_data, które składa się z tych atrybutów:merchant_id: identyfikator powiązanego konta Merchant Center.feed_country_code: dwuznakowy kod regionu pliku danych Merchant Center w formacie ISO 3166.feed_language_code: kod języka pliku danych Merchant Center w formacie ISO 639-1.local_transaction_cost: suma wszystkich rabatów na poziomie transakcji wcurrency_codeClickConversion.items: produkty w koszyku.
Każdy element w
itemsskłada się z tych atrybutów:product_id: identyfikator produktu, czasami nazywany identyfikatorem oferty lub identyfikatorem produktu.quantity: liczba sztuk produktu.unit_price: cena jednostkowa produktu.
Google Ads nie obsługuje
cart_data, gdywbraidlubgbraidjest używany bezgclid.conversion_environmentWskazuje środowisko, w którym zarejestrowano konwersję. Na przykład aplikacja lub internet.
Przykładowy kod
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.V26.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: GoogleAdsClient, customer_id: str, conversion_action_id: str, gclid: Optional[str], conversion_date_time: str, conversion_value: str, conversion_custom_variable_id: Optional[str], conversion_custom_variable_value: Optional[str], gbraid: Optional[str], wbraid: Optional[str], order_id: Optional[str], ad_user_data_consent: Optional[str], ) -> None: """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: ClickConversion = client.get_type("ClickConversion") conversion_upload_service: ConversionUploadServiceClient = ( client.get_service("ConversionUploadService") ) conversion_action_service: ConversionActionServiceClient = ( 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: CustomVariable = 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: UploadClickConversionsRequest = client.get_type( "UploadClickConversionsRequest" ) request.customer_id = customer_id request.conversions.append(click_conversion) request.partial_failure = True conversion_upload_response: UploadClickConversionsResponse = ( conversion_upload_service.upload_click_conversions( request=request, ) ) uploaded_click_conversion: ClickConversionResult = ( 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::V26::Services::ConversionUploadService::ClickConversion ->new({ conversionAction => Google::Ads::GoogleAds::V26::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::V26::Services::ConversionUploadService::CustomVariable ->new({ conversionCustomVariable => Google::Ads::GoogleAds::V26::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::V26::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; }
curl
# This code example uploads a click conversion. # # Variables: # API_VERSION, # CUSTOMER_ID, # MANAGER_CUSTOMER_ID, # OAUTH2_ACCESS_TOKEN: # See https://developers.google.com/google-ads/api/rest/auth#request_headers # for details. # # CONVERSION_ACTION_RESOURCE_NAME: Resource name of the conversion action # associated with this conversion. # GCLID: The Google click ID (gclid) associated with this conversion. # CONVERSION_VALUE: The value of the conversion for the advertiser. # CONVERSION_DATE_TIME: The date time at which the conversion occurred. The # format is "yyyy-mm-dd hh:mm:ss+|-hh:mm", for example, # "2019-01-01 12:32:45-08:00". # CURRENCY_CODE: The currency code of the conversion value. This is the # ISO 4217 3-character currency code. For example: USD, EUR. # CONVERSION_CUSTOM_VARIABLE: The name of the conversion custom variable. # CONVERSION_CUSTOM_VARIABLE_VALUE: The value of the conversion custom # variable. # ORDER_ID: The order ID of the conversion. curl -f --request POST \ "https://googleads.googleapis.com/v${API_VERSION}/customers/${CUSTOMER_ID}:uploadClickConversions" \ --header "Content-Type: application/json" \ --header "login-customer-id: ${MANAGER_CUSTOMER_ID}" \ --header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \ --data @- <<EOF { "conversions": [ { "conversionAction": "${CONVERSION_ACTION_RESOURCE_NAME}", "gclid": "${GCLID}", "conversionValue": ${CONVERSION_VALUE}, "conversionDateTime": "${CONVERSION_DATE_TIME}", "currencyCode": "${CURRENCY_CODE}", "customVariables": [ { "conversionCustomVariable": "${CONVERSION_CUSTOM_VARIABLE}", "value": "${CONVERSION_CUSTOM_VARIABLE_VALUE}" } ], "orderId": "${ORDER_ID}", "consent": { "adUserData": "GRANTED" } } ], "partialFailure": true } EOF
Rozwiązywanie problemów
Diagnostyka danych offline to jedno miejsce, w którym możesz na bieżąco sprawdzać ogólny stan przesyłanych danych. Podczas wdrażania możesz jednak użyć informacji z tej sekcji, aby zbadać błędy zgłoszone w polu partial_failure_error odpowiedzi.
Niektóre z najczęstszych błędów podczas przesyłania działań powodujących konwersję to błędy autoryzacji, takie jak USER_PERMISSION_DENIED. Upewnij się, że identyfikator klienta w żądaniu jest ustawiony na klienta konwersji z reklam Google Ads, który jest właścicielem działania powodującego konwersję. Więcej informacji znajdziesz w naszym przewodniku po autoryzacji, a wskazówki dotyczące debugowania różnych błędów – w przewodniku po typowych błędach.
Debugowanie typowych błędów
| Błąd | |
|---|---|
INVALID_CONVERSION_ACTION_TYPE
|
Określone działanie powodujące konwersję ma typ, który jest nieprawidłowy w przypadku przesyłania konwersji po kliknięciu. Upewnij się, że ConversionAction określony w żądaniu przesyłania ma typ UPLOAD_CLICKS.
|
NO_CONVERSION_ACTION_FOUND
|
Określone działanie powodujące konwersję nie jest włączone lub nie można go znaleźć w przesyłanym pliku customer_id. Pobierz informacje o konfiguracji konwersji, aby się upewnić, że działanie powodujące konwersję, które chcesz przesłać, jest włączone i należy do customer_id z żądania przesłania.
|
TOO_RECENT_CONVERSION_ACTION
|
Działanie powodujące konwersję zostało utworzone niedawno. Po utworzeniu działania odczekaj co najmniej 6 godzin, zanim spróbujesz ponownie przesłać nieudane konwersje. |
INVALID_CUSTOMER_FOR_CLICK
|
Identyfikator klienta customer_id w żądaniu nie jest taki sam jak identyfikator klienta, który był kontem konwersji interfejsu Google Ads API w momencie kliknięcia. Zaktualizuj customer_id żądania, aby wskazywał właściwego klienta.
|
EVENT_NOT_FOUND
|
Google Ads nie może znaleźć kombinacji identyfikatora kliknięcia i customer_id. Sprawdź wymagania dotyczące customer_id i upewnij się, że przesyłasz dane, korzystając z odpowiedniego konta Google Ads.
|
DUPLICATE_CLICK_CONVERSION_IN_REQUEST
|
Wiele konwersji w żądaniu ma tę samą kombinację identyfikatora kliknięcia, conversion_date_time i conversion_action.
Usuń z żądania zduplikowane konwersje.
|
CLICK_CONVERSION_ALREADY_EXISTS
|
Konwersja z tą samą kombinacją identyfikatora kliknięcia, conversion_date_time i conversion_action została już przesłana. Zignoruj ten błąd, jeśli próbujesz ponownie przesłać konwersję, która została już wcześniej przesłana. Jeśli chcesz dodać kolejną konwersję oprócz tej przesłanej wcześniej, dostosuj parametr conversion_date_time w obiekcie ClickConversion, aby uniknąć duplikowania przesłanej wcześniej konwersji.
|
EXPIRED_EVENT
|
Zaimportowane kliknięcie miało miejsce przed przedziałem czasu określonym w polu click_through_lookback_window_days. Zmiana click_through_lookback_window_days wpływa tylko na kliknięcia zarejestrowane po jej wprowadzeniu, więc zmiana okresu ważności nie rozwiąże tego błędu w przypadku konkretnego kliknięcia. W razie potrzeby zmień conversion_action na inne działanie z dłuższym okresem ważności. |
CONVERSION_PRECEDES_EVENT
|
Wartość conversion_date_time jest wcześniejsza niż data i godzina kliknięcia. Zmień conversion_date_time na późniejszą wartość.
|
VALUE_MUST_BE_UNSET
|
Atrybut |
Konwersje w raportach
Przesłane konwersje są uwzględniane w raportach według daty wyświetlenia pierwotnego kliknięcia, a nie według daty przesłania żądania ani daty conversion_date_time ClickConversion.
Statystyki zaimportowanych konwersji pojawiają się na koncie Google Ads po upływie około 3 godzin w przypadku atrybucji ostatniego kliknięcia. W przypadku innych modeli atrybucji w sieci wyszukiwania może to potrwać dłużej niż 3 godziny. Więcej informacji znajdziesz w przewodniku po częstotliwości aktualizacji danych.