Bibliotecas cliente

Nuestras bibliotecas cliente proporcionan vistas de alto nivel y elementos básicos de la funcionalidad de la API de Google Ads, lo que facilita el desarrollo de apps con rapidez. Te recomendamos que comiences con uno si es la primera vez que usas la API.

Biblioteca cliente	Fuente	Distribución	Ejemplos de código
Java	google-ads-java	Maven, tar.gz	Ver en GitHub
.NET	google-ads-dotnet	nuget, tar.gz, zip	Ver en GitHub
PHP	google-ads-php	tar.gz	Ver en GitHub
Python	google-ads-python	tar.gz, zip	Ver en GitHub
Ruby	google-ads-ruby	gem, tar.gz, zip	Ver en GitHub
Perl	google-ads-perl	tar.gz, zip	Ver en GitHub

Bibliotecas comunitarias

Sabemos de varias bibliotecas que mantiene la comunidad de código abierto. Mantenemos esta lista para ayudar a los desarrolladores interesados a encontrarlas. No probamos estas bibliotecas, ni contribuimos a ellas ni las mantenemos. Úsalas bajo tu propio riesgo. Si tienes alguna pregunta, comunícate con los propietarios de los proyectos de código abierto.

Si conoces una biblioteca que no incluimos, haz clic en Enviar comentarios en la parte superior de la página y comunícate con nosotros.

• NodeJS: https://www.npmjs.com/package/google-ads-api

• Ve a https://github.com/shenzhencenter/google-ads-pb.

Versiones de API compatibles

En la tabla, se muestra qué bibliotecas cliente funcionan con qué versiones de la API.

Java

API de Google Ads	Biblioteca cliente para Java
v19	Min: 36.0.0 Max: -
v18	Min: 34.0.0 Max: -
v17	Min: 32.0.0 Max: -

C#

API de Google Ads	Biblioteca cliente para .NET
v19	Min: 22.1.0 Max: -
v18	Min: 21.1.0 Max: -
v17	Min: 20.1.0 Max: -
v16	Min: 18.1.0 Max: 21.1.0

PHP

API de Google Ads	Biblioteca cliente para PHP
v19	Min: 26.1.0 Max: -
v18	Min: 25.0.0 Max: -
v17	Min: 23.1.0 Max: -

Python

API de Google Ads	Biblioteca cliente para Python
v19	Min: 25.2.0 Max: -
v18	Min: 25.1.0 Max: -
v17	Min: 24.1.0 Max: -
v16	Min: 23.1.0 Max: -

Ruby

API de Google Ads	Biblioteca cliente para Ruby
v19	Min: 32.0.0 Max: -
v18	Min: 31.0.0 Max: -
v17	Min: 29.0.0 Max: -

Perl

API de Google Ads	Biblioteca cliente para Perl
v19	Min: 26.0.0 Max: -
v18	Min: 25.0.1 Max: -
v17	Min: 23.0.0 Max: -

Configuración

Cada biblioteca cliente de la API de Google Ads proporciona diferentes parámetros de configuración y métodos de carga que puedes usar para personalizar su comportamiento.

Estas son las variables de entorno que son comunes a todas las bibliotecas cliente y que se pueden cargar para establecer la configuración:

• Biblioteca cliente
  • GOOGLE_ADS_CONFIGURATION_FILE_PATH: Es la ruta de acceso al archivo de configuración.
• OAuth2
  • Modo de aplicación
    • GOOGLE_ADS_CLIENT_ID : Establece este valor en tu ID de cliente de OAuth2.
    • GOOGLE_ADS_CLIENT_SECRET : Establece este valor en el secreto del cliente de OAuth2.
    • GOOGLE_ADS_REFRESH_TOKEN : Establece este valor en un token de actualización de OAuth2 generado previamente si deseas volver a usar tokens de OAuth2. Este parámetro de configuración es opcional.
  • Modo de cuenta de servicio
    • GOOGLE_ADS_JSON_KEY_FILE_PATH : Establece este valor en la ruta de acceso del archivo de configuración de JSON de OAuth2.
    • GOOGLE_ADS_IMPERSONATED_EMAIL : Establece este valor en la dirección de correo electrónico de la cuenta de la que te estás apropiando.
