フィールド マスク

Google Ads API では、更新はフィールド マスクを使用して行われます。フィールド マスクには、更新で変更するすべてのフィールドが一覧表示されます。フィールド マスクにない指定されたフィールドは、サーバーに送信されても無視されます。フィールドマスクを手動で作成するには、Google\Protobuf\FieldMask を作成し、変更するすべてのフィールドの名前を含む配列を作成し、その配列をフィールドマスクのパスのフィールドに割り当てます。

組み込みのフィールドマスク ユーティリティ(FieldMasks)を使用する方法もあります。このユーティリティを使用すると、多くの詳細が非表示になり、エンティティのフィールドに加えた変更をモニタリングしてフィールドマスクを自動的に生成できます。

キャンペーンを更新する例を次に示します。

    $campaign = new Campaign([
        'resource_name' => ResourceNames::forCampaign($customerId, $campaignId),
        'status' => CampaignStatus::PAUSED
    ]);

    $campaignOperation = new CampaignOperation();
    $campaignOperation->setUpdate($campaign);
    $campaignOperation->setUpdateMask(FieldMasks::allSetFieldsOf($campaign));

このコードは、まず Campaign オブジェクトを作成し、次に ResourceNames を使用してリソース名を設定します。これにより、API は更新対象のキャンペーンを認識できます。statusPAUSED に設定されています。

次に、コードは CampaignOperation オブジェクトを作成し、前に作成したキャンペーンを設定します。その後、FieldMasks::allSetFieldsOf() を使用して、変更されたすべてのフィールドを使用してキャンペーンのフィールド マスクを作成します。最後に、返されたマスクをキャンペーン オペレーション オブジェクトに渡します。

FieldMasks::allSetFieldsOfFieldMasks::compare() に便利なメソッドです。渡されたオブジェクトを、同じクラスの空のオブジェクトと比較します。たとえば、上のコードでは、allSetFieldsOf() の代わりに FieldMasks::compare(new Campaign(), $campaign) を使用できます。

メッセージ フィールドとそのサブフィールドの更新

MESSAGE フィールドにはサブフィールドを含めることができます(target_cpa_microscpc_bid_ceiling_microscpc_bid_floor_micros の 3 つを含む MaximizeConversions など)。サブフィールドを含めない場合もあります(ManualCpm など)。

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

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

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

サブフィールドで定義された MESSAGE フィールドを更新するときに、そのメッセージのサブフィールドを明示的に設定しない場合、フィールド マスクを最初から作成した前述の例と同様に、変更可能MESSAGE サブフィールドを FieldMask に手動で追加する必要があります。

よくある例としては、新しい入札戦略のフィールドを設定せずに、キャンペーンの入札戦略を更新することがあります。次のコードは、入札戦略のサブフィールドを設定せずに MaximizeConversions 入札戦略を使用するようにキャンペーンを更新する方法を示しています。

この場合、FieldMasksallSetFieldsOf() メソッドと compare() メソッドを使用しても、目的の目標は達成されません。

次のコードは、maximize_conversions を含むフィールド マスクを生成します。ただし、Google 広告 API では、誤ってフィールドを消去しないように、この動作は許可されていません。FieldMaskError.FIELD_HAS_SUBFIELDS エラーが発生します。

// Creates a campaign with the proper resource name and an empty
// MaximizeConversions field.
$campaign = new Campaign([
    'resource_name' => ResourceNames::forCampaign($customerId, $campaignId),
    'maximize_conversions' => 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 = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask(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.
$campaignServiceClient = $googleAdsClient->getCampaignServiceClient();
$response = $campaignServiceClient->mutateCampaigns($customerId, [$campaignOperation]);

次のコードは、MaximizeConversions 入札戦略を使用するようにキャンペーンを適切に更新し、サブフィールドを設定しない方法を示しています。

// Creates a Campaign object with the proper resource name.
$campaign = new Campaign([
    'resource_name' => ResourceNames::forCampaign($customerId, $campaignId)
]);

// 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 = 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->setPaths(array_merge(
    iterator_to_array($fieldMask->getPaths()->getIterator()),
    ['maximize_conversions.target_cpa_micros']
));

// Creates an operation to update the campaign with the specified fields.
$campaignOperation = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask($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 = new Campaign([
    'resource_name' => ResourceNames::forCampaign($customerId, $campaignId),
    'maximize_conversions' => new MaximizeConversions(['target_cpa' => 0]),
    'status' => CampaignStatus::PAUSED
]);

// 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 = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask(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.
$campaignServiceClient = $googleAdsClient->getCampaignServiceClient();
$response = $campaignServiceClient->mutateCampaigns($customerId, [$campaignOperation]);

次のコードは、MaximizeConversions 入札戦略の target_cpa_micros フィールドを適切に消去する方法を示しています。

// Creates a Campaign object with the proper resource name.
$campaign = new Campaign([
    'resource_name' => ResourceNames::forCampaign($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 = FieldMasks::allSetFieldsOf($campaign);
$fieldMask->setPaths(array_merge(
    iterator_to_array($fieldMask->getPaths()->getIterator()),
    ['maximize_conversions.target_cpa_micros']
));

// Creates an operation to update the campaign with the specified field.
$campaignOperation = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask($fieldMask);

なお、この「正しくない」コードは、Google 広告 API の protocol buffersoptional として定義されているフィールドに対しては、想定どおりに機能します。ただし、target_cpa_microsoptional フィールドではないため、「不正な」コードは入札戦略を更新して target_cpa フィールドを消去しません