Вы можете использовать API Google Рекламы для загрузки конверсий по кликам в офлайн-режиме в Google Рекламу, чтобы отслеживать рекламу, которая привела к продажам в офлайн-мире, например по телефону или через торгового представителя.
Настраивать
Есть несколько предварительных условий для работы настройки офлайн-конверсий. Прежде чем приступить к реализации, убедитесь, что все предварительные условия выполнены:
Включите отслеживание конверсий в своем клиенте-конверсионисте Google Рекламы.
Настройте тегирование и сохраните идентификаторы кликов.
1. Включите отслеживание конверсий в вашем клиенте-конверсионисте Google Рекламы.
Если вы ознакомились с руководством по началу работы с конверсиями и включили отслеживание конверсий, вы можете перейти ко второму шагу: настроить тегирование .
Получите информацию о настройке отслеживания конверсий.
Вы можете проверить настройку отслеживания конверсий вашей учетной записи и убедиться, что отслеживание конверсий включено, запросив у ресурса Customer
ConversionTrackingSetting
. Выполните следующий запрос с помощью 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
Поле google_ads_conversion_customer
указывает аккаунт Google Рекламы, который создает конверсии для этого клиента и управляет ими. Для клиентов, использующих отслеживание конверсий между аккаунтами , это идентификатор управляющего аккаунта. Идентификатор клиента конверсий Google Рекламы следует указывать в качестве customer_id
в запросах API Google Рекламы для создания конверсий и управления ими. Обратите внимание, что это поле заполняется, даже если отслеживание конверсий не включено.
Поле conversion_tracking_status
указывает, включено ли отслеживание конверсий и используется ли в учетной записи отслеживание конверсий между учетными записями.
Создайте действие-конверсию для клиента-конверсии Google Рекламы.
Если значение conversion_tracking_status
равно NOT_CONVERSION_TRACKED
, отслеживание конверсий для учетной записи не включено. Включите отслеживание конверсий, создав хотя бы одно ConversionAction
в аккаунте конверсий Google Рекламы, как показано в следующем примере. Кроме того, вы можете создать действие-конверсию в пользовательском интерфейсе, следуя инструкциям в Справочном центре для того типа конверсии, который вы хотите включить.
Обратите внимание, что расширенное отслеживание конверсий включается автоматически при отправке через API Google Рекламы, но их можно отключить через пользовательский интерфейс Google Рекламы.
Пример кода
Ява
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()); } } }
С#
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 ); } }
Питон
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}".' )
Руби
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
Перл
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; }
Убедитесь, что для conversion_action_type
установлено правильное значение ConversionActionType
. Дополнительные инструкции по созданию действий-конверсий в Google Ads API см. в разделе Создание действий-конверсий .
Получить существующее действие-конверсию
Вы можете получить подробную информацию о существующем действии-конверсии, выполнив следующий запрос. Убедитесь, что в качестве идентификатора клиента в запросе указан клиент-конверсия Google Рекламы, которого вы указали выше, а для типа действия-конверсии установлено правильное значение ConversionActionType
.
SELECT
conversion_action.resource_name,
conversion_action.name,
conversion_action.status
FROM conversion_action
WHERE conversion_action.type = 'INSERT_CONVERSION_ACTION_TYPE'
2. Настройте тегирование и сохраните идентификаторы кликов.
Следуйте инструкциям , чтобы убедиться, что автоматическая пометка включена, и настройте свою учетную запись Google Рекламы, веб-сайт и систему отслеживания потенциальных клиентов для сбора и хранения GCLID, GBRAID или WBRAID каждого показа и нажатия на ваши объявления. Автоматическая пометка включена по умолчанию для новых учетных записей.
Создайте запрос
Следуйте инструкциям ниже, чтобы создать UploadClickConversionsRequest
и установить в его полях соответствующие значения.
-
customer_id
Идентифицирует аккаунт Google Рекламы, в который вы загружаете. Установите это значение для клиента, совершающего конверсию Google Рекламы, для аккаунта, который является источником кликов.
-
job_id
Предоставляет механизм для связывания ваших запросов на загрузку с информацией по каждому заданию в автономной диагностике данных .
Если вы не зададите это поле, API Google Рекламы присваивает каждому запросу уникальное значение в диапазоне
[2^31, 2^63)
. Если вы предпочитаете сгруппировать несколько запросов в одно логическое задание, установите для этого поля одно и то же значение в диапазоне[0, 2^31)
для каждого запроса в вашем задании.job_id
в ответе содержит идентификатор задания для запроса независимо от того, указали ли вы значение или разрешили API Google Рекламы присвоить его.-
partial_failure_enabled
Определяет, как API Google Рекламы обрабатывает ошибки операций.
В этом поле должно быть установлено значение
true
. При обработке ответа следуйте рекомендациям по частичным сбоям .-
debug_enabled
Определяет поведение отчетов об ошибках для расширенного преобразования при загрузке потенциальных клиентов . API Google Рекламы игнорирует это поле при обработке загрузок для конверсий по кликам с помощью
gclid
,gbraid
илиwbraid
.
Создание операций конверсии кликов
Коллекция объектов ClickConversion
в вашем UploadClickConversionRequest
определяет набор конверсий, которые вы хотите загрузить. Следуйте инструкциям ниже, чтобы создать каждое ClickConversion
и установить в его полях соответствующие значения.
Установите обязательные поля для каждой операции преобразования
Следуйте инструкциям ниже, чтобы установить в обязательных полях ClickConversion
соответствующие значения.
-
gclid
,gbraid
,wbraid
- Идентификатор, который вы зафиксировали во время клика или показа конверсии. Установите только одно из этих полей.
-
conversion_date_time
Дата и время преобразования.
Для значения должен быть указан часовой пояс, а формат должен быть
yyyy-mm-dd HH:mm:ss+|-HH:mm
, например:2022-01-01 19:32:45-05:00
(игнорируя летнее время). время) .Часовой пояс может иметь любое допустимое значение: он не обязательно должен совпадать с часовым поясом учетной записи. Однако если вы планируете сравнивать загруженные данные о конверсиях с данными в пользовательском интерфейсе Google Рекламы, мы рекомендуем использовать тот же часовой пояс, что и в вашей учетной записи Google Рекламы, чтобы количество конверсий совпадало. Более подробную информацию и примеры можно найти в Справочном центре , а также проверить коды и форматы, чтобы получить список действительных идентификаторов часовых поясов.
-
user_identifiers
Не заполняйте это поле при загрузке конверсий, использующих только идентификаторы кликов. Если это поле установлено, Google Реклама рассматривает операцию загрузки как загрузку для расширенного преобразования потенциальных клиентов .
-
conversion_action
Имя ресурса
ConversionAction
для преобразования клика.Действие-конверсия должно иметь
type
UPLOAD_CLICKS
и существовать в клиенте-конверсии Google Рекламы в аккаунте Google Рекламы, связанном с кликом.-
conversion_value
Ценность конверсии.
-
currency_code
Код валюты
conversion_value
.
Установите дополнительные поля для каждой операции преобразования
Просмотрите список необязательных полей ниже и при необходимости настройте их в ClickConversion
.
-
order_id
- Идентификатор транзакции для конверсии. Это поле является необязательным, но настоятельно рекомендуется. Если вы установили его во время загрузки, вы должны использовать его для любых корректировок, вносимых в преобразование.
-
external_attribution_data
Если вы используете сторонние инструменты или собственные решения для отслеживания конверсий, вы можете присвоить Google Рекламе только часть ценности конверсии или распределить ценность конверсии между несколькими кликами. Импорт конверсий с внешней атрибуцией позволяет загружать конверсии с дробной ценностью, присваиваемой каждому клику.
Чтобы загрузить дробные баллы, установите в этом поле объект
ExternalAttributionData
со значениямиexternal_attribution_model
иexternal_attribution_credit
.-
custom_variables
Значения пользовательских переменных преобразования .
Google Реклама не поддерживает специальные переменные конверсии в сочетании с
wbraid
илиgbraid
.-
cart_data
Вы можете включить информацию о корзине покупок для
ClickConversion
в полеcart_data
, которое состоит из следующих атрибутов:-
merchant_id
: идентификатор связанной учетной записи Merchant Center . -
feed_country_code
: двухзначный код региона ISO 3166 фида Merchant Center. -
feed_language_code
: код языка ISO 639-1 фида Merchant Center. -
local_transaction_cost
: сумма всех скидок на уровне транзакции вcurrency_code
ClickConversion
. -
items
: Товары в корзине.
Каждый элемент в
items
состоит из следующих атрибутов:-
product_id
: идентификатор продукта, иногда называемый идентификатором предложения или идентификатором товара. -
quantity
: количество товара. -
unit_price
: цена за единицу товара.
-
conversion_environment
Указывает среду, в которой было записано это преобразование. Например, Приложение или Интернет.
Пример кода
Ява
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); } } } } }
С#
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 ); } }
Питон
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}"' )
Руби
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
Перл
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; }
Устранение неполадок
Автономная диагностика данных предоставляет единый ресурс для постоянной проверки общего состояния ваших загрузок. Однако во время реализации вы можете использовать информацию из этого раздела для изучения любых ошибок, указанных в поле partial_failure_error
ответа.
Одними из наиболее распространенных ошибок при загрузке действий-конверсий являются ошибки авторизации, например USER_PERMISSION_DENIED
. Дважды проверьте, что в вашем запросе указан идентификатор клиента, связанного с конверсией Google Рекламы, которому принадлежит действие-конверсия. Посетите наше руководство по авторизации для получения более подробной информации и ознакомьтесь с нашим руководством по распространенным ошибкам , где вы найдете советы по устранению этих различных ошибок.
Отладка распространенных ошибок
Ошибка | |
---|---|
ConversionUploadError.INVALID_CONVERSION_ACTION_TYPE | Тип указанного действия-конверсии недопустим для загрузки конверсий по кликам. Убедитесь, что ConversionAction указанный в вашем запросе на загрузку, имеет тип UPLOAD_CLICKS . |
ConversionUploadError.NO_CONVERSION_ACTION_FOUND | Указанное действие-конверсия либо неактивно, либо не найдено в загружаемом идентификаторе customer_id . Убедитесь, что действие-конверсия в вашей загрузке включено и принадлежит клиенту customer_id запроса на загрузку. |
ConversionUploadError.TOO_RECENT_CONVERSION_ACTION | Действие-конверсия создано заново. Прежде чем повторять неудачные конверсии, подождите не менее 6 часов после создания действия. |
ConversionUploadError.INVALID_CUSTOMER_FOR_CLICK | customer_id запроса не совпадает с идентификатором клиента, который был аккаунтом конверсии Google Ads API на момент клика. Обновите customer_id запроса на правильного клиента. |
ConversionUploadError.EVENT_NOT_FOUND | Google Реклама не может найти комбинацию идентификатора клика и customer_id . Ознакомьтесь с требованиями для customer_id и убедитесь, что вы загружаете данные, используя правильный аккаунт Google Рекламы. |
ConversionUploadError.DUPLICATE_CLICK_CONVERSION_IN_REQUEST | Несколько конверсий в запросе имеют одинаковую комбинацию идентификатора клика, conversion_date_time и conversion_action . Удалите повторяющиеся конверсии из вашего запроса. |
ConversionUploadError.CLICK_CONVERSION_ALREADY_EXISTS | Ранее была загружена конверсия с такой же комбинацией идентификатора клика, conversion_date_time и conversion_action . Игнорируйте эту ошибку, если вы повторяли загрузку и ранее это преобразование было успешным. Если вы хотите добавить еще одну конверсию в дополнение к ранее загруженной конверсии, измените conversion_date_time ClickConversion , чтобы избежать дублирования ранее загруженной конверсии. |
ConversionUploadError.EVENT_NOT_FOUND | Google Реклама не может найти комбинацию идентификатора клика и customer_id . Ознакомьтесь с требованиями для customer_id и убедитесь, что вы загружаете данные, используя правильный аккаунт Google Рекламы. |
ConversionUploadError.EXPIRED_EVENT | Импортированный клик произошел раньше периода времени, указанного в поле click_through_lookback_window_days . Изменение параметра click_through_lookback_window_days влияет только на клики, зарегистрированные после изменения , поэтому изменение окна ретроспективного анализа не устранит эту ошибку для конкретного клика. При необходимости измените conversion_action на другое действие с более длительным окном ретроспективного анализа. |
ConversionUploadError.CONVERSION_PRECEDES_EVENT | conversion_date_time предшествует дате и времени клика. Обновите conversion_date_time до более позднего значения. |
ConversionUploadError.GBRAID_WBRAID_BOTH_SET | ClickConversion имеет набор значений как для gbraid , так и для wbraid . Обновите конверсию, чтобы использовать только один идентификатор клика, и убедитесь, что вы не объединяете несколько кликов в одну конверсию. Каждый клик имеет только один идентификатор клика. |
FieldError.VALUE_MUST_BE_UNSET | Проверьте location ошибки GoogleAdsError , чтобы определить, какая из следующих проблем привела к ошибке.
|
Конверсии в отчетах
Загруженные конверсии отражаются в отчетах по дате показа исходного клика, а не по дате запроса на загрузку или дате conversion_date_time
ClickConversion
.
Импортированная статистика конверсий появится в вашем аккаунте Google Рекламы для атрибуции по последнему клику в течение 3 часов. Для других моделей поисковой атрибуции это может занять более 3 часов. Дополнительную информацию см. в руководстве по обновлению данных .