Da die Google Ads API Protobuf als Standardnutzlastformat verwendet, ist es wichtig, einige Protobuf-Konventionen und ‑Typen zu kennen, wenn Sie mit der API arbeiten.
Optionale Felder
Viele Felder in der Google Ads API sind als optional gekennzeichnet. So können Sie unterscheiden, ob das Feld einen leeren Wert hat oder der Server keinen Wert für das Feld zurückgesendet hat. Diese Felder verhalten sich wie normale Felder, bieten aber zusätzliche Methoden zum Löschen des Felds und zum Prüfen, ob das Feld festgelegt ist.
Das Feld Name des Campaign-Objekts ist beispielsweise als optional gekennzeichnet.
Sie können 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.
Ein Beispiel ist das Feld url_custom_parameters einer Kampagne, das ein wiederkehrendes Feld ist. Es wird daher in der .NET-Clientbibliothek als schreibgeschütztes RepeatedField<CustomParameter> dargestellt.
Die RepeatedField implementiert die IList<T>-Schnittstelle.
Es gibt zwei Möglichkeiten, ein RepeatedField-Feld zu füllen.
Ältere C#-Version: Werte mit der AddRange-Methode hinzufügen
Unten finden 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 für Sammlungsinitialisierer 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-Typen
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 dem Union-Typ in C.
Die .NET-Bibliothek implementiert OneOf-Felder, indem für jeden Werttyp, der in einem OneOf-Feld gespeichert werden kann, eine Property bereitgestellt wird. Alle Properties aktualisieren ein gemeinsames Klassenfeld.
Angenommen, das campaign_bidding_strategy der Kampagne ist als OneOf-Feld gekennzeichnet. Diese Klasse wird so implementiert (Code aus Vereinfachungsgründen gekürzt):
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-Properties denselben Speicherplatz nutzen, kann eine Zuweisung eine vorherige Zuweisung überschreiben, was zu subtilen Fehlern führt. Beispiel:
Campaign campaign = new Campaign()
{
ManualCpc = new ManualCpc()
{
EnhancedCpcEnabled = true
},
ManualCpm = new ManualCpm()
{
}
};
In diesem Fall ist campaign.ManualCpc jetzt null, da durch die Initialisierung des Felds campaign.ManualCpm die vorherige Initialisierung für campaign.ManualCpc überschrieben wird.
In andere Formate konvertieren
Sie können protobuf-Objekte ganz einfach in das JSON-Format konvertieren und umgekehrt. Das ist nützlich, wenn Systeme entwickelt werden, die mit anderen Systemen kommunizieren müssen, 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 Bytes serialisieren und wieder in den ursprünglichen Zustand zurückversetzen. Die binäre Serialisierung ist speicher- 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);