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

ใน 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 ที่ไม่ได้กำหนดด้วยช่องย่อย ให้ใช้ FieldMaskUtill เพื่อสร้างฟิลด์มาสก์ตามที่อธิบายไว้ข้างต้น

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

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

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

ในกรณีนี้ การใช้เมธอด allSetFieldsOf() และ compare() ของ FieldMaskUsil จะช่วยให้บรรลุเป้าหมายที่ต้องการ

ตัวอย่างต่อไปนี้สร้างฟิลด์มาสก์ที่มี 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

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