Praca z typami protobuf

Interfejs Google Ads API używa proto3 jako domyślnego formatu ładunku, dlatego podczas pracy z biblioteką klienta .NET ważne jest, aby znać kilka konwencji i typów buforów protokołu.

Pola opcjonalne

Wiele pól w interfejsie Google Ads API jest oznaczonych jako optional. Dzięki temu możesz odróżnić przypadki, w których pole ma pustą wartość, od sytuacji, gdy serwer nie zwraca wartości dla tego pola. Te pola zachowują się jak zwykłe właściwości, ale dodatkowo udostępniają metody czyszczenia pola i sprawdzania, czy pole jest ustawione.

Na przykład pole Name obiektu Campaign jest oznaczone jako optional, więc do pracy z tym polem możesz używać tych metod:

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

Pola powtarzane

Tablica pól jest reprezentowana w interfejsie Google Ads API jako tylko do odczytu RepeatedField.

Na przykład pole url_custom_parameters kampanii jest polem powtarzanym, więc w bibliotece klienta .NET jest reprezentowane jako RepeatedField<CustomParameter> tylko do odczytu. RepeatedField<T> implementuje interfejs IList<T>.

Właściwość RepeatedField można wypełnić na 2 sposoby:

Metoda 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" }
});

Składnia inicjatora kolekcji

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

Pola oneof

Niektóre pola w interfejsie Google Ads API są oznaczone jako oneof pola, co oznacza, że pole może zawierać różne typy, ale tylko jedną wartość naraz. Pola oneof są podobne do typu union w języku programowania C.

Biblioteka .NET implementuje pola oneof, udostępniając jedną właściwość dla każdego typu wartości, która może być przechowywana w polu oneof. Wszystkie właściwości aktualizują wspólne pole pamięci.

Na przykład pole campaign_bidding_strategy kampanii jest oznaczone jako pole oneof. Ta klasa jest zaimplementowana w ten sposób (kod uproszczony dla zwięzłości):

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

Ponieważ właściwości oneof współdzielą pamięć, jedno przypisanie może zastąpić poprzednie, co może prowadzić do subtelnych błędów. Na przykład:

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

W tym przypadku campaign.ManualCpc ma wartość null, ponieważ zainicjowanie właściwości campaign.ManualCpm zastępuje poprzednią inicjację campaign.ManualCpc.

Konwersja na inne formaty

Konwertowanie na format JSON

Obiekty protobuf możesz konwertować na format JSON i z powrotem za pomocą Google.Protobuf.JsonFormatter. Jest to przydatne podczas tworzenia systemów, które muszą współpracować z innymi systemami wymagającymi formatów tekstowych, takich jak JSON lub 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);

Konwertowanie na bajty

Obiekt możesz serializować do bajtów i z powrotem za pomocą Google.Protobuf. Serializacja binarna jest bardziej wydajna pod względem pamięci i miejsca na dysku niż format 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);