หน้ากากอนามัย

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

FieldMaskUtil

วิธีที่แนะนำสำหรับการสร้างมาสก์ของช่องคือการใช้มาสก์ของช่องในตัว ซึ่งช่วยให้คุณสร้างฟิลด์มาสก์จากออบเจ็กต์ที่ถูกดัดแปลงแทน สร้างสรรค์สิ่งใหม่ๆ ตั้งแต่ต้น

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

// Update campaign by setting its status to paused, and "Search network" to false.
Campaign campaignToUpdate = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
    Status = CampaignStatus.Paused,
    NetworkSettings = new NetworkSettings()
    {
        TargetSearchNetwork = false
    }
};

// Create the operation.
CampaignOperation operation = new CampaignOperation()
{
    Update = campaignToUpdate,
    UpdateMask = FieldMasks.AllSetFieldsOf(campaignToUpdate)
};

// Update the campaign.
MutateCampaignsResponse response = campaignService.MutateCampaigns(
    customerId.ToString(), new CampaignOperation[] { operation });

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

ตัวอย่างนี้ใช้เมธอด FieldMasks.AllSetFieldsOf ในแคมเปญ สร้างมาสก์ฟิลด์ที่แจกแจงฟิลด์ที่ตั้งค่าทั้งหมดโดยอัตโนมัติ จากนั้นคุณจะสามารถ ส่งมาสก์ที่ส่งคืนไปยังการเรียกใช้การอัปเดตโดยตรง

บางครั้งคุณอาจต้องทำงานกับออบเจ็กต์ที่มีอยู่และอัปเดตช่อง 2-3 ช่อง ในกรณีเช่นนี้ คุณจะต้องแก้ไขโค้ดดังนี้

Campaign existingCampaign;

// Obtain existingCampaign from elsewhere.
...

// Create a new campaign based off the existing campaign for update.
Campaign campaignToUpdate = new Campaign(existingCampaign);

// Update campaign by setting its status to paused, and "Search network" to
// false.
campaignToUpdate.Status = CampaignStatus.Paused;
campaignToUpdate.NetworkSettings = new NetworkSettings()
{
    TargetSearchNetwork = false
}

// Create the operation.
CampaignOperation operation = new CampaignOperation()
{
    Update = campaignToUpdate,
    UpdateMask = FieldMasks.FromChanges(existingCampaign, campaignToUpdate)
};

หากต้องการสร้างมาสก์ช่องตั้งแต่ต้น คุณจะต้องสร้าง FieldMask จากนั้นสร้างอาร์เรย์ที่มีการเติมข้อมูลด้วยชื่อของช่องทั้งหมดที่คุณต้องการ เปลี่ยน และสุดท้ายให้เพิ่มเนื้อหาอาร์เรย์ลงในช่อง Path ของมาสก์

FieldMask fieldMask = new FieldMask();
fieldMask.Paths.AddRange(new string[] { "status", "name" });

การอัปเดตฟิลด์ข้อความและฟิลด์ย่อย

MESSAGE ช่องสามารถมีช่องย่อยได้ (เช่น MaximizeConversions ซึ่งมี 3 ส่วน: target_cpa_micros, cpc_bid_ceiling_micros และ cpc_bid_floor_micros) หรือไม่ต้องไม่มีรายการใดๆ เลย (เช่น ManualCpm)

ฟิลด์ข้อความที่ไม่มีฟิลด์ย่อยที่กำหนด

เมื่ออัปเดตช่อง MESSAGE ที่ไม่ได้กำหนดด้วยช่องย่อยใดๆ ให้ใช้ FieldMasks เพื่อสร้างฟิลด์มาสก์ตามที่อธิบายไว้ข้างต้น

ช่องข้อความที่มีช่องย่อยที่กำหนด

เมื่ออัปเดตช่อง MESSAGE ที่กำหนดด้วยช่องย่อยที่ไม่มี ตั้งค่าฟิลด์ย่อยในข้อความดังกล่าวอย่างชัดเจน คุณจะต้อง เพิ่มฟิลด์ย่อย MESSAGE ที่เปลี่ยนแปลงได้แต่ละรายการลงใน FieldMask จากตัวอย่างด้านบนที่สร้างฟิลด์มาสก์ใหม่ตั้งแต่ต้น

