Esegui una chiamata API

Questa guida richiede diverse impostazioni dei prerequisiti che sono state configurate in passaggi precedenti. Inizia con Introduzione se non l'hai ancora fatto.

Questa guida utilizza anche i token di aggiornamento, un flusso di lavoro in cui un utente l'accesso all'account Google Ads può autorizzare la tua app, in una configurazione una tantum, a effettuare chiamate API offline all'account senza alcun intervento da parte dell'utente. Puoi utilizzare i token di aggiornamento per creare entrambi i flussi di lavoro offline, ad esempio cron job o pipeline di dati, nonché flussi di lavoro interattivi come app web o per dispositivi mobili.

Recupera un token di aggiornamento

L'API Google Ads utilizza OAuth 2.0 come meccanismo di autorizzazione. Per impostazione predefinita, OAuth L'autenticazione 2.0 emette un token di accesso che scade dopo un periodo limitato nel tempo. Per rinnovare automaticamente il token di accesso, devi eseguire un aggiornamento .

  1. Genera il token di aggiornamento eseguendo il comando Strumento oauth2l:

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

    Il file credentials.json è di una precedente passaggio.

  2. Il comando oauth2l apre una finestra di accesso all'Account Google in un nuovo browser e che guiderà nella procedura di autenticazione OAuth 2.0.

    Assicurati di accedere utilizzando l'indirizzo email indicato nel passaggio in cui identificato il tuo ID cliente di accesso.

    Se la tua app non è verificata, potresti visualizzare una schermata di avviso. In questi casi, puoi fare clic sul link Mostra impostazioni avanzate e poi su l'opzione Vai a PROJECT_NAME (non verificato).

  3. Dopo aver verificato gli ambiti, concedi l'autorizzazione facendo clic sul Pulsante Continua.

    Nel browser viene visualizzato un prompt con il seguente testo:

    Authorization code granted. Please close this tab.

    Il comando oauth2l restituisce il seguente snippet 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"
}

Esegui una chiamata API

Seleziona il client che preferisci per istruzioni su come effettuare una chiamata API:

Java

Gli artefatti della libreria client vengono pubblicati su Maven central un repository attendibile. Aggiungi la libreria client come dipendenza dal progetto, come segue:

La dipendenza Maven è:

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

La dipendenza di Gradle è:

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

Crea un file ~/ads.properties con i seguenti contenuti:

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 oggetto GoogleAdsClient come segue:

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);
}

Successivamente, crea un report sulla campagna utilizzando GoogleAdsService.SearchStream per recuperare le campagne nel tuo account. Questa guida non tratta gli argomenti dettagli dei report.

  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#

I pacchetti della libreria client vengono pubblicati su Nuget.org un repository attendibile. Per iniziare, aggiungi riferimento nuget al pacchetto Google.Ads.GoogleAds.

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

Crea un oggetto GoogleAdsConfig con le impostazioni pertinenti e utilizzalo per un oggetto GoogleAdsClient.

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

Successivamente, crea un report sulla campagna utilizzando GoogleAdsService.SearchStream per recuperare le campagne nel tuo account. Questa guida non tratta gli argomenti dettagli dei report.

  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

I pacchetti della libreria client vengono pubblicati in Packagist un repository attendibile. Cambia in alla directory radice del progetto ed esegui questo comando per installare la libreria e tutte le sue dipendenze nella directory vendor/ delle nella directory radice del progetto.

composer require googleads/google-ads-php:22.0.0

Crea una copia del google_ads_php.ini dal repository GitHub e modificarlo in modo da includere le tue credenziali.

[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 un'istanza dell'oggetto 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();

Successivamente, crea un report sulla campagna utilizzando GoogleAdsService.SearchStream per recuperare le campagne nel tuo account. Questa guida non tratta gli argomenti dettagli dei report.

  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 libreria client è distribuita tramite PyPI può essere installata utilizzando il comando pip come segue:

python -m pip install google-ads==21.3.0

Crea una copia del google-ads.yaml dal repository GitHub e modificarlo in modo da includere le tue credenziali.

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 un'istanza GoogleAdsClient chiamando il metodo Metodo GoogleAdsClient.load_from_storage. Passa il percorso verso google-ads.yaml come stringa al metodo quando viene chiamato:

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

Successivamente, crea un report sulla campagna utilizzando GoogleAdsService.SearchStream per recuperare le campagne nel tuo account. Questa guida non tratta gli argomenti dettagli dei report.

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

Le gemme Ruby per la libreria client sono pubblicate nella gemma Rubygems sito di hosting. Metodo consigliato da installare usa bundler. Aggiungi una riga al tuo file Gemfile:

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

Dopodiché, esegui:

bundle install

Crea una copia del google_ads_config.rb dal repository GitHub e modificarlo in modo da includere le tue credenziali.

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

Crea un'istanza GoogleAdsClient passando il percorso in cui lo conservi .

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

Successivamente, crea un report sulla campagna utilizzando GoogleAdsService.SearchStream per recuperare le campagne nel tuo account. Questa guida non tratta gli argomenti dettagli dei report.

  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 libreria è distribuita su CPAN. Per iniziare, clona Repository google-ads-perl nella directory di tua scelta.

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

Passa alla directory google-ads-perl ed esegui questo comando all'indirizzo al prompt dei comandi per installare tutte le dipendenze necessarie per l'utilizzo della libreria.

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

Crea una copia del googleads.properties dal repository GitHub e modificarlo in modo da includere le tue credenziali.

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

Crea un'istanza Client passando il percorso in cui conservi il file.

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

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

Successivamente, crea un report sulla campagna utilizzando GoogleAdsService.SearchStream per recuperare le campagne nel tuo account. Questa guida non tratta gli argomenti dettagli dei report.

  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

Per iniziare, utilizza un client HTTP per recuperare un token di accesso OAuth 2.0. Questa guida usa il 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

Successivamente, crea un report sulla campagna utilizzando GoogleAdsService.SearchStream per recuperare le campagne nel tuo account. Questa guida non tratta gli argomenti dettagli dei report.

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"

I contenuti di query.json sono i seguenti:

{
  "query": "SELECT campaign.id, campaign.name, campaign.network_settings.target_content_network FROM campaign ORDER BY campaign.id"
}
Indietro
Scaricare strumenti e librerie
Avanti
Errori comuni