אתם יכולים להשתמש ב-Google Ads API כדי להעלות המרות אופליין מקליקים ל-Google Ads, וכך לעקוב אחרי מודעות שהובילו למכירות בעולם הפיזי, למשל בטלפון או דרך נציג מכירות.
הגדרה
כדי להגדיר המרות אופליין, צריך לעמוד בכמה דרישות מוקדמות. לפני שמתחילים בהטמעה, חשוב לוודא שכל הדרישות המוקדמות מתקיימות:
מפעילים את מעקב ההמרות בחשבון הלקוח ב-Google Ads שבו מוגדרות ההמרות.
מגדירים תיוג ושומרים את מזהי הקליקים.
1. הפעלת מעקב המרות בחשבון ההמרות ב-Google Ads
אם השלמתם את המדריך לתחילת העבודה עם המרות והפעלתם מעקב המרות, אתם יכולים לדלג לשלב השני: הגדרת תיוג.
אחזור מידע על ההגדרה של מעקב ההמרות
כדי לבדוק את ההגדרה של מעקב ההמרות בחשבון ולוודא שמעקב ההמרות מופעל, שולחים שאילתה למשאב 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 Ads שבו נוצרות ההמרות של הלקוח הזה וממנו הן מנוהלות. אם אתם משתמשים במעקב המרות ברמת חשבון הניהול, זהו המזהה של חשבון הניהול. צריך לציין את מספר הלקוח של ההמרות ב-Google Ads בתור customer_id בבקשות של Google Ads API כדי ליצור ולנהל המרות. השדה הזה מאוכלס גם אם מעקב ההמרות לא מופעל.
השדה conversion_tracking_status מציין אם מעקב ההמרות מופעל ואם בחשבון נעשה שימוש במעקב המרות ברמת חשבון הניהול.
יוצרים פעולת המרה בלקוח ההמרות של Google Ads
אם הערך של conversion_tracking_status הוא NOT_CONVERSION_TRACKED, מעקב ההמרות לא מופעל בחשבון. מפעילים את מעקב ההמרות על ידי יצירה של לפחות ConversionAction אחת בחשבון ההמרות ב-Google Ads, כמו בדוגמה הבאה. לחלופין, אתם יכולים ליצור פעולת המרה בממשק המשתמש לפי ההוראות שמפורטות במאמר במרכז העזרה של Google Ads בנושא הגדרת מעקב המרות, בהתאם לסוג ההמרה שאתם רוצים להפעיל.
שימו לב שהמרות משופרות מופעלות באופן אוטומטי כשהן נשלחות דרך Google Ads API, אבל אפשר להשבית אותן דרך ממשק המשתמש של Google Ads.
קוד לדוגמה
Java
private void runExample(GoogleAdsClient googleAdsClient, long customerId) { // Creates a ConversionAction. ConversionAction conversionAction = ConversionAction.newBuilder() // Note that conversion action names must be unique. If a conversion action already // exists with the specified conversion_action_name the create operation will fail with // a ConversionActionError.DUPLICATE_NAME error. .setName("Earth to Mars Cruises Conversion #" + getPrintableDateTime()) .setCategory(ConversionActionCategory.DEFAULT) .setType(ConversionActionType.WEBPAGE) .setStatus(ConversionActionStatus.ENABLED) .setViewThroughLookbackWindowDays(15L) .setValueSettings( ValueSettings.newBuilder() .setDefaultValue(23.41) .setAlwaysUseDefaultValue(true) .build()) .build(); // Creates the operation. ConversionActionOperation operation = ConversionActionOperation.newBuilder().setCreate(conversionAction).build(); try (ConversionActionServiceClient conversionActionServiceClient = googleAdsClient.getLatestVersion().createConversionActionServiceClient()) { MutateConversionActionsResponse response = conversionActionServiceClient.mutateConversionActions( Long.toString(customerId), Collections.singletonList(operation)); System.out.printf("Added %d conversion actions:%n", response.getResultsCount()); for (MutateConversionActionResult result : response.getResultsList()) { System.out.printf( "New conversion action added with resource name: '%s'%n", result.getResourceName()); } } }
C#
public void Run(GoogleAdsClient client, long customerId) { // Get the ConversionActionService. ConversionActionServiceClient conversionActionService = client.GetService(Services.V26.ConversionActionService); // Note that conversion action names must be unique. // If a conversion action already exists with the specified name the create operation // will fail with a ConversionAction.DUPLICATE_NAME error. string ConversionActionName = "Earth to Mars Cruises Conversion #" + ExampleUtilities.GetRandomString(); // Add a conversion action. ConversionAction conversionAction = new ConversionAction() { Name = ConversionActionName, Category = ConversionActionCategory.Default, Type = ConversionActionType.Webpage, Status = ConversionActionStatus.Enabled, ViewThroughLookbackWindowDays = 15, ValueSettings = new ConversionAction.Types.ValueSettings() { DefaultValue = 23.41, AlwaysUseDefaultValue = true } }; // Create the operation. ConversionActionOperation operation = new ConversionActionOperation() { Create = conversionAction }; try { // Create the conversion action. MutateConversionActionsResponse response = conversionActionService.MutateConversionActions(customerId.ToString(), new ConversionActionOperation[] { operation }); // Display the results. foreach (MutateConversionActionResult newConversionAction in response.Results) { Console.WriteLine($"New conversion action with resource name = " + $"'{newConversionAction.ResourceName}' was added."); } } catch (GoogleAdsException e) { Console.WriteLine("Failure:"); Console.WriteLine($"Message: {e.Message}"); Console.WriteLine($"Failure: {e.Failure}"); Console.WriteLine($"Request ID: {e.RequestId}"); throw; } }
PHP
public static function runExample(GoogleAdsClient $googleAdsClient, int $customerId) { // Creates a conversion action. $conversionAction = new ConversionAction( [ // Note that conversion action names must be unique. // If a conversion action already exists with the specified conversion_action_name // the create operation will fail with a ConversionActionError.DUPLICATE_NAME error. 'name' => 'Earth to Mars Cruises Conversion #' . Helper::getPrintableDatetime(), 'category' => ConversionActionCategory::PBDEFAULT, 'type' => ConversionActionType::WEBPAGE, 'status' => ConversionActionStatus::ENABLED, 'view_through_lookback_window_days' => 15, 'value_settings' => new ValueSettings( [ 'default_value' => 23.41, 'always_use_default_value' => true ] ) ] ); // Creates a conversion action operation. $conversionActionOperation = new ConversionActionOperation(); $conversionActionOperation->setCreate($conversionAction); // Issues a mutate request to add the conversion action. $conversionActionServiceClient = $googleAdsClient->getConversionActionServiceClient(); $response = $conversionActionServiceClient->mutateConversionActions( MutateConversionActionsRequest::build($customerId, [$conversionActionOperation]) ); printf("Added %d conversion actions:%s", $response->getResults()->count(), PHP_EOL); foreach ($response->getResults() as $addedConversionAction) { /** * @var ConversionAction $addedConversionAction */ printf( "New conversion action added with resource name: '%s'%s", $addedConversionAction->getResourceName(), PHP_EOL ); } }
Python
def main(client: GoogleAdsClient, customer_id: str) -> None: conversion_action_service: ConversionActionServiceClient = ( client.get_service("ConversionActionService") ) # Create the operation. conversion_action_operation: ConversionActionOperation = client.get_type( "ConversionActionOperation" ) # Create conversion action. conversion_action: ConversionAction = conversion_action_operation.create # Note that conversion action names must be unique. If a conversion action # already exists with the specified conversion_action_name, the create # operation will fail with a ConversionActionError.DUPLICATE_NAME error. conversion_action.name = f"Earth to Mars Cruises Conversion {uuid.uuid4()}" conversion_action.type_ = ( client.enums.ConversionActionTypeEnum.UPLOAD_CLICKS ) conversion_action.category = ( client.enums.ConversionActionCategoryEnum.DEFAULT ) conversion_action.status = client.enums.ConversionActionStatusEnum.ENABLED conversion_action.view_through_lookback_window_days = 15 # Create a value settings object. value_settings: ConversionAction.ValueSettings = ( conversion_action.value_settings ) value_settings.default_value = 15.0 value_settings.always_use_default_value = True # Add the conversion action. conversion_action_response: MutateConversionActionsResponse = ( conversion_action_service.mutate_conversion_actions( customer_id=customer_id, operations=[conversion_action_operation], ) ) print( "Created conversion action " f'"{conversion_action_response.results[0].resource_name}".' )
Ruby
def add_conversion_action(customer_id) # GoogleAdsClient will read a config file from # ENV['HOME']/google_ads_config.rb when called without parameters client = Google::Ads::GoogleAds::GoogleAdsClient.new # Add a conversion action. conversion_action = client.resource.conversion_action do |ca| ca.name = "Earth to Mars Cruises Conversion #{(Time.new.to_f * 100).to_i}" ca.type = :UPLOAD_CLICKS ca.category = :DEFAULT ca.status = :ENABLED ca.view_through_lookback_window_days = 15 # Create a value settings object. ca.value_settings = client.resource.value_settings do |vs| vs.default_value = 15 vs.always_use_default_value = true end end # Create the operation. conversion_action_operation = client.operation.create_resource.conversion_action(conversion_action) # Add the ad group ad. response = client.service.conversion_action.mutate_conversion_actions( customer_id: customer_id, operations: [conversion_action_operation], ) puts "New conversion action with resource name = #{response.results.first.resource_name}." end
Perl
sub add_conversion_action { my ($api_client, $customer_id) = @_; # Note that conversion action names must be unique. # If a conversion action already exists with the specified conversion_action_name, # the create operation fails with error ConversionActionError.DUPLICATE_NAME. my $conversion_action_name = "Earth to Mars Cruises Conversion #" . uniqid(); # Create a conversion action. my $conversion_action = Google::Ads::GoogleAds::V26::Resources::ConversionAction->new({ name => $conversion_action_name, category => DEFAULT, type => WEBPAGE, status => ENABLED, viewThroughLookbackWindowDays => 15, valueSettings => Google::Ads::GoogleAds::V26::Resources::ValueSettings->new({ defaultValue => 23.41, alwaysUseDefaultValue => "true" })}); # Create a conversion action operation. my $conversion_action_operation = Google::Ads::GoogleAds::V26::Services::ConversionActionService::ConversionActionOperation ->new({create => $conversion_action}); # Add the conversion action. my $conversion_actions_response = $api_client->ConversionActionService()->mutate({ customerId => $customer_id, operations => [$conversion_action_operation]}); printf "New conversion action added with resource name: '%s'.\n", $conversion_actions_response->{results}[0]{resourceName}; return 1; }
curl
מוודאים שהשדה type מוגדר לערך הנכון של ConversionActionType. במאמר יצירת פעולות המרה מוסבר איך ליצור פעולות המרה ב-Google Ads API.
אחזור של פעולת המרה קיימת
כדי לאחזר פרטים של פעולת המרה קיימת, שולחים את השאילתה הבאה. מוודאים שמספר הלקוח בבקשה מוגדר ללקוח של ההמרה ב-Google Ads שזיהיתם קודם, ושהערך של סוג פעולת ההמרה מוגדר לערך הנכון של ConversionActionType.
SELECT
conversion_action.id,
conversion_action.resource_name,
conversion_action.name,
conversion_action.type,
conversion_action.category,
conversion_action.status
FROM conversion_action
WHERE conversion_action.type = 'UPLOAD_CLICKS'
2. הגדרת תיוג ושמירת מזהי קליקים
פועלים לפי ההוראות להפעלת התיוג האוטומטי כדי לוודא שהתיוג האוטומטי מופעל. מגדירים את חשבון Google Ads, את האתר ואת המערכת למעקב אחרי לידים כדי לתעד ולאחסן את ה-GCLID של כל חשיפה, וגם את הפרמטרים של כתובות ה-URL GBRAID או WBRAID של המודעות. בחשבונות חדשים התיוג האוטומטי מופעל כברירת מחדל.
יצירת הבקשה
כדי ליצור את UploadClickConversionsRequest ולהגדיר את השדות שלו לערכים המתאימים, צריך לפעול לפי ההנחיות הבאות.
customer_idמזהה את חשבון Google Ads שאליו אתם מעלים את הנתונים. מגדירים את השדה הזה בתור Google Ads conversion customer של החשבון שהוא המקור של הקליקים.
job_idמספק מנגנון לשיוך בקשות ההעלאה למידע על כל משימה באבחון נתונים ממקורות אופליין.
אם לא מגדירים את השדה הזה, Google Ads API מקצה לכל בקשה ערך ייחודי בטווח של
[2^31, 2^63). אם אתם מעדיפים לקבץ כמה בקשות למשימה לוגית אחת, הגדירו את השדה הזה לאותו ערך בטווח[1, 2^31)בכל בקשה במשימה.השדה
job_idבתגובה מכיל את מזהה המשימה של הבקשה, גם אם ציינתם ערך וגם אם נתתם ל-Google Ads API להקצות ערך.partial_failureקובעת איך Google Ads API מטפל בשגיאות שנובעות מפעולות.
הערך בשדה הזה חייב להיות
true. כשמעבדים את התגובה, פועלים לפי ההנחיות לגבי כשלים חלקיים.
יצירת פעולות של המרות מסוג קליקים
אוסף האובייקטים מסוג ClickConversion ב-UploadClickConversionsRequest מגדיר את קבוצת ההמרות שרוצים להעלות. כדי ליצור כל ClickConversion ולהגדיר את השדות שלו לערכים המתאימים, צריך לפעול לפי ההנחיות הבאות.
מגדירים את שדות החובה של כל פעולת המרה
כדי להגדיר את שדות החובה של ClickConversion לערכים המתאימים, פועלים לפי ההוראות הבאות.
gclid,gbraid,wbraidהפרמטרים של ה-GCLID או של כתובת ה-URL שאתם מתעדים כשמשתמש מגיע לאתר או לאפליקציה שלכם אחרי לחיצה על מודעה. צריך למלא לפחות אחד מהשדות הבאים:
gclidgbraidwbraid
צריך לכלול כל מזהה קליק שתועד להמרה באותו אובייקט
ClickConversion. אם יש יותר ממזהה אחד, מערכת Google Ads משתמשת בהם לפי סדר העדיפויות הבא:gclid, אחר כךwbraidואזgbraid.conversion_date_timeהתאריך והשעה של ההמרה.
צריך לציין אזור זמן בערך, והפורמט צריך להיות
yyyy-mm-dd HH:mm:ss+|-HH:mm, לדוגמה:2022-01-01 19:32:45-05:00(ללא התייחסות לשעון קיץ).אפשר להגדיר כל ערך תקין של אזור זמן, הוא לא חייב להיות זהה לאזור הזמן שמוגדר בחשבון. עם זאת, אם אתם מתכננים להשוות בין נתוני ההמרות שהעליתם לבין הנתונים בממשק המשתמש של Google Ads, מומלץ להשתמש באותו אזור זמן שמוגדר בחשבון Google Ads כדי שמספרי ההמרות יהיו תואמים. פרטים נוספים ודוגמאות זמינים במאמר הכנת הנתונים לייבוא, ובמאמר קודים ופורמטים מופיעה רשימה של מזהי אזורי זמן חוקיים.
user_identifiersאל תגדירו את השדה הזה כשאתם מעלים המרות באמצעות מזהי קליקים בלבד. אם השדה הזה מוגדר, מערכת Google Ads מתייחסת לפעולת ההעלאה כהעלאה של המרות משופרות לצורך שיוך ללידים.
conversion_actionשם המשאב של
ConversionActionלהמרת קליקים.לפעולת ההמרה צריך להיות
typeשלUPLOAD_CLICKS, והיא צריכה להיות קיימת בלקוח ההמרות של Google Ads בחשבון Google Ads שמשויך לקליק.conversion_valueהערך של ההמרה.
currency_codeקוד המטבע של
conversion_value.
הגדרת שדות אופציונליים לכל פעולת המרה
בודקים את הרשימה הבאה של שדות אופציונליים ומגדירים אותם ב-ClickConversion לפי הצורך.
order_id- מזהה העסקה של ההמרה. השדה הזה הוא אופציונלי, אבל מומלץ מאוד. אם מגדירים אותו במהלך ההעלאה, חובה להשתמש בו בכל התאמה שמבצעים להמרה. איך להשתמש במזהה עסקה כדי לצמצם כפילויות בספירת ההמרות
external_attribution_dataאם אתם משתמשים בכלים של צד שלישי או בפתרונות שפיתחתם בעצמכם כדי לעקוב אחרי המרות, יכול להיות שתרצו לתת ל-Google Ads רק חלק מהקרדיט על ההמרה, או לחלק את הקרדיט על ההמרה בין כמה קליקים. ייבוא של המרות משויכות חיצונית מאפשר לכם להעלות המרות עם קרדיט חלקי שמוקצה לכל קליק.
כדי להעלות קרדיטים חלקיים, מגדירים את השדה הזה לאובייקט
ExternalAttributionDataעם ערכים שלexternal_attribution_modelו-external_attribution_credit.custom_variablesהערכים של משתני המרות מותאמים אישית.
מערכת Google Ads לא תומכת במשתני המרות מותאמים אישית כשמשתמשים ב-
wbraidאו ב-gbraidבליgclid.cart_dataאפשר לכלול נתוני עגלות הקניות עבור
ClickConversionבשדהcart_data, שמורכב מהמאפיינים הבאים:-
merchant_id: המזהה של חשבון Merchant Center המשויך. -
feed_country_code: קוד האזור בן שני התווים לפי תקן ISO 3166 של הפיד ב-Merchant Center. -
feed_language_code: קוד השפה של הפיד ב-Merchant Center, לפי תקן ISO 639-1. -
local_transaction_cost: הסכום של כל ההנחות ברמת העסקה, בcurrency_codeשל ה-ClickConversion. -
items: הפריטים בעגלת הקניות.
כל פריט ב-
itemsמורכב מהמאפיינים הבאים:-
product_id: מזהה המוצר, לפעמים נקרא מזהה המוצר או מזהה הפריט. -
quantity: כמות היחידות של הפריט. -
unit_price: מחיר היחידה של הפריט.
מערכת Google Ads לא תומכת ב-
cart_dataכשמשתמשים ב-wbraidאו ב-gbraidבליgclid.-
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.V26.ConversionUploadService); // Creates a click conversion by specifying currency as USD. ClickConversion clickConversion = new ClickConversion() { ConversionAction = ResourceNames.ConversionAction(customerId, conversionActionId), ConversionValue = conversionValue, ConversionDateTime = conversionTime, CurrencyCode = "USD", }; // Sets the consent information, if provided. if (adUserDataConsent != null) { // Specifies whether user consent was obtained for the data you are uploading. See // https://www.google.com/about/company/user-consent-policy // for details. clickConversion.Consent = new Consent() { AdUserData = (ConsentStatus)adUserDataConsent }; } // Verifies that exactly one of gclid, gbraid, and wbraid is specified, as required. // See https://developers.google.com/google-ads/api/docs/conversions/upload-clicks // for details. string[] ids = { gclid, gbraid, wbraid }; int idCount = ids.Where(id => !string.IsNullOrEmpty(id)).Count(); if (idCount != 1) { throw new ArgumentException($"Exactly 1 of gclid, gbraid, or wbraid is " + $"required, but {idCount} ID values were provided"); } // Sets the single specified ID field. if (!string.IsNullOrEmpty(gclid)) { clickConversion.Gclid = gclid; } else if (!string.IsNullOrEmpty(wbraid)) { clickConversion.Wbraid = wbraid; } else if (!string.IsNullOrEmpty(gbraid)) { clickConversion.Gbraid = gbraid; } try { // Issues a request to upload the click conversion. UploadClickConversionsResponse response = conversionUploadService.UploadClickConversions( new UploadClickConversionsRequest() { CustomerId = customerId.ToString(), Conversions = { clickConversion }, PartialFailure = true, ValidateOnly = false }); // Prints the result. ClickConversionResult uploadedClickConversion = response.Results[0]; Console.WriteLine($"Uploaded conversion that occurred at " + $"'{uploadedClickConversion.ConversionDateTime}' from Google " + $"Click ID '{uploadedClickConversion.Gclid}' to " + $"'{uploadedClickConversion.ConversionAction}'."); } catch (GoogleAdsException e) { Console.WriteLine("Failure:"); Console.WriteLine($"Message: {e.Message}"); Console.WriteLine($"Failure: {e.Failure}"); Console.WriteLine($"Request ID: {e.RequestId}"); throw; } }
PHP
public static function runExample( GoogleAdsClient $googleAdsClient, int $customerId, int $conversionActionId, ?string $gclid, ?string $gbraid, ?string $wbraid, ?string $orderId, string $conversionDateTime, float $conversionValue, ?string $conversionCustomVariableId, ?string $conversionCustomVariableValue, ?int $adUserDataConsent ) { // Verifies that exactly one of gclid, gbraid, and wbraid is specified, as required. // See https://developers.google.com/google-ads/api/docs/conversions/upload-clicks for details. $nonNullFields = array_filter( [$gclid, $gbraid, $wbraid], function ($field) { return !is_null($field); } ); if (count($nonNullFields) !== 1) { throw new \UnexpectedValueException( sprintf( "Exactly 1 of gclid, gbraid or wbraid is required, but %d ID values were " . "provided", count($nonNullFields) ) ); } // Creates a click conversion by specifying currency as USD. $clickConversion = new ClickConversion( [ 'conversion_action' => ResourceNames::forConversionAction($customerId, $conversionActionId), 'conversion_value' => $conversionValue, 'conversion_date_time' => $conversionDateTime, 'currency_code' => 'USD' ] ); // Sets the single specified ID field. if (!is_null($gclid)) { $clickConversion->setGclid($gclid); } elseif (!is_null($gbraid)) { $clickConversion->setGbraid($gbraid); } else { $clickConversion->setWbraid($wbraid); } if (!is_null($conversionCustomVariableId) && !is_null($conversionCustomVariableValue)) { $clickConversion->setCustomVariables( [new CustomVariable( [ 'conversion_custom_variable' => ResourceNames::forConversionCustomVariable( $customerId, $conversionCustomVariableId ), 'value' => $conversionCustomVariableValue ] )] ); } // Sets the consent information, if provided. if (!empty($adUserDataConsent)) { // Specifies whether user consent was obtained for the data you are uploading. See // https://www.google.com/about/company/user-consent-policy for details. $clickConversion->setConsent(new Consent(['ad_user_data' => $adUserDataConsent])); } if (!empty($orderId)) { // Sets the order ID (unique transaction ID), if provided. $clickConversion->setOrderId($orderId); } // Issues a request to upload the click conversion. $conversionUploadServiceClient = $googleAdsClient->getConversionUploadServiceClient(); /** * @var UploadClickConversionsResponse $response */ // NOTE: This request contains a single conversion as a demonstration. However, if you have // multiple conversions to upload, it's best to upload multiple conversions per request // instead of sending a separate request per conversion. See the following for per-request // limits: // https://developers.google.com/google-ads/api/docs/best-practices/quotas#conversion_upload_service $response = $conversionUploadServiceClient->uploadClickConversions( // Uploads the click conversion. Partial failure should always be set to true. UploadClickConversionsRequest::build($customerId, [$clickConversion], true) ); // Prints the status message if any partial failure error is returned. // Note: The details of each partial failure error are not printed here, you can refer to // the example HandlePartialFailure.php to learn more. if ($response->hasPartialFailureError()) { printf( "Partial failures occurred: '%s'.%s", $response->getPartialFailureError()->getMessage(), PHP_EOL ); } else { // Prints the result if exists. /** * @var ClickConversionResult $uploadedClickConversion */ $uploadedClickConversion = $response->getResults()[0]; printf( "Uploaded click conversion that occurred at '%s' from Google Click ID '%s' " . "to '%s'.%s", $uploadedClickConversion->getConversionDateTime(), $uploadedClickConversion->getGclid(), $uploadedClickConversion->getConversionAction(), PHP_EOL ); } }
Python
def main( client: GoogleAdsClient, customer_id: str, conversion_action_id: str, gclid: Optional[str], conversion_date_time: str, conversion_value: str, conversion_custom_variable_id: Optional[str], conversion_custom_variable_value: Optional[str], gbraid: Optional[str], wbraid: Optional[str], order_id: Optional[str], ad_user_data_consent: Optional[str], ) -> None: """Creates a click conversion with a default currency of USD. Args: client: An initialized GoogleAdsClient instance. customer_id: The client customer ID string. conversion_action_id: The ID of the conversion action to upload to. gclid: The Google Click Identifier ID. If set, the wbraid and gbraid parameters must be None. conversion_date_time: The the date and time of the conversion (should be after the click time). The format is 'yyyy-mm-dd hh:mm:ss+|-hh:mm', e.g. '2021-01-01 12:32:45-08:00'. conversion_value: The conversion value in the desired currency. conversion_custom_variable_id: The ID of the conversion custom variable to associate with the upload. conversion_custom_variable_value: The str value of the conversion custom variable to associate with the upload. gbraid: The GBRAID for the iOS app conversion. If set, the gclid and wbraid parameters must be None. wbraid: The WBRAID for the iOS app conversion. If set, the gclid and gbraid parameters must be None. order_id: The order ID for the click conversion. ad_user_data_consent: The ad user data consent for the click. """ click_conversion: ClickConversion = client.get_type("ClickConversion") conversion_upload_service: ConversionUploadServiceClient = ( client.get_service("ConversionUploadService") ) conversion_action_service: ConversionActionServiceClient = ( client.get_service("ConversionActionService") ) click_conversion.conversion_action = ( conversion_action_service.conversion_action_path( customer_id, conversion_action_id ) ) # Sets the single specified ID field. if gclid: click_conversion.gclid = gclid elif gbraid: click_conversion.gbraid = gbraid else: click_conversion.wbraid = wbraid click_conversion.conversion_value = float(conversion_value) click_conversion.conversion_date_time = conversion_date_time click_conversion.currency_code = "USD" if conversion_custom_variable_id and conversion_custom_variable_value: conversion_custom_variable: CustomVariable = client.get_type( "CustomVariable" ) conversion_custom_variable.conversion_custom_variable = ( conversion_upload_service.conversion_custom_variable_path( customer_id, conversion_custom_variable_id ) ) conversion_custom_variable.value = conversion_custom_variable_value click_conversion.custom_variables.append(conversion_custom_variable) if order_id: click_conversion.order_id = order_id # Sets the consent information, if provided. if ad_user_data_consent: # Specifies whether user consent was obtained for the data you are # uploading. For more details, see: # https://www.google.com/about/company/user-consent-policy click_conversion.consent.ad_user_data = client.enums.ConsentStatusEnum[ ad_user_data_consent ] # Uploads the click conversion. Partial failure must be set to True here. # # NOTE: This request only uploads a single conversion, but if you have # multiple conversions to upload, it's most efficient to upload them in a # single request. See the following for per-request limits for reference: # https://developers.google.com/google-ads/api/docs/best-practices/quotas#conversion_upload_service request: UploadClickConversionsRequest = client.get_type( "UploadClickConversionsRequest" ) request.customer_id = customer_id request.conversions.append(click_conversion) request.partial_failure = True conversion_upload_response: UploadClickConversionsResponse = ( conversion_upload_service.upload_click_conversions( request=request, ) ) uploaded_click_conversion: ClickConversionResult = ( conversion_upload_response.results[0] ) print( f"Uploaded conversion that occurred at " f'"{uploaded_click_conversion.conversion_date_time}" from ' f'Google Click ID "{uploaded_click_conversion.gclid}" ' f'to "{uploaded_click_conversion.conversion_action}"' )
Ruby
def upload_offline_conversion( customer_id, conversion_action_id, gclid, gbraid, wbraid, conversion_date_time, conversion_value, conversion_custom_variable_id, conversion_custom_variable_value, ad_user_data_consent) # GoogleAdsClient will read a config file from # ENV['HOME']/google_ads_config.rb when called without parameters client = Google::Ads::GoogleAds::GoogleAdsClient.new # Verifies that exactly one of gclid, gbraid, and wbraid is specified, as required. # See https://developers.google.com/google-ads/api/docs/conversions/upload-clicks for details. identifiers_specified = [gclid, gbraid, wbraid].reject {|v| v.nil?}.count if identifiers_specified != 1 raise "Must specify exactly one of GCLID, GBRAID, and WBRAID. " \ "#{identifiers_specified} values were provided." end click_conversion = client.resource.click_conversion do |cc| cc.conversion_action = client.path.conversion_action(customer_id, conversion_action_id) # Sets the single specified ID field. if !gclid.nil? cc.gclid = gclid elsif !gbraid.nil? cc.gbraid = gbraid else cc.wbraid = wbraid end cc.conversion_value = conversion_value.to_f cc.conversion_date_time = conversion_date_time cc.currency_code = 'USD' if conversion_custom_variable_id && conversion_custom_variable_value cc.custom_variables << client.resource.custom_variable do |cv| cv.conversion_custom_variable = client.path.conversion_custom_variable( customer_id, conversion_custom_variable_id) cv.value = conversion_custom_variable_value end end # Sets the consent information, if provided. unless ad_user_data_consent.nil? cc.consent = client.resource.consent do |c| # Specifies whether user consent was obtained for the data you are # uploading. For more details, see: # https://www.google.com/about/company/user-consent-policy c.ad_user_data = ad_user_data_consent end end end response = client.service.conversion_upload.upload_click_conversions( customer_id: customer_id, # NOTE: This request contains a single conversion as a demonstration. # However, if you have multiple conversions to upload, it's best to upload # multiple conversions per request instead of sending a separate request per # conversion. See the following for per-request limits: # https://developers.google.com/google-ads/api/docs/best-practices/quotas#conversion_upload_service conversions: [click_conversion], partial_failure: true, ) if response.partial_failure_error.nil? result = response.results.first puts "Uploaded conversion that occurred at #{result.conversion_date_time} " \ "from Google Click ID #{result.gclid} to #{result.conversion_action}." else failures = client.decode_partial_failure_error(response.partial_failure_error) puts "Request failed. Failure details:" failures.each do |failure| failure.errors.each do |error| puts "\t#{error.error_code.error_code}: #{error.message}" end end end end
Perl
sub upload_offline_conversion { my ( $api_client, $customer_id, $conversion_action_id, $gclid, $gbraid, $wbraid, $conversion_date_time, $conversion_value, $conversion_custom_variable_id, $conversion_custom_variable_value, $order_id, $ad_user_data_consent ) = @_; # Verify that exactly one of gclid, gbraid, and wbraid is specified, as required. # See https://developers.google.com/google-ads/api/docs/conversions/upload-clicks for details. my $number_of_ids_specified = grep { defined $_ } ($gclid, $gbraid, $wbraid); if ($number_of_ids_specified != 1) { die sprintf "Exactly 1 of gclid, gbraid, or wbraid is required, " . "but %d ID values were provided.\n", $number_of_ids_specified; } # Create a click conversion by specifying currency as USD. my $click_conversion = Google::Ads::GoogleAds::V26::Services::ConversionUploadService::ClickConversion ->new({ conversionAction => Google::Ads::GoogleAds::V26::Utils::ResourceNames::conversion_action( $customer_id, $conversion_action_id ), conversionDateTime => $conversion_date_time, conversionValue => $conversion_value, currencyCode => "USD" }); # Set the single specified ID field. if (defined $gclid) { $click_conversion->{gclid} = $gclid; } elsif (defined $gbraid) { $click_conversion->{gbraid} = $gbraid; } else { $click_conversion->{wbraid} = $wbraid; } if ($conversion_custom_variable_id && $conversion_custom_variable_value) { $click_conversion->{customVariables} = [ Google::Ads::GoogleAds::V26::Services::ConversionUploadService::CustomVariable ->new({ conversionCustomVariable => Google::Ads::GoogleAds::V26::Utils::ResourceNames::conversion_custom_variable( $customer_id, $conversion_custom_variable_id ), value => $conversion_custom_variable_value })]; } if (defined $order_id) { # Set the order ID (unique transaction ID), if provided. $click_conversion->{orderId} = $order_id; } # Set the consent information, if provided. if ($ad_user_data_consent) { # Specify whether user consent was obtained for the data you are uploading. # See https://www.google.com/about/company/user-consent-policy for details. $click_conversion->{consent} = Google::Ads::GoogleAds::V26::Common::Consent->new({ adUserData => $ad_user_data_consent }); } # Issue a request to upload the click conversion. Partial failure should # always be set to true. # # NOTE: This request contains a single conversion as a demonstration. # However, if you have multiple conversions to upload, it's best to # upload multiple conversions per request instead of sending a separate # request per conversion. See the following for per-request limits: # https://developers.google.com/google-ads/api/docs/best-practices/quotas#conversion_upload_service my $upload_click_conversions_response = $api_client->ConversionUploadService()->upload_click_conversions({ customerId => $customer_id, conversions => [$click_conversion], partialFailure => "true" }); # Print any partial errors returned. if ($upload_click_conversions_response->{partialFailureError}) { printf "Partial error encountered: '%s'.\n", $upload_click_conversions_response->{partialFailureError}{message}; } # Print the result if valid. my $uploaded_click_conversion = $upload_click_conversions_response->{results}[0]; if (%$uploaded_click_conversion) { printf "Uploaded conversion that occurred at '%s' from Google Click ID '%s' " . "to the conversion action with resource name '%s'.\n", $uploaded_click_conversion->{conversionDateTime}, $uploaded_click_conversion->{gclid}, $uploaded_click_conversion->{conversionAction}; } return 1; }
curl
# This code example uploads a click conversion. # # Variables: # API_VERSION, # CUSTOMER_ID, # MANAGER_CUSTOMER_ID, # OAUTH2_ACCESS_TOKEN: # See https://developers.google.com/google-ads/api/rest/auth#request_headers # for details. # # CONVERSION_ACTION_RESOURCE_NAME: Resource name of the conversion action # associated with this conversion. # GCLID: The Google click ID (gclid) associated with this conversion. # CONVERSION_VALUE: The value of the conversion for the advertiser. # CONVERSION_DATE_TIME: The date time at which the conversion occurred. The # format is "yyyy-mm-dd hh:mm:ss+|-hh:mm", for example, # "2019-01-01 12:32:45-08:00". # CURRENCY_CODE: The currency code of the conversion value. This is the # ISO 4217 3-character currency code. For example: USD, EUR. # CONVERSION_CUSTOM_VARIABLE: The name of the conversion custom variable. # CONVERSION_CUSTOM_VARIABLE_VALUE: The value of the conversion custom # variable. # ORDER_ID: The order ID of the conversion. curl -f --request POST \ "https://googleads.googleapis.com/v${API_VERSION}/customers/${CUSTOMER_ID}:uploadClickConversions" \ --header "Content-Type: application/json" \ --header "login-customer-id: ${MANAGER_CUSTOMER_ID}" \ --header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \ --data @- <<EOF { "conversions": [ { "conversionAction": "${CONVERSION_ACTION_RESOURCE_NAME}", "gclid": "${GCLID}", "conversionValue": ${CONVERSION_VALUE}, "conversionDateTime": "${CONVERSION_DATE_TIME}", "currencyCode": "${CURRENCY_CODE}", "customVariables": [ { "conversionCustomVariable": "${CONVERSION_CUSTOM_VARIABLE}", "value": "${CONVERSION_CUSTOM_VARIABLE_VALUE}" } ], "orderId": "${ORDER_ID}", "consent": { "adUserData": "GRANTED" } } ], "partialFailure": true } EOF
פתרון בעיות
אבחון של נתונים ממקורות אופליין מספק מקור אחד לבדיקת התקינות הכוללת של ההעלאות שלכם באופן שוטף. עם זאת, במהלך ההטמעה אתם יכולים להשתמש במידע שבקטע הזה כדי לבדוק שגיאות שדווחו בשדה 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
|
פעולת ההמרה נוצרה לאחרונה. צריך להמתין לפחות 6 שעות אחרי שיוצרים את הפעולה, ורק אז לנסות שוב להעלות את ההמרות שנכשלו. |
INVALID_CUSTOMER_FOR_CLICK
|
השדה customer_id בבקשה לא זהה למספר הלקוח שהיה חשבון ההמרות ב-Google Ads API בזמן הקליק. מעדכנים את customer_id של הבקשה ללקוח הנכון.
|
EVENT_NOT_FOUND
|
מערכת Google Ads לא מוצאת את השילוב של מזהה הקליק ו-customer_id. בודקים את הדרישות של customer_id ומוודאים שמעלים את הנתונים באמצעות חשבון Google Ads הנכון.
|
DUPLICATE_CLICK_CONVERSION_IN_REQUEST
|
לכמה המרות בבקשה יש אותו שילוב של מזהה קליק, conversion_date_time ו-conversion_action.
צריך להסיר המרות כפולות מהבקשה.
|
CLICK_CONVERSION_ALREADY_EXISTS
|
כבר העלית בעבר המרה עם אותו שילוב של מזהה קליק,
conversion_date_time ו-conversion_action. אם ניסית להעלות שוב את ההמרה הזו והיא כבר הועלתה בהצלחה, אפשר להתעלם מהשגיאה הזו. אם רוצים להוסיף עוד המרה בנוסף להמרה שכבר הועלתה, צריך לשנות את ה-conversion_date_time של ה-ClickConversion כדי למנוע כפילות של ההמרה שכבר הועלתה.
|
EXPIRED_EVENT
|
הקליק המיובא התרחש לפני מסגרת הזמן שצוינה בשדה click_through_lookback_window_days. שינוי
בclick_through_lookback_window_days משפיע רק על קליקים
שתועדו אחרי השינוי, ולכן שינוי של חלון המבט לאחור לא
יפתור את השגיאה הזו בקליק הספציפי. אם זה רלוונטי, משנים את conversion_action לפעולה אחרת עם חלון מבט לאחור ארוך יותר. |
CONVERSION_PRECEDES_EVENT
|
הערך של conversion_date_time הוא לפני התאריך והשעה של הקליק. צריך לעדכן את הערך של conversion_date_time לערך מאוחר יותר.
|
VALUE_MUST_BE_UNSET
|
ל- |
המרות בדוחות
המרות שהועלו משתקפות בדוחות לפי תאריך החשיפה של הקליק המקורי, ולא לפי תאריך בקשת ההעלאה או תאריך ה-conversion_date_time של ה-ClickConversion.
הנתונים הסטטיסטיים של ההמרות המיובאות יוצגו בחשבון Google Ads תוך כ-3 שעות, אם משתמשים במודל שיוך לקליק אחרון. במודלים אחרים של שיוך (Attribution) לרשת החיפוש, התהליך יכול להימשך יותר מ-3 שעות. מידע נוסף זמין במדריך בנושא עדכניות הנתונים.