Google verwendet KI-Technologie, um Inhalte in Ihre bevorzugte Sprache zu übersetzen. KI-Übersetzungen können Fehler enthalten.

Konfiguration

Die Google Ads API-Clientbibliothek bietet mehrere Konfigurationseinstellungen, mit denen Sie das Verhalten der Bibliothek anpassen können.

Bibliothek zur Laufzeit konfigurieren

Die bevorzugte Methode zum Konfigurieren der Clientbibliothek besteht darin, zur Laufzeit ein GoogleAdsConfig-Objekt zu initialisieren:

GoogleAdsConfig config = new GoogleAdsConfig()
{
    DeveloperToken = "******",
    OAuth2Mode = OAuth2Flow.APPLICATION,
    OAuth2ClientId = "******.apps.googleusercontent.com",
    OAuth2ClientSecret = "******",
    OAuth2RefreshToken = "******"
};

GoogleAdsClient client = new GoogleAdsClient(config);

Alternative Konfigurationsoptionen

Wir bieten auch einige zusätzliche Optionen zum Konfigurieren der Clientbibliothek. Wenn Sie diese aktivieren möchten, fügen Sie in Ihrem Projekt einen NuGet-Verweis auf das Google.Ads.GoogleAds.Extensions Paket hinzu.

Wenn Sie eine dieser Optionen verwenden, werden die Konfigurationseinstellungen nicht automatisch übernommen. Sie müssen sie explizit laden, wie unten gezeigt.

App.config verwenden

Alle Einstellungen für die Google Ads API werden im Knoten GoogleAdsApi der Datei App.config gespeichert. Eine typische App.config-Konfiguration sieht so aus:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <configSections>
    <section name="GoogleAdsApi" type="System.Configuration.DictionarySectionHandler"></section>
  </configSections>
  <GoogleAdsApi>
    <!-- Set the service timeout in milliseconds. -->
    <add key="Timeout" value="2000" />

    <!-- Proxy settings for library. -->
    <add key="ProxyServer" value="http://localhost:8888"/>
    <add key="ProxyUser" value=""/>
    <add key="ProxyPassword" value=""/>
    <add key="ProxyDomain" value=""/>

    <!-- API-specific settings -->
    <add key="DeveloperToken" value="******"/>

    <!-- OAuth2 settings -->
    <add key = "OAuth2Mode" value="APPLICATION"/>
    <add key = "OAuth2ClientId" value = "******.apps.googleusercontent.com" />
    <add key = "OAuth2ClientSecret" value = "******" />
    <add key = "OAuth2RefreshToken" value = "******" />
  </GoogleAdsApi>
  <startup>
    <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5.2" />
  </startup>
</configuration>

Wenn Sie Konfigurationseinstellungen aus einer App.config-Datei laden möchten, rufen Sie die Methode LoadFromDefaultAppConfigSection für ein GoogleAdsConfig-Objekt auf:

GoogleAdsConfig config = new GoogleAdsConfig();
config.LoadFromDefaultAppConfigSection();
GoogleAdsClient client = new GoogleAdsClient(config);

Separate App.config-Datei angeben

Wenn Sie Ihre App.config nicht überladen möchten, können Sie die bibliotheksspezifische Konfiguration mit der configSource Eigenschaft in eine eigene Konfigurationsdatei verschieben.

Schritt 1: configSource in App.config angeben

Ändern Sie Ihre App.config-Datei so, dass sie so aussieht:

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <configSections>
    <section name="GoogleAdsApi" type="System.Configuration.DictionarySectionHandler"></section>
  </configSections>
  <GoogleAdsApi configSource="GoogleAdsApi.config"/>
...
</configuration>

Schritt 2: Inhalt der Konfigurationsdatei angeben

Erstellen Sie jetzt eine weitere Konfigurationsdatei mit dem Namen, den Sie für configSource angegeben haben, und verschieben Sie den Konfigurationsknoten aus Ihrer App.config-Datei in diese Datei:

<?xml version="1.0" encoding="utf-8" ?>
<GoogleAdsApi>
  ... More settings.
</GoogleAdsApi>

Schritt 3: Build-Regeln in der CSPROJ-Datei korrigieren

Fügen Sie die neue Konfigurationsdatei in Ihr Projekt ein. Ändern Sie die Eigenschaften dieser Datei in Immer in Ausgabeverzeichnis kopieren.

Erstellen Sie jetzt Ihr Projekt und führen Sie es aus. Ihre Anwendung übernimmt die Werte aus der neuen Konfigurationsdatei.

Benutzerdefinierte JSON-Datei verwenden

Sie können eine IConfigurationRoot Instanz verwenden, um die Clientbibliothek zu konfigurieren.

JSON-Datei erstellen

