شما میتوانید از API گوگل ادز برای آپلود تبدیلهای کلیک آفلاین در گوگل ادز استفاده کنید تا تبلیغاتی را که منجر به فروش در دنیای آفلاین، مانند تلفن یا از طریق نماینده فروش، شدهاند، ردیابی کنید.
راهاندازی
چند پیشنیاز برای راهاندازی تبدیلهای آفلاین کارآمد وجود دارد. قبل از ادامهی پیادهسازی، مطمئن شوید که تمام پیشنیازها برآورده شدهاند:
ردیابی تبدیل را در بخش مشتری تبدیل گوگل ادز خود فعال کنید.
پیکربندی برچسبگذاری و ذخیره شناسههای کلیک
۱. ردیابی تبدیل را در بخش مشتری تبدیل گوگل ادز خود فعال کنید
اگر راهنمای شروع تبدیلها را تکمیل کردهاید و ردیابی تبدیل را فعال کردهاید، میتوانید به مرحله دوم بروید: پیکربندی برچسبگذاری .
اطلاعات مربوط به تنظیمات ردیابی تبدیل خود را بازیابی کنید
شما میتوانید تنظیمات ردیابی تبدیل حساب کاربری خود را بررسی کنید و با جستجوی منبع 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 نشاندهنده حساب کاربری گوگل ادز است که تبدیلها را برای این مشتری ایجاد و مدیریت میکند. برای مشتریانی که از ردیابی تبدیل بین حسابهای کاربری استفاده میکنند، این شناسه یک حساب کاربری مدیر است. شناسه مشتری تبدیل گوگل ادز باید به عنوان customer_id در درخواستهای API گوگل ادز برای ایجاد و مدیریت تبدیلها ارائه شود. توجه داشته باشید که این فیلد حتی اگر ردیابی تبدیل فعال نباشد، پر میشود.
فیلد conversion_tracking_status نشان میدهد که آیا ردیابی تبدیل فعال است و آیا حساب از ردیابی تبدیل بین حسابها استفاده میکند یا خیر.
یک اقدام تبدیل در زیر بخش مشتری تبدیل گوگل ادز ایجاد کنید
اگر مقدار conversion_tracking_status NOT_CONVERSION_TRACKED باشد، ردیابی تبدیل برای حساب فعال نشده است. با ایجاد حداقل یک ConversionAction در حساب تبدیل گوگل ادز، مانند مثال زیر، ردیابی تبدیل را فعال کنید. همچنین میتوانید با دنبال کردن دستورالعملهای موجود در مرکز راهنما برای نوع تبدیلی که میخواهید فعال کنید، یک عمل تبدیل در رابط کاربری ایجاد کنید.
توجه داشته باشید که تبدیلهای پیشرفته هنگام ارسال از طریق API تبلیغات گوگل به طور خودکار فعال میشوند، اما میتوان آنها را از طریق رابط کاربری تبلیغات گوگل غیرفعال کرد.
مثال کد
جاوا
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.V22.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; } }
پی اچ پی
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: GoogleAdsClient, customer_id: str) -> None: conversion_action_service: ConversionActionServiceClient = ( client.get_service("ConversionActionService") ) # Create the operation. conversion_action_operation: ConversionActionOperation = client.get_type( "ConversionActionOperation" ) # Create conversion action. conversion_action: ConversionAction = conversion_action_operation.create # Note that conversion action names must be unique. If a conversion action # already exists with the specified conversion_action_name, the create # operation will fail with a ConversionActionError.DUPLICATE_NAME error. conversion_action.name = f"Earth to Mars Cruises Conversion {uuid.uuid4()}" conversion_action.type_ = ( client.enums.ConversionActionTypeEnum.UPLOAD_CLICKS ) conversion_action.category = ( client.enums.ConversionActionCategoryEnum.DEFAULT ) conversion_action.status = client.enums.ConversionActionStatusEnum.ENABLED conversion_action.view_through_lookback_window_days = 15 # Create a value settings object. value_settings: ConversionAction.ValueSettings = ( conversion_action.value_settings ) value_settings.default_value = 15.0 value_settings.always_use_default_value = True # Add the conversion action. conversion_action_response: MutateConversionActionsResponse = ( conversion_action_service.mutate_conversion_actions( customer_id=customer_id, operations=[conversion_action_operation], ) ) print( "Created conversion action " f'"{conversion_action_response.results[0].resource_name}".' )
روبی
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::V22::Resources::ConversionAction->new({ name => $conversion_action_name, category => DEFAULT, type => WEBPAGE, status => ENABLED, viewThroughLookbackWindowDays => 15, valueSettings => Google::Ads::GoogleAds::V22::Resources::ValueSettings->new({ defaultValue => 23.41, alwaysUseDefaultValue => "true" })}); # Create a conversion action operation. my $conversion_action_operation = Google::Ads::GoogleAds::V22::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 تنظیم شده است. برای راهنمایی بیشتر در مورد ایجاد اقدامات تبدیل در API تبلیغات گوگل، به بخش ایجاد اقدامات تبدیل مراجعه کنید.
بازیابی یک اقدام تبدیل موجود
شما میتوانید با اجرای کوئری زیر، جزئیات مربوط به یک اقدام تبدیل موجود را بازیابی کنید. مطمئن شوید که شناسه مشتری در درخواست، روی مشتری تبدیل گوگل ادز که در بالا شناسایی کردید، تنظیم شده باشد و نوع اقدام تبدیل نیز روی مقدار صحیح ConversionActionType تنظیم شده باشد.
SELECT
conversion_action.resource_name,
conversion_action.name,
conversion_action.status
FROM conversion_action
WHERE conversion_action.type = 'INSERT_CONVERSION_ACTION_TYPE'
۲. پیکربندی برچسبگذاری و ذخیره شناسههای کلیک
برای تأیید فعال بودن برچسبگذاری خودکار، دستورالعملها را دنبال کنید. حساب کاربری گوگل ادز، وبسایت و سیستم ردیابی سرنخ خود را طوری تنظیم کنید که GCLID هر نمایش و همچنین پارامترهای URL GBRAID یا WBRAID را برای تبلیغات شما ثبت و ذخیره کند. برچسبگذاری خودکار به طور پیشفرض برای حسابهای جدید فعال است.
ساخت درخواست
برای ساخت UploadClickConversionsRequest و تنظیم فیلدهای آن با مقادیر مناسب، از این راهنما استفاده کنید.
-
customer_id حساب گوگل ادز آپلود شما را شناسایی میکند. این را روی مشتری تبدیل گوگل ادز حسابی که منبع کلیکها است تنظیم کنید.
-
job_id مکانیزمی برای مرتبط کردن درخواستهای آپلود شما با اطلاعات مربوط به هر کار در تشخیص دادههای آفلاین ارائه میدهد.
اگر این فیلد را تنظیم نکنید، API گوگل ادز به هر درخواست یک مقدار منحصر به فرد در محدوده
[2^31, 2^63)اختصاص میدهد. اگر ترجیح میدهید چندین درخواست را در یک کار منطقی گروهبندی کنید، این فیلد را برای هر درخواست در کار خود روی یک مقدار یکسان در محدوده[0, 2^31)تنظیم کنید.job_idدر پاسخ، صرف نظر از اینکه شما مقداری را مشخص کردهاید یا اجازه دادهاید که API تبلیغات گوگل مقداری را اختصاص دهد، حاوی شناسه کار برای درخواست است.-
partial_failure_enabled نحوه مدیریت خطاهای ناشی از عملیات توسط API گوگل ادز را تعیین میکند.
این فیلد باید روی
trueتنظیم شود. هنگام پردازش پاسخ ، دستورالعملهای مربوط به خرابیهای جزئی را دنبال کنید.-
debug_enabled رفتار گزارش خطا را برای تبدیلهای بهبود یافته برای آپلودهای سرنخ تعیین میکند. API تبلیغات گوگل هنگام مدیریت آپلودها برای تبدیلهای کلیک با استفاده از پارامترهای URL
gclidیاgbraidیاwbraid، این فیلد را نادیده میگیرد.
ایجاد عملیات تبدیل کلیک
مجموعه اشیاء ClickConversion در UploadClickConversionRequest شما، مجموعهای از تبدیلهایی را که میخواهید آپلود کنید، تعریف میکند. برای ساخت هر ClickConversion و تنظیم فیلدهای آن به مقادیر مناسب، از این راهنما پیروی کنید.
فیلدهای مورد نیاز هر عملیات تبدیل را تنظیم کنید
برای تنظیم فیلدهای مورد نیاز ClickConversion به مقادیر مناسب، این دستورالعملها را دنبال کنید.
-
gclid،gbraid،wbraid پارامترهای GCLID یا URL که هنگام ورود کاربر به وبسایت یا برنامه شما پس از کلیک روی تبلیغ، ثبت میکنید. یکی از موارد زیر الزامی است:
-
gclid -
gbraid -
wbraid
-
-
conversion_date_time تاریخ و زمان تبدیل.
مقدار باید دارای یک منطقه زمانی مشخص باشد و قالب آن باید
yyyy-mm-dd HH:mm:ss+|-HH:mmباشد، برای مثال:2022-01-01 19:32:45-05:00(زمان تابستانی در نظر گرفته نمیشود).منطقه زمانی میتواند برای هر مقدار معتبری باشد: لازم نیست با منطقه زمانی حساب کاربری مطابقت داشته باشد. با این حال، اگر قصد دارید دادههای تبدیل آپلود شده خود را با دادههای موجود در رابط کاربری گوگل ادز مقایسه کنید، توصیه میکنیم از همان منطقه زمانی حساب گوگل ادز خود استفاده کنید تا تعداد تبدیلها مطابقت داشته باشد. میتوانید جزئیات و مثالهای بیشتری را در مرکز راهنما بیابید و کدها و قالبها را برای لیستی از شناسههای منطقه زمانی معتبر بررسی کنید.
-
user_identifiers هنگام آپلود تبدیلها فقط با استفاده از شناسههای کلیک، این فیلد را تنظیم نکنید. اگر این فیلد تنظیم شود، گوگل ادز عملیات آپلود را به عنوان آپلود برای تبدیلهای بهبود یافته برای سرنخها در نظر میگیرد.
-
conversion_action نام منبع
ConversionActionبرای تبدیل کلیک.عمل تبدیل باید از
typeUPLOAD_CLICKSباشد و باید در حساب کاربری تبدیل گوگل ادز مرتبط با کلیک، در حساب کاربری گوگل ادز وجود داشته باشد.-
conversion_value ارزش تبدیل.
-
currency_code کد ارز
conversion_value.
تنظیم فیلدهای اختیاری هر عملیات تبدیل
لیست فیلدهای اختیاری زیر را بررسی کنید و در صورت نیاز آنها را در ClickConversion خود تنظیم کنید.
-
order_id - شناسه تراکنش برای تبدیل. این فیلد اختیاری است اما اکیداً توصیه میشود. اگر آن را در حین آپلود تنظیم کنید، باید از آن برای هرگونه تنظیمی که روی تبدیل انجام میشود استفاده کنید. برای کسب اطلاعات بیشتر در مورد نحوه استفاده از شناسه تراکنش برای به حداقل رساندن تبدیلهای تکراری، به این مقاله مرکز راهنما مراجعه کنید.
-
external_attribution_data اگر از ابزارهای شخص ثالث یا راهحلهای داخلی برای ردیابی تبدیلها استفاده میکنید، ممکن است بخواهید فقط بخشی از اعتبار تبدیل را به گوگل ادز بدهید، یا ممکن است بخواهید اعتبار یک تبدیل را بین چندین کلیک توزیع کنید. واردات تبدیل با نسبتدهی خارجی به شما این امکان را میدهد که تبدیلها را با اعتبار کسری اختصاص داده شده به هر کلیک آپلود کنید.
برای آپلود اعتبارات کسری، این فیلد را روی یک شیء
ExternalAttributionDataبا مقادیرexternal_attribution_modelوexternal_attribution_creditتنظیم کنید.-
custom_variables مقادیر مربوط به متغیرهای تبدیل سفارشی .
گوگل ادز از متغیرهای تبدیل سفارشی در ترکیب با
wbraidیاgbraidپشتیبانی نمیکند.
cart_data
شما میتوانید دادههای سبد خرید برای ClickConversion را در فیلد cart_data وارد کنید که شامل ویژگیهای زیر است:
-
merchant_id: شناسه حساب مرکز تجاری مرتبط. -
feed_country_code: کد منطقه دو کاراکتری ISO 3166 مربوط به فید مرکز فروشندگان. -
feed_language_code: کد زبان ISO 639-1 مربوط به فید مرکز فروشندگان. -
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.V22.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; } }
پی اچ پی
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: GoogleAdsClient, customer_id: str, conversion_action_id: str, gclid: Optional[str], conversion_date_time: str, conversion_value: str, conversion_custom_variable_id: Optional[str], conversion_custom_variable_value: Optional[str], gbraid: Optional[str], wbraid: Optional[str], order_id: Optional[str], ad_user_data_consent: Optional[str], ) -> None: """Creates a click conversion with a default currency of USD. Args: client: An initialized GoogleAdsClient instance. customer_id: The client customer ID string. conversion_action_id: The ID of the conversion action to upload to. gclid: The Google Click Identifier ID. If set, the wbraid and gbraid parameters must be None. conversion_date_time: The the date and time of the conversion (should be after the click time). The format is 'yyyy-mm-dd hh:mm:ss+|-hh:mm', e.g. '2021-01-01 12:32:45-08:00'. conversion_value: The conversion value in the desired currency. conversion_custom_variable_id: The ID of the conversion custom variable to associate with the upload. conversion_custom_variable_value: The str value of the conversion custom variable to associate with the upload. gbraid: The GBRAID for the iOS app conversion. If set, the gclid and wbraid parameters must be None. wbraid: The WBRAID for the iOS app conversion. If set, the gclid and gbraid parameters must be None. order_id: The order ID for the click conversion. ad_user_data_consent: The ad user data consent for the click. """ click_conversion: ClickConversion = client.get_type("ClickConversion") conversion_upload_service: ConversionUploadServiceClient = ( client.get_service("ConversionUploadService") ) conversion_action_service: ConversionActionServiceClient = ( client.get_service("ConversionActionService") ) click_conversion.conversion_action = ( conversion_action_service.conversion_action_path( customer_id, conversion_action_id ) ) # Sets the single specified ID field. if gclid: click_conversion.gclid = gclid elif gbraid: click_conversion.gbraid = gbraid else: click_conversion.wbraid = wbraid click_conversion.conversion_value = float(conversion_value) click_conversion.conversion_date_time = conversion_date_time click_conversion.currency_code = "USD" if conversion_custom_variable_id and conversion_custom_variable_value: conversion_custom_variable: CustomVariable = client.get_type( "CustomVariable" ) conversion_custom_variable.conversion_custom_variable = ( conversion_upload_service.conversion_custom_variable_path( customer_id, conversion_custom_variable_id ) ) conversion_custom_variable.value = conversion_custom_variable_value click_conversion.custom_variables.append(conversion_custom_variable) if order_id: click_conversion.order_id = order_id # Sets the consent information, if provided. if ad_user_data_consent: # Specifies whether user consent was obtained for the data you are # uploading. For more details, see: # https://www.google.com/about/company/user-consent-policy click_conversion.consent.ad_user_data = client.enums.ConsentStatusEnum[ ad_user_data_consent ] # Uploads the click conversion. Partial failure must be set to True here. # # NOTE: This request only uploads a single conversion, but if you have # multiple conversions to upload, it's most efficient to upload them in a # single request. See the following for per-request limits for reference: # https://developers.google.com/google-ads/api/docs/best-practices/quotas#conversion_upload_service request: UploadClickConversionsRequest = client.get_type( "UploadClickConversionsRequest" ) request.customer_id = customer_id request.conversions.append(click_conversion) request.partial_failure = True conversion_upload_response: UploadClickConversionsResponse = ( conversion_upload_service.upload_click_conversions( request=request, ) ) uploaded_click_conversion: ClickConversionResult = ( conversion_upload_response.results[0] ) print( f"Uploaded conversion that occurred at " f'"{uploaded_click_conversion.conversion_date_time}" from ' f'Google Click ID "{uploaded_click_conversion.gclid}" ' f'to "{uploaded_click_conversion.conversion_action}"' )
روبی
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::V22::Services::ConversionUploadService::ClickConversion ->new({ conversionAction => Google::Ads::GoogleAds::V22::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::V22::Services::ConversionUploadService::CustomVariable ->new({ conversionCustomVariable => Google::Ads::GoogleAds::V22::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::V22::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; }
حلقه زدن
# This code example uploads a click conversion. # # Variables: # API_VERSION, # CUSTOMER_ID, # DEVELOPER_TOKEN, # MANAGER_CUSTOMER_ID, # OAUTH2_ACCESS_TOKEN: # See https://developers.google.com/google-ads/api/rest/auth#request_headers # for details. # # CONVERSION_ACTION_RESOURCE_NAME: Resource name of the conversion action # associated with this conversion. # GCLID: The Google click ID (gclid) associated with this conversion. # CONVERSION_VALUE: The value of the conversion for the advertiser. # CONVERSION_DATE_TIME: The date time at which the conversion occurred. The # format is "yyyy-mm-dd hh:mm:ss+|-hh:mm", for example, # "2019-01-01 12:32:45-08:00". # CURRENCY_CODE: The currency code of the conversion value. This is the # ISO 4217 3-character currency code. For example: USD, EUR. # CONVERSION_CUSTOM_VARIABLE: The name of the conversion custom variable. # CONVERSION_CUSTOM_VARIABLE_VALUE: The value of the conversion custom # variable. # ORDER_ID: The order ID of the conversion. curl -f --request POST \ "https://googleads.googleapis.com/v${API_VERSION}/customers/${CUSTOMER_ID}:uploadClickConversions" \ --header "Content-Type: application/json" \ --header "developer-token: ${DEVELOPER_TOKEN}" \ --header "login-customer-id: ${MANAGER_CUSTOMER_ID}" \ --header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \ --data @- <<EOF { "conversions": [ { "conversionAction": "${CONVERSION_ACTION_RESOURCE_NAME}", "gclid": "${GCLID}", "conversionValue": ${CONVERSION_VALUE}, "conversionDateTime": "${CONVERSION_DATE_TIME}", "currencyCode": "${CURRENCY_CODE}", "customVariables": [ { "conversionCustomVariable": "${CONVERSION_CUSTOM_VARIABLE}", "value": "${CONVERSION_CUSTOM_VARIABLE_VALUE}" } ], "orderId": "${ORDER_ID}", "consent": { "adUserData": "GRANTED" } } ], "partialFailure": true } EOF
عیبیابی
تشخیص آفلاین دادهها، منبعی واحد برای بررسی سلامت کلی آپلودهای شما به صورت مداوم فراهم میکند. با این حال، در طول پیادهسازی میتوانید از اطلاعات این بخش برای بررسی هرگونه خطای گزارش شده در فیلد partial_failure_error پاسخ استفاده کنید.
برخی از رایجترین خطاها هنگام آپلود اقدامات تبدیل، خطاهای مجوز مانند USER_PERMISSION_DENIED هستند. دوباره بررسی کنید که شناسه مشتری در درخواست شما روی مشتری تبدیل Google Ads که مالک اقدام تبدیل است، تنظیم شده باشد. برای جزئیات بیشتر به راهنمای مجوز ما مراجعه کنید و برای نکاتی در مورد نحوه اشکالزدایی این خطاهای مختلف، به راهنمای خطاهای رایج ما مراجعه کنید.
اشکالزدایی خطاهای رایج
| خطا | |
|---|---|
INVALID_CONVERSION_ACTION_TYPE | عمل تبدیل مشخص شده نوعی دارد که برای آپلود تبدیلهای کلیک معتبر نیست. مطمئن شوید که ConversionAction مشخص شده در درخواست آپلود شما از نوع UPLOAD_CLICKS باشد. |
NO_CONVERSION_ACTION_FOUND | عمل تبدیل مشخص شده یا فعال نیست یا در customer_id در حال آپلود یافت نمیشود. اطلاعات مربوط به تنظیمات تبدیل خود را بازیابی کنید تا مطمئن شوید که عمل تبدیل در آپلود شما فعال است و متعلق به customer_id درخواست آپلود است. |
TOO_RECENT_CONVERSION_ACTION | عملیات تبدیل به تازگی ایجاد شده است. قبل از تلاش مجدد برای تبدیلهای ناموفق، حداقل ۶ ساعت پس از ایجاد عملیات صبر کنید. |
INVALID_CUSTOMER_FOR_CLICK | customer_id درخواست، همان شناسه مشتری حساب تبدیل API گوگل ادز در زمان کلیک نیست. customer_id درخواست را به مشتری صحیح بهروزرسانی کنید. |
EVENT_NOT_FOUND | گوگل ادز نمیتواند ترکیب click ID و customer_id را پیدا کند. الزامات customer_id را بررسی کنید و مطمئن شوید که با استفاده از حساب گوگل ادز صحیح، آپلود میکنید. |
DUPLICATE_CLICK_CONVERSION_IN_REQUEST | تبدیلهای چندگانه در درخواست، ترکیب یکسانی از شناسه کلیک، conversion_date_time و conversion_action دارند. تبدیلهای تکراری را از درخواست خود حذف کنید. |
CLICK_CONVERSION_ALREADY_EXISTS | قبلاً تبدیلی با همین ترکیب click ID، conversion_date_time و conversion_action آپلود شده است. اگر دوباره سعی در آپلود دارید و این تبدیل قبلاً با موفقیت انجام شده است، این خطا را نادیده بگیرید. اگر میخواهید علاوه بر تبدیل آپلود شده قبلی، تبدیل دیگری اضافه کنید، conversion_date_time مربوط به ClickConversion را تنظیم کنید تا از تکرار تبدیل آپلود شده قبلی جلوگیری شود. |
EVENT_NOT_FOUND | گوگل ادز نمیتواند ترکیب click ID و customer_id را پیدا کند. الزامات customer_id را بررسی کنید و مطمئن شوید که با استفاده از حساب گوگل ادز صحیح، آپلود میکنید. |
EXPIRED_EVENT | کلیک وارد شده قبل از بازه زمانی مشخص شده در فیلد click_through_lookback_window_days رخ داده است. تغییر در click_through_lookback_window_days فقط روی کلیکهای ثبت شده پس از تغییر تأثیر میگذارد ، بنابراین تغییر پنجره lookback این خطا را برای آن کلیک خاص برطرف نمیکند. در صورت لزوم، conversion_action به اکشن دیگری با پنجره lookback طولانیتر تغییر دهید. |
CONVERSION_PRECEDES_EVENT | مقدار conversion_date_time قبل از تاریخ و زمان کلیک است. conversion_date_time را به مقداری جدیدتر بهروزرسانی کنید. |
GBRAID_WBRAID_BOTH_SET | ClickConversion برای هر دو پارامتر gbraid و wbraid یک مقدار تنظیم شده دارد. تبدیل را بهروزرسانی کنید تا فقط از یک شناسه کلیک یا پارامتر URL استفاده کند و مطمئن شوید که چندین کلیک را در یک تبدیل ترکیب نمیکنید. هر کلیک فقط یک شناسه کلیک یا پارامتر URL دارد. |
VALUE_MUST_BE_UNSET | location GoogleAdsError را بررسی کنید تا مشخص شود کدام یک از مشکلات زیر منجر به خطا شده است.
|
تبدیلها در گزارشها
تبدیلهای آپلود شده در گزارشها برای تاریخ نمایش کلیک اصلی منعکس میشوند، نه تاریخ درخواست آپلود یا تاریخ conversion_date_time مربوط به ClickConversion .
نمایش آمار تبدیل وارد شده در حساب گوگل ادز شما برای انتساب آخرین کلیک، تا ۳ ساعت طول میکشد. برای سایر مدلهای انتساب جستجو، میتواند بیش از ۳ ساعت طول بکشد. برای اطلاعات بیشتر به راهنمای تازگی دادهها مراجعه کنید.