Cómo comenzar

Java

A continuación, se incluye un ejemplo básico que muestra cómo usar la biblioteca cliente de Java. Para obtener información de uso más detallada, consulta el archivo README en la distribución de la biblioteca cliente.

1. Configura tus credenciales

   Ejecuta el siguiente comando en una shell:

   curl https://raw.githubusercontent.com/googleads/googleads-java-lib/main/examples/admanager_axis/src/main/resources/ads.properties -o ~/ads.properties

   Abre el archivo ~/ads.properties y propaga los siguientes campos:

   [...]
   api.admanager.applicationName=INSERT_APPLICATION_NAME_HERE
   api.admanager.jsonKeyFilePath=INSERT_PATH_TO_JSON_KEY_FILE_HERE
   api.admanager.networkCode=INSERT_NETWORK_CODE_HERE
   [...]

2. Especifica dependencias

   Edita tu archivo pom.xml y agrega lo siguiente a la etiqueta dependencies. Puedes encontrar el número de versión más reciente en GitHub.

   <dependency>
     <groupId>com.google.api-ads</groupId>
     <artifactId>ads-lib</artifactId>
     <version>RELEASE</version>
   </dependency>
   <dependency>
     <groupId>com.google.api-ads</groupId>
     <artifactId>dfp-axis</artifactId>
     <version>RELEASE</version>
   </dependency>

3. Escribe código y realiza una solicitud.

   import com.google.api.ads.common.lib.auth.OfflineCredentials;
   import com.google.api.ads.common.lib.auth.OfflineCredentials.Api;
   import com.google.api.ads.admanager.axis.factory.AdManagerServices;
   import com.google.api.ads.admanager.axis.v202308.Network;
   import com.google.api.ads.admanager.axis.v202308.NetworkServiceInterface;
   import com.google.api.ads.admanager.lib.client.AdManagerSession;
   import com.google.api.client.auth.oauth2.Credential;
   
   public class App {
     public static void main(String[] args) throws Exception {
       Credential oAuth2Credential = new OfflineCredentials.Builder()
           .forApi(Api.AD_MANAGER)
           .fromFile()
           .build()
           .generateCredential();
   
       // Construct an AdManagerSession.
       AdManagerSession session = new AdManagerSession.Builder()
           .fromFile()
           .withOAuth2Credential(oAuth2Credential)
           .build();
   
       // Construct a Google Ad Manager service factory, which can only be used once per
       // thread, but should be reused as much as possible.
       AdManagerServices adManagerServices = new AdManagerServices();
   
       // Retrieve the appropriate service
       NetworkServiceInterface networkService = adManagerServices.get(session,
           NetworkServiceInterface.class);
   
       // Make a request
       Network network = networkService.getCurrentNetwork();
   
       System.out.printf("Current network has network code '%s' and display" +
           " name '%s'.%n", network.getNetworkCode(), network.getDisplayName());
     }
   }
   

   Ver en GitHub

Python

A continuación, presentamos un ejemplo básico que muestra cómo usar la biblioteca cliente Python. La biblioteca cliente de Python es compatible con Python v3.6 y versiones posteriores. Para obtener información de uso más detallada, consulta el archivo README en la distribución de la biblioteca cliente.

1. Instala la biblioteca y configura tus credenciales.

   Ejecuta los siguientes comandos en un shell:

   pip install googleads
   curl https://raw.githubusercontent.com/googleads/googleads-python-lib/main/googleads.yaml \
        -o ~/googleads.yaml
   

2. Configura el archivo ~/googleads.yaml.

   Complete los siguientes campos:

   ad_manager:
     application_name: INSERT_APPLICATION_NAME_HERE
     network_code: INSERT_NETWORK_CODE_HERE
     path_to_private_key_file: INSERT_PATH_TO_FILE_HERE
   

3. Ejecuta código y haz una solicitud.

   # Import the library.
   from googleads import ad_manager
   
   # Initialize a client object, by default uses the credentials in ~/googleads.yaml.
   client = ad_manager.AdManagerClient.LoadFromStorage()
   
   # Initialize a service.
   network_service = client.GetService('NetworkService', version='v202308')
   
   # Make a request.
   current_network = network_service.getCurrentNetwork()
   
   print("Current network has network code '%s' and display name '%s'." %
           (current_network['networkCode'], current_network['displayName']))
   

   Ver en GitHub

PHP

A continuación, te mostramos un ejemplo básico que muestra cómo usar la biblioteca cliente PHP.

1. Instala la biblioteca y configura tus credenciales.

   Ejecuta los siguientes comandos en un shell para instalar la biblioteca cliente y descarga el archivo adsapi_php.ini a tu directorio principal:

   composer require googleads/googleads-php-lib
   curl https://raw.githubusercontent.com/googleads/googleads-php-lib/main/examples/AdManager/adsapi_php.ini -o ~/adsapi_php.ini

2. Configura el archivo ~/adsapi_php.ini.

   Complete los siguientes campos:

   [AD_MANAGER]
   networkCode = "INSERT_NETWORK_CODE_HERE"
   applicationName = "INSERT_APPLICATION_NAME_HERE"
   
   [OAUTH2]
   jsonKeyFilePath = "INSERT_ABSOLUTE_PATH_TO_OAUTH2_JSON_KEY_FILE_HERE"
   scopes = "https://www.googleapis.com/auth/dfp"
   