Erstellen Sie eine JSON-Datei mit dem Namen GoogleAdsApi.json, die eine ähnliche Struktur wie die Datei App.config hat.

{
    "Timeout": "2000",

    "ProxyServer": "http://localhost:8888",
    "ProxyUser": "",
    "ProxyPassword": "",
    "ProxyDomain": "",

    "DeveloperToken": "******",

    "OAuth2Mode": "APPLICATION",
    "OAuth2ClientId": "******.apps.googleusercontent.com",
    "OAuth2ClientSecret": "******",
    "OAuth2RefreshToken": "******",
}

Konfiguration laden

Laden Sie als Nächstes die JSON-Datei in eine IConfigurationRoot-Datei.

ConfigurationBuilder builder = new ConfigurationBuilder()
    .SetBasePath(Directory.GetCurrentDirectory())
    .AddJsonFile("GoogleAdsApi.json");
IConfigurationRoot configRoot = builder.Build();

GoogleAdsConfig config = new GoogleAdsConfig();
config.LoadFromConfigurationRoot(configRoot);
GoogleAdsClient client = new GoogleAdsClient(config);

settings.json verwenden

Der Vorgang ist hier ähnlich wie bei der Verwendung einer benutzerdefinierten JSON-Datei, mit dem Unterschied, dass die Schlüssel in einem Abschnitt mit dem Namen GoogleAdsApi enthalten sein müssen:

{
    "GoogleAdsApi":
    {
        "DeveloperToken": "******",
        "OAuth2Mode": "APPLICATION",
        "OAuth2ClientId": "******.apps.googleusercontent.com",
        "OAuth2ClientSecret": "******",
        "OAuth2RefreshToken": "******",
        ...
    }
    // More settings...
}

Als Nächstes können Sie die IConfiguration-Instanz auf Ihrer Seite verwenden:

IConfigurationSection section = Configuration.GetSection("GoogleAdsApi");
GoogleAdsConfig config = new GoogleAdsConfig();
config.LoadFromConfigurationSection(section);
GoogleAdsClient client = new GoogleAdsClient(config);

Umgebungsvariablen verwenden

Sie können den GoogleAdsClient auch mit Umgebungsvariablen initialisieren:

GoogleAdsConfig config = new GoogleAdsConfig();
config.LoadFromEnvironmentVariables();
GoogleAdsClient client = new GoogleAdsClient(config);

Die vollständige Liste der unterstützten Umgebungsvariablen finden Sie hier.

Generischen Stream verwenden

Sie können die Konfiguration oder Teile davon auch aus einem generischen Stream laden, einschließlich eines verschlüsselten Streams:

GoogleAdsConfig config = new GoogleAdsConfig()
{
  //Set some configuration properties in code.
  DeveloperToken = "******",
  OAuth2Mode = OAuth2Flow.SERVICE_ACCOUNT,
};

// Load your encrypted data from a file.

CryptoStream strm = ....

StreamReader rdr = new StreamReader(strm);
// Configure the OAuth credentials from the encrypted file.
config.LoadOAuth2SecretsFromStream(rdr);

GoogleAdsClient client = new GoogleAdsClient(config);

Felder für die Konfiguration

Im Folgenden finden Sie eine Liste der Einstellungen, die von der Google Ads .NET-Bibliothek unterstützt werden.

Konnektivitätseinstellungen

Timeout: Mit diesem Schlüssel können Sie das Dienst-Timeout in Millisekunden festlegen. Der Standardwert wird anhand der method_config/timeout Einstellung in googleads_grpc_service_config.json festgelegt. Legen Sie einen niedrigeren Wert fest, wenn Sie ein kürzeres Limit für die maximale Zeit für einen API-Aufruf erzwingen möchten. Sie können das Timeout auf 2 Stunden oder mehr festlegen. Bei extrem langen Anfragen kann es jedoch trotzdem zu einem Timeout kommen und der Fehler DEADLINE_EXCEEDED zurückgegeben werden.
ProxyServer: Legen Sie dies auf die HTTP-Proxyserver-URL fest, wenn Sie einen Proxy verwenden, um eine Verbindung zum Internet herzustellen.
ProxyUser: Legen Sie dies auf den Nutzernamen fest, den Sie zur Authentifizierung beim Proxyserver benötigen. Lassen Sie dieses Feld leer, wenn kein Nutzername erforderlich ist.
ProxyPassword: Legen Sie dies auf das Passwort von ProxyUser fest, wenn Sie einen Wert für ProxyUser festgelegt haben.
ProxyDomain: Legen Sie dies auf die Domain für ProxyUser fest, wenn Ihr Proxyserver dies erfordert.
MaxReceiveMessageLengthInBytes: Mit dieser Einstellung können Sie die maximale Größe der API-Antwort erhöhen, die von der Clientbibliothek verarbeitet werden kann. Der Standardwert ist 64 MB.
MaxMetadataSizeInBytes: Mit dieser Einstellung können Sie die maximale Größe der API-Fehlerantwort erhöhen, die von der Clientbibliothek verarbeitet werden kann. Der Standardwert ist 16 MB.

