ใน Google Ads API การอัปเดตจะทำโดยใช้มาสก์ฟิลด์ Field Mask จะแสดงรายการ
ฟิลด์ทั้งหมดที่คุณต้องการเปลี่ยนแปลงด้วยการอัปเดต และระบบจะ
ไม่สนใจฟิลด์ที่ระบุซึ่งไม่ได้อยู่ใน Field Mask แม้ว่าจะส่งไปยังเซิร์ฟเวอร์ก็ตาม คุณสร้างมาสก์ฟิลด์ได้ด้วยตนเองโดยการสร้าง
Google\Protobuf\FieldMask
สร้างอาร์เรย์ที่ป้อนชื่อของฟิลด์ทั้งหมดที่คุณต้องการเปลี่ยน
แล้วกำหนดอาร์เรย์นั้นให้กับฟิลด์เส้นทางของมาสก์ฟิลด์
นอกจากนี้ คุณยังใช้ยูทิลิตีมาสก์ฟิลด์ในตัวของเรา (FieldMasks) ซึ่งซ่อนรายละเอียดเฉพาะจำนวนมากและช่วยให้คุณสร้างมาสก์ฟิลด์ได้โดยอัตโนมัติด้วยการตรวจสอบการเปลี่ยนแปลงที่คุณทำกับฟิลด์ของเอนทิตี
ตัวอย่างการอัปเดตแคมเปญมีดังนี้
$campaign = new Campaign([
'resource_name' => ResourceNames::forCampaign($customerId, $campaignId),
'status' => CampaignStatus::PAUSED
]);
$campaignOperation = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask(FieldMasks::allSetFieldsOf($campaign));
โค้ดนี้จะสร้างออบเจ็กต์แคมเปญก่อน จากนั้นจึงตั้งชื่อทรัพยากรโดยใช้
ResourceNames
เพื่อให้ API ทราบว่าแคมเปญใดกำลังได้รับการอัปเดต
นอกจากนี้ status
ยังตั้งค่าเป็น PAUSED
ด้วย
จากนั้นโค้ดจะสร้างออบเจ็กต์ CampaignOperation
และตั้งค่าแคมเปญที่สร้างไว้ก่อนหน้านี้
ให้กับออบเจ็กต์ หลังจากนั้นจะใช้
FieldMasks::allSetFieldsOf()
เพื่อสร้างมาสก์ฟิลด์สำหรับแคมเปญโดยใช้ฟิลด์ที่เปลี่ยนแปลงทั้งหมด สุดท้าย ระบบจะส่งมาสก์ที่ส่งคืนไปยังออบเจ็กต์การดำเนินการแคมเปญ
โปรดทราบว่า
FieldMasks::allSetFieldsOf
เป็นวิธีที่สะดวกสำหรับ
FieldMasks::compare()
โดยจะเปรียบเทียบออบเจ็กต์ที่ส่งผ่านกับออบเจ็กต์ว่างของคลาสเดียวกัน ตัวอย่างเช่น ในโค้ดก่อนหน้านี้ คุณอาจใช้ FieldMasks::compare(new
Campaign(), $campaign)
แทน allSetFieldsOf()
ได้
การอัปเดตฟิลด์ข้อความและฟิลด์ย่อย
ฟิลด์ MESSAGE
อาจมีฟิลด์ย่อย (เช่น MaximizeConversions
ซึ่งมี 3 ฟิลด์ ได้แก่ target_cpa_micros
, cpc_bid_ceiling_micros
และ cpc_bid_floor_micros
) หรืออาจไม่มีเลย (เช่น ManualCpm
)
ฟิลด์ข้อความที่ไม่มีฟิลด์ย่อยที่กำหนด
เมื่ออัปเดตMESSAGE
ฟิลด์ที่ไม่ได้กำหนดด้วยฟิลด์ย่อยใดๆ ให้ใช้FieldMasks
เพื่อสร้างมาสก์ฟิลด์ตามที่อธิบายไว้ก่อนหน้านี้
ฟิลด์ข้อความที่มีฟิลด์ย่อยที่กำหนด
เมื่ออัปเดตฟิลด์ MESSAGE
ที่กําหนดด้วยฟิลด์ย่อยโดยไม่ได้ตั้งค่าฟิลด์ย่อยใดๆ ในข้อความนั้นอย่างชัดเจน คุณต้องเพิ่มฟิลด์ย่อย MESSAGE
แต่ละรายการที่แก้ไขได้ลงใน FieldMask
ด้วยตนเอง ซึ่งคล้ายกับ
ตัวอย่างก่อนหน้าซึ่งสร้างมาสก์ฟิลด์ตั้งแต่ต้น
ตัวอย่างที่พบบ่อยอย่างหนึ่งคือการอัปเดตกลยุทธ์การเสนอราคาของแคมเปญโดยไม่ได้ตั้งค่าฟิลด์ใดๆ ในกลยุทธ์การเสนอราคาใหม่ โค้ดด้านล่างแสดงวิธี
อัปเดตแคมเปญให้ใช้กลยุทธ์การเสนอราคา
MaximizeConversions
โดยไม่ต้องตั้งค่าฟิลด์ย่อยใดๆ ในกลยุทธ์การเสนอราคา
ในกรณีนี้ การใช้วิธี allSetFieldsOf()
และ compare()
ของ
FieldMasks
จะไม่บรรลุเป้าหมายที่ต้องการ
โค้ดต่อไปนี้จะสร้างมาสก์ของช่องที่มี maximize_conversions
อย่างไรก็ตาม Google Ads API ไม่อนุญาตให้ดำเนินการเช่นนี้เพื่อป้องกันไม่ให้มีการล้างฟิลด์โดยไม่ตั้งใจและทำให้เกิดข้อผิดพลาด FieldMaskError.FIELD_HAS_SUBFIELDS
// Creates a campaign with the proper resource name and an empty
// MaximizeConversions field.
$campaign = new Campaign([
'resource_name' => ResourceNames::forCampaign($customerId, $campaignId),
'maximize_conversions' => new MaximizeConversions()
]);
// Constructs an operation, using the FieldMasks' allSetFieldsOf utility to
// derive the update mask. The field mask will include 'maximize_conversions`,
// which will produce a FieldMaskError.FIELD_HAS_SUBFIELDS error.
$campaignOperation = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask(FieldMasks::allSetFieldsOf($campaign));
// Sends the operation in a mutate request that will result in a
// FieldMaskError.FIELD_HAS_SUBFIELDS error because empty MESSAGE fields cannot
// be included in a field mask.
$campaignServiceClient = $googleAdsClient->getCampaignServiceClient();
$response = $campaignServiceClient->mutateCampaigns($customerId, [$campaignOperation]);
โค้ดต่อไปนี้แสดงวิธีอัปเดตแคมเปญอย่างถูกต้องเพื่อใช้
MaximizeConversions
กลยุทธ์การเสนอราคาโดยไม่ต้องตั้งค่าฟิลด์ย่อย
// Creates a Campaign object with the proper resource name.
$campaign = new Campaign([
'resource_name' => ResourceNames::forCampaign($customerId, $campaignId)
]);
// Creates a field mask from the existing campaign and adds all of the mutable
// fields (only one in this case) on the MaximizeConversions bidding strategy to
// the field mask. Because this field is included in the field mask but
// excluded from the campaign object, the Google Ads API will set the campaign's
// bidding strategy to a MaximizeConversions object without any of its subfields
// set.
fieldMask = FieldMasks::allSetFieldsOf($campaign);
// Only include 'maximize_conversions.target_cpa_micros' in the field mask
// as it is the only mutable subfield on MaximizeConversions when used as a
// standard bidding strategy.
//
// Learn more about standard and portfolio bidding strategies here:
// https://developers.google.com/google-ads/api/docs/campaigns/bidding/assign-strategies
$fieldMask->setPaths(array_merge(
iterator_to_array($fieldMask->getPaths()->getIterator()),
['maximize_conversions.target_cpa_micros']
));
// Creates an operation to update the campaign with the specified fields.
$campaignOperation = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask($fieldMask);
การล้างช่อง
คุณล้างข้อมูลบางช่องได้อย่างชัดเจน เช่นเดียวกับตัวอย่างก่อนหน้า คุณต้องเพิ่มฟิลด์เหล่านี้ลงในมาสก์ฟิลด์อย่างชัดเจน เช่น สมมติว่าคุณมีแคมเปญที่ใช้MaximizeConversions
กลยุทธ์การเสนอราคา และตั้งค่าฟิลด์ target_cpa_micros
ด้วยค่าที่มากกว่า 0
โค้ดต่อไปนี้จะทํางาน แต่จะไม่เพิ่ม maximize_conversions.target_cpa_micros
ลงในมาสก์ฟิลด์ จึงไม่มีการเปลี่ยนแปลงฟิลด์ target_cpa_micros
// Creates a campaign with the proper resource name and a MaximizeConversions
// object with target_cpa_micros set to 0.
$campaign = new Campaign([
'resource_name' => ResourceNames::forCampaign($customerId, $campaignId),
'maximize_conversions' => new MaximizeConversions(['target_cpa' => 0]),
'status' => CampaignStatus::PAUSED
]);
// Constructs an operation, using the FieldMasks' allSetFieldsOf utility to
// derive the update mask. However, the field mask will NOT include
// 'maximize_conversions.target_cpa_micros'.
$campaignOperation = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask(FieldMasks::allSetFieldsOf($campaign));
// Sends the operation in a mutate request that will succeed but will NOT update
// the 'target_cpa_micros' field because
// 'maximize_conversions.target_cpa_micros' was not included in the field mask.
$campaignServiceClient = $googleAdsClient->getCampaignServiceClient();
$response = $campaignServiceClient->mutateCampaigns($customerId, [$campaignOperation]);
โค้ดต่อไปนี้แสดงวิธีล้างtarget_cpa_micros
ฟิลด์ในMaximizeConversions
กลยุทธ์การเสนอราคาอย่างถูกต้อง
// Creates a Campaign object with the proper resource name.
$campaign = new Campaign([
'resource_name' => ResourceNames::forCampaign($customerId, $campaignId)
]);
// Constructs a field mask from the existing campaign and adds the
// 'maximize_conversions.target_cpa_micros' field to the field mask, which will
// clear this field from the bidding strategy without impacting any other fields
// on the bidding strategy.
$fieldMask = FieldMasks::allSetFieldsOf($campaign);
$fieldMask->setPaths(array_merge(
iterator_to_array($fieldMask->getPaths()->getIterator()),
['maximize_conversions.target_cpa_micros']
));
// Creates an operation to update the campaign with the specified field.
$campaignOperation = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask($fieldMask);
โปรดทราบว่าโค้ด "ไม่ถูกต้อง" จะทํางานตามที่ตั้งใจไว้สําหรับฟิลด์ที่กําหนดเป็น optional
ใน Google Ads API protocol buffers
แต่เนื่องจาก
target_cpa_micros
ไม่ใช่ช่อง optional
รหัส "ไม่ถูกต้อง" จึงไม่อัปเดตกลยุทธ์การเสนอราคาเพื่อล้างช่อง target_cpa