• API de Google Ads
  • GOOGLE_ADS_DEVELOPER_TOKEN : Establece este valor en tu token de desarrollador.
  • GOOGLE_ADS_LOGIN_CUSTOMER_ID : Es el ID del cliente autorizado que se debe usar en la solicitud, sin guiones (-).
  • GOOGLE_ADS_LINKED_CUSTOMER_ID : Este encabezado solo es obligatorio para los métodos que actualizan los recursos de una entidad cuando se otorga permiso a través de las cuentas vinculadas en la IU de Google Ads (recurso AccountLink en la API de Google Ads). Establece este valor en el ID de cliente del proveedor de datos que actualiza los recursos del ID de cliente especificado. Debe establecerse sin guiones (-). Para obtener más información sobre las cuentas vinculadas, visita el Centro de ayuda.

Nota: Para obtener más detalles sobre cómo usarlas y cualquier variable de entorno adicional específica de la biblioteca cliente, consulta las guías de configuración de cada biblioteca cliente: Java, .NET, PHP, Python, Ruby y Perl.

Por lo general, las variables de entorno se definen en un archivo de configuración de Bash, como un archivo .bashrc o .bash_profile ubicado en el directorio $HOME. También se pueden definir con la línea de comandos.

Nota: En estas instrucciones, se da por sentado que usas Bash. Si usas un shell diferente, consulta la documentación para ver los comandos equivalentes.

Estos son algunos pasos básicos para definir una variable de entorno con un archivo .bashrc en una terminal:

# Append the line "export GOOGLE_ADS_CLIENT_ID=1234567890" to
# the bottom of your .bashrc file.
echo "export GOOGLE_ADS_CLIENT_ID=1234567890" >> ~/.bashrc

# Update your bash environment to use the most recently updated
# version of your .bashrc file.
src ~/.bashrc

Las variables de entorno también se pueden configurar en la instancia de la terminal directamente desde la línea de comandos:

export GOOGLE_ADS_CLIENT_ID=1234567890

Otra alternativa es configurar las variables de entorno cuando llames al comando que las usa:

GOOGLE_ADS_CLIENT_ID=1234567890 php /path/to/script/that/uses/envvar.php

Cómo recuperar entidades

Por lo general, GoogleAdsService.SearchStream se usa para recuperar entidades, y los resultados se muestran como un flujo de filas. Como alternativa, puedes usar GoogleAdsService.Search para recuperar entidades a través de una conexión a Internet poco confiable. GoogleAdsService.Search muestra los resultados como tamaños de página fijos de 10,000 filas por página.

Nuestra biblioteca cliente implementa la paginación automáticamente cuando iteras los resultados para que puedas descargarlos y procesarlos de forma secuencial todos a la vez.

Java

private void runExample(GoogleAdsClient googleAdsClient, long customerId) {
  try (GoogleAdsServiceClient googleAdsServiceClient =
      googleAdsClient.getLatestVersion().createGoogleAdsServiceClient()) {
    String query = "SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id";
    // Constructs the SearchGoogleAdsStreamRequest.
    SearchGoogleAdsStreamRequest request =
        SearchGoogleAdsStreamRequest.newBuilder()
            .setCustomerId(Long.toString(customerId))
            .setQuery(query)
            .build();

    // Creates and issues a search Google Ads stream request that will retrieve all campaigns.
    ServerStream<SearchGoogleAdsStreamResponse> stream =
        googleAdsServiceClient.searchStreamCallable().call(request);

    // Iterates through and prints all of the results in the stream response.
    for (SearchGoogleAdsStreamResponse response : stream) {
      for (GoogleAdsRow googleAdsRow : response.getResultsList()) {
        System.out.printf(
            "Campaign with ID %d and name '%s' was found.%n",
            googleAdsRow.getCampaign().getId(), googleAdsRow.getCampaign().getName());
      }
    }
  }
}
GetCampaigns.java
      

