このページは Cloud Translation API によって翻訳されました。

Protobuf タイプを操作する

Google Ads 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 フィールドは、 UNION 型と似ています。

.NET ライブラリは、型ごとに 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.ManualCpc は null を初期化して campaign.ManualCpm フィールドは、以前の初期化フィールドを上書きします。 campaign.ManualCpc。

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

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