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

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

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

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

Например, поле Name объекта Campaign помечено как необязательное. Таким образом, вы можете использовать следующие методы для работы с этим полем.

// 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 поле.

Старая версия 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 }
};

Один из типов

Некоторые поля в Google Ads API помечены как поля 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()
    {
        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);