หน้ากากภาคสนาม

ใน Google Ads API การอัปเดตจะดำเนินการโดยใช้มาสก์ฟิลด์ ฟิลด์มาสก์จะแสดงรายการฟิลด์ทั้งหมดที่คุณต้องการเปลี่ยนแปลงด้วยการอัปเดต และระบบจะไม่สนใจฟิลด์ที่ระบุซึ่งไม่ได้อยู่ในฟิลด์มาสก์ แม้ว่าจะส่งไปยังเซิร์ฟเวอร์ก็ตาม คุณสามารถสร้างมาสก์ของฟิลด์ด้วยตนเองได้โดยสร้าง FieldMask (Google\Protobuf\FieldMask) สร้างอาร์เรย์ที่ป้อนชื่อของฟิลด์ทั้งหมดที่คุณต้องการเปลี่ยนแปลง แล้วกำหนดอาร์เรย์นั้นให้กับฟิลด์ paths ของมาสก์ของฟิลด์

นอกจากนี้ คุณยังใช้ยูทิลิตีมาสก์ฟิลด์ในตัว (FieldMasks) ซึ่งจะซ่อนรายละเอียดที่เฉพาะเจาะจงจำนวนมากและช่วยให้คุณสร้างมาสก์ฟิลด์โดยอัตโนมัติได้ด้วยการตรวจสอบการเปลี่ยนแปลงที่คุณทำกับฟิลด์ของเอนทิตี

ตัวอย่างการอัปเดตแคมเปญมีดังนี้

$campaign = new Campaign([
    'resource_name' => ResourceNames::forCampaign($customerId, $campaignId),
    'status' => CampaignStatusEnum\CampaignStatus::PAUSED
]);

$campaignOperation = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask(FieldMasks::allSetFieldsOf($campaign));

โค้ดนี้จะสร้างออบเจ็กต์ Campaign ก่อน จากนั้นจึงตั้งชื่อทรัพยากรโดยใช้ ResourceNames เพื่อให้ API ทราบว่ากำลังอัปเดตแคมเปญใด status ยังตั้งค่าเป็น CampaignStatus::PAUSED ด้วย

จากนั้นโค้ดจะสร้างออบเจ็กต์ CampaignOperation และตั้งค่าแคมเปญที่สร้างไว้ก่อนหน้านี้ในออบเจ็กต์ หลังจากนั้น ระบบจะใช้ FieldMasks::allSetFieldsOf() เพื่อสร้างมาสก์ฟิลด์สําหรับแคมเปญโดยแจกแจงฟิลด์ที่แก้ไขทั้งหมด สุดท้าย ระบบจะส่งมาสก์ที่แสดงผลไปยังออบเจ็กต์การดำเนินการของแคมเปญ

โปรดทราบว่า FieldMasks::allSetFieldsOf() เป็นวิธีที่สะดวกสำหรับ FieldMasks::compare() โดยจะเปรียบเทียบออบเจ็กต์ที่ส่งกับออบเจ็กต์ว่างเปล่าของคลาสเดียวกัน ตัวอย่างเช่น ในโค้ดก่อนหน้านี้ คุณสามารถใช้ FieldMasks::compare(new Campaign(), $campaign) แทน FieldMasks::allSetFieldsOf($campaign) ได้

อัปเดตช่องข้อความและช่องย่อย

ฟิลด์ MESSAGE สามารถมีฟิลด์ย่อยได้ (เช่น MaximizeConversions ซึ่งรวมถึงฟิลด์ย่อยอย่าง 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 includes 'maximize_conversions',
// which produces 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 results in a
// FieldMaskError.FIELD_HAS_SUBFIELDS error because empty MESSAGE fields cannot
// be included in a field mask.
$campaignServiceClient = $googleAdsClient->getCampaignServiceClient();
$response = $campaignServiceClient->mutateCampaigns(
    MutateCampaignsRequest::build($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 the mutable
// subfield 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 sets 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:
// https://developers.google.com/google-ads/api/docs/campaigns/bidding/assign-strategies
$fieldMask->getPaths()[] = '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);

ล้างช่อง

คุณสามารถล้างข้อมูลบางช่องได้อย่างชัดเจน เช่นเดียวกับตัวอย่างก่อนหน้านี้ คุณต้องเพิ่มช่องเหล่านี้ลงในมาสก์ช่องอย่างชัดเจน เนื่องจาก FieldMasks จะละเว้นช่องสเกลาร์ Proto3 ที่ตั้งค่าเป็นค่าเริ่มต้น (เช่น 0, false หรือ "") ตัวอย่างเช่น สมมติว่าคุณมีแคมเปญที่ใช้กลยุทธ์การเสนอราคา 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_micros' => 0
    ]),
    'status' => CampaignStatusEnum\CampaignStatus::PAUSED
]);

// Constructs an operation, using the FieldMasks' allSetFieldsOf utility to
// derive the update mask. However, the field mask does 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 succeeds, but does 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(
    MutateCampaignsRequest::build($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
// clears this field from the bidding strategy without impacting any other
// fields on the bidding strategy.
$fieldMask = FieldMasks::allSetFieldsOf($campaign);
$fieldMask->getPaths()[] = '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 อย่างไรก็ตาม เนื่องจาก target_cpa_micros ไม่ใช่ช่อง optional การตั้งค่าเป็น 0 โดยไม่เพิ่มเส้นทางไปยังฟิลด์มาสก์อย่างชัดเจนจะไม่อัปเดตกลยุทธ์การเสนอราคาเพื่อล้าง target_cpa_micros