protobuf 型の操作

Google Ads API はデフォルトのペイロード形式として proto3 を使用するため、.NET クライアント ライブラリを使用する際は、いくつかの Protocol Buffers の規則と型を理解しておくことが重要です。

省略可能項目

Google Ads API の多くのフィールドは optional としてマークされています。これにより、フィールドに空の値がある場合と、サーバーがフィールドの値を返さない場合を区別できます。これらのフィールドは通常のプロパティのように動作しますが、フィールドをクリアするメソッドや、フィールドが設定されているかどうかを確認するメソッドも提供します。

たとえば、Campaign オブジェクトの Name フィールドは optional としてマークされているため、次のメソッドを使用してこのフィールドを操作できます。

// Get the name.
string name = campaign.Name;

// Set the name.
campaign.Name = name;

// Check if the campaign object has the name field set.
bool hasName = campaign.HasName();

// Clear the name field. Use this method to exclude the Name field from
// being sent to the server in a subsequent API call.
campaign.ClearName();

// Set the campaign name to an empty string value. This value will be
// sent to the server if you use this object in a subsequent API call.
campaign.Name = "";

// This throws a runtime ArgumentNullException. Use ClearName() instead.
campaign.Name = null;

繰り返しフィールド

フィールド配列は、Google Ads API で読み取り専用の RepeatedField として表されます。

たとえば、キャンペーンの url_custom_parameters フィールドは繰り返しフィールドであるため、.NET クライアント ライブラリでは読み取り専用の RepeatedField<CustomParameter> として表されます。RepeatedField<T> は IList<T> インターフェースを実装します。

RepeatedField プロパティを設定する方法は 2 つあります。

AddRange メソッド

Campaign campaign = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
    Status = CampaignStatus.Paused,
};

// Add values to UrlCustomParameters using the AddRange method.
campaign.UrlCustomParameters.AddRange(new CustomParameter[]
{
    new CustomParameter { Key = "season", Value = "christmas" },
    new CustomParameter { Key = "promocode", Value = "NY123" }
});

コレクション初期化子の構文

// Option 1: Initialize the field directly.
Campaign campaign = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
    Status = CampaignStatus.Paused,
    // Directly initialize the field.
    UrlCustomParameters =
    {
        new CustomParameter { Key = "season", Value = "christmas" },
        new CustomParameter { Key = "promocode", Value = "NY123" }
    }
};

// Option 2: Initialize using an intermediate variable.
CustomParameter[] parameters = new CustomParameter[]
{
    new CustomParameter { Key = "season", Value = "christmas" },
    new CustomParameter { Key = "promocode", Value = "NY123" }
};

Campaign campaign1 = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
    Status = CampaignStatus.Paused,
    // Initialize from an existing array.
    UrlCustomParameters = { parameters }
};

Oneof フィールド

Google Ads API の一部のフィールドは oneof フィールドとしてマークされています。これは、フィールドがさまざまな型を保持できるものの、一度に 1 つの値しか保持できないことを意味します。oneof フィールドは、C プログラミング言語の共用体型に似ています。

.NET ライブラリは、oneof フィールドに保持できる値の型ごとに 1 つのプロパティを提供することで oneof フィールドを実装します。すべてのプロパティは、共有の基盤となるストレージ フィールドを更新します。

たとえば、キャンペーンの campaign_bidding_strategy は oneof フィールドとしてマークされます。このクラスは次のように実装されます（簡潔にするためコードを簡略化しています）。

public sealed partial class Campaign : pb::IMessage<Campaign>
{
    object campaignBiddingStrategy_ = null;
    CampaignBiddingStrategyOneofCase campaignBiddingStrategyCase_;

    public ManualCpc ManualCpc
    {
        get
        {
            return campaignBiddingStrategyCase_ ==
                CampaignBiddingStrategyOneofCase.ManualCpc
                ? (ManualCpc)campaignBiddingStrategy_ : null;
        }
        set
        {
            campaignBiddingStrategy_ = value;
            campaignBiddingStrategyCase_ =
                CampaignBiddingStrategyOneofCase.ManualCpc;
        }
    }

    public ManualCpm ManualCpm
    {
        get
        {
            return campaignBiddingStrategyCase_ ==
                CampaignBiddingStrategyOneofCase.ManualCpm
                ? (ManualCpm)campaignBiddingStrategy_ : null;
        }
        set
        {
            campaignBiddingStrategy_ = value;
            campaignBiddingStrategyCase_ =
                CampaignBiddingStrategyOneofCase.ManualCpm;
        }
    }

    public CampaignBiddingStrategyOneofCase CampaignBiddingStrategyCase
    {
        get { return campaignBiddingStrategyCase_; }
    }
}

oneof プロパティはストレージを共有するため、1 つの割り当てで以前の割り当てを上書きでき、微妙なバグにつながる可能性があります。次に例を示します。

Campaign campaign = new Campaign()
{
    ManualCpc = new ManualCpc(),
    ManualCpm = new ManualCpm()
};

この場合、campaign.ManualCpm プロパティを初期化すると、campaign.ManualCpc の以前の初期化が上書きされるため、campaign.ManualCpc は null になります。

他の形式への変換

JSON 形式に変換する

Google.Protobuf.JsonFormatter を使用すると、protobuf オブジェクトを JSON 形式に変換したり、JSON 形式から protobuf オブジェクトに変換したりできます。これは、JSON や XML などのテキストベースの形式を必要とする他のシステムと連携する必要があるシステムを構築する場合に便利です。

using Google.Protobuf;

GoogleAdsRow row = new GoogleAdsRow()
{
    Campaign = new Campaign()
    {
        Id = 123,
        Name = "Campaign 1",
        ResourceName = ResourceNames.Campaign(1234567890, 123)
    }
};

// Serialize to JSON and back.
string json = JsonFormatter.Default.Format(row);
row = GoogleAdsRow.Parser.ParseJson(json);

バイトに変換

Google.Protobuf を使用して、オブジェクトをバイトにシリアル化し、元に戻すことができます。バイナリ シリアル化は、JSON 形式よりもメモリとストレージの効率が優れています。

using Google.Protobuf;

GoogleAdsRow row = new GoogleAdsRow()
{
    Campaign = new Campaign()
    {
        Id = 123,
        Name = "Campaign 1",
        ResourceName = ResourceNames.Campaign(1234567890, 123)
    }
};

// Serialize to bytes and back.
byte[] bytes = row.ToByteArray();
row = GoogleAdsRow.Parser.ParseFrom(bytes);