คุณสามารถใช้ Google Ads API เพื่ออัปโหลด Conversion ของคลิกออฟไลน์ไปยัง Google Ads เพื่อติดตามโฆษณาที่นำไปสู่การขายในโลกออฟไลน์ เช่น ทางโทรศัพท์หรือผ่านตัวแทนฝ่ายขาย
ตั้งค่า
การตั้งค่า Conversion ออฟไลน์ที่ใช้งานได้มีข้อกําหนดเบื้องต้น 2-3 อย่าง ตรวจสอบว่าข้อกำหนดเบื้องต้นทั้งหมดเป็นไปตามข้อกำหนดก่อนที่จะดำเนินการติดตั้งใช้งาน
เปิดใช้เครื่องมือวัด Conversion ในกลุ่มลูกค้า Conversion ของ Google Ads
กำหนดค่าการติดแท็กและรหัสการคลิกของร้านค้า
1. เปิดใช้เครื่องมือวัด Conversion ในกลุ่มลูกค้า Conversion ของ Google Ads
หากคุณทำตามคู่มือเริ่มต้นใช้งาน Conversion และเปิดใช้เครื่องมือวัด Conversion แล้ว ให้ข้ามไปที่ขั้นตอนที่ 2: กำหนดค่าการติดแท็ก
ดึงข้อมูลเกี่ยวกับการตั้งค่าเครื่องมือวัด Conversion ของคุณ
คุณตรวจสอบการตั้งค่าเครื่องมือวัด Conversion ของบัญชีและยืนยันว่าได้เปิดใช้เครื่องมือวัด Conversion แล้วโดยค้นหาแหล่งข้อมูล 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 ที่สร้างและจัดการ Conversion สำหรับลูกค้ารายนี้ สำหรับลูกค้าที่ใช้เครื่องมือวัด Conversion ข้ามบัญชี นี่คือรหัสของบัญชีดูแลจัดการ คุณควรระบุรหัสลูกค้า Conversion ของ Google Ads เป็น customer_id ในคําขอของ Google Ads API เพื่อสร้างและจัดการ Conversion
โปรดทราบว่าระบบจะป้อนข้อมูลในช่องนี้ แม้จะไม่ได้เปิดใช้เครื่องมือวัด Conversion ก็ตาม
ช่อง conversion_tracking_status จะระบุว่ามีการเปิดใช้เครื่องมือวัด Conversion หรือไม่และบัญชีใช้เครื่องมือวัด Conversion ข้ามบัญชีหรือไม่
สร้างการกระทําที่ถือเป็น Conversion ในส่วนลูกค้าที่ทำ Conversion ของ Google Ads
หากค่า conversion_tracking_status คือ NOT_CONVERSION_TRACKED
จะไม่มีการเปิดใช้เครื่องมือวัด Conversion สำหรับบัญชี เปิดใช้เครื่องมือวัด Conversion โดยการสร้าง ConversionAction อย่างน้อย 1 รายการในบัญชี Conversion ของ Google Ads เหมือนในตัวอย่างต่อไปนี้ หรือจะสร้างการกระทำที่ถือเป็น Conversion ใน UI ได้โดยทำตามวิธีการในศูนย์ช่วยเหลือสำหรับประเภท Conversion ที่ต้องการเปิดใช้
โปรดทราบว่าระบบจะเปิดใช้ Conversion ที่ปรับปรุงแล้วโดยอัตโนมัติเมื่อส่งผ่าน Google Ads API แต่คุณสามารถปิดใช้ผ่าน UI ของ 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.V16.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::V16::Resources::ConversionAction->new({
name => $conversion_action_name,
category => DEFAULT,
type => WEBPAGE,
status => ENABLED,
viewThroughLookbackWindowDays => 15,
valueSettings =>
Google::Ads::GoogleAds::V16::Resources::ValueSettings->new({
defaultValue => 23.41,
alwaysUseDefaultValue => "true"
})});
# Create a conversion action operation.
my $conversion_action_operation =
Google::Ads::GoogleAds::V16::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 ที่ถูกต้อง
ดูคำแนะนำเพิ่มเติมเกี่ยวกับการสร้างการกระทำที่ถือเป็น Conversion ใน Google Ads API ได้ที่สร้างการกระทำที่ถือเป็น Conversion
ดึงข้อมูลการกระทำที่ถือเป็น Conversion ที่มีอยู่
คุณสามารถเรียกดูรายละเอียดสำหรับการกระทำที่ถือเป็น Conversion ที่มีอยู่ได้ด้วยการออกคำค้นหาต่อไปนี้ ตรวจสอบว่าได้กำหนดรหัสลูกค้าในคำขอเป็นลูกค้า Conversion ของ Google Ads ที่ระบุไว้ข้างต้น และตั้งค่าประเภทการกระทำที่ถือเป็น Conversion เป็นค่า ConversionActionType ที่ถูกต้องแล้ว
SELECT
conversion_action.resource_name,
conversion_action.name,
conversion_action.status
FROM conversion_action
WHERE conversion_action.type = 'INSERT_CONVERSION_ACTION_TYPE'
2. กำหนดค่าการติดแท็กและรหัสการคลิกของร้านค้า
ทำตามinstructionsเพื่อยืนยันว่าได้เปิดใช้การติดแท็กอัตโนมัติแล้ว และตั้งค่าบัญชี Google Ads, เว็บไซต์ และระบบการติดตามโอกาสในการขายเพื่อบันทึกและจัดเก็บ GCLID, GBRAID หรือ WBRAID ของการแสดงผลและการคลิกโฆษณาแต่ละครั้ง การติดแท็กอัตโนมัติจะเปิดอยู่โดยค่าเริ่มต้นสำหรับบัญชีใหม่
สร้างคำขอ
ทำตามคำแนะนำด้านล่างเพื่อสร้าง UploadClickConversionsRequest และตั้งค่าฟิลด์ของฟิลด์เป็นค่าที่เหมาะสม
customer_idระบุบัญชี Google Ads ที่อัปโหลด ตั้งค่าเป็นลูกค้า Conversion ของ Google Ads ของบัญชีที่เป็นแหล่งที่มาของการคลิก
job_idมีกลไกในการเชื่อมโยงคำขออัปโหลดกับข้อมูลต่องานในการวินิจฉัยข้อมูลออฟไลน์
หากคุณไม่ตั้งค่าช่องนี้ Google Ads API จะกำหนดค่าที่ไม่ซ้ำกันให้กับแต่ละคำขอในช่วงของ
[2^31, 2^63)หากต้องการจัดกลุ่มคำขอหลายรายการไว้ในงานเชิงตรรกะเดียว ให้ตั้งค่าช่องนี้เป็นค่าเดียวกันในช่วง[0, 2^31)สำหรับทุกคำขอในงานjob_idในการตอบกลับจะมีรหัสงานสำหรับคำขอ ไม่ว่าคุณจะระบุค่าหรือให้ Google Ads API กำหนดค่าก็ตามpartial_failure_enabledกำหนดวิธีที่ Google Ads API จัดการกับข้อผิดพลาดจากการดำเนินการ
ต้องตั้งค่าช่องนี้เป็น
trueทำตามหลักเกณฑ์สำหรับความล้มเหลวบางส่วนเมื่อประมวลผลคำตอบdebug_enabledกำหนดพฤติกรรมการรายงานข้อผิดพลาดสำหรับการอัปโหลด Conversion ที่ปรับปรุงแล้วสำหรับโอกาสในการขาย Google Ads API จะไม่สนใจช่องนี้เมื่อจัดการการอัปโหลด Conversion การคลิกโดยใช้
gclid,gbraidหรือwbraid
สร้างการกระทำที่ถือเป็น Conversion การคลิก
การรวบรวมออบเจ็กต์ ClickConversion ใน UploadClickConversionRequest จะกำหนดชุด Conversion ที่คุณต้องการอัปโหลด ทำตามคำแนะนำด้านล่างเพื่อสร้างClickConversionแต่ละช่องและตั้งค่าช่องให้เป็นค่าที่เหมาะสม
ตั้งค่าช่องที่ต้องกรอกสําหรับการกระทําที่ถือเป็น Conversion แต่ละรายการ
ทำตามวิธีการด้านล่างเพื่อตั้งค่าช่องที่ต้องกรอกของ ClickConversion เป็นค่าที่เหมาะสม
gclid,gbraid,wbraid- ตัวระบุที่คุณบันทึกไว้ในขณะที่คลิกสำหรับการคลิกหรือการแสดงผลของ Conversion ให้ตั้งค่าช่องเหล่านี้เพียงช่องเดียวเท่านั้น
conversion_date_timeวันที่และเวลาที่เกิด Conversion
ค่าต้องระบุเขตเวลา และรูปแบบต้องเป็น
yyyy-mm-dd HH:mm:ss+|-HH:mmเช่น2022-01-01 19:32:45-05:00(ไม่สนใจเวลาออมแสง)สามารถใช้เขตเวลากับค่าที่ถูกต้องค่าใดก็ได้ ซึ่งไม่ต้องตรงกับเขตเวลาของบัญชี อย่างไรก็ตาม หากคุณวางแผนที่จะเปรียบเทียบข้อมูล Conversion ที่อัปโหลดกับข้อมูลใน UI ของ Google Ads เราขอแนะนำให้ใช้เขตเวลาเดียวกับบัญชี Google Ads เพื่อให้จำนวน Conversion ตรงกัน คุณดูรายละเอียดและตัวอย่างเพิ่มเติมได้ในศูนย์ช่วยเหลือ รวมถึงดูรหัสและรูปแบบเพื่อดูรายการรหัสเขตเวลาที่ถูกต้อง
user_identifiersอย่าตั้งค่าช่องนี้เมื่ออัปโหลด Conversion โดยใช้เฉพาะรหัสคลิกเท่านั้น หากตั้งค่าช่องนี้ไว้ Google Ads จะถือว่าการอัปโหลดเป็นการอัปโหลด Conversion ที่ปรับปรุงแล้วสำหรับโอกาสในการขาย
conversion_actionชื่อทรัพยากรของ
ConversionActionสำหรับ Conversion การคลิกการกระทำที่ถือเป็น Conversion ต้องมี
typeเป็นUPLOAD_CLICKSและต้องมีอยู่ในลูกค้าที่ทำ Conversion ของ Google Ads ของบัญชี Google Ads ที่เชื่อมโยงกับการคลิกนั้นconversion_valueมูลค่าของ Conversion
currency_codeรหัสสกุลเงินของ
conversion_value
ตั้งค่าช่องที่ไม่บังคับของการกระทำที่ถือเป็น Conversion แต่ละรายการ
ตรวจสอบรายการช่องที่ไม่บังคับด้านล่าง แล้วตั้งค่าใน ClickConversion ตามต้องการ
order_id- รหัสธุรกรรมสำหรับ Conversion ช่องนี้ไม่บังคับ แต่ขอแนะนำอย่างยิ่ง หากตั้งค่าขณะอัปโหลด คุณต้องนำไปใช้กับการปรับเปลี่ยนที่เกิดขึ้นกับ Conversion
external_attribution_dataหากคุณใช้เครื่องมือของบุคคลที่สามหรือโซลูชันภายในเพื่อติดตาม Conversion คุณอาจต้องให้เครดิต Google Ads เพียงบางส่วนสำหรับ Conversion หรืออาจต้องการกระจายเครดิตสำหรับ Conversion หนึ่งให้กับคลิกหลายๆ ครั้ง การนำเข้า Conversion ที่มาจากภายนอกช่วยให้คุณอัปโหลด Conversion ที่มีเครดิตบางส่วนซึ่งมอบหมายให้กับแต่ละคลิกได้
หากต้องการอัปโหลดเครดิตบางส่วน ให้ตั้งค่าช่องนี้เป็นออบเจ็กต์
ExternalAttributionDataที่มีค่าสำหรับexternal_attribution_modelและexternal_attribution_creditcustom_variablesค่าของตัวแปร Conversion ที่กำหนดเอง
Google Ads ไม่รองรับตัวแปร Conversion ที่กําหนดเองร่วมกับ
wbraidหรือgbraidcart_dataคุณใส่ข้อมูลรถเข็นช็อปปิ้งสำหรับ
ClickConversionในช่องcart_dataได้ ซึ่งประกอบด้วยแอตทริบิวต์ต่อไปนี้merchant_id: รหัสของบัญชี Merchant Center ที่เชื่อมโยงfeed_country_code: รหัสภูมิภาค 2 อักขระตามมาตรฐาน ISO 3166 ของฟีด Merchant Centerfeed_language_code: รหัสภาษา ISO 639-1 ของฟีด Merchant Centerlocal_transaction_cost: ผลรวมของส่วนลดในระดับธุรกรรมทั้งหมดในcurrency_codeของClickConversionitems: สินค้าในรถเข็นช็อปปิ้ง
แต่ละรายการใน
itemsประกอบด้วยแอตทริบิวต์ต่อไปนี้product_id: รหัสของผลิตภัณฑ์ ซึ่งบางครั้งเรียกว่ารหัสข้อเสนอหรือรหัสสินค้าquantity: จํานวนสินค้าunit_price: ราคาต่อหน่วยของสินค้า
conversion_environmentระบุสภาพแวดล้อมที่มีการบันทึก Conversion นี้ เช่น แอปหรือเว็บ
ตัวอย่างโค้ด
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.V16.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?
c.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::V16::Services::ConversionUploadService::ClickConversion
->new({
conversionAction =>
Google::Ads::GoogleAds::V16::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::V16::Services::ConversionUploadService::CustomVariable
->new({
conversionCustomVariable =>
Google::Ads::GoogleAds::V16::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::V16::Common::Consent->new({
adUserData => $ad_user_data_consent
});
}
# Issue a request to upload the click conversion. Partial failure should
# always be set to true.
#
# NOTE: This request contains a single conversion as a demonstration.
# However, if you have multiple conversions to upload, it's best to
# upload multiple conversions per request instead of sending a separate
# request per conversion. See the following for per-request limits:
# https://developers.google.com/google-ads/api/docs/best-practices/quotas#conversion_upload_service
my $upload_click_conversions_response =
$api_client->ConversionUploadService()->upload_click_conversions({
customerId => $customer_id,
conversions => [$click_conversion],
partialFailure => "true"
});
# Print any partial errors returned.
if ($upload_click_conversions_response->{partialFailureError}) {
printf "Partial error encountered: '%s'.\n",
$upload_click_conversions_response->{partialFailureError}{message};
}
# Print the result if valid.
my $uploaded_click_conversion =
$upload_click_conversions_response->{results}[0];
if (%$uploaded_click_conversion) {
printf
"Uploaded conversion that occurred at '%s' from Google Click ID '%s' " .
"to the conversion action with resource name '%s'.\n",
$uploaded_click_conversion->{conversionDateTime},
$uploaded_click_conversion->{gclid},
$uploaded_click_conversion->{conversionAction};
}
return 1;
}
แก้ปัญหา
การวินิจฉัยข้อมูลออฟไลน์เป็นแหล่งข้อมูลเดียวสำหรับการตรวจสอบประสิทธิภาพโดยรวมของการอัปโหลดอย่างสม่ำเสมอ อย่างไรก็ตาม ในระหว่างการติดตั้งใช้งาน คุณสามารถใช้ข้อมูลในส่วนนี้เพื่อตรวจสอบข้อผิดพลาดที่รายงานในช่อง partial_failure_error ของการตอบกลับได้
ข้อผิดพลาดที่พบบ่อยที่สุดบางอย่างเมื่ออัปโหลดการกระทําที่ถือเป็น Conversion คือข้อผิดพลาดในการให้สิทธิ์ เช่น USER_PERMISSION_DENIED ตรวจสอบอีกครั้งว่าคุณมีรหัสลูกค้าในคำขอเป็นลูกค้า Conversion ของ Google Ads ซึ่งเป็นเจ้าของการกระทำที่ถือเป็น Conversion โปรดไปที่คู่มือการให้สิทธิ์เพื่อดูรายละเอียดเพิ่มเติม และดูเคล็ดลับเกี่ยวกับวิธีแก้ไขข้อผิดพลาดที่แตกต่างกันเหล่านี้จากคู่มือข้อผิดพลาดที่พบบ่อย
แก้ไขข้อผิดพลาดที่พบบ่อย
| ข้อผิดพลาด | |
|---|---|
ConversionUploadError.INVALID_CONVERSION_ACTION_TYPE
|
การกระทำที่ถือเป็น Conversion ที่ระบุเป็นประเภทที่ไม่ถูกต้องสำหรับการอัปโหลด Conversion การคลิก โปรดตรวจสอบว่า ConversionAction ที่ระบุในคำขออัปโหลดมีประเภท UPLOAD_CLICKS
|
ConversionUploadError.NO_CONVERSION_ACTION_FOUND
|
ไม่ได้เปิดใช้การกระทำที่ถือเป็น Conversion ที่ระบุหรือไม่พบภายใน customer_id ที่อัปโหลด โปรดตรวจสอบว่าได้เปิดใช้การกระทำที่ถือเป็น Conversion ในการอัปโหลดแล้ว และ customer_id ของคำขออัปโหลดเป็นเจ้าของ
|
ConversionUploadError.TOO_RECENT_CONVERSION_ACTION
|
สร้างการกระทำที่ถือเป็น Conversion ใหม่แล้ว โปรดรออย่างน้อย 6 ชั่วโมงหลังจากสร้างการดำเนินการแล้วจึงลองดำเนินการ Conversion ที่ล้มเหลวอีกครั้ง |
ConversionUploadError.INVALID_CUSTOMER_FOR_CLICK
|
customer_id ของคำขอไม่ใช่รหัสลูกค้าเดียวกันกับที่เป็นลูกค้าที่ทำ Conversion ของ Google Ads ณ เวลาที่คลิก อัปเดต customer_id ของคำขอไปยังลูกค้าที่ถูกต้อง
|
ConversionUploadError.EVENT_NOT_FOUND
|
Google Ads ไม่พบชุดค่าผสมของรหัสคลิกและ customer_id ตรวจสอบข้อกำหนดสำหรับ customer_id และยืนยันว่าคุณกำลังอัปโหลดโดยใช้บัญชี Google Ads ที่ถูกต้อง
|
ConversionUploadError.DUPLICATE_CLICK_CONVERSION_IN_REQUEST
|
Conversion หลายรายการในคำขอมีชุดค่าผสมของรหัสคลิก conversion_date_time และ conversion_action เหมือนกัน นํา Conversion ที่ซ้ำกันออกจากคําขอ
|
ConversionUploadError.CLICK_CONVERSION_ALREADY_EXISTS
|
เคยอัปโหลด Conversion ที่มีชุดค่าผสมของรหัสคลิก conversion_date_time และ conversion_action เดียวกันแล้ว ไม่ต้องสนใจข้อผิดพลาดนี้หากคุณลองอัปโหลดอีกครั้งและ Conversion นี้สําเร็จแล้วก่อนหน้านี้ หากต้องการเพิ่ม Conversion อื่นนอกเหนือจาก Conversion ที่อัปโหลดก่อนหน้านี้ ให้ปรับ conversion_date_time ของ ClickConversion เพื่อหลีกเลี่ยงไม่ให้เกิด Conversion ที่อัปโหลดก่อนหน้านี้ซ้ำ
|
ConversionUploadError.EVENT_NOT_FOUND
|
Google Ads ไม่พบชุดค่าผสมของรหัสคลิกและ customer_id ตรวจสอบข้อกำหนดสำหรับ customer_id และยืนยันว่าคุณกำลังอัปโหลดโดยใช้บัญชี Google Ads ที่ถูกต้อง
|
ConversionUploadError.EXPIRED_EVENT
|
การคลิกที่นำเข้าเกิดขึ้นก่อนกรอบเวลาที่ระบุในช่อง click_through_lookback_window_days การเปลี่ยนแปลง click_through_lookback_window_days ส่งผลต่อการคลิกที่บันทึกไว้หลังจากการเปลี่ยนแปลงเท่านั้น ดังนั้นการเปลี่ยนกรอบเวลามองย้อนกลับไม่ได้ช่วยแก้ไขข้อผิดพลาดของคลิกนั้นๆ หากเป็นไปได้ ให้เปลี่ยน conversion_action เป็นการดำเนินการอื่นที่มีกรอบเวลามองย้อนกลับที่นานขึ้น |
ConversionUploadError.CONVERSION_PRECEDES_GCLID
|
conversion_date_time อยู่ก่อนวันที่และเวลาของการคลิก อัปเดต conversion_date_time เป็นค่าในภายหลัง
|
ConversionUploadError.GBRAID_WBRAID_BOTH_SET
|
ClickConversion มีการตั้งค่าสำหรับทั้ง gbraid และ wbraid อัปเดต Conversion ให้ใช้รหัสคลิกเพียงรหัสเดียว และตรวจสอบว่าไม่ได้รวมคลิกหลายรายการไว้ใน Conversion เดียวกัน แต่ละคลิกจะมีรหัสคลิกเพียงรายการเดียว
|
FieldError.VALUE_MUST_BE_UNSET
|
ตรวจสอบ location ของ GoogleAdsError เพื่อดูว่าปัญหาใดต่อไปนี้ที่ทำให้เกิดข้อผิดพลาด
|
Conversion ในรายงาน
Conversion ที่อัปโหลดจะแสดงในรายงานสำหรับวันที่แสดงผลของการคลิกครั้งแรก ไม่ใช่วันที่ของคำขออัปโหลดหรือวันที่conversion_date_timeของClickConversion
อาจใช้เวลาถึง 3 ชั่วโมงกว่าที่สถิติ Conversion ที่นำเข้าจะปรากฏในบัญชี Google Ads สำหรับการระบุแหล่งที่มาของคลิกสุดท้าย รูปแบบการระบุแหล่งที่มาของการค้นหาอื่นๆ อาจใช้เวลามากกว่า 3 ชั่วโมง โปรดดูข้อมูลเพิ่มเติมในคำแนะนำเกี่ยวกับความใหม่ของข้อมูล