Praca z typami buforów protokołu

Ponieważ interfejs Google Ads API używa domyślnego formatu ładunku Protobuf, warto poznać kilka konwencji i typów tego protokołu podczas pracy z tym interfejsem.

Pola opcjonalne

Wiele pól w interfejsie Google Ads API jest oznaczonych jako optional. Pozwala to rozróżnić przypadki, gdy pole ma pustą wartość, a serwer nie odesłał wartości tego pola. Działają one jak zwykłe pola, ale zapewniają dodatkowe metody czyszczenia pola i sprawdzania, czy są ustawione.

Na przykład pole Name obiektu Campaign jest oznaczone jako opcjonalne. Aby skorzystać z tego pola, możesz użyć 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 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;

Powtórzone typy

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

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

RepeatedField implementuje interfejs IList<T>.

Pole RepeatedField można wypełnić na 2 sposoby.

Starsza wersja C#: dodaj wartości za pomocą metody AddRange

Oto przykład.

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

Nowsze wersje języka C#: użyj składni 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 }
};

Jeden z typów

Niektóre pola interfejsu Google Ads API są oznaczone jako OneOf, co oznacza, że mogą w nim występować różne typy, ale tylko jedną z nich. Jedno z pól jest podobne do typu unii w C.

Biblioteka .NET implementuje pola OneOf, podając jedną właściwość dla każdego typu wartości, którą można umieścić w polu OneOf, oraz wszystkie właściwości aktualizujące pole klasy udostępnionej.

Na przykład campaign_bidding_strategy w kampanii jest oznaczone jako pole OneOf. Ta klasa jest zaimplementowana w podany niżej sposób (dla zachowania 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ż usługi OneOf używają wspólnego miejsca na dane, 1 z nich może zastępować poprzednie przypisanie, co prowadzi do drobnego błędu. Przykład:

Campaign campaign = new Campaign()
{
    ManualCpc = new ManualCpc()
    {
        EnhancedCpcEnabled = true
    },
    ManualCpm = new ManualCpm()
    {

    }
};

W tym przypadku campaign.ManualCpc to teraz null, bo zainicjowanie pola campaign.ManualCpm zastępuje poprzednie inicjowanie campaign.ManualCpc.

Konwersja na inne formaty

Obiekty protobuf można łatwo konwertować do formatu JSON i odwrotnie. Jest to przydatne, gdy tworzysz systemy, które muszą łączyć się z innymi systemami, które wymagają danych w formacie tekstowym, np. JSON lub 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);

Obiekt możesz też zserializować do bajtów i z powrotem. Seria binarna jest wydajniejsza od pamięci i pamięci niż format 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);