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> として表されます。

RepeatedFieldIList<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 の union 型に似ています。

.NET ライブラリは OneOf フィールドを実装するために、OneOf フィールドに保持できる値のタイプごとに 1 つのプロパティを指定し、すべてのプロパティで共有クラス フィールドを更新します。

たとえば、キャンペーンの 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.ManualCpcnull になりました。

他のフォーマットへの変換

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