Mit Protobuf-Typen arbeiten

Da die Google Ads API proto3 als Standardnutzlastformat verwendet, ist es wichtig, einige Konventionen und Typen von Protocol Buffers zu kennen, wenn Sie mit der .NET-Clientbibliothek arbeiten.

Optionale Felder

Viele Felder in der Google Ads API sind mit optional gekennzeichnet. So können Sie unterscheiden, ob das Feld einen leeren Wert hat oder der Server keinen Wert für das Feld zurückgibt. Diese Felder verhalten sich wie reguläre Eigenschaften, bieten aber auch zusätzliche Methoden zum Löschen des Felds und zum Prüfen, ob das Feld festgelegt ist.

Das Feld Name des Objekts Campaign ist beispielsweise als optional gekennzeichnet. Sie können also die folgenden Methoden verwenden, um mit diesem Feld zu arbeiten:

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

Wiederkehrende Felder

Ein Feldarray wird in der Google Ads API als schreibgeschütztes RepeatedField dargestellt.

Das Feld url_custom_parameters einer Kampagne ist beispielsweise ein wiederkehrendes Feld und wird daher in der .NET-Clientbibliothek als schreibgeschütztes RepeatedField<CustomParameter> dargestellt. RepeatedField<T> implementiert die IList<T>-Schnittstelle.

Es gibt zwei Möglichkeiten, eine RepeatedField-Property zu füllen:

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-Felder

Einige Felder in der Google Ads API sind als oneof-Felder gekennzeichnet. Das bedeutet, dass das Feld verschiedene Typen, aber jeweils nur einen Wert enthalten kann. oneof-Felder ähneln einem Union-Typ in der Programmiersprache C.

In der .NET-Bibliothek werden oneof-Felder implementiert, indem für jeden Werttyp, der in einem oneof-Feld enthalten sein kann, eine Eigenschaft bereitgestellt wird. Alle Eigenschaften aktualisieren ein gemeinsames zugrunde liegendes Speicherfeld.

Beispielsweise wird der campaign_bidding_strategy der Kampagne als oneof-Feld gekennzeichnet. Diese Klasse wird so implementiert (der Code wurde zur besseren Lesbarkeit vereinfacht):

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

Da sich oneof-Properties Speicherplatz teilen, kann eine Zuweisung eine vorherige Zuweisung überschreiben, was zu subtilen Fehlern führen kann. Beispiel:

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

In diesem Fall ist campaign.ManualCpc gleich null, da durch die Initialisierung der campaign.ManualCpm-Eigenschaft die vorherige Initialisierung für campaign.ManualCpc überschrieben wird.

Konvertierung in andere Formate

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

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