フィールド マスク

Google Ads API では、フィールド マスクを使用して、API リクエストで更新するフィールドのリストを指定します。フィールド マスクで指定されていないフィールドは、サーバーに送信されても無視されます。

FieldMasks クラス

.NET クライアント ライブラリでフィールド マスクを生成するには、組み込みの FieldMasks ユーティリティ クラスを使用することをおすすめします。このクラスを使用すると、フィールド マスクをゼロから構築するのではなく、変更されたオブジェクトから生成できます。

FieldMasks.AllSetFieldsOf メソッドを使用して、設定されたすべてのフィールドを列挙するフィールド マスクを生成するキャンペーンを更新する例を次に示します。生成されたフィールド マスクを更新呼び出しに直接渡すことができます。

// 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 });

既存のオブジェクトを操作して、いくつかのフィールドを更新する必要がある場合があります。このような場合は、代わりに FieldMasks.FromChanges メソッドを使用します。このメソッドは、2 つのオブジェクト間の差分を表すフィールド マスクを生成します。

Campaign existingCampaign;

// Obtain existingCampaign from an earlier API call.

// Create a new campaign based on 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)
};

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()
};

CampaignOperation operation = new CampaignOperation()
{
    Update = campaign,
    UpdateMask = FieldMasks.AllSetFieldsOf(campaign)
};

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

この API 呼び出しは FieldMaskError.FIELD_HAS_SUBFIELDS エラーで失敗します。MaximizeConversions にはサブフィールドがあるため、Google Ads API サーバーは、変更可能なサブフィールドのフィールド マスクがリクエストに存在することを想定しています。ただし、リクエストでサブフィールドが設定されていないため、この状況では FieldMasks がサブフィールド マスクを自動的に生成することはできません。

このような場合は、fieldMask.Paths（RepeatedField<string>）にパスを手動で追加できます。

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

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 at:
// https://developers.google.com/google-ads/api/docs/campaigns/bidding/assign-strategies
fieldMask.Paths.Add("maximize_conversions.target_cpa_micros");

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

フィールドをクリア

Google Ads API は、一部のフィールド値のクリアをサポートしています。フィールドをクリアするには、フィールド マスクにそのフィールドを手動で含め、リソース オブジェクトのフィールドは設定しないままにする必要があります。フィールドをデフォルト値（int64 フィールドの 0 など）に設定しても、フィールドはクリアされません。

次のコード例は、MaximizeConversions 入札戦略の target_cpa_micros フィールドをクリアする方法を示しています。

正しいコード

次のコードは、campaign.MaximizeConversions.TargetCpaMicros プロパティを設定せずに maximize_conversions.target_cpa_micros をフィールド マスクに追加するため、target_cpa_micros フィールドをクリアします。

// 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
// clears this field from the bidding strategy without impacting any other
// fields on the bidding strategy.
FieldMask fieldMask = FieldMasks.AllSetFieldsOf(campaign);
fieldMask.Paths.Add("maximize_conversions.target_cpa_micros");

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

コードが誤っています

次のコードでは、フィールドが 0 に設定されているため、target_cpa_micros フィールドはクリアされません。TargetCpaMicros が 0 の場合、またはパスがマスクから省略されている場合、FieldMasks ユーティリティと Google Ads API サーバーの両方がこの値を無視し、サーバーはエラーを返しません。

// Creates a campaign with the proper resource name and a
// MaximizeConversions object. Attempts to clear the target_cpa_micros
// field by setting it to 0.
Campaign campaign = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
    MaximizeConversions = new MaximizeConversions()
    {
        TargetCpaMicros = 0
    }
};

// Constructs an operation using FieldMasks.AllSetFieldsOf to derive the
// update mask.
CampaignOperation operation = new CampaignOperation()
{
    Update = campaign,
    UpdateMask = FieldMasks.AllSetFieldsOf(campaign)
};

// Sends the operation in a mutate request that succeeds without clearing
// the previous 'target_cpa_micros' value cleanly.
MutateCampaignsResponse response = campaignService.MutateCampaigns(
    customerId.ToString(), new CampaignOperation[] { operation });