Za pomocą interfejsu Google Ads API możesz przesyłać do Google Ads konwersje po kliknięciu offline, aby śledzić reklamy, które doprowadziły do sprzedaży w świecie offline, np. przez telefon lub przedstawiciela handlowego.
Konfiguracja
Aby prawidłowo skonfigurować konwersje offline, musisz spełnić kilka warunków wstępnych. Zanim przejdziesz do implementacji, upewnij się, że spełniasz wszystkie wymagania wstępne:
Włącz śledzenie konwersji w kontenerze konwersji Google Ads.
Skonfiguruj tagowanie i zapisywanie identyfikatorów kliknięć.
1. Włączanie śledzenia konwersji na koncie klienta konwersji Google Ads
Jeśli masz już za sobą wstępny przewodnik dotyczący konwersji i masz włączone śledzenie konwersji, możesz przejść do drugiego kroku: skonfiguruj tagowanie.
Pobieranie informacji o konfiguracji śledzenia konwersji
Aby sprawdzić konfigurację śledzenia konwersji na koncie i sprawdzić, czy śledzenie konwersji jest włączone, prześlij zapytanie do zasobu Customer
dotyczącego ConversionTrackingSetting
.
Wykonaj to zapytanie:
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. Aby tworzyć konwersje i zarządzać nimi, w żądaniach interfejsu Google Ads API należy podać identyfikator klienta Google Ads jako parametr customer_id
.
Pamiętaj, że to pole jest wypełnione nawet wtedy, gdy śledzenie konwersji jest wyłączone.
Pole conversion_tracking_status
wskazuje, czy śledzenie konwersji jest włączone i czy konto używa ś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 tym przykładzie. Możesz też utworzyć działanie powodujące konwersję w interfejsie, wykonując instrukcje w Centrum pomocy dotyczące rodzaju 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.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; }
Sprawdź, czy conversion_action_type
ma prawidłową wartość ConversionActionType
.
Więcej wskazówek o tworzeniu działań powodujących konwersję w interfejsie Google Ads API znajdziesz w artykule Tworzenie działań powodujących konwersję.
Pobieranie dotychczasowego działania powodującego konwersję
Szczegóły istniejącego działania powodującego konwersję możesz pobrać, wysyłając to zapytanie. Upewnij się, że identyfikator klienta w żądaniu jest ustawiony na klienta konwersji Google Ads, którego identyfikator podano powyżej, a typ działania powodującego konwersję ma prawidłową wartość ConversionActionType
.
SELECT
conversion_action.resource_name,
conversion_action.name,
conversion_action.status
FROM conversion_action
WHERE conversion_action.type = 'INSERT_CONVERSION_ACTION_TYPE'
2. Konfigurowanie tagowania i zapisywania identyfikatorów kliknięć
Postępuj zgodnie z instrukcjami, aby potwierdzić, że automatyczne tagowanie jest włączone, i skonfiguruj konto Google Ads, witrynę i system śledzenia potencjalnych klientów, aby rejestrować i przechowywać identyfikator GCLID, GBRAID lub WBRAID każdego wyświetlenia i kliku reklamy. Automatyczne tagowanie jest domyślnie włączone na nowych kontach.
Utwórz żądanie
Postępuj zgodnie z poniższymi wskazówkami, aby utworzyć obiekt UploadClickConversionsRequest
i ustawić odpowiednie wartości w jego polach.
customer_id
Identyfikuje konto Google Ads, z którego przesłano plik. Ustaw tę wartość na Klient konwersji Google Ads na koncie, które jest źródłem kliknięć.
job_id
Zapewnia mechanizm do kojarzenia żądań przesyłania z informacjami dotyczącymi poszczególnych zadań w diagnostyce danych offline.
Jeśli nie ustawisz tego pola, interfejs Google Ads API przypisze każdemu żądaniu unikalną wartość w zakresie
[2^31, 2^63)
. Jeśli wolisz zgrupować wiele żądań w jedno zadanie logiczne, ustaw w tym polu tę samą wartość z zakresu[0, 2^31)
przy każdym żądaniu w zadaniu.Wartość
job_id
w odpowiedzi zawiera identyfikator zadania dla żądania, niezależnie od tego, czy została podana przez Ciebie wartość, czy też interfejs Google Ads API przypisał wartość.partial_failure_enabled
Określa, jak interfejs Google Ads API obsługuje błędy z operacji.
To pole musi mieć wartość
true
. Podczas przetwarzania odpowiedzi postępuj zgodnie z wytycznymi dotyczącymi częściowych błędów.debug_enabled
Określa sposób zgłaszania błędów w przypadku przesyłania konwersji rozszerzonych dotyczących potencjalnych klientów. Interfejs Google Ads API ignoruje to pole podczas przesyłania konwersji kliknięć za pomocą parametrów
gclid
,gbraid
lubwbraid
.
Tworzenie operacji konwersji z kliknięcia
Zbiór obiektów ClickConversion
w obiekcie UploadClickConversionRequest
określa zbiór konwersji, które chcesz przesłać. Postępuj zgodnie z poniższymi wskazówkami, aby utworzyć poszczególne ClickConversion
i ustawić w ich polach odpowiednie wartości.
Skonfiguruj wymagane pola każdej operacji konwersji
Aby ustawić odpowiednie wartości w wymaganych polach w plikach ClickConversion
, wykonaj podane niżej instrukcje.
gclid
,gbraid
,wbraid
- Identyfikator zarejestrowany w momencie kliknięcia lub wyświetlenia, które doprowadziło do konwersji. Ustaw tylko jedno z tych pól.
conversion_date_time
Data i godzina konwersji.
Wartość musi mieć określoną strefę czasową i format musi mieć format
yyyy-mm-dd HH:mm:ss+|-HH:mm
, np.2022-01-01 19:32:45-05:00
(bez czasu letniego).Strefa czasowa może mieć dowolną prawidłową wartość: nie musi odpowiadać strefie czasowej konta. Jeśli jednak planujesz porównywać przesłane dane o konwersjach z danymi w interfejsie Google Ads, zalecamy użycie tego samego czasu strefy, co na Twoim koncie Google Ads, aby liczby konwersji były zgodne. Więcej informacji i przykładów znajdziesz w Centrum pomocy. Aby poznać listę prawidłowych identyfikatorów stref czasowych, zapoznaj się z artykułem Kodów i formatów.
user_identifiers
Nie ustawiaj tego pola podczas przesyłania konwersji z wykorzystaniem tylko identyfikatorów kliknięć. Jeśli to pole jest skonfigurowane, Google Ads traktuje operację przesyłania jako przesyłanie danych w przypadku konwersji rozszerzonych dotyczących potencjalnych klientów.
conversion_action
Nazwa zasobu
ConversionAction
odpowiadającego konwersji z kliknięcia.Działanie powodujące konwersję musi mieć wartość
type
UPLOAD_CLICKS
i występować w koncie klienta konwersji Google Ads powiązanym z kliknięciem.conversion_value
Wartość konwersji.
currency_code
Kod waluty
conversion_value
.
Ustawianie opcjonalnych pól każdej operacji konwersji
Zapoznaj się z listą pól opcjonalnych poniżej i w razie potrzeby skonfiguruj je w swoim ClickConversion
.
order_id
- Identyfikator transakcji konwersji. To pole jest opcjonalne, ale zdecydowanie zalecane. Jeśli ustawisz go podczas przesyłania, musisz go używać do wprowadzania korekt w konwersji.
external_attribution_data
Jeśli do śledzenia konwersji używasz narzędzi innych firm lub rozwiązań spersonalizowanych, możesz przypisać Google Ads tylko część udziału w konwersji lub przypisać udział w konwersji na wiele kliknięć. Importowanie konwersji przypisanych zewnętrznie umożliwia przesyłanie konwersji z przypisanym częściowym udziałem do każdego kliknięcia.
Aby przesłać kredyty cząstkowe, ustaw to pole na obiekt
ExternalAttributionData
z wartościami dlaexternal_attribution_model
iexternal_attribution_credit
.custom_variables
wartości niestandardowych zmiennych konwersji.
Google Ads nie obsługuje niestandardowych zmiennych konwersji w połączeniu z parametrami
wbraid
anigbraid
.cart_data
Informacje o koszyku na zakupy dla
ClickConversion
możesz podać w polucart_data
, które zawiera te atrybuty:merchant_id
: identyfikator powiązanego konta Merchant Center.feed_country_code
: 2-znakowy kod regionu pliku danych Merchant Center zgodny z normą ISO 3166.feed_language_code
: kod języka w formacie ISO 639-1 pliku danych Merchant Center.local_transaction_cost
: suma wszystkich rabatów na poziomie transakcji wcurrency_code
ClickConversion
.items
: produkty w koszyku.
Każdy element w
items
skł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.
conversion_environment
Wskazuje środowisko, w którym została zarejestrowana ta konwersja. Na przykład aplikacja lub sieć.
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.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; }
Rozwiązywanie problemów
Diagnostyka danych offline to pojedyncze narzędzie, które pozwala na bieżąco sprawdzać ogólny stan przesyłanych danych. Podczas implementacji możesz jednak skorzystać z informacji w tej sekcji, aby zbadać błędy zgłoszone w polu partial_failure_error
odpowiedzi.
Najczęstsze błędy podczas przesyłania działań powodujących konwersję to błędy autoryzacji, np. USER_PERMISSION_DENIED
. Sprawdź, czy identyfikator klienta w żądaniu jest ustawiony na klienta konwersji Google Ads, który jest właścicielem działania powodującego konwersję. Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji, a w przewodniku po typowych błędach znajdziesz wskazówki dotyczące debugowania tych różnych błędów.
Debugowanie typowych błędów
Błąd | |
---|---|
ConversionUploadError.INVALID_CONVERSION_ACTION_TYPE
|
Wskazane działanie powodujące konwersję ma typ, który nie jest prawidłowy w przypadku przesyłania konwersji z kliknięcia. Upewnij się, że ConversionAction określony w żądaniu przesyłania ma typ UPLOAD_CLICKS .
|
ConversionUploadError.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 . Sprawdź, czy działanie powodujące konwersję w przesyłanych danych jest włączone i należy do konta customer_id w żądaniu przesłania.
|
ConversionUploadError.TOO_RECENT_CONVERSION_ACTION
|
Działanie powodujące konwersję zostało utworzone niedawno. Poczekaj co najmniej 6 godzin od utworzenia działania i spróbuj ponownie wykonać nieudane konwersje. |
ConversionUploadError.INVALID_CUSTOMER_FOR_CLICK
|
Identyfikator customer_id żądania nie jest tym samym identyfikatorem klienta, który był kontem konwersji interfejsu Google Ads API w chwili kliknięcia. Zaktualizuj customer_id prośby o przeniesienie, aby dotyczyła właściwego klienta.
|
ConversionUploadError.EVENT_NOT_FOUND
|
Google Ads nie może znaleźć kombinacji identyfikatora kliknięcia
i customer_id . Zapoznaj się z wymaganiami dotyczącymi customer_id i sprawdź, czy przesyłasz dane z właściwego konta Google Ads.
|
ConversionUploadError.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.
|
ConversionUploadError.CLICK_CONVERSION_ALREADY_EXISTS
|
Konwersja z tą samą kombinacją identyfikatora kliknięcia, conversion_date_time i conversion_action została przesłana wcześniej. Ignoruj ten błąd, jeśli próbujesz ponownie przesłać dane, a ta konwersja została już wcześniej zarejestrowana. Jeśli oprócz wcześniej przesłanej konwersji chcesz dodać kolejną konwersję, dostosuj conversion_date_time parametru ClickConversion , aby uniknąć duplikowania konwersji przesłanej wcześniej.
|
ConversionUploadError.EVENT_NOT_FOUND
|
Google Ads nie może znaleźć kombinacji identyfikatora kliknięcia i customer_id . Zapoznaj się z wymaganiami dotyczącymi customer_id i sprawdź, czy przesyłasz dane z właściwego konta Google Ads.
|
ConversionUploadError.EXPIRED_EVENT
|
Zaimportowane kliknięcie miało miejsce przed okresem określonym w polu click_through_lookback_window_days . Zmiana w ustawieniu click_through_lookback_window_days dotyczy tylko kliknięć zarejestrowanych po wprowadzeniu tej zmiany, więc zmiana okresu ważności nie rozwiąże tego problemu w przypadku danego kliknięcia. W razie potrzeby zmień conversion_action na inne działanie z dłuższym okresem ważności. |
ConversionUploadError.CONVERSION_PRECEDES_EVENT
|
conversion_date_time jest wcześniejsza niż data i godzina kliknięcia. Zmień wartość conversion_date_time na późniejszą.
|
ConversionUploadError.GBRAID_WBRAID_BOTH_SET
|
W przypadku parametru ClickConversion ustawiono wartość zarówno dla gbraid , jak i wbraid . Zmień konwersję tak, aby używała tylko jednego identyfikatora kliknięcia. Upewnij się, że nie łączysz wielu kliknięć w 1 konwersję. Każde kliknięcie ma tylko 1 identyfikator kliknięcia.
|
FieldError.VALUE_MUST_BE_UNSET
|
Sprawdź location GoogleAdsError , aby określić, który z tych problemów spowodował błąd.
|
Konwersje w raportach
Przesłane konwersje są widoczne w raportach pod datą wyświetlenia pierwotnego kliknięcia, a nie datą żądania przesłania ani datą conversion_date_time
w ClickConversion
.
Zanim na koncie Google Ads pojawią się statystyki zaimportowanych konwersji z przypisaniem atrybucji do ostatniego kliknięcia, może minąć do 3 godzin. W przypadku innych modeli atrybucji wyszukiwania może to potrwać dłużej niż 3 godziny. Więcej informacji znajdziesz w przewodniku na temat częstotliwości aktualizacji danych.