ตัวอย่างหนึ่งที่พบบ่อยคือการอัปเดตกลยุทธ์การเสนอราคาของแคมเปญโดยไม่ตั้งค่า เกี่ยวกับกลยุทธ์การเสนอราคาใหม่ ตัวอย่างด้านล่างแสดงวิธี อัปเดตแคมเปญให้ใช้ฟังก์ชัน กลยุทธ์การเสนอราคา MaximizeConversions โดยไม่ตั้งค่าฟิลด์ย่อยในกลยุทธ์การเสนอราคา

ในกรณีนี้ การใช้เมธอด AllSetFieldsOf() และ FromChanges() ของ FieldMasks ไม่บรรลุเป้าหมายที่ตั้งใจ

ตัวอย่างต่อไปนี้จะสร้างมาสก์ฟิลด์ที่มี maximize_conversions แต่ Google Ads API ไม่อนุญาตให้คุณกระทำการดังกล่าว เพื่อป้องกันการล้างฟิลด์โดยไม่ตั้งใจและสร้าง FieldMaskError.FIELD_HAS_SUBFIELDS 

// Creates a campaign with the proper resource name and an empty
// MaximizeConversions field.
Campaign campaign = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
    MaximizeConversions = 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 operation = new CampaignOperation()
{
    Update = campaign,
    UpdateMask = 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.
MutateCampaignsResponse response = campaignService.MutateCampaigns(
    customerId.ToString(), new CampaignOperation[] { operation });

ตัวอย่างต่อไปนี้แสดงวิธีอัปเดตแคมเปญอย่างถูกต้องเพื่อใช้ MaximizeConversions กลยุทธ์การเสนอราคาที่ไม่ได้ตั้งค่าฟิลด์ย่อย

// Creates a Campaign object with the proper resource name.
Campaign campaign = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
};

// Creates a field mask from the existing campaign and adds all of the fields
// on the MaximizeConversions bidding strategy to the field mask. Because these
// fields are 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 with none of its subfields set.
FieldMask 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.Paths.AddRange(new string[] {
    "maximize_conversions.target_cpa_micros",
});

// Creates an operation to update the campaign with the specified fields.
CampaignOperation operation = new CampaignOperation()
{
    Update = campaign,
    UpdateMask = 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 campaign = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
    MaximizeConversions = new MaximizeConversions()
    {
        TargetCpaMicros = 0
    }
};

// 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 = new CampaignOperation()
{
    Update = campaign,
    UpdateMask = 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.
MutateCampaignsResponse response = campaignService.MutateCampaigns(
    customerId.ToString(), new CampaignOperation[] { operation });

ตัวอย่างถัดไปแสดงวิธีล้าง target_cpa_micros อย่างถูกต้อง ในกลยุทธ์การเสนอราคา MaximizeConversions

// Creates a Campaign object with the proper resource name.
Campaign campaign = new Campaign()
{
    ResourceName = ResourceNames.Campaign(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 fieldMask = FieldMasks.AllSetFieldsOf(campaign);
fieldMask.Paths.AddRange(new string[] {
    "maximize_conversions.target_cpa_micros",
});

// Creates an operation to update the campaign with the specified field.
CampaignOperation operation = new CampaignOperation()
{
    Update = campaign,
    UpdateMask = fieldMask
};

โปรดทราบว่าลิงก์ที่ "ไม่ถูกต้อง" ตัวอย่างข้างต้นทำงานตามที่ควรจะเป็นสำหรับฟิลด์ ระบุเป็น optional ใน Google Ads API protocol buffers แต่ตั้งแต่ target_cpa_micros ไม่ใช่ช่อง optional แสดงว่า "ไม่ถูกต้อง" ตัวอย่าง ไม่อัปเดต กลยุทธ์การเสนอราคาเพื่อล้างฟิลด์ target_cpa