Como começar

Este guia oferece uma breve visão geral de como começar a usar a biblioteca .NET da API Google Ads.

Instalação

Os binários da biblioteca de cliente são distribuídos com o NuGet. Adicione uma referência NuGet ao pacote Google.Ads.GoogleAds (em inglês) no projeto para usar a biblioteca de cliente.

configurar a autorização

Para autorizar suas chamadas de API, especifique o ID, a chave secreta, o token de atualização e o token de desenvolvedor do cliente na biblioteca.

Se você precisar gerar credenciais

Se você já tiver credenciais

  • Copie o nó GoogleAdsApi e a seção GoogleAdsApi abaixo do nó configSections do arquivo App.config no GitHub para o arquivo App.config / Web.config. Se você usou o NuGet para instalar o pacote, esses nós serão inseridos automaticamente no arquivo App.config / Web.config.
  • Inclua o token do desenvolvedor, o ID do cliente, a chave secreta do cliente e o token de atualização no App.config / Web.config do app.

O arquivo App.config incluído no GitHub está bem documentado, mas você também pode consultar o guia de configuração para saber mais e usar outras maneiras de configurar a biblioteca de cliente, como variáveis de ambiente.

Fazer uma chamada de API

O uso básico da biblioteca de cliente é o seguinte:

// 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.

Criar uma instância do GoogleAdsClient

As classes mais importantes na biblioteca .NET da API Google Ads são a GoogleAdsClient. Ele permite criar uma classe de serviço pré-configurada que pode ser usada para fazer chamadas de API. GoogleAdsClient fornece um construtor padrão que cria um objeto de usuário usando as configurações especificadas no App.config / Web.config do app. Consulte o guia de configuração para conferir as opções de configuração.

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

Criar um serviço

GoogleAdsClient fornece um método GetService que pode ser usado para criar um serviço de anúncios.

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

Fornecemos uma classe Services que enumera todas as versões e serviços da API compatíveis. O método GetService aceita esses objetos de enumeração como argumento ao criar o serviço. Por exemplo, para criar uma instância de CampaignServiceClient para a versão V18 da API Google Ads, você precisa chamar o método GoogleAdsClient.GetService com Services.V18.CampaignService como argumento, conforme mostrado no exemplo anterior.

Segurança de linha de execução

Não é seguro compartilhar uma instância GoogleAdsClient entre várias linhas de execução, porque as mudanças de configuração feitas em uma instância em uma linha de execução podem afetar os serviços criados em outras linhas de execução. Operações como a obtenção de novas instâncias de serviço de uma instância GoogleAdsClient e a realização de chamadas para vários serviços em paralelo são seguras para linhas de execução.

Um aplicativo multithread ficaria assim:

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.
  ...
}

Evitar congelamentos em aplicativos .NET Framework

Os métodos síncronos podem fazer com que alguns dos seus aplicativos do .NET Framework congelem. Um exemplo comum é fazer chamadas de API usando um método de manipulador de eventos de um aplicativo WinForm.

Há duas maneiras de resolver esse problema:

  1. Usar a biblioteca Grpc legada.

    É possível definir a propriedade UseGrpcCore de GoogleAdsConfig para usar a biblioteca Grpc.Core legada em vez da biblioteca Grpc.Net.Client padrão. Esse método não foi testado extensivamente em aplicativos do .NET Framework. Portanto, ele pode não resolver o problema. Confira um exemplo de snippet:

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

    A página de suporte do gRPC tem mais detalhes sobre as diferenças entre a biblioteca Grpc.Core legada e a biblioteca Grpc.Net.Client padrão.

  2. Use métodos assíncronos.

    Você pode usar métodos assíncronos para evitar congelamentos. Veja alguns exemplos:

    SearchStream

    Uma chamada para SearchStream() é realizada, e os resultados são preenchidos em uma visualização em lista.

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

    Orçamento da campanha

    Uma chamada CampaignBudget é criada, e o nome do recurso do novo orçamento é exibido usando um alerta MessageBox.

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

Tratamento de erros

Nem todas as chamadas de API são bem-sucedidas. O servidor pode gerar erros se as chamadas de API falharem por algum motivo. É importante capturar e processar os erros de API adequadamente.

Uma instância GoogleAdsException é gerada quando ocorre um erro na API. Ele tem detalhes para ajudar você a descobrir o que deu errado:

// 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}");
}