Passen Sie die Einstellungen MaxReceiveMessageLengthInBytes und MaxMetadataSizeInBytes an, um bestimmte ResourceExhausted-Fehler zu beheben. Diese Einstellungen beheben Fehler der Form Status(StatusCode="ResourceExhausted",Detail="Received message larger than max (423184132 versus 67108864)".

In diesem Beispiel ist der Fehler darauf zurückzuführen, dass die Nachrichtengröße (423184132 bytes) größer ist als die Größe, die von der Bibliothek verarbeitet werden kann (67108864 bytes). Erhöhen Sie MaxReceiveMessageLengthInBytes auf 500000000, um diesen Fehler zu vermeiden.

Der Fehler weist auch darauf hin, dass Ihr Code ein sehr großes Antwortobjekt (z. B. eine große SearchGoogleAdsResponse) verarbeitet hat. Dies kann aufgrund des Large Object Heap von .NET Auswirkungen auf die Leistung Ihres Codes haben. Wenn dies zu einem Leistungsproblem wird, müssen Sie möglicherweise Ihre API-Aufrufe neu organisieren oder Teile Ihrer App neu gestalten.

OAuth2-Einstellungen

Wenn Sie OAuth2 verwenden, um Ihre Aufrufe an die Google Ads API-Server zu autorisieren, sollten Sie die folgenden Konfigurationsschlüssel festlegen:

AuthorizationMethod: Legen Sie dies auf OAuth2 fest.
OAuth2Mode: Legen Sie dies auf APPLICATION oder SERVICE_ACCOUNT fest.
OAuth2ClientId: Legen Sie diesen Wert auf Ihre OAuth2-Client-ID fest.
OAuth2ClientSecret: Legen Sie diesen Wert auf Ihr OAuth2-Client-Secret fest.
OAuth2Scope: Legen Sie diesen Wert auf verschiedene Bereiche fest, wenn Sie OAuth2-Tokens für mehrere APIs autorisieren möchten. Diese Einstellung ist optional.

Wenn Sie OAuth2Mode == APPLICATION verwenden, müssen Sie die folgenden zusätzlichen Konfigurationsschlüssel festlegen.

OAuth2RefreshToken: Legen Sie diesen Wert auf ein vorab generiertes OAuth2-Aktualisierungstoken fest, wenn Sie OAuth2-Tokens wiederverwenden möchten. Diese Einstellung ist optional.
OAuth2RedirectUri: Legen Sie diesen Wert auf die OAuth2-Weiterleitungs-URL fest. Diese Einstellung ist optional.

Weitere Informationen finden Sie in den folgenden Anleitungen:

Wenn Sie OAuth2Mode == SERVICE_ACCOUNT verwenden, müssen Sie die folgenden zusätzlichen Konfigurationsschlüssel festlegen.

OAuth2PrnEmail: Legen Sie diesen Wert auf die E-Mail-Adresse des Kontos fest, dessen Identität Sie annehmen.
OAuth2SecretsJsonPath: Legen Sie diesen Wert auf den Pfad der OAuth2-JSON-Konfigurationsdatei fest.

Weitere Informationen finden Sie in der Anleitung zum OAuth-Dienstkontoablauf.

Transporteinstellungen

UseGrpcCore: Legen Sie diese Einstellung auf true fest, um die Grpc.Core-Bibliothek als zugrunde liegende Transportschicht zu verwenden. Weitere Informationen finden Sie unter Legacy-gRPC-Bibliothek verwenden.

Google Ads API-Einstellungen

Die folgenden Einstellungen sind spezifisch für die Google Ads API.

DeveloperToken: Legen Sie dies auf Ihr Entwicklertoken fest.
LoginCustomerId: Dies ist die Kunden-ID des autorisierten Kunden, die in der Anfrage verwendet werden soll, ohne Bindestriche (-).
LinkedCustomerId: Dieser Header ist nur für Methoden erforderlich, mit denen die Ressourcen einer Entität aktualisiert werden, wenn die Berechtigung über verknüpfte Konten in der Google Ads-Benutzeroberfläche erteilt wurde (AccountLink-Ressource in der Google Ads API). Legen Sie diesen Wert auf die Kunden-ID des Datenanbieters fest, der die Ressourcen der angegebenen Kunden-ID aktualisiert. Sie sollte ohne Bindestriche (-) festgelegt werden. Weitere Informationen zu verknüpften Konten.

Konfiguration Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.