A biblioteca de cliente Perl

A biblioteca de cliente Perl está hospedada no GitHub, e o pacote está disponível no CPAN.

A biblioteca é compatível com a versão 5.28.1 ou mais recente do Perl.

Protocolo da API REST

Observação: a API Google Ads expõe endpoints REST JSON padrão e uma interface gRPC de alto desempenho. Como o Perl não é uma linguagem compatível na pilha do gRPC, essa biblioteca de cliente é implementada no protocolo JSON REST por HTTP 1.1.

As entidades de classe, como serviço, recurso, tipo enumerado e erro, na biblioteca de cliente do Perl são geradas pela análise das definições de buffer de protocolo. Para saber mais sobre como os dados estruturados são serializados, consulte a documentação do buffer de protocolo.

Para se conectar à API Google Ads, a biblioteca de cliente cria uma solicitação HTTP em JSON, envia-a ao endpoint REST por HTTP 1.1, desserializa a resposta como um objeto JSON e interpreta os resultados.

Instalar a biblioteca

A biblioteca de cliente Perl está hospedada no GitHub e é distribuída usando o CPAN.

Instalar do CPAN

Instale a distribuição Google::Ads::GoogleAds::Client diretamente do CPAN usando cpanm (ou cpan):

cpanm Google::Ads::GoogleAds::Client

Observação: cada versão de Google::Ads::GoogleAds::Client agrupa módulos específicos da API Google Ads em lib/Google/Ads/GoogleAds/ (em que as versões secundárias da API, como v25.1, são incluídas no módulo da versão principal, V25). Consulte a tabela de versões compatíveis da API para saber mais sobre a compatibilidade de versões.

Criar da origem e executar exemplos

Para executar os exemplos de código incluídos ou criar a biblioteca usando o código-fonte:

1. Clone a biblioteca do GitHub:

   git clone https://github.com/googleads/google-ads-perl.git
   

2. Mude para o diretório google-ads-perl:

   cd google-ads-perl
   

   Você verá alguns arquivos e subdiretórios:

   • Build.PL: o arquivo de build do Perl, que contém as dependências e os tipos de teste desse projeto.
   • lib: código-fonte da biblioteca.
   • t: casos de teste do código da biblioteca.
   • examples: muitos exemplos que demonstram como usar a biblioteca para executar casos de uso comuns usando a API Google Ads.
   • googleads.properties: o arquivo de configuração de amostra da biblioteca.
   • log4perl.conf: o arquivo de configuração de geração de registros de amostra.

3. Instale as dependências necessárias e crie a biblioteca. O arquivo Build.PL lista todas as dependências necessárias para a biblioteca. Para instalá-los, execute os seguintes comandos:

   cpan install Module::Build
   perl Build.PL
   ./Build installdeps
   ./Build
   ./Build install
   

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 Google::Ads::GoogleAds::Client (que carrega as credenciais de ~/googleads.properties ou GOOGLE_ADS_CONFIGURATION_FILE_PATH por padrão) e transmita as linhas da campanha usando SearchStreamHandler:

use strict;
use warnings;
use Google::Ads::GoogleAds::Client;
use Google::Ads::GoogleAds::Utils::SearchStreamHandler;
use Google::Ads::GoogleAds::V26::Services::GoogleAdsService::SearchGoogleAdsStreamRequest;

my $api_client = Google::Ads::GoogleAds::Client->new();
my $google_ads_service = $api_client->GoogleAdsService();

my $search_stream_request =
  Google::Ads::GoogleAds::V26::Services::GoogleAdsService::SearchGoogleAdsStreamRequest
  ->new({
    customerId => "INSERT_CUSTOMER_ID_HERE",
    query      =>
      "SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id"
  });

my $search_stream_handler =
  Google::Ads::GoogleAds::Utils::SearchStreamHandler->new({
    service => $google_ads_service,
    request => $search_stream_request
  });

$search_stream_handler->process_contents(
  sub {
    my $google_ads_row = shift;
    printf "Campaign with ID %d and name '%s' was found.\n",
      $google_ads_row->{campaign}{id},
      $google_ads_row->{campaign}{name};
  });

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

Autenticação e autorização

A biblioteca de cliente Perl é compatível com várias abordagens de autenticação e autorização. Consulte o guia Autenticação e autorização para saber mais.

Configuração e geração de registros

A biblioteca de cliente Perl usa googleads.properties para configuração e log4perl.conf para geração de registros. É possível modificar esses arquivos para personalizar o comportamento da biblioteca. Consulte os guias de Configuração e Geração de registros para saber mais.

Utilitários

A biblioteca de cliente Perl inclui classes de utilitários para melhorar a usabilidade da API. Consulte os guias a seguir para saber mais:

• Máscaras de campo
• Nomes de recursos

Ajustar o desempenho do aplicativo

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