ใน Google Ads API การอัปเดตจะทําโดยใช้มาสก์ช่อง มาสก์ฟิลด์จะแสดงรายการฟิลด์ทั้งหมดที่คุณต้องการเปลี่ยนแปลงด้วยการอัปเดต และระบบจะไม่สนใจฟิลด์ที่ระบุซึ่งไม่ได้อยู่ในมาสก์ฟิลด์ แม้ว่าจะส่งไปยังเซิร์ฟเวอร์แล้วก็ตาม
FieldMaskUtil
วิธีสร้างมาสก์ฟิลด์ที่แนะนําคือการใช้ยูทิลิตีมาสก์ฟิลด์ในตัว ซึ่งจะช่วยให้คุณสร้างมาสก์ฟิลด์จากออบเจ็กต์ที่แก้ไขแล้วได้โดยไม่ต้องสร้างใหม่ตั้งแต่ต้น
ตัวอย่างการอัปเดตแคมเปญมีดังนี้
// Creates a Campaign object with the proper resource name and any other changes. Campaign campaign = Campaign.newBuilder() .setResourceName(ResourceNames.campaign(customerId, campaignId)) .setStatus(CampaignStatus.PAUSED) .build(); // Constructs an operation that will update the campaign, using the FieldMasks' // allSetFieldsOf utility to derive the update mask. This mask tells the Google // Ads API which attributes of the campaign you want to change. CampaignOperation operation = CampaignOperation.newBuilder() .setUpdate(campaign) .setUpdateMask(FieldMasks.allSetFieldsOf(campaign)) .build(); // Sends the operation in a mutate request. MutateCampaignsResponse response = campaignServiceClient.mutateCampaigns( customerId.toString(), Collections.singletonList(operation));
ตัวอย่างนี้จะสร้างออบเจ็กต์ Campaign
ว่างก่อน จากนั้นตั้งชื่อแหล่งข้อมูลเพื่อให้ API ทราบว่ากําลังอัปเดตแคมเปญใด
ตัวอย่างนี้ใช้เมธอด FieldMasks.allSetFieldsOf()
ในแคมเปญเพื่อสร้างมาสก์ฟิลด์โดยอัตโนมัติซึ่งจะแสดงรายการฟิลด์ที่กำหนดไว้ทั้งหมด จากนั้นคุณสามารถส่งมาสก์ที่แสดงผลไปยังการเรียกใช้การอัปเดตได้โดยตรง
หากต้องการทำงานกับออบเจ็กต์ที่มีอยู่เพื่ออัปเดตบางช่อง คุณสามารถแก้ไขโค้ดได้ดังนี้
Campaign existingCampaign; // Obtains existingCampaign from elsewhere. ... // Creates a new campaign based off the existing campaign and updates the // campaign by setting its status to paused. Campaign campaignToUpdate = existingCampaign.toBuilder() .setStatus(CampaignStatus.PAUSED) .build(); // Constructs an operation that will update the campaign, using the FieldMasks' // compare utility to derive the update mask. This mask tells the Google Ads API // which attributes of the campaign you want to change. CampaignOperation operation = CampaignOperation.newBuilder() .setUpdate(campaignToUpdate) .setUpdateMask(FieldMasks.compare(existingCampaign, campaignToUpdate)) .build(); // Sends the operation in a mutate request. MutateCampaignsResponse response = campaignServiceClient.mutateCampaigns( customerId.toString(), Collections.singletonList(operation));
หากต้องการสร้างมาสก์ฟิลด์ตั้งแต่ต้น ก่อนอื่นให้สร้างออบเจ็กต์ FieldMask
แล้วเพิ่มชื่อของฟิลด์แต่ละช่องที่ต้องการเปลี่ยนลงในออบเจ็กต์
FieldMask fieldMask = FieldMask.newBuilder() .addPaths("status") .addPaths("name") .build();
การอัปเดตช่องข้อความและช่องย่อยของข้อความ
ฟิลด์ MESSAGE
อาจมีฟิลด์ย่อย (เช่น MaximizeConversions
ซึ่งมี 3 ฟิลด์ ได้แก่ target_cpa_micros
, cpc_bid_ceiling_micros
และ cpc_bid_floor_micros
) หรือไม่มีฟิลด์ย่อยเลยก็ได้ (เช่น ManualCpm
)
ฟิลด์ข้อความที่ไม่มีการกำหนดช่องย่อย
เมื่ออัปเดตช่อง MESSAGE
ที่ไม่ได้กำหนดให้มีช่องย่อย ให้ใช้ FieldMaskUtil เพื่อสร้างฟิลด์มาสก์ตามที่อธิบายไว้ข้างต้น
ช่องข้อความที่มีช่องย่อยที่กําหนดไว้
เมื่ออัปเดตช่อง MESSAGE
ที่กําหนดให้มีช่องย่อยโดยไม่ตั้งค่าช่องย่อยใดๆ ในข้อความนั้นอย่างชัดเจน คุณต้องเพิ่มช่องย่อย MESSAGE
ที่เปลี่ยนแปลงได้แต่ละช่องลงใน FieldMask
ด้วยตนเอง ซึ่งคล้ายกับตัวอย่างด้านบนที่สร้างมาสก์ช่องตั้งแต่ต้น
ตัวอย่างที่พบบ่อยอย่างหนึ่งคือการอัปเดตกลยุทธ์การเสนอราคาของแคมเปญโดยไม่กรอกข้อมูลในช่องใดๆ ของกลยุทธ์การเสนอราคาใหม่ ตัวอย่างด้านล่างแสดงวิธีอัปเดตแคมเปญให้ใช้กลยุทธ์การเสนอราคา MaximizeConversions
โดยไม่ต้องตั้งค่าช่องย่อยในกลยุทธ์การเสนอราคา
ในกรณีนี้ การใช้เมธอด allSetFieldsOf()
และ compare()
ของ FieldMaskUtil จะไม่บรรลุเป้าหมายที่ต้องการ
ตัวอย่างต่อไปนี้สร้างมาสก์ช่องที่มี maximize_conversions
อย่างไรก็ตาม Google Ads API ไม่อนุญาตให้มีการทำงานลักษณะนี้เพื่อป้องกันการล้างช่องโดยไม่ตั้งใจและทำให้เกิดข้อผิดพลาด FieldMaskError.FIELD_HAS_SUBFIELDS
// Creates a campaign with the proper resource name and an empty // MaximizeConversions field. Campaign campaign = Campaign.newBuilder() .setResourceName(ResourceNames.campaign(customerId, campaignId)) .setMaximizeConversions(MaximizeConversions.newBuilder().build()) .build(); // 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 operation = CampaignOperation.newBuilder() .setUpdate(campaign) .setUpdateMask(FieldMasks.allSetFieldsOf(campaign)) .build(); // 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. MutateCampaignsResponse response = campaignServiceClient.mutateCampaigns( customerId.toString(), Collections.singletonList(operation));
ตัวอย่างต่อไปนี้แสดงวิธีอัปเดตแคมเปญอย่างถูกต้องเพื่อใช้กลยุทธ์การเสนอราคา MaximizeConversions
โดยไม่ต้องตั้งค่าช่องย่อยใดๆ
// Creates a Campaign object with the proper resource name. Campaign campaign = Campaign.newBuilder() .setResourceName(ResourceNames.campaign(customerId, campaignId)) .build(); // 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 fieldMask = FieldMasks.allSetFieldsOf(campaign) .toBuilder() // 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 .addPaths("maximize_conversions.target_cpa_micros") .build(); // Creates an operation to update the campaign with the specified fields. CampaignOperation operation = CampaignOperation.newBuilder() .setUpdate(campaign) .setUpdateMask(fieldMask) .build();
การล้างฟิลด์
คุณสามารถล้างข้อมูลในบางช่องได้อย่างชัดเจน คุณต้องเพิ่มช่องเหล่านี้ลงในมาสก์ฟิลด์อย่างชัดเจน เช่นเดียวกับตัวอย่างข้างต้น ตัวอย่างเช่น สมมติว่าคุณมีแคมเปญที่ใช้กลยุทธ์การเสนอราคา 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 campaign = Campaign.newBuilder() .setResourceName(ResourceNames.campaign(customerId, campaignId)) .setMaximizeConversions( MaximizeConversions.newBuilder().setTargetCpa(0).build()) .setStatus(CampaignStatus.PAUSED) .build(); // 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 operation = CampaignOperation.newBuilder() .setUpdate(campaign) .setUpdateMask(FieldMasks.allSetFieldsOf(campaign)) .build(); // 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. MutateCampaignsResponse response = campaignServiceClient.mutateCampaigns( customerId.toString(), Collections.singletonList(operation));
ตัวอย่างถัดไปแสดงวิธีล้างtarget_cpa_micros
ช่องในกลยุทธ์การเสนอราคา MaximizeConversions
อย่างถูกต้อง
// Creates a Campaign object with the proper resource name. Campaign campaign = Campaign.newBuilder() .setResourceName(ResourceNames.campaign(customerId, campaignId)) .build(); // 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 fieldMask = FieldMasks.allSetFieldsOf(campaign) .toBuilder() .addPaths("maximize_conversions.target_cpa_micros") .build(); // Creates an operation to update the campaign with the specified field. CampaignOperation operation = CampaignOperation.newBuilder() .setUpdate(campaign) .setUpdateMask(fieldMask)) .build();
โปรดทราบว่าตัวอย่างที่ "ไม่ถูกต้อง" ข้างต้นทํางานตามที่ตั้งใจไว้สําหรับช่องที่กําหนดเป็น optional
ใน Google Ads API protocol buffers
แต่เนื่องจาก target_cpa_micros
ไม่ใช่ช่อง optional
ตัวอย่าง "ไม่ถูกต้อง" จึงไม่อัปเดตกลยุทธ์การเสนอราคาเพื่อล้างช่อง target_cpa