Protobuf タイプを操作する

Google Ads API ではデフォルトのペイロード形式として Protobuf が使用されるため、API を使用する場合は Protobuf の規則と型を理解しておくことが重要です。

省略可能項目

Google Ads API の多くのフィールドは optional とマークされています。これにより、フィールドに空の値が設定されている場合と、サーバーがフィールドの値を返さなかった場合を区別できます。これらのフィールドは通常のフィールドと同様に動作しますが、フィールドを消去したり、フィールドが設定されているかどうかを確認したりするための追加メソッドも用意されています。

たとえば、Campaign オブジェクトの Name フィールドは省略可能とマークされています。そのため、このフィールドは次の方法で操作できます。

// 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 Name field from
// being sent to the server in a subsequent API call.
campaign.ClearName();

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

// This will throw a runtime error. Use ClearName() instead.
campaign.Name = null;

繰り返しの型

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

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

RepeatedField は IList<T> インターフェースを実装します。

RepeatedField フィールドに入力する方法は 2 つあります。

古い C# バージョン: AddRange メソッドを使用して値を追加する

以下に例を示します。

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

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

新しい C# バージョン: コレクション初期化子構文を使用する

// 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()
    {
        EnhancedCpcEnabled = true
    },
    ManualCpm = new ManualCpm()
    {

    }
};

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

他の形式への変換

protobuf オブジェクトを JSON 形式に変換したり、その逆を行ったりするのは簡単です。これは、JSON や XML などのテキストベースの形式でデータを必要とする他のシステムとインターフェースを構築する必要があるシステムを構築する場合に便利です。

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

オブジェクトをバイトにシリアル化して、バイトから復元することもできます。バイナリシリアル化は、JSON 形式よりもメモリとストレージの効率が高くなります。

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