Da die Google Ads API Protobuf als Standard-Nutzlastformat verwendet, ist es wichtig, einige Protobuf-Konventionen und -Typen zu verstehen, wenn Sie mit der API arbeiten.
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 enthält und der Server keinen Wert für das Feld zurückgegeben hat. Diese Felder verhalten sich wie normale Felder, mit dem Unterschied, dass sie zusätzliche Methoden zum Löschen des Felds und Prüfen, ob das Feld festgelegt ist, bieten.
Beispielsweise ist das Feld Name des Objekts Campaign als optional gekennzeichnet.
Daher können Sie 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ützte RepeatedField dargestellt.
Ein Beispiel dafür ist, dass das Feld url_custom_parameters einer Kampagne ein wiederkehrendes Feld ist. Daher wird es in der .NET-Clientbibliothek als schreibgeschützte RepeatedField<CustomParameter> dargestellt.
Mit RepeatedField wird die Schnittstelle IList<T> implementiert.
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-Typen
Einige Felder in der Google Ads API sind als OneOf-Felder gekennzeichnet. Das bedeutet, dass das Feld verschiedene Typen enthalten kann, aber jeweils nur einen Wert. Eines der Felder ähnelt dem
Union-Typ in C.
Die .NET-Bibliothek implementiert OneOf-Felder, indem sie ein Attribut für jeden Werttyp, der in einem OneOf-Feld enthalten sein kann, und alle Attribute zum Aktualisieren eines gemeinsam genutzten Klassenfelds bereitstellt.
Beispielsweise ist das Feld campaign_bidding_strategy der Kampagne als „OneOf“-Feld markiert. Diese Klasse wird wie folgt implementiert (Code wurde der Einfachheit halber 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 OneOf-Eigenschaften Speicherplatz gemeinsam nutzen, kann eine Zuweisung eine vorherige Zuweisung überschreiben, was zu kleinen 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 die Initialisierung des Felds campaign.ManualCpm die vorherige Initialisierung für campaign.ManualCpc überschreibt.
In andere Formate umwandeln
Sie können protobuf-Objekte ganz einfach in das JSON-Format und umgekehrt konvertieren. Dies ist nützlich, wenn Sie Systeme erstellen, 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 Byte und zurück serialisieren. Die binäre Serialisierung bietet mehr Arbeitsspeicher und Speicherplatz 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);