欄位遮罩

在 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 方法 自動產生欄位遮罩來列舉所有集合欄位。接著 將傳回的遮罩直接傳遞至更新呼叫。

有時候，您可能需要使用現有物件並更新一些欄位。 在這種情況下，您可以按照以下方式修改程式碼：

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，其中包含三個： 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
};

請注意，即使上述範例對 在 Google Ads API 中定義為 optional protocol buffers。 但自從 target_cpa_micros敬上 不是 optional 欄位，「不正確」範例「不會」更新 出價策略，以便清除「target_cpa」欄位。