אתם יכולים להשתמש ב-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 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.V20.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::V20::Resources::ConversionAction->new({ name => $conversion_action_name, category => DEFAULT, type => WEBPAGE, status => ENABLED, viewThroughLookbackWindowDays => 15, valueSettings => Google::Ads::GoogleAds::V20::Resources::ValueSettings->new({ defaultValue => 23.41, alwaysUseDefaultValue => "true" })}); # Create a conversion action operation. my $conversion_action_operation = Google::Ads::GoogleAds::V20::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 Ads שציינתם למעלה, וסוג פעולת ההמרה מוגדר לערך הנכון ConversionActionType
.
SELECT
conversion_action.resource_name,
conversion_action.name,
conversion_action.status
FROM conversion_action
WHERE conversion_action.type = 'INSERT_CONVERSION_ACTION_TYPE'
2. הגדרת תיוג ומזהים של קליקים על חנויות
פועלים לפי ההוראות כדי לוודא שהתיוג האוטומטי מופעל. מגדירים את חשבון Google Ads, את האתר ואת המערכת למעקב אחרי לידים כך שיתעדו ויאחסנו את ה-GCLID, ה-GBRAID או ה-WBRAID של כל חשיפה וקליק של המודעות. התיוג האוטומטי מופעל כברירת מחדל בחשבונות חדשים.
יצירת הבקשה
כדי ליצור את התג UploadClickConversionsRequest
ולהגדיר את השדות שלו לערכים המתאימים, צריך לפעול לפי ההנחיות האלה.
customer_id
מזהה את חשבון Google Ads שאליו מתבצעת ההעלאה. מגדירים את הערך הזה למספר הלקוח של ההמרה ב-Google Ads של החשבון שממנו מגיעים הקליקים.
job_id
מספקת מנגנון לשיוך בקשות ההעלאה למידע על כל משימה בנפרד באבחון של נתונים ממקורות אופליין.
אם לא מגדירים את השדה הזה, Google Ads API מקצה לכל בקשה ערך ייחודי בטווח של
[2^31, 2^63)
. אם אתם מעדיפים לקבץ כמה בקשות למשימה לוגית אחת, צריך להגדיר את השדה הזה לאותו ערך בטווח[0, 2^31)
בכל בקשה במשימה.השדה
job_id
בתגובה מכיל את מזהה המשימה של הבקשה, בין אם ציינתם ערך ובין אם לא.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 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
.
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
בעמודה הזו מצוינת הסביבה שבה נרשמה ההמרה הזו. לדוגמה, App או Web.
קוד לדוגמה
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.V20.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::V20::Services::ConversionUploadService::ClickConversion ->new({ conversionAction => Google::Ads::GoogleAds::V20::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::V20::Services::ConversionUploadService::CustomVariable ->new({ conversionCustomVariable => Google::Ads::GoogleAds::V20::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::V20::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, # 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
|
פעולת ההמרה נוצרה לאחרונה. צריך להמתין לפחות 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 כדי למנוע כפילות של ההמרה שהועלתה קודם.
|
EVENT_NOT_FOUND
|
ל-Google Ads אין אפשרות למצוא את השילוב של מזהה הקליק ושל
customer_id . קוראים את הדרישות ל-customer_id ומוודאים שאתם מעלים את הנתונים באמצעות חשבון Google Ads הנכון.
|
EXPIRED_EVENT
|
הקליק המיובא התרחש לפני מסגרת הזמן שצוינה בשדה click_through_lookback_window_days . שינוי בclick_through_lookback_window_days משפיע רק על קליקים שתועדו אחרי השינוי, ולכן שינוי חלון המבט לאחור לא יפתור את השגיאה הזו לגבי הקליק הספציפי. אם מתאים, משנים את
conversion_action לפעולה אחרת עם חלון מבט לאחור ארוך יותר. |
CONVERSION_PRECEDES_EVENT
|
הערך conversion_date_time הוא לפני התאריך והשעה של
הקליק. מעדכנים את הערך של conversion_date_time לערך מאוחר יותר.
|
GBRAID_WBRAID_BOTH_SET
|
למאפיין ClickConversion יש ערך שמוגדר גם ל-gbraid וגם ל-wbraid . מעדכנים את ההמרה כך שתשתמש רק במזהה קליק אחד, ומוודאים שלא משלבים כמה קליקים באותה המרה. לכל קליק יש רק מזהה קליק אחד.
|
VALUE_MUST_BE_UNSET
|
בודקים את location של התגית GoogleAdsError כדי לזהות איזו מהבעיות הבאות גרמה לשגיאה.
|
המרות בדוחות
ההמרות שהועלו משתקפות בדוחות לפי תאריך החשיפה שלהקליק המקורי, ולא לפי תאריך בקשת ההעלאה או תאריך conversion_date_time
של ClickConversion
.
יכולות לעבור עד 3 שעות עד שהנתונים הסטטיסטיים של ההמרות המיובאות יופיעו בחשבון Google Ads כשמשתמשים בשיוך לקליק האחרון. במודלים אחרים של שיוך לחיפוש, התהליך יכול להימשך יותר מ-3 שעות. מידע נוסף זמין במדריך בנושא עדכניות הנתונים.