空のメッセージ オブジェクトをフィールドとして設定する

Google Ads API では、一部のメッセージ フィールドが空のメッセージ オブジェクト(campaign.manual_cpm など)として定義されているか、設定する必要のないオプション フィールド(campaign.manual_cpc など)のみが含まれている場合があります。これらのフィールドを設定することは、特定のキャンペーンで使用する入札戦略を API に伝えるうえで重要ですが、メッセージが空の場合、直感的に理解できません。

文字列である campaign.name フィールドを更新するときは、通常の Python オブジェクト属性であるかのように直接更新してフィールドを設定します。

campaign.name = "Test campaign value"

campaign.manual_cpc はネストされたフィールドです。つまり、文字列などのプリミティブ型ではなく、別の protobuf メッセージが含まれています。フィールドを直接更新することもできます。

campaign.manual_cpc.enhanced_cpc_enabled = True

これにより、このキャンペーンでは拡張クリック単価が有効になっている manual_cpc の入札戦略が使用されていることが API に通知されます。

しかし、空の manual_cpm を使用したい場合はどうすればよいでしょうか。または、拡張クリック単価を有効にせずに manual_cpc を使用できますか?これを行うには、クラスの個別の空のインスタンスをキャンペーンにコピーする必要があります。例:

client = GoogleAdsClient.load_from_storage()

empty_cpm = client.get_type('ManualCpm')
client.copy_from(campaign.manual_cpm, empty_cpm)

campaign オブジェクトに manual_cpm が指定されていることに注意してください。

name {
  value: "Test campaign value"
}
manual_cpm {
}

manual_cpm フィールドは設定されていますが、そのフィールドには値がありません。このパターンを使用する API にリクエストを送信するときに、ロギングを有効にしてリクエスト ペイロードを検査することで、空のメッセージ オブジェクトが正しく設定されていることを確認できます。

最後に、このフィールドをリクエスト オブジェクトの update_mask に手動で追加する必要があります。フィールド マスク ヘルパーには、空のオブジェクトに明示的に設定されたフィールドと、設定されていないフィールドの違いを判断するメカニズムがありません。

from google.api_core.protobuf_helpers import field_mask

campaign_operation.create = campaign
campaign_operation.update_mask = field_mask(None, campaign)
# Here we manually add the "manual_cpm" field
campaign_operation.update_mask.append("manual_cpm")