Questa pagina è stata tradotta dall'API Cloud Translation.

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 esecuzione

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

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 Google.Ads.GoogleAds.Extensions package nel tuo progetto.

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

Configurazione tramite App.config

Tutte le impostazioni specifiche di Google Ads API sono memorizzate nel nodo GoogleAdsApi del file App.config. Una configurazione App.config tipica è 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);

Specifica un file App.config separato

Se non vuoi che App.config sia troppo pieno, puoi spostare la configurazione specifica della libreria nel relativo file di configurazione utilizzando la proprietà configSource.

Passaggio 1: specifica un valore configSource in App.config

Modifica App.config in questo modo:

<?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 progetto. Modifica le proprietà di questo file in Copia sempre nella cartella di output.

Ora crea ed esegui il progetto. L'applicazione inizierà a rilevare i valori dal nuovo file di configurazione.

Configurazione utilizzando 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 al 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 utilizzando settings.json

La procedura è simile all'utilizzo di un JSON personalizzato, tranne per il fatto che le chiavi devono essere in una sezione denominata GoogleAdsApi:

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

Successivamente, puoi utilizzare l'istanza IConfiguration nella 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 .NET di Google Ads.

Impostazioni di connettività

Timeout: utilizza questa chiave per impostare il timeout del servizio in millisecondi. Il valore predefinito viene 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 almeno 2 ore, ma l'API potrebbe comunque scadere per le richieste estremamente lunghe e restituire un errore DEADLINE_EXCEEDED.
ProxyServer: imposta questo valore sull'URL del server proxy HTTP se utilizzi un proxy per connetterti a internet.
ProxyUser: imposta il nome utente necessario per eseguire l'autenticazione sul server proxy. Lascia vuoto questo campo se non è richiesto un nome utente.
ProxyPassword: imposta la password di ProxyUser se imposti un valore per ProxyUser.
ProxyDomain: imposta questo valore sul dominio per ProxyUser se il tuo server proxy richiede l'impostazione di un valore.
MaxReceiveMessageLengthInBytes: utilizza questa impostazione per aumentare le dimensioni massime della risposta dell'API che la libreria client può gestire. Il valore predefinito è 64 MB.
MaxMetadataSizeInBytes: utilizza questa impostazione per aumentare le dimensioni massime della risposta all'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 al fatto che le dimensioni del messaggio (423184132 bytes) sono superiori a quelle che la libreria può gestire (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 molto grande (ad esempio un grande SearchGoogleAdsResponse). Ciò potrebbe avere implicazioni sul rendimento del codice a causa dell'heap di oggetti grandi di .NET. Se questo diventa un problema di prestazioni, potresti dover scoprire come riorganizzare le chiamate API o riprogettare parti dell'app.

Impostazioni OAuth2

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

AuthorizationMethod: impostato su OAuth2.
OAuth2Mode: imposta su APPLICATION o SERVICE_ACCOUNT.
OAuth2ClientId: imposta questo valore sul tuo ID client OAuth2.
OAuth2ClientSecret: imposta questo valore sul tuo client secret OAuth2.
OAuth2Scope: imposta questo valore su ambiti diversi se vuoi autorizzare i 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 ulteriori 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 di cui stai usurpando l'identità.
OAuth2SecretsJsonPath: imposta questo valore sul percorso del file di configurazione JSON OAuth2.

Per ulteriori dettagli, consulta la guida sul flusso dell'account di servizio OAuth.

Impostazioni di trasporto

UseGrpcCore: imposta questa impostazione su true per utilizzare la libreria Grpc.Core come livello di trasporto sottostante. Vedi Utilizzare la libreria Grpc precedente.

Impostazioni dell'API Google Ads

Le seguenti impostazioni sono specifiche per l'API Google Ads.

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