Uso básico

El uso básico de la biblioteca cliente es el siguiente:

Instalación

La forma recomendada de instalar la biblioteca es con Bundler. Agrega una línea a tu Gemfile (reemplaza x.y.z por el número de versión que quieras usar):

gem 'google-ads-googleads', '~> x.y.z'

Luego, ejecute lo siguiente:

bundle install

Este comando usa Bundler para actualizar tu Gemfile.lock, lo que bloquea la versión exacta de la gema y todas las dependencias de la gema que se instalaron. El operador de versión pesimista "~> x.y.z" garantiza que bundle install o bundle update solo instalen versiones de parches nuevas en la serie x.y.*, por lo que debes habilitar de forma manual las versiones secundarias o principales nuevas actualizando tu Gemfile.

Otras opciones de instalación

Si no usas Bundler, puedes usar una de estas opciones:

  1. Instala esta biblioteca con RubyGems:

    gem install google-ads-googleads

  2. Descarga la gema de la página de versiones y, luego, instálala desde el archivo local:

    gem install google-ads-googleads-[version].gem

Configura la autenticación

Para autenticar tus llamadas a la API, configura tu archivo google_ads_config.rb y sigue las instrucciones de la página Autenticación y autorización.

Uso

A partir de la versión 41.1.0 de google-ads-googleads, la gema admite el requisito automático de Bundler (Bundler.require). En las versiones anteriores a la v41.1.0 (o cuando no se usa Bundler.require), se requiere explícitamente la gema en tu código:

require 'google/ads/google_ads'

Inicializa el cliente (que carga la configuración desde ~/google_ads_config.rb de forma predeterminada) y recupera un servicio específico, como CampaignService:

# Initialize the client using ~/google_ads_config.rb.
client = Google::Ads::GoogleAds::GoogleAdsClient.new

# Fetch the CampaignService client.
campaign_service = client.service.campaign

Consulta los ejemplos en GitHub para obtener demostraciones más detalladas sobre cómo usar la biblioteca.

Una vez que te familiarices con los ejemplos, explora las fábricas, que proporcionan un conjunto de métodos de conveniencia de alto nivel para trabajar con la API de Google Ads.

Manejo de errores

No todas las llamadas a la API se realizan correctamente. El servidor genera excepciones si las llamadas a la API fallan. Es importante capturar los errores de la API y controlarlos de forma adecuada.

Se genera una instancia de Google::Ads::GoogleAds::Errors::GoogleAdsError cuando se produce un error de la API. Contiene detalles que te ayudarán a determinar qué salió mal, y puedes configurar una función auxiliar para controlar los errores. Consulta un ejemplo de un controlador de errores en GitHub.