In diesem Leitfaden erhalten Sie einen kurzen Überblick über die ersten Schritte mit der Google Ads API. .NET-Bibliothek.
Installation
Die Binärdateien der Clientbibliothek werden mithilfe von NuGet verteilt. NuGet-Referenz hinzufügen
zu Google.Ads.GoogleAds
Paket in Ihrem Projekt, das Sie verwenden möchten
der Clientbibliothek.
Autorisierung einrichten
Zum Autorisieren Ihrer API-Aufrufe müssen Sie Ihre Client-ID, Ihren Clientschlüssel Aktualisierungstoken und Entwicklertoken für die Bibliothek.
Wenn Sie Anmeldedaten generieren müssen
- Folgen Sie dem Leitfaden für Entwicklertoken, um Ihr Entwickler-Token, falls Sie noch keines haben.
- Folgen Sie dem OAuth-Vorgang für Desktop-Anwendungen. Anleitung zum Generieren einer Client-ID, eines Clientschlüssels und eines Aktualisierungstokens.
Wenn Sie bereits Anmeldedaten haben
- Kopieren Sie den Knoten
GoogleAdsApi
und den AbschnittGoogleAdsApi
unter demconfigSections
-Knoten aus der DateiApp.config
in GitHub in IhreApp.config
/Web.config
-Datei einfügen. Wenn Sie zur Installation des werden diese Knoten automatisch in IhrApp.config
/Web.config
Datei. - Entwickler-Token, Client-ID, Clientschlüssel und Aktualisierungstoken angeben
in der
App.config
/Web.config
Ihrer App.
Die App.config
der in GitHub enthaltenen Datei ist gut dokumentiert. Sie können aber auch
Konfigurationsanleitung
um mehr zu erfahren und alternative Möglichkeiten zur Konfiguration der Clientbibliothek zu nutzen.
wie Umgebungsvariablen.
API aufrufen
Die grundlegende Verwendung der Clientbibliothek sieht so aus:
// Create a Google Ads client.
GoogleAdsClient client = new GoogleAdsClient();
// Create the required service.
CampaignServiceClient campaignService =
client.GetService(Services.V17.CampaignService);
// Make more calls to service class.
GoogleAdsClient-Instanz erstellen
Die wichtigsten Klassen in der Google Ads API-.NET-Bibliothek sind die
Klasse GoogleAdsClient
. Sie können damit eine vorkonfigurierte Dienstklasse erstellen.
das für API-Aufrufe verwendet werden kann. GoogleAdsClient
stellt einen Standardwert bereit.
-Konstruktor erstellt, der ein Nutzerobjekt mithilfe der in Ihrem
App.config
/ Web.config
der App. Weitere Informationen finden Sie im Abschnitt Konfiguration
Leitfaden für die Konfiguration
Optionen.
// Create a new GoogleAdsClient with the App.config settings.
GoogleAdsClient user = new GoogleAdsClient();
Dienste erstellen
GoogleAdsClient
bietet eine GetService
-Methode zum Erstellen eines
Anzeigendienst
CampaignServiceClient campaignService = client.GetService(Services.V17.CampaignService);
// Now make calls to CampaignService.
Wir stellen eine Services
-Klasse zur Verfügung, die alle unterstützten API-Versionen auflistet und
. Die Methode GetService
akzeptiert diese Aufzählungsobjekte als Argument
wenn Sie den Dienst erstellen. Um beispielsweise eine Instanz von
CampaignServiceClient
für Version V17
der Google Ads API
müssen Sie die Methode GoogleAdsClient.GetService
mit
Services.V17.CampaignService
als Argument, wie gezeigt
aus dem vorherigen Beispiel.
Threadsicherheit
Es ist nicht sicher, eine GoogleAdsClient
-Instanz zwischen mehreren Threads zu teilen.
da die Konfigurationsänderungen, die Sie an einer Instanz in einem Thread vornehmen,
wirken sich auf die Dienste aus, die Sie in anderen Threads erstellen. Vorgänge wie die Beschaffung
neue Dienstinstanzen von einer GoogleAdsClient
-Instanz erstellen und Aufrufe an
mehrere Dienste parallel verwenden, sind threadsicher.
Eine Multithread-Anwendung würde in etwa so aussehen:
GoogleAdsClient client1 = new GoogleAdsClient();
GoogleAdsClient client2 = new GoogleAdsClient();
Thread userThread1 = new Thread(addAdGroups);
Thread userThread2 = new Thread(addAdGroups);
userThread1.start(client1);
userThread2.start(client2);
userThread1.join();
userThread2.join();
public void addAdGroups(object data) {
GoogleAdsClient client = (GoogleAdsClient) data;
// Do more operations here.
...
}
Einfrieren der .NET Framework-Anwendungen vermeiden
Synchrone Methoden können dazu führen, dass einige Ihrer .NET Framework-Anwendungen einfrieren. Ein gängiges Beispiel sind API-Aufrufe über eine Event-Handler-Methode. einer WinForm-Anwendung.
Es gibt zwei Möglichkeiten, dieses Problem zu beheben:
Legacy-GRPC-Bibliothek verwenden
Sie können das Attribut
UseGrpcCore
vonGoogleAdsConfig
festlegen, um die Methode alteGrpc.Core
-Bibliothek anstelle derGrpc.Net.Client
-Standardbibliothek. Diese Methode wurde noch nicht eingehend an .NET Framework-Anwendungen getestet, sodass das Problem möglicherweise nicht behoben wird. Hier ist ein Beispiel-Snippet:GoogleAdsConfig config = new GoogleAdsConfig(); config.UseGrpcCore = true; GoogleAdsClient client = new GoogleAdsClient(config);
Auf der gRPC-Supportseite finden Sie Details zu den Unterschieden zwischen der alten
Grpc.Core
-Bibliothek und derGrpc.Net.Client
-Standardbibliothek.Verwenden Sie asynchrone Methoden.
Sie können asynchrone Methoden verwenden, um Einfrieren zu vermeiden. Beispiele:
SearchStream
Es wird ein
SearchStream()
-Aufruf durchgeführt und die Ergebnisse werden angezeigt. Listenansicht dargestellt werden.private async void button1_Click(object sender, EventArgs e) { // Get the GoogleAdsService. GoogleAdsServiceClient googleAdsService = client.GetService( Services.V17.GoogleAdsService); // Create a query that will retrieve all campaigns. string query = @"SELECT campaign.id, campaign.name, campaign.network_settings.target_content_network FROM campaign ORDER BY campaign.id"; List
items = new List (); Task t = googleAdsService.SearchStreamAsync(customerId.ToString(), query, delegate (SearchGoogleAdsStreamResponse resp) { foreach (GoogleAdsRow googleAdsRow in resp.Results) { ListViewItem item = new ListViewItem(); item.Text = googleAdsRow.Campaign.Id.ToString(); item.SubItems.Add(googleAdsRow.Campaign.Name); items.Add(item); } } ); await t; listView1.Items.AddRange(items.ToArray()); } Kampagnenbudget
Ein CampaignBudget-Aufruf wird erstellt und der Ressourcenname des neuen Budgets lautet mit einer
MessageBox
-Benachrichtigung angezeigt.private async void button2_Click(object sender, EventArgs e) { // Get the BudgetService. CampaignBudgetServiceClient budgetService = client.GetService( Services.V17.CampaignBudgetService); // Create the campaign budget. CampaignBudget budget = new CampaignBudget() { Name = "Interplanetary Cruise Budget #" + ExampleUtilities.GetRandomString(), DeliveryMethod = BudgetDeliveryMethod.Standard, AmountMicros = 500000 }; // Create the operation. CampaignBudgetOperation budgetOperation = new CampaignBudgetOperation() { Create = budget }; // Create the campaign budget. Task
t = budgetService.MutateCampaignBudgetsAsync( customerId.ToString(), new CampaignBudgetOperation[] { budgetOperation }); await t; MutateCampaignBudgetsResponse response = t.Result; MessageBox.Show(response.Results[0].ResourceName); }
Fehlerbehandlung
Nicht jeder API-Aufruf ist erfolgreich. Der Server kann Fehler ausgeben, wenn Ihre API-Aufrufe aus irgendeinem Grund nicht scheitert. Es ist wichtig, API-Fehler zu erfassen und zu beheben. angemessen.
Eine GoogleAdsException
-Instanz wird ausgelöst, wenn ein API-Fehler auftritt. Sie enthält
um herauszufinden, was schiefgelaufen ist:
// Get the CampaignService.
CampaignServiceClient campaignService = client.GetService(Services.V17.CampaignService);
// Create a campaign for update.
Campaign campaignToUpdate = new Campaign()
{
ResourceName = ResourceNames.Campaign(customerId, campaignId),
// More fields to update.
// ...
};
// Create the operation.
CampaignOperation operation = new CampaignOperation()
{
Update = campaignToUpdate,
UpdateMask = FieldMasks.AllSetFieldsOf(campaignToUpdate)
};
try
{
// Update the campaign.
MutateCampaignsResponse response = campaignService.MutateCampaigns(
customerId.ToString(), new CampaignOperation[] { operation });
// Display the results.
// ...
}
catch (GoogleAdsException e)
{
Console.WriteLine("Failure:");
Console.WriteLine($"Message: {e.Message}");
// Can examine to get more error details.
Console.WriteLine($"Failure: {e.Failure}");
// Can be shared with Google for further troubleshooting.
Console.WriteLine($"Request ID: {e.RequestId}");
}