Configurazione

La libreria client dell'API Google Ads fornisce diverse impostazioni di configurazione che puoi utilizzare per personalizzare il comportamento della libreria.

Configurare la libreria in fase di runtime

Il modo preferito per configurare la libreria client è inizializzare un oggetto GoogleAdsConfig in fase di runtime:

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

GoogleAdsClient client = new GoogleAdsClient(config);

Opzioni di configurazione alternative

Forniamo anche alcune opzioni aggiuntive per configurare la libreria client: per attivarle, aggiungi un riferimento Nuget al pacchetto Google.Ads.GoogleAds.Extensions nel tuo progetto.

Se utilizzi una di queste opzioni, le impostazioni di configurazione non vengono rilevate automaticamente: devi caricarle in modo esplicito come mostrato di seguito.

Configurare utilizzando App.config

Tutte le impostazioni specifiche di Google Ads API sono archiviate nel nodo GoogleAdsApi del file App.config. Una configurazione tipica App.config è la seguente:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <configSections>
    <section name="GoogleAdsApi" type="System.Configuration.DictionarySectionHandler" />
  </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>

Per caricare le impostazioni di configurazione da un file App.config, chiama il metodo LoadFromDefaultAppConfigSection su un oggetto GoogleAdsConfig:

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

Specificare un file App.config separato

Se non vuoi che App.config sia troppo disordinato, puoi spostare la configurazione specifica della libreria in un file di configurazione separato utilizzando la proprietà configSource.

Passaggio 1: specifica un'origine di configurazione nel file App.config

Modifica il tuo App.config in modo che sia simile a questo:

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

Passaggio 2: specifica i contenuti del file di configurazione

Ora crea un altro file di configurazione con il nome specificato in configSource e sposta il nodo di configurazione da App.config in questo file:

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

Passaggio 3: correggi le regole di compilazione nel file csproj

Infine, includi il nuovo file di configurazione nel tuo progetto. Modifica le proprietà di questo file in Copia sempre nella cartella di output.

Ora crea ed esegui il progetto. La tua applicazione inizierà a recuperare i valori dal nuovo file di configurazione.

Configurazione tramite un file JSON personalizzato

Puoi utilizzare un'istanza IConfigurationRoot per configurare la libreria client.

Crea un file JSON

Crea un file JSON denominato GoogleAdsApi.json con una struttura simile a quella del file App.config.

{
    "Timeout": "2000",

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

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

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

Carica la configurazione

Successivamente, carica il file JSON in un IConfigurationRoot.

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);

Configurazione tramite settings.json

La procedura è simile a quella per l'utilizzo di un file JSON personalizzato, tranne per il fatto che le chiavi devono trovarsi in una sezione denominata GoogleAdsApi:

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

Successivamente, puoi utilizzare l'istanza IConfiguration nella tua pagina:

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

Configurazione tramite variabili di ambiente

Puoi anche inizializzare GoogleAdsClient utilizzando le variabili di ambiente:

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

Consulta l'elenco completo delle variabili di ambiente supportate.

Campi di configurazione

Di seguito è riportato l'elenco delle impostazioni supportate dalla libreria Google Ads .NET.

Impostazioni di connettività

  • Timeout: utilizza questa chiave per impostare il timeout del servizio in millisecondi. Il valore predefinito è impostato in base all'impostazione method_config/timeout in googleads_grpc_service_config.json. Imposta un valore inferiore se devi applicare un limite più breve al tempo massimo per una chiamata API. Puoi impostare il timeout su 2 ore o più, ma l'API potrebbe comunque andare in timeout per le richieste a esecuzione molto lunga e restituire un errore DEADLINE_EXCEEDED.
  • ProxyServer: impostalo sull'URL del server proxy HTTP se utilizzi un proxy per connetterti a internet.
  • ProxyUser: impostalo sul nome utente necessario per l'autenticazione sul server proxy. Lascia questo campo vuoto se non è richiesto un nome utente.
  • ProxyPassword: imposta questo valore sulla password di ProxyUser se hai impostato un valore per ProxyUser.
  • ProxyDomain: impostalo sul dominio per ProxyUser se il server proxy richiede di impostarne uno.
  • MaxReceiveMessageLengthInBytes: utilizza questa impostazione per aumentare la dimensione massima della risposta API che la libreria client può gestire. Il valore predefinito è 64 MB.
  • MaxMetadataSizeInBytes: utilizza questa impostazione per aumentare le dimensioni massime della risposta di errore dell'API che la libreria client può gestire. Il valore predefinito è 16 MB.

