Bibliotecas cliente

Nuestras bibliotecas cliente ofrecen vistas de alto nivel y componentes básicos de la funcionalidad de la API de Google Ads, que facilita el desarrollo rápido de aplicaciones. Recomendaciones comenzando con uno si recién comienzas a usar la API.

Biblioteca cliente	Fuente	Distribución	Ejemplos de código
Java	google-ads-java	Maven y 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 y zip	Ver en GitHub
Ruby	google-ads-rubí	gem, tar.gz y zip	Ver en GitHub
Perl	google-ads-perl	tar.gz y zip	Ver en GitHub

Versiones de API compatibles

La tabla muestra qué bibliotecas cliente funcionan con qué versiones de API.

Java

API de Google Ads	Biblioteca cliente para Java
v17	Min: 32.0.0 Max::
v16	Min: 30.0.0 Max::
v15	Min: 28.0.0 Max::

C#

API de Google Ads	Biblioteca cliente para .NET
v17	Min: 20.1.0 Max::
v16	Min: 18.1.0 Max::
v15	Min: 17.1.0 Max::

PHP

API de Google Ads	Biblioteca cliente para PHP
v17	Min: 23.1.0 Max::
v16	Min: 22.1.0 Max::
v15	Min: 21.1.0 Max::

Python

API de Google Ads	Biblioteca cliente para Python
v17	Min: 24.1.0 Max::
v16	Min: 23.1.0 Max::
v15	Min: 22.1.0 Max::

Rita

API de Google Ads	Biblioteca cliente para Ruby
v17	Min: 29.0.0 Max::
v16	Min: 27.0.0 Max::
v15	Min: 25.0.0 Max::

Perl

API de Google Ads	Biblioteca cliente para Perl
v17	Min: 23.0.0 Max::
v16	Min: 21.0.0 Max::
v15	Min: 19.0.0 Max::

Configuración

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

Estas son las variables de entorno comunes a todas las bibliotecas cliente y que se puede cargar para establecer los parámetros de configuración:

• Biblioteca cliente
  • GOOGLE_ADS_CONFIGURATION_FILE_PATH: Ruta de acceso al archivo de configuración.
• OAuth2
  • Modo de aplicación
    • GOOGLE_ADS_CLIENT_ID : Establece este valor como tu ID de cliente de OAuth2.
    • GOOGLE_ADS_CLIENT_SECRET : Establece este valor en tu secreto de cliente de OAuth2.
    • GOOGLE_ADS_REFRESH_TOKEN : Establece este valor como un token de actualización de OAuth2 generado previamente. si quieres reutilizar tokens de OAuth2. Esta configuración es opcional.
  • Modo de cuenta de servicio
    • GOOGLE_ADS_JSON_KEY_FILE_PATH : Establece este valor en la configuración JSON de OAuth2. ruta de acceso al archivo.
    • GOOGLE_ADS_IMPERSONATED_EMAIL : Establece este valor como la dirección de correo electrónico de la cuenta que estás suplantando.
• API de Google Ads
  • GOOGLE_ADS_DEVELOPER_TOKEN : Establece esto como tu token de desarrollador.
  • GOOGLE_ADS_LOGIN_CUSTOMER_ID : Este es el ID de cliente del cliente autorizado que se utilizará. en la solicitud, sin guiones (-).
  • GOOGLE_ADS_LINKED_CUSTOMER_ID : Este encabezado solo es necesario para los métodos que actualizan el recursos de una entidad cuando se otorga el permiso de Cuentas vinculadas en la IU de Google Ads (recurso AccountLink en la API de Google Ads). Establece este valor al ID de cliente del proveedor de datos que actualiza los recursos de la el ID de cliente especificado. Se debe establecer sin guiones (-). Para obtener más información acerca de las cuentas vinculadas, visite el Centro de ayuda.

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

Las variables de entorno se definen comúnmente en un archivo de configuración Bash como como un archivo .bashrc o .bash_profile, ubicado en el directorio $HOME. Ellas también se puede definir con la línea de comandos.

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

Estos son algunos pasos básicos para definir una variable de entorno mediante un .bashrc con 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 tu instancia de terminal directamente desde la línea de comandos:

export GOOGLE_ADS_CLIENT_ID=1234567890

Otra alternativa es establecer variables de entorno cuando se llama al comando que los usa:

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

Buscar paginación

GoogleAdsService.Search es normalmente se usan en apps interactivas que muestran páginas de resultados.

Nuestra biblioteca cliente implementa automáticamente Paging cuando iteras los resultados para que puedas de forma secuencial, descargar y procesar todos a la vez, por ejemplo:

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

Rita

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::V17::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
      

Según el caso de uso, es posible que debas hacer lo siguiente:

• Optimizar la cantidad de páginas que se recuperan
• Optimiza la cantidad de resultados que se almacenan a la vez.
• Descargar y procesar las páginas de resultados en un orden específico

Para ello, se pueden almacenar los tokens de la página en lugar de los resultados, lo que agrega más complejidad a tu código.

Ejemplos de código

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