3. Ejecuta código y haz una solicitud.

   <?php
   require 'vendor/autoload.php';
   use Google\AdsApi\AdManager\AdManagerSession;
   use Google\AdsApi\AdManager\AdManagerSessionBuilder;
   use Google\AdsApi\AdManager\v202308\ApiException;
   use Google\AdsApi\AdManager\v202308\ServiceFactory;
   use Google\AdsApi\Common\OAuth2TokenBuilder;
   
   // Generate a refreshable OAuth2 credential for authentication.
   $oAuth2Credential = (new OAuth2TokenBuilder())
       ->fromFile()
       ->build();
   // Construct an API session configured from a properties file and the OAuth2
   // credentials above.
   $session = (new AdManagerSessionBuilder())
       ->fromFile()
       ->withOAuth2Credential($oAuth2Credential)
       ->build();
   
   // Get a service.
   $serviceFactory = new ServiceFactory();
   $networkService = $serviceFactory->createNetworkService($session);
   
   // Make a request
   $network = $networkService->getCurrentNetwork();
   printf(
       "Network with code %d and display name '%s' was found.\n",
       $network->getNetworkCode(),
       $network->getDisplayName()
   );
   

   Ver en GitHub

.NET

A continuación, te mostramos un ejemplo básico en el que se muestra cómo usar la biblioteca cliente .NET.

1. Crea un proyecto nuevo

   Abre Visual Studio y crea un proyecto nuevo (aplicación de Console).

2. Agrega a tu proyecto referencias de biblioteca obligatorias

   Agrega una dependencia de nuget para Google.Dfp.

3. Configura tu app.config

   Copia src\App.config al directorio de tu proyecto y agrégalo al proyecto. Si tu aplicación tiene su propio App.config, puedes copiar los siguientes nodos en tu app.config:

   • configuración/AdManagerApi
   • configuración/configSections/section[name="AdManagerApi"]
   • configuración/system.net
4. Configuración de credenciales

   Abre App.config y edita las siguientes claves:

   <add key="ApplicationName" value="INSERT_YOUR_APPLICATION_NAME_HERE" />
   <add key="NetworkCode" value="INSERT_YOUR_NETWORK_CODE_HERE" />
   <add key="OAuth2Mode" value="SERVICE_ACCOUNT" />
   <add key="OAuth2SecretsJsonPath" value="INSERT_OAUTH2_SECRETS_JSON_FILE_PATH_HERE" />
   

5. Cómo hacer una llamada a la biblioteca

   Puedes llamar a la biblioteca como se muestra en el siguiente fragmento de código de C#

   Ver en GitHub

   AdManagerUser user = new AdManagerUser();
         using (InventoryService inventoryService = user.GetService<InventoryService>())
               {
                   // Create a statement to select ad units.
                   int pageSize = StatementBuilder.SUGGESTED_PAGE_LIMIT;
                   StatementBuilder statementBuilder =
                       new StatementBuilder().OrderBy("id ASC").Limit(pageSize);
   
                   // Retrieve a small amount of ad units at a time, paging through until all
                   // ad units have been retrieved.
                   int totalResultSetSize = 0;
                   do
                   {
                       AdUnitPage page =
                           inventoryService.getAdUnitsByStatement(statementBuilder.ToStatement());
   
                       // Print out some information for each ad unit.
                       if (page.results != null)
                       {
                           totalResultSetSize = page.totalResultSetSize;
                           int i = page.startIndex;
                           foreach (AdUnit adUnit in page.results)
                           {
                               Console.WriteLine(
                                   "{0}) Ad unit with ID \"{1}\" and name \"{2}\" was found.", i++,
                                   adUnit.id, adUnit.name);
                           }
                       }
   
                       statementBuilder.IncreaseOffsetBy(pageSize);
                   } while (statementBuilder.GetOffset() < totalResultSetSize);
   
                   Console.WriteLine("Number of results found: {0}", totalResultSetSize);
               }
           

Si no quieres establecer tus credenciales en la configuración de la app, consulta este artículo de wiki para conocer formas alternativas de usar la clase AdManagerUser. Para obtener información más detallada sobre el uso de la biblioteca cliente de .NET, consulta el archivo README . Si deseas desarrollar en .NET sin la biblioteca cliente, consulta el artículo de wiki NoClientLibrary.

Ruby

A continuación, se incluye un ejemplo básico que muestra cómo usar la biblioteca cliente Ruby. La biblioteca cliente de Ruby requiere Ruby 2.1 o una versión posterior.

1. Instalar la gema de Ruby y obtener el archivo de configuración

   Ejecuta los siguientes comandos en un shell:

   gem install google-dfp-api
   curl https://raw.githubusercontent.com/googleads/google-api-ads-ruby/main/ad_manager_api/ad_manager_api.yml -o ~/ad_manager_api.yml
   

2. Configura tus credenciales

   Propaga los campos obligatorios en el archivo ~/ad_manager_api.yml. Si aún no tienes un archivo de claves de OAuth2, deberás seguir los pasos para crear tus credenciales de OAuth2.

   :authentication:
     :oauth2_keyfile: INSERT_PATH_TO_JSON_KEY_FILE_HERE
     :application_name: INSERT_APPLICATION_NAME_HERE
     :network_code: INSERT_NETWORK_CODE_HERE
   

3. Escribe código y realiza una solicitud.

   # Import the library.
   require 'ad_manager_api'
   
   # Initialize an Ad Manager client instance (uses credentials in ~/ad_manager_api.yml by default).
   ad_manager = AdManagerApi::Api.new
   
   # Get a service instance.
   network_service = ad_manager.service(:NetworkService, :v202308)
   
   # Make a request.
   network = network_service.get_current_network()
   
   puts "The current network is %s (%d)." %
           [network[:display_name], network[:network_code]]
   

   Ver en GitHub

Puedes encontrar pasos más detallados para comenzar en el archivo README que se distribuye con la biblioteca cliente de Ruby. Además, consulta nuestra biblioteca de ejemplo completa para Ruby.