A biblioteca de cliente .NET

A biblioteca de cliente .NET está hospedada no GitHub e é distribuída como um pacote NuGet. Ela oferece vários recursos para ajudar você a usar a API, incluindo um gerenciamento mais fácil de credenciais e a criação de clientes de serviço da API Google Ads.

A biblioteca é compatível com os seguintes frameworks .NET:

  • .NET Framework 4.7.2 e versões mais recentes (net472)
  • .NET Standard 2.1 (netstandard2.1)
  • .NET 8.0 (net8.0)

O .NET Standard 2.1 é compatível com várias outras versões e implementações do .NET, então a biblioteca pode funcionar bem em muitas outras plataformas. No entanto, não testamos oficialmente a compatibilidade e, portanto, não oferecemos suporte oficial a essas plataformas. Consulte a documentação do.NET Standard 2.1 para saber mais.

A biblioteca .NET da API Google Ads usa Grpc.Net.Client como a camada de transporte padrão, com um substituto para Grpc.Core em plataformas não compatíveis. Embora seja possível forçar o uso de Grpc.Core definindo UseGrpcCore como true, observe que Grpc.Core foi descontinuado e destina-se apenas à manutenção legada. Consulte o guia de uso básico para saber mais.

Instalação

Instale o pacote NuGet Google.Ads.GoogleAds no seu projeto usando a ferramenta de linha de comando dotnet:

dotnet add package Google.Ads.GoogleAds

Para carregar as definições de configuração de appsettings.json, App.config ou variáveis de ambiente, instale também o pacote Google.Ads.GoogleAds.Extensions:

dotnet add package Google.Ads.GoogleAds.Extensions

Fazer sua primeira chamada de API

Para usar a API Google Ads, você precisa seguir várias etapas para ter acesso à API e configurar suas contas do Google Ads. Siga o guia de início rápido, que mostra todas as etapas importantes, incluindo a configuração das suas contas do Google Ads.

Uso básico

Inicialize GoogleAdsConfig e GoogleAdsClient com suas definições de configuração, recupere GoogleAdsServiceClient e transmita linhas de campanha com SearchStream:

using System;
using Google.Ads.Gax.Config;
using Google.Ads.GoogleAds.Config;
using Google.Ads.GoogleAds.Lib;
using Google.Ads.GoogleAds.V26.Errors;
using Google.Ads.GoogleAds.V26.Services;

GoogleAdsConfig config = new GoogleAdsConfig()
{
    OAuth2Mode = OAuth2Flow.APPLICATION,
    OAuth2ClientId = "INSERT_CLIENT_ID.apps.googleusercontent.com",
    OAuth2ClientSecret = "INSERT_CLIENT_SECRET",
    OAuth2RefreshToken = "INSERT_REFRESH_TOKEN",
    LoginCustomerId = "INSERT_LOGIN_CUSTOMER_ID_HERE"
};

GoogleAdsClient client = new GoogleAdsClient(config);
GoogleAdsServiceClient googleAdsService =
    client.GetService(Services.V26.GoogleAdsService);

string customerId = "INSERT_CUSTOMER_ID_HERE";
string query =
    "SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id";

try
{
    googleAdsService.SearchStream(
        customerId,
        query,
        delegate (SearchGoogleAdsStreamResponse response)
        {
            foreach (GoogleAdsRow row in response.Results)
            {
                Console.WriteLine(
                    $"Campaign ID {row.Campaign.Id}: {row.Campaign.Name}");
            }
        });
}
catch (GoogleAdsException ex)
{
    Console.WriteLine($"Request ID {ex.RequestId} failed: {ex.Message}");
}

Consulte o guia de uso básico para saber mais sobre como usar a biblioteca de cliente .NET.

Autorização e autenticação

A biblioteca de cliente .NET é compatível com várias abordagens de autenticação e autorização, incluindo credenciais de usuário do OAuth 2.0 (para aplicativos para computador e Web), contas de serviço, Application Default Credentials (v24.1.0 e mais recentes) e injeção manual de credenciais (v27.0.0 e mais recentes). Consulte o guia de autorização e autenticação para saber mais.

Configuração e geração de registros

A biblioteca de cliente .NET é compatível com várias opções de configuração e geração de registros usando objetos de ambiente de execução, appsettings.json ou arquivos JSON personalizados, variáveis de ambiente ou arquivos App.config. Se você precisar modificar o comportamento de geração de registros da biblioteca de cliente, consulte o guia do interceptador gRPC personalizado.

Utilitários

A biblioteca de cliente .NET inclui classes de utilitários para melhorar a usabilidade da API, incluindo auxiliares de upload de mídia e vídeo (UploadVideo em v27.2.0 e versões mais recentes). Consulte os guias a seguir para saber mais:

Ajustar o desempenho do aplicativo

Consulte o guia de ajuste de desempenho para recomendações sobre como ajustar o desempenho do aplicativo.