Realiza una llamada a la API

Esta guía requiere varios parámetros de configuración de requisitos previos que se establecieron en pasos anteriores. Comienza con Introducción si todavía no lo has hecho.

Esta guía también usa tokens de actualización, un flujo de trabajo en el que un usuario con suficientes acceso a la cuenta de Google Ads puede autorizar a tu aplicación, en una configuración única, a realizar llamadas a la API sin conexión a la cuenta sin ninguna otra intervención del usuario Puedes utilizar tokens de actualización para crear ambos flujos de trabajo sin conexión, como los trabajos cron. o canalizaciones de datos, y flujos de trabajo interactivos, como apps web o para dispositivos móviles.

Cómo recuperar un token de actualización

La API de Google Ads utiliza OAuth 2.0 como mecanismo de autorización. De forma predeterminada, OAuth La autenticación 2.0 emite un token de acceso que vence después de un período tiempo. Para renovar el token de acceso automáticamente, debes emitir una actualización token en su lugar.

  1. Ejecuta el comando Herramienta oauth2l:

    oauth2l fetch --credentials credentials.json --scope adwords \
    --output_format refresh_token

    El archivo credentials.json es de un modelo anterior paso a paso.

  2. El comando oauth2l abre la ventana de acceso de una Cuenta de Google en un navegador nuevo y te guiará a través de los pasos de autenticación de OAuth 2.0.

    Asegúrate de acceder con la dirección de correo electrónico que se indicó en el paso en el que identificó su ID de cliente de acceso.

    Si tu app no está verificada, es posible que veas una pantalla de advertencia. En esos casos, puedes hacer clic en el vínculo Mostrar opciones avanzadas y, luego, la opción Ir a PROJECT_NAME (no verificado).

  3. Después de verificar los permisos, otórgales haciendo clic en el botón Botón Continuar.

    Se mostrará un mensaje en el navegador con el siguiente texto:

    Authorization code granted. Please close this tab.

    El comando oauth2l genera el siguiente fragmento JSON:

    {
  "client_id": "******.apps.googleusercontent.com",
  "client_secret": "******",
  "token_uri": "https://oauth2.googleapis.com/token",
  "auth_uri": "https://accounts.google.com/o/oauth2/auth",
  "refresh_token": "******",
  "type": "authorized_user"
}

Realiza una llamada a la API

Selecciona el cliente que prefieras para obtener instrucciones sobre cómo realizar una llamada a la API:

Java

Los artefactos de la biblioteca cliente se publican en la plataforma Maven central Cloud Storage. Agrega la biblioteca cliente como una dependencia para tu proyecto de la siguiente manera:

La dependencia de Maven es la siguiente:

<dependency>
  <groupId>com.google.api-ads</groupId>
  <artifactId>google-ads</artifactId>
  <version>33.0.0</version>
</dependency>

La dependencia de Gradle es la siguiente:

implementation 'com.google.api-ads:google-ads:33.0.0'

Crea un archivo ~/ads.properties con el siguiente contenido:

api.googleads.clientId=INSERT_CLIENT_ID_HERE
api.googleads.clientSecret=INSERT_CLIENT_SECRET_HERE
api.googleads.refreshToken=INSERT_REFRESH_TOKEN_HERE
api.googleads.developerToken=INSERT_DEVELOPER_TOKEN_HERE
api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE

Crea un objeto GoogleAdsClient de la siguiente manera:

GoogleAdsClient googleAdsClient = null;
try {
  googleAdsClient = GoogleAdsClient.newBuilder().fromPropertiesFile().build();
} catch (FileNotFoundException fnfe) {
  System.err.printf(
      "Failed to load GoogleAdsClient configuration from file. Exception: %s%n",
      fnfe);
  System.exit(1);
} catch (IOException ioe) {
  System.err.printf("Failed to create GoogleAdsClient. Exception: %s%n", ioe);
  System.exit(1);
}

A continuación, ejecuta un informe de campaña con GoogleAdsService.SearchStream para recuperar las campañas de tu cuenta. En esta guía, no se abarcan detalles de los informes

  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#

Los paquetes de la biblioteca cliente se publican en la página Nuget.org Cloud Storage. Comienza por agregar un Referencia nuget al paquete Google.Ads.GoogleAds.

dotnet add package Google.Ads.GoogleAds --version 18.1.0

Crea un objeto GoogleAdsConfig con la configuración relevante y úsalo para Crea un objeto GoogleAdsClient.

GoogleAdsConfig config = new GoogleAdsConfig()
{
    DeveloperToken = "******",
    OAuth2Mode = "APPLICATION",
    OAuth2ClientId = "******.apps.googleusercontent.com",
    OAuth2ClientSecret = "******",
    OAuth2RefreshToken = "******",
    LoginCustomerId = ******
};
GoogleAdsClient client = new GoogleAdsClient(config);

A continuación, ejecuta un informe de campaña con GoogleAdsService.SearchStream para recuperar las campañas de tu cuenta. En esta guía, no se abarcan detalles de los informes

  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

Los paquetes de la biblioteca cliente se publican en el Packagist Cloud Storage. Cambiar a directorio raíz de tu proyecto y ejecuta el siguiente comando para instalar la biblioteca y todas sus dependencias en el directorio vendor/ de tu directorio raíz del proyecto.

composer require googleads/google-ads-php:22.0.0

Haz una copia de la google_ads_php.ini desde el repositorio de GitHub y modificarlo para incluir tus credenciales.

[GOOGLE_ADS]
developerToken = "INSERT_DEVELOPER_TOKEN_HERE"
loginCustomerId = "INSERT_LOGIN_CUSTOMER_ID_HERE"

