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

ใน 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