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

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

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

Многие поля в Google Ads API помечены значком 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;

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

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

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

Заполнить свойство RepeatedField можно двумя способами:

Метод AddRange

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

Поля Oneof

Некоторые поля в Google Ads API отмечены как поля oneof. Это означает, что в поле может храниться значение разных типов, но только одно значение в определенный момент времени. Поля oneof похожи на тип union в языке программирования 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.

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

Преобразовать в формат JSON

Вы можете преобразовать объекты protobuf в формат JSON и обратно с помощью Google.Protobuf.JsonFormatter. Это полезно при создании систем, которые должны взаимодействовать с другими системами, требующими текстовых форматов, таких как JSON или XML.

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

Преобразовать в байты

Вы можете сериализовать объект в байты и обратно с помощью Google.Protobuf. Двоичная сериализация эффективнее использует память и хранилище, чем формат 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);