يمكنك استخدام Google Ads API لتحميل الإحالات الناجحة الناتجة عن نقرات بلا اتصال بالإنترنت إلى "إعلانات 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
في طلبات Google Ads API لإنشاء الإحالات الناجحة وإدارتها.
تجدر الإشارة إلى أنّه تتم تعبئة هذا الحقل حتى في حال عدم تفعيل ميزة تتبُّع الإحالات الناجحة.
يشير الحقل
conversion_tracking_status
إلى ما إذا كانت ميزة تتبُّع الإحالات الناجحة مفعَّلة وما إذا كان الحساب
يستخدم تتبُّع الإحالات الناجحة في جميع الحسابات.
إنشاء إجراء إحالة ناجحة ضمن عميل الإحالة الناجحة في "إعلانات Google"
إذا كانت القيمة conversion_tracking_status
هي NOT_CONVERSION_TRACKED
،
لن يتم تفعيل ميزة تتبُّع الإحالات الناجحة للحساب. فعِّل تتبُّع الإحالات الناجحة
عن طريق إنشاء علامة ConversionAction
واحدة على الأقل
في حساب الإحالات الناجحة على "إعلانات Google"، كما في المثال التالي. بدلاً من ذلك، يمكنك إنشاء إجراء إحالة ناجحة في واجهة المستخدم باتّباع التعليمات الواردة في مركز المساعدة لنوع الإحالة الناجحة الذي تريد تفعيله.
تجدُر الإشارة إلى أنّه يتم تفعيل ميزة الإحالات الناجحة المحسّنة تلقائيًا عند إرسالها من خلال Google Ads API، ولكن يمكن إيقافها من خلال واجهة مستخدم "إعلانات Google".
مثال الرمز البرمجي
Java
private void runExample(GoogleAdsClient googleAdsClient, long customerId) { // Creates a ConversionAction. ConversionAction conversionAction = ConversionAction.newBuilder() // Note that conversion action names must be unique. If a conversion action already // exists with the specified conversion_action_name the create operation will fail with // a ConversionActionError.DUPLICATE_NAME error. .setName("Earth to Mars Cruises Conversion #" + getPrintableDateTime()) .setCategory(ConversionActionCategory.DEFAULT) .setType(ConversionActionType.WEBPAGE) .setStatus(ConversionActionStatus.ENABLED) .setViewThroughLookbackWindowDays(15L) .setValueSettings( ValueSettings.newBuilder() .setDefaultValue(23.41) .setAlwaysUseDefaultValue(true) .build()) .build(); // Creates the operation. ConversionActionOperation operation = ConversionActionOperation.newBuilder().setCreate(conversionAction).build(); try (ConversionActionServiceClient conversionActionServiceClient = googleAdsClient.getLatestVersion().createConversionActionServiceClient()) { MutateConversionActionsResponse response = conversionActionServiceClient.mutateConversionActions( Long.toString(customerId), Collections.singletonList(operation)); System.out.printf("Added %d conversion actions:%n", response.getResultsCount()); for (MutateConversionActionResult result : response.getResultsList()) { System.out.printf( "New conversion action added with resource name: '%s'%n", result.getResourceName()); } } }
C#
public void Run(GoogleAdsClient client, long customerId) { // Get the ConversionActionService. ConversionActionServiceClient conversionActionService = client.GetService(Services.V17.ConversionActionService); // Note that conversion action names must be unique. // If a conversion action already exists with the specified name the create operation // will fail with a ConversionAction.DUPLICATE_NAME error. string ConversionActionName = "Earth to Mars Cruises Conversion #" + ExampleUtilities.GetRandomString(); // Add a conversion action. ConversionAction conversionAction = new ConversionAction() { Name = ConversionActionName, Category = ConversionActionCategory.Default, Type = ConversionActionType.Webpage, Status = ConversionActionStatus.Enabled, ViewThroughLookbackWindowDays = 15, ValueSettings = new ConversionAction.Types.ValueSettings() { DefaultValue = 23.41, AlwaysUseDefaultValue = true } }; // Create the operation. ConversionActionOperation operation = new ConversionActionOperation() { Create = conversionAction }; try { // Create the conversion action. MutateConversionActionsResponse response = conversionActionService.MutateConversionActions(customerId.ToString(), new ConversionActionOperation[] { operation }); // Display the results. foreach (MutateConversionActionResult newConversionAction in response.Results) { Console.WriteLine($"New conversion action with resource name = " + $"'{newConversionAction.ResourceName}' was added."); } } catch (GoogleAdsException e) { Console.WriteLine("Failure:"); Console.WriteLine($"Message: {e.Message}"); Console.WriteLine($"Failure: {e.Failure}"); Console.WriteLine($"Request ID: {e.RequestId}"); throw; } }
PHP
public static function runExample(GoogleAdsClient $googleAdsClient, int $customerId) { // Creates a conversion action. $conversionAction = new ConversionAction([ // Note that conversion action names must be unique. // If a conversion action already exists with the specified conversion_action_name // the create operation will fail with a ConversionActionError.DUPLICATE_NAME error. 'name' => 'Earth to Mars Cruises Conversion #' . Helper::getPrintableDatetime(), 'category' => ConversionActionCategory::PBDEFAULT, 'type' => ConversionActionType::WEBPAGE, 'status' => ConversionActionStatus::ENABLED, 'view_through_lookback_window_days' => 15, 'value_settings' => new ValueSettings([ 'default_value' => 23.41, 'always_use_default_value' => true ]) ]); // Creates a conversion action operation. $conversionActionOperation = new ConversionActionOperation(); $conversionActionOperation->setCreate($conversionAction); // Issues a mutate request to add the conversion action. $conversionActionServiceClient = $googleAdsClient->getConversionActionServiceClient(); $response = $conversionActionServiceClient->mutateConversionActions( MutateConversionActionsRequest::build($customerId, [$conversionActionOperation]) ); printf("Added %d conversion actions:%s", $response->getResults()->count(), PHP_EOL); foreach ($response->getResults() as $addedConversionAction) { /** @var ConversionAction $addedConversionAction */ printf( "New conversion action added with resource name: '%s'%s", $addedConversionAction->getResourceName(), PHP_EOL ); } }
Python
def main(client, customer_id): conversion_action_service = client.get_service("ConversionActionService") # Create the operation. conversion_action_operation = client.get_type("ConversionActionOperation") # Create conversion action. conversion_action = conversion_action_operation.create # Note that conversion action names must be unique. If a conversion action # already exists with the specified conversion_action_name, the create # operation will fail with a ConversionActionError.DUPLICATE_NAME error. conversion_action.name = f"Earth to Mars Cruises Conversion {uuid.uuid4()}" conversion_action.type_ = ( client.enums.ConversionActionTypeEnum.UPLOAD_CLICKS ) conversion_action.category = ( client.enums.ConversionActionCategoryEnum.DEFAULT ) conversion_action.status = client.enums.ConversionActionStatusEnum.ENABLED conversion_action.view_through_lookback_window_days = 15 # Create a value settings object. value_settings = conversion_action.value_settings value_settings.default_value = 15.0 value_settings.always_use_default_value = True # Add the conversion action. conversion_action_response = ( conversion_action_service.mutate_conversion_actions( customer_id=customer_id, operations=[conversion_action_operation], ) ) print( "Created conversion action " f'"{conversion_action_response.results[0].resource_name}".' )
Ruby
def add_conversion_action(customer_id) # GoogleAdsClient will read a config file from # ENV['HOME']/google_ads_config.rb when called without parameters client = Google::Ads::GoogleAds::GoogleAdsClient.new # Add a conversion action. conversion_action = client.resource.conversion_action do |ca| ca.name = "Earth to Mars Cruises Conversion #{(Time.new.to_f * 100).to_i}" ca.type = :UPLOAD_CLICKS ca.category = :DEFAULT ca.status = :ENABLED ca.view_through_lookback_window_days = 15 # Create a value settings object. ca.value_settings = client.resource.value_settings do |vs| vs.default_value = 15 vs.always_use_default_value = true end end # Create the operation. conversion_action_operation = client.operation.create_resource.conversion_action(conversion_action) # Add the ad group ad. response = client.service.conversion_action.mutate_conversion_actions( customer_id: customer_id, operations: [conversion_action_operation], ) puts "New conversion action with resource name = #{response.results.first.resource_name}." end
Perl
sub add_conversion_action { my ($api_client, $customer_id) = @_; # Note that conversion action names must be unique. # If a conversion action already exists with the specified conversion_action_name, # the create operation fails with error ConversionActionError.DUPLICATE_NAME. my $conversion_action_name = "Earth to Mars Cruises Conversion #" . uniqid(); # Create a conversion action. my $conversion_action = Google::Ads::GoogleAds::V17::Resources::ConversionAction->new({ name => $conversion_action_name, category => DEFAULT, type => WEBPAGE, status => ENABLED, viewThroughLookbackWindowDays => 15, valueSettings => Google::Ads::GoogleAds::V17::Resources::ValueSettings->new({ defaultValue => 23.41, alwaysUseDefaultValue => "true" })}); # Create a conversion action operation. my $conversion_action_operation = Google::Ads::GoogleAds::V17::Services::ConversionActionService::ConversionActionOperation ->new({create => $conversion_action}); # Add the conversion action. my $conversion_actions_response = $api_client->ConversionActionService()->mutate({ customerId => $customer_id, operations => [$conversion_action_operation]}); printf "New conversion action added with resource name: '%s'.\n", $conversion_actions_response->{results}[0]{resourceName}; return 1; }
تأكَّد من ضبط السمة 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. ضبط وضع العلامات ومعرّفات تخزين النقرات
اتّبِع instructions لتأكيد تفعيل وضع العلامات التلقائي، وأعِد ضبط حسابك على "إعلانات Google" وموقعك الإلكتروني ونظام تتبُّع العملاء المحتملين لتسجيل معرّف GCLID أو GBRAID أو WBRAID وتخزينه لكل مرّة ظهور ونقرة لإعلاناتك. يكون وضع العلامات التلقائي مفعَّلاً بشكلٍ تلقائي في الحسابات الجديدة.
إنشاء الطلب
اتّبِع الإرشادات الواردة أدناه لإنشاء
UploadClickConversionsRequest
وضبط حقوله على القيم المناسبة.
customer_id
يحدّد حساب "إعلانات Google" الذي حمّلته. اضبط ذلك على عميل الإحالات الناجحة في "إعلانات Google" للحساب الذي يشكّل مصدر النقرات.
job_id
توفّر آلية لربط طلبات التحميل بمعلومات خاصة بكل وظيفة في بيانات تشخيص البيانات المتوفّرة بلا إنترنت.
إذا لم تحدّد هذا الحقل، تعيّن Google Ads API قيمة فريدة لكل طلب ضمن النطاق
[2^31, 2^63)
. إذا كنت تفضّل تجميع طلبات متعدّدة في مهمة منطقية واحدة، اضبط هذا الحقل على القيمة نفسها في النطاق[0, 2^31)
في كل طلب في مهمتك.يحتوي
job_id
في الرد على معرّف الوظيفة للطلب، بغض النظر عما إذا كنت قد حددت قيمة أو سمحت لـ Google Ads API بتعيين قيمة.partial_failure_enabled
تحديد كيفية تعامل Google Ads API مع الأخطاء الناتجة عن العمليات.
يجب ضبط هذا الحقل على
true
. اتّبِع إرشادات الإخفاقات الجزئية عند معالجة الرد.debug_enabled
تحدِّد سلوك الإبلاغ عن الأخطاء لعمليات تحميل الإحالات الناجحة المحسّنة للعملاء المحتملين. تتجاهل Google Ads API هذا الحقل عند معالجة عمليات التحميل للإحالات الناجحة الناتجة عن النقر باستخدام
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
يشير إلى البيئة التي تم تسجيل هذه الإحالة الناجحة فيها. على سبيل المثال، التطبيق أو الويب.
مثال الرمز البرمجي
Java
private void runExample( GoogleAdsClient googleAdsClient, long customerId, long conversionActionId, String gclid, String gbraid, String wbraid, String conversionDateTime, Double conversionValue, Long conversionCustomVariableId, String conversionCustomVariableValue, String orderId, ConsentStatus adUserDataConsent) throws InvalidProtocolBufferException { // Verifies that exactly one of gclid, gbraid, and wbraid is specified, as required. // See https://developers.google.com/google-ads/api/docs/conversions/upload-clicks for details. long numberOfIdsSpecified = Arrays.asList(gclid, gbraid, wbraid).stream().filter(idField -> idField != null).count(); if (numberOfIdsSpecified != 1) { throw new IllegalArgumentException( "Exactly 1 of gclid, gbraid, or wbraid is required, but " + numberOfIdsSpecified + " ID values were provided"); } // Constructs the conversion action resource name from the customer and conversion action IDs. String conversionActionResourceName = ResourceNames.conversionAction(customerId, conversionActionId); // Creates the click conversion. ClickConversion.Builder clickConversionBuilder = ClickConversion.newBuilder() .setConversionAction(conversionActionResourceName) .setConversionDateTime(conversionDateTime) .setConversionValue(conversionValue) .setCurrencyCode("USD"); // Sets the single specified ID field. if (gclid != null) { clickConversionBuilder.setGclid(gclid); } else if (gbraid != null) { clickConversionBuilder.setGbraid(gbraid); } else { clickConversionBuilder.setWbraid(wbraid); } if (conversionCustomVariableId != null && conversionCustomVariableValue != null) { // Sets the custom variable and value, if provided. clickConversionBuilder.addCustomVariables( CustomVariable.newBuilder() .setConversionCustomVariable( ResourceNames.conversionCustomVariable(customerId, conversionCustomVariableId)) .setValue(conversionCustomVariableValue)); } if (orderId != null) { // Sets the order ID (unique transaction ID), if provided. clickConversionBuilder.setOrderId(orderId); } // Sets the consent information, if provided. if (adUserDataConsent != null) { // Specifies whether user consent was obtained for the data you are uploading. See // https://www.google.com/about/company/user-consent-policy for details. clickConversionBuilder.setConsent(Consent.newBuilder().setAdUserData(adUserDataConsent)); } ClickConversion clickConversion = clickConversionBuilder.build(); // Creates the conversion upload service client. try (ConversionUploadServiceClient conversionUploadServiceClient = googleAdsClient.getLatestVersion().createConversionUploadServiceClient()) { // Uploads the click conversion. Partial failure should always be set to true. // NOTE: This request contains a single conversion as a demonstration. However, if you have // multiple conversions to upload, it's best to upload multiple conversions per request // instead of sending a separate request per conversion. See the following for per-request // limits: // https://developers.google.com/google-ads/api/docs/best-practices/quotas#conversion_upload_service UploadClickConversionsResponse response = conversionUploadServiceClient.uploadClickConversions( UploadClickConversionsRequest.newBuilder() .setCustomerId(Long.toString(customerId)) .addConversions(clickConversion) // Enables partial failure (must be true). .setPartialFailure(true) .build()); // Prints any partial errors returned. if (response.hasPartialFailureError()) { GoogleAdsFailure googleAdsFailure = ErrorUtils.getInstance().getGoogleAdsFailure(response.getPartialFailureError()); // Constructs a protocol buffer printer that will print error details in a concise format. Printer errorPrinter = JsonFormat.printer().omittingInsignificantWhitespace(); for (int operationIndex = 0; operationIndex < response.getResultsCount(); operationIndex++) { ClickConversionResult conversionResult = response.getResults(operationIndex); if (ErrorUtils.getInstance().isPartialFailureResult(conversionResult)) { // Prints the errors for the failed operation. System.out.printf("Operation %d failed with the following errors:%n", operationIndex); for (GoogleAdsError resultError : ErrorUtils.getInstance().getGoogleAdsErrors(operationIndex, googleAdsFailure)) { // Prints the error with newlines and extra spaces removed. System.out.printf(" %s%n", errorPrinter.print(resultError)); } } else { // Prints the information about the successful operation. StringBuilder clickInfoBuilder = new StringBuilder("conversion that occurred at ") .append(String.format("'%s' ", conversionResult.getConversionDateTime())) .append("with "); if (conversionResult.hasGclid()) { clickInfoBuilder.append(String.format("gclid '%s'", conversionResult.getGclid())); } else if (!conversionResult.getGbraid().isEmpty()) { clickInfoBuilder.append(String.format("gbraid '%s'", conversionResult.getGbraid())); } else if (!conversionResult.getWbraid().isEmpty()) { clickInfoBuilder.append(String.format("wbraid '%s'", conversionResult.getWbraid())); } else { clickInfoBuilder.append("no click ID"); } System.out.printf("Operation %d for %s succeeded.%n", operationIndex, clickInfoBuilder); } } } } }
C#
public void Run(GoogleAdsClient client, long customerId, long conversionActionId, string gclid, string gbraid, string wbraid, string conversionTime, double conversionValue, ConsentStatus? adUserDataConsent) { // Get the ConversionActionService. ConversionUploadServiceClient conversionUploadService = client.GetService(Services.V17.ConversionUploadService); // Creates a click conversion by specifying currency as USD. ClickConversion clickConversion = new ClickConversion() { ConversionAction = ResourceNames.ConversionAction(customerId, conversionActionId), ConversionValue = conversionValue, ConversionDateTime = conversionTime, CurrencyCode = "USD", }; // Sets the consent information, if provided. if (adUserDataConsent != null) { // Specifies whether user consent was obtained for the data you are uploading. See // https://www.google.com/about/company/user-consent-policy // for details. clickConversion.Consent = new Consent() { AdUserData = (ConsentStatus)adUserDataConsent }; } // Verifies that exactly one of gclid, gbraid, and wbraid is specified, as required. // See https://developers.google.com/google-ads/api/docs/conversions/upload-clicks // for details. string[] ids = { gclid, gbraid, wbraid }; int idCount = ids.Where(id => !string.IsNullOrEmpty(id)).Count(); if (idCount != 1) { throw new ArgumentException($"Exactly 1 of gclid, gbraid, or wbraid is " + $"required, but {idCount} ID values were provided"); } // Sets the single specified ID field. if (!string.IsNullOrEmpty(gclid)) { clickConversion.Gclid = gclid; } else if (!string.IsNullOrEmpty(wbraid)) { clickConversion.Wbraid = wbraid; } else if (!string.IsNullOrEmpty(gbraid)) { clickConversion.Gbraid = gbraid; } try { // Issues a request to upload the click conversion. UploadClickConversionsResponse response = conversionUploadService.UploadClickConversions( new UploadClickConversionsRequest() { CustomerId = customerId.ToString(), Conversions = { clickConversion }, PartialFailure = true, ValidateOnly = false }); // Prints the result. ClickConversionResult uploadedClickConversion = response.Results[0]; Console.WriteLine($"Uploaded conversion that occurred at " + $"'{uploadedClickConversion.ConversionDateTime}' from Google " + $"Click ID '{uploadedClickConversion.Gclid}' to " + $"'{uploadedClickConversion.ConversionAction}'."); } catch (GoogleAdsException e) { Console.WriteLine("Failure:"); Console.WriteLine($"Message: {e.Message}"); Console.WriteLine($"Failure: {e.Failure}"); Console.WriteLine($"Request ID: {e.RequestId}"); throw; } }
PHP
public static function runExample( GoogleAdsClient $googleAdsClient, int $customerId, int $conversionActionId, ?string $gclid, ?string $gbraid, ?string $wbraid, ?string $orderId, string $conversionDateTime, float $conversionValue, ?string $conversionCustomVariableId, ?string $conversionCustomVariableValue, ?int $adUserDataConsent ) { // Verifies that exactly one of gclid, gbraid, and wbraid is specified, as required. // See https://developers.google.com/google-ads/api/docs/conversions/upload-clicks for details. $nonNullFields = array_filter( [$gclid, $gbraid, $wbraid], function ($field) { return !is_null($field); } ); if (count($nonNullFields) !== 1) { throw new \UnexpectedValueException( sprintf( "Exactly 1 of gclid, gbraid or wbraid is required, but %d ID values were " . "provided", count($nonNullFields) ) ); } // Creates a click conversion by specifying currency as USD. $clickConversion = new ClickConversion([ 'conversion_action' => ResourceNames::forConversionAction($customerId, $conversionActionId), 'conversion_value' => $conversionValue, 'conversion_date_time' => $conversionDateTime, 'currency_code' => 'USD' ]); // Sets the single specified ID field. if (!is_null($gclid)) { $clickConversion->setGclid($gclid); } elseif (!is_null($gbraid)) { $clickConversion->setGbraid($gbraid); } else { $clickConversion->setWbraid($wbraid); } if (!is_null($conversionCustomVariableId) && !is_null($conversionCustomVariableValue)) { $clickConversion->setCustomVariables([new CustomVariable([ 'conversion_custom_variable' => ResourceNames::forConversionCustomVariable( $customerId, $conversionCustomVariableId ), 'value' => $conversionCustomVariableValue ])]); } // Sets the consent information, if provided. if (!empty($adUserDataConsent)) { // Specifies whether user consent was obtained for the data you are uploading. See // https://www.google.com/about/company/user-consent-policy for details. $clickConversion->setConsent(new Consent(['ad_user_data' => $adUserDataConsent])); } if (!empty($orderId)) { // Sets the order ID (unique transaction ID), if provided. $clickConversion->setOrderId($orderId); } // Issues a request to upload the click conversion. $conversionUploadServiceClient = $googleAdsClient->getConversionUploadServiceClient(); /** @var UploadClickConversionsResponse $response */ // NOTE: This request contains a single conversion as a demonstration. However, if you have // multiple conversions to upload, it's best to upload multiple conversions per request // instead of sending a separate request per conversion. See the following for per-request // limits: // https://developers.google.com/google-ads/api/docs/best-practices/quotas#conversion_upload_service $response = $conversionUploadServiceClient->uploadClickConversions( // Uploads the click conversion. Partial failure should always be set to true. UploadClickConversionsRequest::build($customerId, [$clickConversion], true) ); // Prints the status message if any partial failure error is returned. // Note: The details of each partial failure error are not printed here, you can refer to // the example HandlePartialFailure.php to learn more. if ($response->hasPartialFailureError()) { printf( "Partial failures occurred: '%s'.%s", $response->getPartialFailureError()->getMessage(), PHP_EOL ); } else { // Prints the result if exists. /** @var ClickConversionResult $uploadedClickConversion */ $uploadedClickConversion = $response->getResults()[0]; printf( "Uploaded click conversion that occurred at '%s' from Google Click ID '%s' " . "to '%s'.%s", $uploadedClickConversion->getConversionDateTime(), $uploadedClickConversion->getGclid(), $uploadedClickConversion->getConversionAction(), PHP_EOL ); } }
Python
def main( client, customer_id, conversion_action_id, gclid, conversion_date_time, conversion_value, conversion_custom_variable_id, conversion_custom_variable_value, gbraid, wbraid, order_id, ad_user_data_consent, ): """Creates a click conversion with a default currency of USD. Args: client: An initialized GoogleAdsClient instance. customer_id: The client customer ID string. conversion_action_id: The ID of the conversion action to upload to. gclid: The Google Click Identifier ID. If set, the wbraid and gbraid parameters must be None. conversion_date_time: The the date and time of the conversion (should be after the click time). The format is 'yyyy-mm-dd hh:mm:ss+|-hh:mm', e.g. '2021-01-01 12:32:45-08:00'. conversion_value: The conversion value in the desired currency. conversion_custom_variable_id: The ID of the conversion custom variable to associate with the upload. conversion_custom_variable_value: The str value of the conversion custom variable to associate with the upload. gbraid: The GBRAID for the iOS app conversion. If set, the gclid and wbraid parameters must be None. wbraid: The WBRAID for the iOS app conversion. If set, the gclid and gbraid parameters must be None. order_id: The order ID for the click conversion. ad_user_data_consent: The ad user data consent for the click. """ click_conversion = client.get_type("ClickConversion") conversion_upload_service = client.get_service("ConversionUploadService") conversion_action_service = client.get_service("ConversionActionService") click_conversion.conversion_action = ( conversion_action_service.conversion_action_path( customer_id, conversion_action_id ) ) # Sets the single specified ID field. if gclid: click_conversion.gclid = gclid elif gbraid: click_conversion.gbraid = gbraid else: click_conversion.wbraid = wbraid click_conversion.conversion_value = float(conversion_value) click_conversion.conversion_date_time = conversion_date_time click_conversion.currency_code = "USD" if conversion_custom_variable_id and conversion_custom_variable_value: conversion_custom_variable = client.get_type("CustomVariable") conversion_custom_variable.conversion_custom_variable = ( conversion_upload_service.conversion_custom_variable_path( customer_id, conversion_custom_variable_id ) ) conversion_custom_variable.value = conversion_custom_variable_value click_conversion.custom_variables.append(conversion_custom_variable) if order_id: click_conversion.order_id = order_id # Sets the consent information, if provided. if ad_user_data_consent: # Specifies whether user consent was obtained for the data you are # uploading. For more details, see: # https://www.google.com/about/company/user-consent-policy click_conversion.consent.ad_user_data = client.enums.ConsentStatusEnum[ ad_user_data_consent ] # Uploads the click conversion. Partial failure must be set to True here. # # NOTE: This request only uploads a single conversion, but if you have # multiple conversions to upload, it's most efficient to upload them in a # single request. See the following for per-request limits for reference: # https://developers.google.com/google-ads/api/docs/best-practices/quotas#conversion_upload_service request = client.get_type("UploadClickConversionsRequest") request.customer_id = customer_id request.conversions.append(click_conversion) request.partial_failure = True conversion_upload_response = ( conversion_upload_service.upload_click_conversions( request=request, ) ) uploaded_click_conversion = conversion_upload_response.results[0] print( f"Uploaded conversion that occurred at " f'"{uploaded_click_conversion.conversion_date_time}" from ' f'Google Click ID "{uploaded_click_conversion.gclid}" ' f'to "{uploaded_click_conversion.conversion_action}"' )
Ruby
def upload_offline_conversion( customer_id, conversion_action_id, gclid, gbraid, wbraid, conversion_date_time, conversion_value, conversion_custom_variable_id, conversion_custom_variable_value, ad_user_data_consent) # GoogleAdsClient will read a config file from # ENV['HOME']/google_ads_config.rb when called without parameters client = Google::Ads::GoogleAds::GoogleAdsClient.new # Verifies that exactly one of gclid, gbraid, and wbraid is specified, as required. # See https://developers.google.com/google-ads/api/docs/conversions/upload-clicks for details. identifiers_specified = [gclid, gbraid, wbraid].reject {|v| v.nil?}.count if identifiers_specified != 1 raise "Must specify exactly one of GCLID, GBRAID, and WBRAID. " \ "#{identifiers_specified} values were provided." end click_conversion = client.resource.click_conversion do |cc| cc.conversion_action = client.path.conversion_action(customer_id, conversion_action_id) # Sets the single specified ID field. if !gclid.nil? cc.gclid = gclid elsif !gbraid.nil? cc.gbraid = gbraid else cc.wbraid = wbraid end cc.conversion_value = conversion_value.to_f cc.conversion_date_time = conversion_date_time cc.currency_code = 'USD' if conversion_custom_variable_id && conversion_custom_variable_value cc.custom_variables << client.resource.custom_variable do |cv| cv.conversion_custom_variable = client.path.conversion_custom_variable( customer_id, conversion_custom_variable_id) cv.value = conversion_custom_variable_value end end # Sets the consent information, if provided. unless ad_user_data_consent.nil? cc.consent = client.resource.consent do |c| # Specifies whether user consent was obtained for the data you are # uploading. For more details, see: # https://www.google.com/about/company/user-consent-policy c.ad_user_data = ad_user_data_consent end end end response = client.service.conversion_upload.upload_click_conversions( customer_id: customer_id, # NOTE: This request contains a single conversion as a demonstration. # However, if you have multiple conversions to upload, it's best to upload # multiple conversions per request instead of sending a separate request per # conversion. See the following for per-request limits: # https://developers.google.com/google-ads/api/docs/best-practices/quotas#conversion_upload_service conversions: [click_conversion], partial_failure: true, ) if response.partial_failure_error.nil? result = response.results.first puts "Uploaded conversion that occurred at #{result.conversion_date_time} " \ "from Google Click ID #{result.gclid} to #{result.conversion_action}." else failures = client.decode_partial_failure_error(response.partial_failure_error) puts "Request failed. Failure details:" failures.each do |failure| failure.errors.each do |error| puts "\t#{error.error_code.error_code}: #{error.message}" end end end end
Perl
sub upload_offline_conversion { my ( $api_client, $customer_id, $conversion_action_id, $gclid, $gbraid, $wbraid, $conversion_date_time, $conversion_value, $conversion_custom_variable_id, $conversion_custom_variable_value, $order_id, $ad_user_data_consent ) = @_; # Verify that exactly one of gclid, gbraid, and wbraid is specified, as required. # See https://developers.google.com/google-ads/api/docs/conversions/upload-clicks for details. my $number_of_ids_specified = grep { defined $_ } ($gclid, $gbraid, $wbraid); if ($number_of_ids_specified != 1) { die sprintf "Exactly 1 of gclid, gbraid, or wbraid is required, " . "but %d ID values were provided.\n", $number_of_ids_specified; } # Create a click conversion by specifying currency as USD. my $click_conversion = Google::Ads::GoogleAds::V17::Services::ConversionUploadService::ClickConversion ->new({ conversionAction => Google::Ads::GoogleAds::V17::Utils::ResourceNames::conversion_action( $customer_id, $conversion_action_id ), conversionDateTime => $conversion_date_time, conversionValue => $conversion_value, currencyCode => "USD" }); # Set the single specified ID field. if (defined $gclid) { $click_conversion->{gclid} = $gclid; } elsif (defined $gbraid) { $click_conversion->{gbraid} = $gbraid; } else { $click_conversion->{wbraid} = $wbraid; } if ($conversion_custom_variable_id && $conversion_custom_variable_value) { $click_conversion->{customVariables} = [ Google::Ads::GoogleAds::V17::Services::ConversionUploadService::CustomVariable ->new({ conversionCustomVariable => Google::Ads::GoogleAds::V17::Utils::ResourceNames::conversion_custom_variable( $customer_id, $conversion_custom_variable_id ), value => $conversion_custom_variable_value })]; } if (defined $order_id) { # Set the order ID (unique transaction ID), if provided. $click_conversion->{orderId} = $order_id; } # Set the consent information, if provided. if ($ad_user_data_consent) { # Specify whether user consent was obtained for the data you are uploading. # See https://www.google.com/about/company/user-consent-policy for details. $click_conversion->{consent} = Google::Ads::GoogleAds::V17::Common::Consent->new({ adUserData => $ad_user_data_consent }); } # Issue a request to upload the click conversion. Partial failure should # always be set to true. # # NOTE: This request contains a single conversion as a demonstration. # However, if you have multiple conversions to upload, it's best to # upload multiple conversions per request instead of sending a separate # request per conversion. See the following for per-request limits: # https://developers.google.com/google-ads/api/docs/best-practices/quotas#conversion_upload_service my $upload_click_conversions_response = $api_client->ConversionUploadService()->upload_click_conversions({ customerId => $customer_id, conversions => [$click_conversion], partialFailure => "true" }); # Print any partial errors returned. if ($upload_click_conversions_response->{partialFailureError}) { printf "Partial error encountered: '%s'.\n", $upload_click_conversions_response->{partialFailureError}{message}; } # Print the result if valid. my $uploaded_click_conversion = $upload_click_conversions_response->{results}[0]; if (%$uploaded_click_conversion) { printf "Uploaded conversion that occurred at '%s' from Google Click ID '%s' " . "to the conversion action with resource name '%s'.\n", $uploaded_click_conversion->{conversionDateTime}, $uploaded_click_conversion->{gclid}, $uploaded_click_conversion->{conversionAction}; } return 1; }
تحديد المشاكل وحلّها
توفّر بيانات تشخيص البيانات المتوفّرة بلا إنترنت
موردًا واحدًا لمراجعة الأداء العام لعمليات التحميل بشكل مستمر. ومع ذلك، أثناء التنفيذ، يمكنك استخدام المعلومات الواردة في هذا القسم
للتحقيق في أي أخطاء تم الإبلاغ عنها في حقل
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" في وقت النقرة. عدِّل 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_GCLID
|
يقع 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 ساعات بالنسبة إلى نماذج تحديد المصدر على شبكة البحث الأخرى. راجِع دليل تعديل البيانات للحصول على مزيد من المعلومات.