Mit Protobuf-Typen arbeiten

Da die Google Ads API Protobuf als Standardnutzlastformat verwendet, ist es wichtig, dass Sie einige Protobuf-Konventionen und -Typen bei der Arbeit mit der API verstehen.

Optionale Felder

Viele Felder in der Google Ads API sind mit optional gekennzeichnet. So können Sie zwischen Fällen unterscheiden, in denen das Feld einen leeren Wert hat und der Server keinen Wert für das Feld zurückgegeben hat. Diese Felder verhalten sich wie normale Felder, bieten aber auch zusätzliche Methoden, um das Feld zu löschen und zu prüfen, ob das Feld festgelegt ist.

So ist beispielsweise das Feld Name des Objekts Campaign 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 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;

Wiederholte Typen

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

Beispiel: Das Feld url_custom_parameters einer Kampagne ist ein wiederkehrendes Feld, das in der .NET-Clientbibliothek als schreibgeschütztes RepeatedField<CustomParameter> dargestellt wird.

Der RepeatedField implementiert die Schnittstelle IList<T>.

Es gibt zwei Möglichkeiten, ein RepeatedField-Feld auszufüllen.

Ältere C#-Version: Werte mit der AddRange-Methode hinzufügen

Unten sehen Sie ein Beispiel.

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

Neuere C#-Versionen: Syntax des Sammlungsinitialisierers verwenden

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

Einige Felder in der Google Ads API sind als OneOf-Felder gekennzeichnet. Das Feld kann also unterschiedliche Typen, aber jeweils nur einen Wert enthalten. OneOf-Felder ähneln dem Union-Typ in C.

Die .NET-Bibliothek implementiert OneOf-Felder. Dazu stellt sie für jeden Werttyp, der in einem OneOf-Feld enthalten sein kann, ein Attribut bereit. Durch alle Attribute wird ein Feld der freigegebenen Klasse aktualisiert.

Beispielsweise ist das campaign_bidding_strategy der Kampagne als OneOf-Feld gekennzeichnet. Diese Klasse wird wie folgt implementiert (der Kürzer vereinfachter Code):

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 OneOf-Attribute Speicherplatz gemeinsam nutzen, kann eine vorherige Zuweisung durch eine Zuweisung überschrieben werden, was zu geringfügigen Fehlern führen kann. Beispiel:

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

    }
};

In diesem Fall ist campaign.ManualCpc jetzt null, da die Initialisierung des Felds campaign.ManualCpm die vorherige Initialisierung für campaign.ManualCpc überschreibt.

In andere Formate konvertieren

Sie können protobuf-Objekte ganz einfach in das JSON-Format konvertieren und umgekehrt. Dies ist nützlich, wenn Sie Systeme erstellen, die eine Schnittstelle zu anderen Systemen benötigen, die Daten in textbasierten Formaten wie JSON oder XML benötigen.

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

Sie können ein Objekt auch in Byte und wieder zurückserialisieren. Die binäre Serialisierung ist arbeitsspeicher- und speichereffizienter als das JSON-Format.

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