Modifica le impostazioni MaxReceiveMessageLengthInBytes e MaxMetadataSizeInBytes per correggere determinati errori ResourceExhausted. Queste impostazioni risolvono gli errori del modulo Status(StatusCode="ResourceExhausted",Detail="Received message larger than max (423184132 versus 67108864)".

In questo esempio, l'errore è dovuto alle dimensioni del messaggio (423184132 bytes) superiori a quelle gestibili dalla libreria (67108864 bytes). Aumenta MaxReceiveMessageLengthInBytes a 500000000 per evitare questo errore.

Tieni presente che l'errore indica anche che il codice ha gestito un oggetto Response significativamente grande (ad esempio un grande SearchGoogleAdsResponse). Ciò potrebbe avere implicazioni sulle prestazioni del codice a causa dell'heap di oggetti di grandi dimensioni di .NET. Se questo diventa un problema di prestazioni, potresti dover esplorare come riorganizzare le chiamate API o riprogettare parti della tua app.

Impostazioni OAuth2

Quando utilizzi OAuth2 per autorizzare le chiamate ai server dell'API Google Ads, devi impostare le seguenti chiavi di configurazione:

  • AuthorizationMethod: imposta su OAuth2.
  • OAuth2Mode: imposta su APPLICATION o SERVICE_ACCOUNT.
  • OAuth2ClientId: imposta questo valore sull'ID client OAuth2.
  • OAuth2ClientSecret: imposta questo valore sul client secret OAuth2.
  • OAuth2Scope: imposta questo valore su ambiti diversi se vuoi autorizzare token OAuth2 per più API. Questa impostazione è facoltativa.

Se utilizzi OAuth2Mode == APPLICATION, devi impostare le seguenti chiavi di configurazione aggiuntive.

  • OAuth2RefreshToken: imposta questo valore su un token di aggiornamento OAuth2 pregenerato se vuoi riutilizzare i token OAuth2. Questa impostazione è facoltativa.
  • OAuth2RedirectUri: imposta questo valore sull'URL di reindirizzamento OAuth2. Questa impostazione è facoltativa.

Per maggiori dettagli, consulta le seguenti guide:

Se utilizzi OAuth2Mode == SERVICE_ACCOUNT, devi impostare le seguenti chiavi di configurazione aggiuntive.

  • OAuth2PrnEmail: imposta questo valore sull'indirizzo email dell'account che stai rappresentando.
  • OAuth2SecretsJsonPath: imposta questo valore sul percorso del file di configurazione JSON OAuth2.

Per maggiori dettagli, consulta la guida Flusso del service account OAuth.

Impostazioni di trasporto

Impostazioni dell'API Google Ads

Le seguenti impostazioni sono specifiche dell'API Google Ads.

  • DeveloperToken: impostalo sul tuo token sviluppatore.
  • LoginCustomerId: l'ID cliente del cliente autorizzato da utilizzare nella richiesta, senza trattini (-).
  • LinkedCustomerId: questa intestazione è obbligatoria solo per i metodi che aggiornano le risorse di un'entità quando l'autorizzazione viene concessa tramite gli account collegati nell'interfaccia utente Google Ads (risorsa AccountLink nell'API Google Ads). Imposta questo valore sull'ID cliente del fornitore di dati che aggiorna le risorse dell'ID cliente specificato. Deve essere impostato senza trattini (-). Scopri di più sugli account collegati.