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

ใน 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() ในแคมเปญเพื่อ สร้างมาสก์ฟิลด์ที่แจกแจงฟิลด์ที่ตั้งไว้ทั้งหมดโดยอัตโนมัติ จากนั้นคุณจะสามารถ ส่งมาสก์ที่ส่งคืนไปยังการเรียกใช้การอัปเดตโดยตรง

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

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:

คำเตือน: โค้ดนี้จะไม่ทำให้เกิดข้อผิดพลาด แต่ target_cpa_micros ของ MaximizeConversions กลยุทธ์การเสนอราคาจะไม่ถูกล้าง

// 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

สำเร็จ: รหัสต่อไปนี้ล้าง target_cpa_micros

// 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

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