C#

public void Run(GoogleAdsClient client, long customerId)
{
    // Get the GoogleAdsService.
    GoogleAdsServiceClient googleAdsService = client.GetService(
        Services.V19.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";

    try
    {
        // Issue a search request.
        googleAdsService.SearchStream(customerId.ToString(), query,
            delegate (SearchGoogleAdsStreamResponse resp)
            {
                foreach (GoogleAdsRow googleAdsRow in resp.Results)
                {
                    Console.WriteLine("Campaign with ID {0} and name '{1}' was found.",
                        googleAdsRow.Campaign.Id, googleAdsRow.Campaign.Name);
                }
            }
        );
    }
    catch (GoogleAdsException e)
    {
        Console.WriteLine("Failure:");
        Console.WriteLine($"Message: {e.Message}");
        Console.WriteLine($"Failure: {e.Failure}");
        Console.WriteLine($"Request ID: {e.RequestId}");
        throw;
    }
}
GetCampaigns.cs
      

PHP

public static function runExample(GoogleAdsClient $googleAdsClient, int $customerId)
{
    $googleAdsServiceClient = $googleAdsClient->getGoogleAdsServiceClient();
    // Creates a query that retrieves all campaigns.
    $query = 'SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id';
    // Issues a search stream request.
    /** @var GoogleAdsServerStreamDecorator $stream */
    $stream = $googleAdsServiceClient->searchStream(
        SearchGoogleAdsStreamRequest::build($customerId, $query)
    );

    // Iterates over all rows in all messages and prints the requested field values for
    // the campaign in each row.
    foreach ($stream->iterateAllElements() as $googleAdsRow) {
        /** @var GoogleAdsRow $googleAdsRow */
        printf(
            "Campaign with ID %d and name '%s' was found.%s",
            $googleAdsRow->getCampaign()->getId(),
            $googleAdsRow->getCampaign()->getName(),
            PHP_EOL
        );
    }
}
GetCampaigns.php
      

Python

def main(client, customer_id):
    ga_service = client.get_service("GoogleAdsService")

    query = """
        SELECT
          campaign.id,
          campaign.name
        FROM campaign
        ORDER BY campaign.id"""

    # Issues a search request using streaming.
    stream = ga_service.search_stream(customer_id=customer_id, query=query)

    for batch in stream:
        for row in batch.results:
            print(
                f"Campaign with ID {row.campaign.id} and name "
                f'"{row.campaign.name}" was found.'
            )
get_campaigns.py
      

Ruby

def get_campaigns(customer_id)
  # GoogleAdsClient will read a config file from
  # ENV['HOME']/google_ads_config.rb when called without parameters
  client = Google::Ads::GoogleAds::GoogleAdsClient.new

  responses = client.service.google_ads.search_stream(
    customer_id: customer_id,
    query: 'SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id',
  )

  responses.each do |response|
    response.results.each do |row|
      puts "Campaign with ID #{row.campaign.id} and name '#{row.campaign.name}' was found."
    end
  end
end
get_campaigns.rb
      

Perl

sub get_campaigns {
  my ($api_client, $customer_id) = @_;

  # Create a search Google Ads stream request that will retrieve all campaigns.
  my $search_stream_request =
    Google::Ads::GoogleAds::V19::Services::GoogleAdsService::SearchGoogleAdsStreamRequest
    ->new({
      customerId => $customer_id,
      query      =>
        "SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id"
    });

  # Get the GoogleAdsService.
  my $google_ads_service = $api_client->GoogleAdsService();

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

  # Issue a search request and process the stream response to print the requested
  # field values for the campaign in each row.
  $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};
    });

  return 1;
}
get_campaigns.pl
      

Ejemplos de código

Consulta nuestros ejemplos de código de algunas funciones comunes en la API de Google Ads.