フィールド マスク

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 オブジェクトを作成します。次に、更新するキャンペーンを正確に把握できるようにリソース名を設定します。

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

場合によっては、既存のオブジェクトを操作して、いくつかのフィールドを更新する必要があります。このような場合は、次のようにコードを変更します。

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 フィールドには、サブフィールドを含めることも（例: target_cpa_micros、cpc_bid_ceiling_micros、cpc_bid_floor_micros の 3 つを持つ MaximizeConversions）、まったく持たない（ManualCpm など）こともできます。

サブフィールドが定義されていないメッセージ フィールド

サブフィールドで定義されていない MESSAGE フィールドを更新する場合は、上記のように FieldMasks を使用してフィールド マスクを生成します。

サブフィールドが定義されたメッセージ フィールド

メッセージのサブフィールドを明示的に設定せずにサブフィールドで定義された MESSAGE フィールドを更新する場合は、フィールド マスクをゼロから作成する上記の例と同様に、変更可能な各 MESSAGE サブフィールドを FieldMask に手動で追加する必要があります。

一般的な例としては、新しい入札戦略のフィールドを設定せずにキャンペーンの入札戦略を更新する場合があります。以下の例は、入札戦略のサブフィールドを設定せずに、MaximizeConversions 入札戦略を使用するようにキャンペーンを更新する方法を示しています。

この場合、FieldMasks の AllSetFieldsOf() メソッドと FromChanges() メソッドを使用しても、意図した目標を達成できません。

次の例では、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 });

次の例は、MaximizeConversions 入札戦略で 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 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 の protocol buffers で optional として定義されているフィールドに対して、意図したとおりに機能します。ただし、target_cpa_micros は optional フィールドではないため、「不適切」な例では、target_cpa フィールドをクリアするように入札戦略が更新されません。