Utiliser les types de tampons de protocole

Étant donné que l'API Google Ads utilise Protobuf comme format de charge utile par défaut, il est important de comprendre quelques conventions et types Protobuf lorsque vous utilisez l'API.

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 n'a pas renvoyé de valeur pour le champ. Ces champs se comportent comme des champs standards, à l'exception qu'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 facultatif. 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 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;

Types répétés

Dans l'API Google Ads, un tableau de champs est représenté par 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é en tant que RepeatedField<CustomParameter> en lecture seule dans la bibliothèque cliente .NET.

RepeatedField implémente l'interface IList<T>.

Il existe deux façons de renseigner un champ RepeatedField.

Ancienne version de C# : ajouter des valeurs à l'aide de la méthode AddRange

Vous trouverez un exemple ci-dessous.

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

Nouvelles versions de C# : utiliser la syntaxe d'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 }
};

Types 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 au type d'union en C.

La bibliothèque .NET implémente les champs OneOf en fournissant une propriété pour chaque type de valeur pouvant être stocké dans un champ OneOf, et toutes les propriétés mettent à jour un champ de classe partagé.

Par exemple, le campaign_bidding_strategy de la campagne est marqué comme 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, un devoir peut écraser un devoir précédent, ce qui peut entraîner des bugs subtils. Par exemple,

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

    }
};

Dans ce cas, campaign.ManualCpc est désormais null, car l'initialisation du champ campaign.ManualCpm écrase l'initialisation précédente pour campaign.ManualCpc.

Conversion vers d'autres formats

Vous pouvez facilement convertir des objets protobuf au format JSON et inversement. Cela est utile lorsque vous créez des systèmes qui doivent interagir avec d'autres systèmes nécessitant des données dans des formats textuels tels que JSON ou 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);

Vous pouvez également sérialiser un objet en octets et inversement. La sérialisation binaire est plus efficace en termes de mémoire et de stockage que le 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);