[OAUTH2]
clientId = "INSERT_OAUTH2_CLIENT_ID_HERE"
clientSecret = "INSERT_OAUTH2_CLIENT_SECRET_HERE"
refreshToken = "INSERT_OAUTH2_REFRESH_TOKEN_HERE"

Crea una instancia del objeto GoogleAdsClient.

$oAuth2Credential = (new OAuth2TokenBuilder())
    ->fromFile('/path/to/google_ads_php.ini')
    ->build();

$googleAdsClient = (new GoogleAdsClientBuilder())
    ->fromFile('/path/to/google_ads_php.ini')
    ->withOAuth2Credential($oAuth2Credential)
    ->build();

A continuación, ejecuta un informe de campaña con GoogleAdsService.SearchStream para recuperar las campañas de tu cuenta. En esta guía, no se abarcan detalles de los informes

  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

La biblioteca cliente se distribuye en PyPI se pueden instalar con el comando pip de la siguiente manera:

python -m pip install google-ads==21.3.0

Crea una copia de google-ads.yaml desde el repositorio de GitHub y modificarlo para incluir tus credenciales.

client_id: INSERT_OAUTH2_CLIENT_ID_HERE
client_secret: INSERT_OAUTH2_CLIENT_SECRET_HERE
refresh_token: INSERT_REFRESH_TOKEN_HERE
developer_token: INSERT_DEVELOPER_TOKEN_HERE
login_customer_id: INSERT_LOGIN_CUSTOMER_ID_HERE

Crea una instancia de GoogleAdsClient llamando al GoogleAdsClient.load_from_storage. Pasa la ruta a tu google-ads.yaml como una cadena para el método cuando se lo llama:

from google.ads.googleads.client import GoogleAdsClient
client = GoogleAdsClient.load_from_storage("path/to/google-ads.yaml")

A continuación, ejecuta un informe de campaña con GoogleAdsService.SearchStream para recuperar las campañas de tu cuenta. En esta guía, no se abarcan detalles de los informes

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

Las gemas de Ruby para la biblioteca cliente se publican en la gema de Ruby de hosting. La forma recomendada instalar es mediante agrupador. Agrega una línea a tu Gemfile:

gem 'google-ads-googleads', '~> 30.0.0'

Luego, ejecute lo siguiente:

bundle install

Haz una copia de la google_ads_config.rb desde el repositorio de GitHub y modificarlo para incluir tus credenciales.

Google::Ads::GoogleAds::Config.new do |c|
  c.client_id = 'INSERT_CLIENT_ID_HERE'
  c.client_secret = 'INSERT_CLIENT_SECRET_HERE'
  c.refresh_token = 'INSERT_REFRESH_TOKEN_HERE'
  c.developer_token = 'INSERT_DEVELOPER_TOKEN_HERE'
  c.login_customer_id = 'INSERT_LOGIN_CUSTOMER_ID_HERE'
end

Para crear una instancia de GoogleAdsClient, pasa la ruta de acceso a donde la guardas .

client = Google::Ads::GoogleAds::GoogleAdsClient.new('path/to/google_ads_config.rb')

A continuación, ejecuta un informe de campaña con GoogleAdsService.SearchStream para recuperar las campañas de tu cuenta. En esta guía, no se abarcan detalles de los informes

  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

La biblioteca se distribuye en CPAN. Para comenzar, clona el archivo google-ads-perl en el directorio que elijas.

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

Cambia al directorio google-ads-perl y ejecuta el siguiente comando en el símbolo del sistema para instalar todas las dependencias necesarias para usar la biblioteca.

cd google-ads-perl
cpan install Module::Build
perl Build.PL
perl Build installdeps

Haz una copia de la googleads.properties desde el repositorio de GitHub y modificarlo para incluir tus credenciales.

clientId=INSERT_OAUTH2_CLIENT_ID_HERE
clientSecret=INSERT_OAUTH2_CLIENT_SECRET_HERE
refreshToken=INSERT_OAUTH2_REFRESH_TOKEN_HERE
developerToken=INSERT_DEVELOPER_TOKEN_HERE
loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE

Para crear una instancia de Client, pasa la ruta de acceso a la ubicación en la que guardas este archivo.

my $properties_file = "/path/to/googleads.properties";

my $api_client = Google::Ads::GoogleAds::Client->new({
  properties_file => $properties_file
});

A continuación, ejecuta un informe de campaña con GoogleAdsService.SearchStream para recuperar las campañas de tu cuenta. En esta guía, no se abarcan detalles de los informes

  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

REST

Comienza con un cliente HTTP para recuperar un token de acceso de OAuth 2.0. Esta guía usa el comando curl.

curl \
  --data "grant_type=refresh_token" \
  --data "client_id=CLIENT_ID" \
  --data "client_secret=CLIENT_SECRET" \
  --data "refresh_token=REFRESH_TOKEN" \
  https://www.googleapis.com/oauth2/v3/token

A continuación, ejecuta un informe de campaña con GoogleAdsService.SearchStream para recuperar las campañas de tu cuenta. En esta guía, no se abarcan detalles de los informes

curl -i -X POST https://googleads.googleapis.com/v17/customers/CUSTOMER_ID/googleAds:searchStream \
   -H "Content-Type: application/json" \
   -H "Authorization: Bearer ACCESS_TOKEN" \
   -H "developer-token: DEVELOPER_TOKEN" \
   -H "login-customer-id: LOGIN_CUSTOMER_ID" \
   --data-binary "@query.json"

El contenido de query.json es el siguiente:

{
  "query": "SELECT campaign.id, campaign.name, campaign.network_settings.target_content_network FROM campaign ORDER BY campaign.id"
}
Anterior
Descargar herramientas y bibliotecas
Siguiente
Errores comunes