Questa guida fornisce una breve panoramica su come iniziare a utilizzare la libreria .NET dell'API Google Ads.
Installazione
I file binari della libreria client vengono distribuiti tramite NuGet. Aggiungi un riferimento Nuget al pacchetto Google.Ads.GoogleAds
nel tuo progetto per utilizzare la libreria client.
configura le autorizzazioni
Per autorizzare le chiamate API, devi specificare ID client, client secret, token di aggiornamento e token sviluppatore nella libreria.
Se disponi già delle credenziali...
- Copia il nodo
GoogleAdsApi
e la sezioneGoogleAdsApi
sotto il nodoconfigSections
dal fileApp.config
in GitHub nel fileApp.config
/Web.config
. Se hai utilizzato NuGet per installare il pacchetto, questi nodi verranno inseriti automaticamente nel fileApp.config
/Web.config
. - Includi il token sviluppatore, l'ID client, il client secret e il token di aggiornamento
nei file
App.config
/Web.config
dell'app. Il fileApp.config
incluso in GitHub è ben documentato, ma puoi anche consultare la guida alla configurazione per saperne di più e per utilizzare impostazioni di configurazione alternative.
Se devi generare le credenziali...
- Segui la guida ai token sviluppatore per ottenere il tuo token sviluppatore, se non ne hai già uno.
- Segui la guida al flusso dell'app desktop OAuth per generare un ID client, un client secret e un token di aggiornamento.
- Copia il nodo
GoogleAdsApi
e la sezioneGoogleAdsApi
sotto il nodoconfigSections
dal fileApp.config
in GitHub nel fileApp.config
/Web.config
. Se hai utilizzato NuGet per installare il pacchetto, questi nodi verranno inseriti automaticamente nel fileApp.config
/Web.config
. - Includi il token sviluppatore, l'ID client, il client secret e il token di aggiornamento
nei file
App.config
/Web.config
dell'app. Il fileApp.config
incluso in GitHub è ben documentato, ma puoi anche consultare la guida alla configurazione per saperne di più e per utilizzare impostazioni di configurazione alternative.
Esegui una chiamata API
Di seguito è mostrato l'utilizzo di base della libreria client:
// 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.
Crea un'istanza di Google AdsClient
La classe più importante nella libreria .NET dell'API Google Ads è la
classe GoogleAdsClient
. Consente di creare una classe di servizio
preconfigurata da usare per chiamate API. GoogleAdsClient
fornisce un
costruttore predefinito che crea un oggetto utente utilizzando le impostazioni specificate in
App.config
/ Web.config
dell'app. Consulta la Guida alla configurazione per scoprire varie opzioni di configurazione.
// Create a new GoogleAdsClient with the App.config settings.
GoogleAdsClient user = new GoogleAdsClient();
Creare un servizio
GoogleAdsClient
fornisce un metodo GetService
che può essere utilizzato per creare un
servizio Google Ads.
CampaignServiceClient campaignService = client.GetService(Services.V17.CampaignService);
// Now make calls to CampaignService.
Forniamo una classe Services
che elenca tutte le versioni e tutti i servizi API supportati. Il metodo GetService
accetta questi oggetti di enumerazione come argomento
durante la creazione del servizio. Ad esempio, per creare un'istanza di
CampaignServiceClient
per la versione V17
dell'API Google Ads,
devi chiamare il metodo GoogleAdsClient.GetService
con
Services.V17.CampaignService
come argomento, come mostrato
sopra.
Sicurezza dei thread
Non è sicuro condividere un'istanza GoogleAdsClient
tra più thread,
dal momento che le modifiche alla configurazione che apporti su un'istanza in un thread potrebbero
influire sui servizi che crei in altri thread. Operazioni come l'ottenimento di nuove istanze di servizio da un'istanza GoogleAdsClient
, l'esecuzione di chiamate a più servizi in parallelo e così via sono sicure nei thread.
Un'applicazione multithread avrebbe un aspetto simile a questo:
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.
...
}
Evita i blocchi nelle applicazioni .NET Framework.
I metodi sincroni possono causare il blocco di alcune applicazioni .NET Framework. Un esempio comune è l'esecuzione di chiamate API da un metodo di gestore di eventi di un'applicazione WinForm.
Puoi risolvere il problema in due modi:
Utilizza la libreria Grpc precedente.
Puoi impostare la proprietà
UseGrpcCore
diGoogleAdsConfig
in modo che utilizzi la libreriaGrpc.Core
legacy anziché la libreriaGrpc.Net.Client
predefinita. Questo metodo non è stato testato in modo esaustivo su applicazioni .NET Framework, quindi potrebbe non risolvere il problema. Ecco uno snippet di esempio:GoogleAdsConfig config = new GoogleAdsConfig(); config.UseGrpcCore = true; GoogleAdsClient client = new GoogleAdsClient(config);
Utilizza metodi asincroni.
Puoi utilizzare metodi asincroni per evitare i blocchi. Ecco alcuni esempi:
SearchStream
Viene eseguita una chiamata a
SearchStream()
e i risultati vengono compilati in una visualizzazione elenco.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()); } Budget della campagna
Viene creata una chiamata CampaignBudget e il nome risorsa del nuovo budget viene visualizzato utilizzando un avviso
MessageBox
.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); }
Annullamento dei metodi asincroni
Per la programmazione asincrona, puoi utilizzare il parametro callSettings
per passare un
CancellationToken
:
CancellationTokenSource cancellationTokenSource = new CancellationTokenSource();
cancellationTokenSource.CancelAfter(3000);
CallSettings callSettings = CallSettings.FromCancellationToken(cancellationTokenSource.Token);
string query = "SELECT campaign.name FROM campaign";
var request = new SearchGoogleAdsStreamRequest()
{
CustomerId = customerId.ToString(),
Query = query,
};
GoogleAdsServiceClient googleAdsService = client.GetService(
Services.V17.GoogleAdsService);
googleAdsService.SearchStream(request,
delegate (SearchGoogleAdsStreamResponse resp)
{
foreach (GoogleAdsRow googleAdsRow in resp.Results)
{
// Process the row.
}
}, callSettings
);
Gestione degli errori
Non tutte le chiamate API avranno esito positivo. Il server può generare errori se le chiamate API non vanno a buon fine per qualche motivo. È importante acquisire gli errori relativi alle API e gestirli in modo appropriato.
Quando si verifica un errore dell'API, viene generata un'istanza GoogleAdsException
. e contiene dettagli per aiutarti a capire cosa è andato storto:
// 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}");
}