Utiliser des types Protobuf

Étant donné que l'API Google Ads utilise proto3 comme format de charge utile par défaut, il est important de comprendre certaines conventions et certains types de tampons de protocole lorsque vous utilisez la bibliothèque cliente .NET.

Champs facultatifs

De nombreux champs de l'API Google Ads sont marqués comme optional. Cela vous permet de distinguer les cas où le champ a une valeur vide de ceux où le serveur ne renvoie pas de valeur pour le champ. Ces champs se comportent comme des propriétés standards, mais ils fournissent également des méthodes supplémentaires pour effacer le champ et vérifier s'il est défini.

Par exemple, le champ Name de l'objet Campaign est marqué comme optional. Vous pouvez donc utiliser les méthodes suivantes pour travailler avec ce champ :

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

Champs répétés

Un tableau de champs est représenté dans l'API Google Ads sous la forme d'un RepeatedField en lecture seule.

Par exemple, le champ url_custom_parameters d'une campagne est un champ répété. Il est donc représenté sous la forme d'un RepeatedField<CustomParameter> en lecture seule dans la bibliothèque cliente .NET. RepeatedField<T> implémente l'interface IList<T>.

Il existe deux façons de renseigner une propriété RepeatedField :

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

Syntaxe de l'initialiseur de collection

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

Champs Oneof

Certains champs de l'API Google Ads sont marqués comme champs oneof, ce qui signifie qu'ils peuvent contenir différents types, mais une seule valeur à la fois. Les champs oneof sont semblables à un type d'union dans le langage de programmation C.

La bibliothèque .NET implémente les champs oneof en fournissant une propriété pour chaque type de valeur pouvant être contenu dans un champ oneof, toutes les propriétés mettant à jour un champ de stockage sous-jacent partagé.

Par exemple, le champ campaign_bidding_strategy de la campagne est marqué comme un champ oneof. Cette classe est implémentée comme suit (code simplifié pour plus de concision) :

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

Étant donné que les propriétés oneof partagent l'espace de stockage, une attribution peut écraser une attribution précédente, ce qui peut entraîner des bugs subtils. Exemple :

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

Dans ce cas, campaign.ManualCpc est null, car l'initialisation de la propriété campaign.ManualCpm écrase l'initialisation précédente pour campaign.ManualCpc.

Conversion vers d'autres formats

Convertir au format JSON

Vous pouvez convertir des objets protobuf au format JSON et inversement à l'aide de Google.Protobuf.JsonFormatter. Cela est utile lors de la création de systèmes qui doivent s'interfacer avec d'autres systèmes nécessitant des formats textuels tels que JSON ou 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);

Convertir en octets

Vous pouvez sérialiser un objet en octets et inversement à l'aide de Google.Protobuf. La sérialisation binaire est plus efficace que le format JSON en termes de mémoire et de stockage.

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