Informationen für Einsteiger

In diesem Leitfaden erhalten Sie einen kurzen Überblick über die ersten Schritte mit der .NET-Bibliothek der Google Ads API.

Installation

Die Binärdateien der Clientbibliothek werden über NuGet bereitgestellt. Fügen Sie dem Google.Ads.GoogleAds-Paket in Ihrem Projekt eine NuGet-Referenz hinzu, um die Clientbibliothek zu verwenden.

Autorisierung einrichten

Um Ihre API-Aufrufe zu autorisieren, müssen Sie der Bibliothek Ihre Client-ID, Ihren Clientschlüssel, Ihr Aktualisierungstoken und Ihr Entwicklertoken angeben.

Wenn Sie Anmeldedaten generieren müssen

Wenn Sie bereits Anmeldedaten haben

  • Kopieren Sie den Knoten GoogleAdsApi und den Abschnitt GoogleAdsApi unter dem Knoten configSections aus der Datei App.config in GitHub in Ihre Datei App.config / Web.config. Wenn Sie das Paket mit NuGet installiert haben, werden diese Knoten automatisch in Ihre Datei App.config / Web.config eingefügt.
  • Fügen Sie das Entwicklertoken, die Client-ID, den Clientschlüssel und das Aktualisierungstoken in App.config / Web.config Ihrer App ein.

Die Datei App.config auf GitHub ist gut dokumentiert. Weitere Informationen und alternative Möglichkeiten zur Konfiguration der Clientbibliothek, z. B. über Umgebungsvariablen, finden Sie im Konfigurationsleitfaden.

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.V18.CampaignService);

// Make more calls to service class.

GoogleAdsClient-Instanz erstellen

Die wichtigste Klasse in der .NET-Bibliothek der Google Ads API ist die Klasse GoogleAdsClient. Damit können Sie eine vorkonfigurierte Dienstklasse erstellen, die für API-Aufrufe verwendet werden kann. GoogleAdsClient bietet einen Standardkonstruktor, mit dem ein Nutzerobjekt mit den in App.config / Web.config Ihrer App angegebenen Einstellungen erstellt wird. Informationen zu den Konfigurationsoptionen finden Sie im Konfigurationsleitfaden.

// Create a new GoogleAdsClient with the App.config settings.
GoogleAdsClient user = new GoogleAdsClient();

Dienste erstellen

GoogleAdsClient bietet eine GetService-Methode, mit der ein Google Ads-Dienst erstellt werden kann.

CampaignServiceClient campaignService = client.GetService(Services.V18.CampaignService);
// Now make calls to CampaignService.

Wir stellen eine Services-Klasse bereit, in der alle unterstützten API-Versionen und ‑Dienste aufgelistet sind. Die Methode GetService akzeptiert diese Aufzählungsobjekte als Argument beim Erstellen des Dienstes. Wenn Sie beispielsweise eine Instanz von CampaignServiceClient für Version V18 der Google Ads API erstellen möchten, müssen Sie die Methode GoogleAdsClient.GetService mit Services.V18.CampaignService als Argument aufrufen, wie im vorherigen Beispiel gezeigt.

Threadsicherheit

Es ist nicht sicher, eine GoogleAdsClient-Instanz für mehrere Threads freizugeben, da sich die Konfigurationsänderungen, die Sie an einer Instanz in einem Thread vornehmen, auf die Dienste auswirken können, die Sie in anderen Threads erstellen. Vorgänge wie das Abrufen neuer Dienstinstanzen aus einer GoogleAdsClient-Instanz und das parallele Aufrufen mehrerer Dienste sind threadsicher.

Eine mehrstufige 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 von .NET Framework-Anwendungen vermeiden

Synchrone Methoden können dazu führen, dass einige Ihrer .NET Framework-Anwendungen hängen bleiben. Ein gängiges Beispiel sind API-Aufrufe aus einer Ereignishandlermethode einer WinForm-Anwendung.

Es gibt zwei Möglichkeiten, dieses Problem zu beheben:

  1. Verwenden Sie die alte Grpc-Bibliothek.

    Sie können die Property UseGrpcCore von GoogleAdsConfig so festlegen, dass die alte Grpc.Core-Bibliothek anstelle der Standard-Grpc.Net.Client-Bibliothek verwendet wird. Diese Methode wurde nicht umfassend an .NET Framework-Anwendungen getestet. Daher wird das Problem möglicherweise nicht behoben. Hier ein Beispiel für ein Snippet:

    GoogleAdsConfig config = new GoogleAdsConfig();
config.UseGrpcCore = true;
GoogleAdsClient client = new GoogleAdsClient(config);

  2. Verwenden Sie asynchrone Methoden.

    Sie können asynchrone Methoden verwenden, um Einfrieren zu vermeiden. Hier einige Beispiele:

    SearchStream

    Es wird ein Aufruf von SearchStream() ausgeführt und die Ergebnisse werden in eine Listenansicht eingefügt.

    private async void button1_Click(object sender, EventArgs e)
{
// Get the GoogleAdsService.
GoogleAdsServiceClient googleAdsService = client.GetService(
    Services.V18.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

    Es wird ein CampaignBudget-Aufruf erstellt und der Ressourcenname des neuen Budgets wird in einer MessageBox-Benachrichtigung angezeigt.

    private async void button2_Click(object sender, EventArgs e)
{
// Get the BudgetService.
CampaignBudgetServiceClient budgetService = client.GetService(
    Services.V18.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 fehlschlagen. Es ist wichtig, API-Fehler zu erfassen und entsprechend zu behandeln.

Eine GoogleAdsException-Instanz wird ausgelöst, wenn ein API-Fehler auftritt. Sie enthält Details, die Ihnen helfen können, die Ursache des Problems zu ermitteln:

// Get the CampaignService.
CampaignServiceClient campaignService = client.GetService(Services.V18.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}");
}