Работа с типами protobuf

Поскольку API Google Ads использует proto3 в качестве формата полезной нагрузки по умолчанию, важно понимать некоторые соглашения и типы Protocol Buffers при работе с клиентской библиотекой .NET.

Необязательные поля

Многие поля в API Google Ads помечены как optional . Это позволяет различать случаи, когда поле имеет пустое значение, и случаи, когда сервер не возвращает значение для этого поля. Эти поля ведут себя как обычные свойства, за исключением того, что они также предоставляют дополнительные методы для очистки поля и проверки того, задано ли оно.

Например, поле Name объекта Campaign помечено как 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;

Повторяющиеся поля

В API Google Ads массив полей представлен как RepeatedField , доступный только для чтения.

Например, поле url_custom_parameters кампании является повторяющимся полем, поэтому в клиентской библиотеке .NET оно представлено как RepeatedField<CustomParameter> доступный только для чтения. RepeatedField<T> реализует интерфейс IList<T> .

Существует два способа заполнения свойства RepeatedField :

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

Одно из полей

Некоторые поля в API Google Ads помечены как поля типа oneof , что означает, что поле может содержать разные типы, но только одно значение одновременно. Поля типа oneof аналогичны типу объединения в языке программирования C.

Библиотека .NET реализует поля oneof , предоставляя одно свойство для каждого типа значения, которое может храниться в поле 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 использует общее хранилище, одно присваивание может перезаписать предыдущее, что приводит к незаметным ошибкам. Например:

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

В данном случае campaign.ManualCpc равен null поскольку инициализация свойства campaign.ManualCpm перезаписывает предыдущую инициализацию campaign.ManualCpc .

Преобразование в другие форматы

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

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