Esistono tre API che puoi utilizzare per interagire in modo programmatico con Authorized Buyers:
- API Marketplace: gestisci deal, pacchetti di aste e accesso client.
- API Real-time Bidding: gestisci le offerte, tra cui le quote QPS, il targeting e le creatività.
- (Obsoleto)API Buyer II di Ad Exchange: Questa API è obsoleta. Tutte le risorse diverse da quelle relative alla risoluzione dei problemi relativi all'RTB sono state ritirate.
Di seguito sono riportati alcuni esempi di attività che puoi completare utilizzando le API Authorized Buyers:
- Accedi ai dati dell'account per le offerte in tempo reale.
- Inviare e gestire le creatività in fase di revisione.
- Recupera le metriche per la risoluzione dei problemi relativi alle aste in tempo reale.
- Gestire gli elenchi di utenti di Authorized Buyers.
- Gestisci le configurazioni di pretargeting.
- Configura l'accesso dei client per Marketplace.
- Scopri e gestisci le proposte per i deal in Marketplace.
Se non hai dimestichezza con Authorized Buyers, consulta il Centro assistenza Authorized Buyers e la UI per saperne di più.
Link rapidi
Configura l'autenticazione
Le API di Google utilizzano il protocollo OAuth 2.0 per l'autenticazione e l'autorizzazione. Ecco come configurare l'autenticazione per l'API Real-time Bidding utilizzando OAuth 2.0.
Questo esempio utilizza un account di servizio. Per ulteriori dettagli sul controllo dell'accesso, consulta la documentazione di Identity Access Management di Google Cloud.
Dal menu a discesa del progetto, seleziona un progetto o creane uno nuovo.
Assicurati che nell'elenco API abilitate sia presente l'API Real-time Bidding. Se non è presente nell'elenco, fai clic sulla scheda API di Google, cerca e seleziona l'API Real-time Bidding e fai clic su Attiva API.
Nella barra laterale a sinistra, seleziona Credenziali.
Seleziona il menu a discesa Crea credenziali, quindi scegli Chiave account di servizio.
Nel menu a discesa Account di servizio, scegli Nuovo account di servizio.
Inserisci un nome per l'account di servizio. L'ID account di servizio viene generato automaticamente dal nome e dal nome del progetto.
Prendi nota dell'ID account di servizio: ti servirà per concedere l'accesso al nuovo account di servizio nell'interfaccia utente di Authorized Buyers nel passaggio 11.
Scegli il file JSON consigliato come Tipo di chiave.
Fai clic su Crea. Il file JSON con la coppia di chiavi pubblica/privata dell'account viene salvato nella cartella Download. Conserva il file JSON generato in un luogo sicuro.
Per consentirne il funzionamento, devi concedere all'account di servizio l'accesso nell'interfaccia utente di Authorized Buyers. Seleziona Impostazioni > Impostazioni account, poi scegli Gestione utenti > Utenti account e fai clic su +Account di servizio. Inserisci l'ID account di servizio che hai annotato sopra nel passaggio 8. Viene creato un nuovo utente con il ruolo dell'account di servizio.
Assicurati che più persone abbiano accesso amministrativo al tuo progetto cloud, nel caso in cui abbi bisogno di modificare le autorizzazioni.
Richiedi accesso API
Quando esegui la procedura di autorizzazione OAuth 2.0, la tua applicazione può specificare gli ambiti per richiedere l'accesso a determinate funzionalità per conto di altri Account Google. Utilizza i seguenti ambiti per ottenere accesso in lettura/scrittura a qualsiasi API Authorized Buyers per conto di un account Authorized Buyers:
- API Marketplace: https://www.googleapis.com/auth/authorized-buyers-marketplace
- API Real-time Bidding: https://www.googleapis.com/auth/realtime-bidding
- API Ad Exchange Buyer II: https://www.googleapis.com/auth/adexchange.buyer
Esegui una chiamata API
Ecco alcuni esempi che puoi utilizzare per iniziare nelle lingue supportate:
API Marketplace
Java
/*
* Copyright 2021 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.api.services.samples.authorizedbuyers.marketplace.v1;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.HttpRequestInitializer;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.json.JsonFactory;
import com.google.api.client.json.gson.GsonFactory;
import com.google.api.services.authorizedbuyersmarketplace.v1.AuthorizedBuyersMarketplace;
import com.google.api.services.authorizedbuyersmarketplace.v1.AuthorizedBuyersMarketplaceScopes;
import com.google.api.services.authorizedbuyersmarketplace.v1.model.Client;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;
import com.google.auth.oauth2.ServiceAccountCredentials;
import java.io.FileInputStream;
import java.io.IOException;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
/**
* A sample application that authenticates and runs a request against the Authorized Buyers
* Marketplace API.
*/
public class FirstApiRequest {
/**
* Be sure to specify the name of your application. If the application name is {@code null} or
* blank, the application will log a warning. Suggested format is "MyCompany-ProductName/1.0".
*/
private static final String APPLICATION_NAME = "APPLICATION_NAME_HERE";
// Full path to JSON Key file - include file name.
private static final java.io.File JSON_FILE = new java.io.File("INSERT_PATH_TO_JSON_FILE");
// Name of the buyer resource for which the API call is being made.
private static final String BUYER_NAME = "INSERT_BUYER_RESOURCE_NAME";
// Global instance of the HTTP transport.
private static HttpTransport httpTransport;
// Global instance of the JSON factory.
private static final JsonFactory jsonFactory = GsonFactory.getDefaultInstance();
public static void main(String[] args) throws Exception {
// Create credentials using the JSON key file.
GoogleCredentials credentials = null;
try (FileInputStream serviceAccountStream = new FileInputStream((JSON_FILE))) {
Set<String> scopes = new HashSet<>(AuthorizedBuyersMarketplaceScopes.all());
credentials = ServiceAccountCredentials.fromStream(serviceAccountStream).createScoped(scopes);
} catch (IOException ex) {
System.out.println("Can't complete authorization step. Did you specify a JSON key file?");
System.out.println(ex);
System.exit(1);
}
HttpRequestInitializer requestInitializer = new HttpCredentialsAdapter(credentials);
httpTransport = GoogleNetHttpTransport.newTrustedTransport();
// Use the credentials to create a client for the API service.
AuthorizedBuyersMarketplace marketplaceClient =
new AuthorizedBuyersMarketplace.Builder(httpTransport, jsonFactory, requestInitializer)
.setApplicationName(APPLICATION_NAME)
.build();
// Call the buyers.clients.list method to get a list of clients for the given buyer.
List<Client> clients =
marketplaceClient.buyers().clients().list(BUYER_NAME).execute().getClients();
if (clients != null && clients.size() > 0) {
System.out.printf("Listing of clients associated with buyer \"%s\"%n", BUYER_NAME);
for (Client client : clients) {
System.out.printf("* Client name: %s\n", client.getName());
}
} else {
System.out.printf(
"No clients were found that were associated with buyer \"%s\"%n.", BUYER_NAME);
}
}
}
Python
#!/usr/bin/python
#
# Copyright 2022 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Sample application that authenticates and makes an API request."""
import pprint
from googleapiclient.discovery import build
from google.oauth2 import service_account
# A Service Account key file can be generated via the Google Developers
# Console.
KEY_FILE = 'PATH_TO_JSON_KEY_FILE' # Path to Service Account JSON key file.
# Authorized Buyers Marketplace API authorization scope.
SCOPE = 'https://www.googleapis.com/auth/authorized-buyers-marketplace'
VERSION = 'v1' # Version of Authorized Buyers Marketplace API to use.
# Name of the buyer resource for which the API call is being made.
BUYER_NAME = 'BUYER_RESOURCE_NAME'
def main():
# Create credentials using the Service Account JSON key file.
credentials = service_account.Credentials.from_service_account_file(
KEY_FILE, scopes=[SCOPE])
# Build a client for the authorizedbuyersmarketplace API service.
marketplace = build('authorizedbuyersmarketplace', VERSION, credentials=credentials)
# Call the buyers.clients.list method to get a list of clients for the
# given buyer.
request = marketplace.buyers().clients().list(parent=BUYER_NAME)
pprint.pprint(request.execute())
if __name__ == '__main__':
main()
.NET
/* Copyright 2021 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied
* See the License for the specific language governing permissions and
* limitations under the License.
*/
using Google.Apis.AuthorizedBuyersMarketplace.v1;
using Google.Apis.AuthorizedBuyersMarketplace.v1.Data;
using Google.Apis.Auth.OAuth2;
using Google.Apis.Json;
using Google.Apis.Services;
using System;
using System.Collections.Generic;
namespace Google.Apis.AuthorizedBuyersMarketplace.Examples.v1
{
/// <summary>
/// Self contained sample to return a list of clients for a given buyer account.
/// Primarily used by the Getting Started guide:
/// https://developers.google.com/authorized-buyers/apis/getting_started
///
/// Note: To run this sample, you will need to configure it as the StartupObject in
/// Google.Apis.AuthorizedBuyersMarketplace.Examples.csproj.
/// </summary>
internal class FirstApiRequest
{
private static void Main(string[] args)
{
// See the README.md for details of these fields.
// Retrieved from https://console.developers.google.com
var ServiceKeyFilePath = "PATH TO JSON KEY FILE HERE";
// Name of the buyer resource for which the API call is being made.
var buyerName = "INSERT_BUYER_RESOURCE_NAME_HERE";
// Retrieve credential parameters from the key JSON file.
var credentialParameters = NewtonsoftJsonSerializer.Instance
.Deserialize<JsonCredentialParameters>(
System.IO.File.ReadAllText(ServiceKeyFilePath));
// Create the credentials.
var credentialInitializer = new ServiceAccountCredential.Initializer(
credentialParameters.ClientEmail)
{
Scopes = new[]
{
AuthorizedBuyersMarketplaceService.Scope.AuthorizedBuyersMarketplace
}
}.FromPrivateKey(credentialParameters.PrivateKey);
var oAuth2Credentials = new ServiceAccountCredential(credentialInitializer);
// Use the credentials to create a client for the API service.
var serviceInitializer = new BaseClientService.Initializer
{
HttpClientInitializer = oAuth2Credentials,
ApplicationName = "FirstAPICall"
};
var mkService = new AuthorizedBuyersMarketplaceService(serviceInitializer);
// Call the buyers.clients.list method to list clients for the given buyer.
BuyersResource.ClientsResource.ListRequest request =
mkService.Buyers.Clients.List(buyerName);
IList<Client> clients = request.Execute().Clients;
foreach (Client client in clients)
{
Console.WriteLine("* Client name: {0}", client.Name);
}
Console.ReadLine();
}
}
}
PHP
<?php
/**
* Copyright 2022 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Sample application that authenticates and makes an API request.
*/
namespace Google\Ads\AuthorizedBuyers\Marketplace\Examples\V1;
/**
* Provide path to client library. See README.md for details.
*/
require_once __DIR__ . '/../../vendor/autoload.php';
use Google_Client;
use Google_Service_AuthorizedBuyersMarketplace;
session_start();
/**
* You can retrieve this file from the Google Developers Console.
*
* See README.md for details.
*/
$keyFileLocation = "INSERT_PATH_TO_JSON_KEYFILE";
/**
* Name of the buyer resource for which the API call is being made.
*/
$buyerName = "INSERT_BUYER_RESOURCE_NAME";
if ($keyFileLocation === 'INSERT_PATH_TO_JSON_KEYFILE') {
print "WARNING: Authorization details not provided!\n";
exit(1);
}
$client = new Google_Client();
$client->setApplicationName('Authorized Buyers Marketplace API PHP Samples');
$service = new Google_Service_AuthorizedBuyersMarketplace($client);
$client->setAuthConfig($keyFileLocation);
$client->addScope('https://www.googleapis.com/auth/authorized-buyers-marketplace');
if ($client->isAccessTokenExpired()) {
$client->refreshTokenWithAssertion();
}
if ($client->getAccessToken()) {
// Call the buyers.clients.list method to get a list of clients for the given buyer.
$result = $service->buyers_clients->listBuyersClients($buyerName);
print "Clients associated with buyer account\n";
if (empty($result['clients'])) {
print "No clients found\n";
return;
} else {
foreach ($result['clients'] as $client) {
print_r($client);
}
}
}
Ruby
#!/usr/bin/env ruby
# Encoding: utf-8
#
# Copyright:: Copyright 2022 Google LLC
#
# License:: Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# Sample application that authenticates and makes an API request.
require 'google/apis/authorizedbuyersmarketplace_v1'
require 'googleauth/service_account'
# You can download the JSON keyfile used for authentication from the Google
# Developers Console.
KEY_FILE = 'path_to_key' # Path to JSON file containing your private key.
# Name of the buyer resource for which the API call is being made.
BUYER_NAME = 'insert_buyer_resource_name'
def first_api_request()
# Create credentials using the JSON key file.
auth_options = {
:json_key_io => File.open(KEY_FILE, "r"),
:scope => 'https://www.googleapis.com/auth/authorized-buyers-marketplace'
}
oauth_credentials = Google::Auth::ServiceAccountCredentials.make_creds(
options=auth_options
)
# Create the service and set credentials
marketplace = (
Google::Apis::AuthorizedbuyersmarketplaceV1::AuthorizedBuyersMarketplaceService.new
)
marketplace.authorization = oauth_credentials
marketplace.authorization.fetch_access_token!
begin
# Call the buyers.clients.list method to get list of clients for given buyer.
clients_list = marketplace.list_buyer_clients(BUYER_NAME)
if clients_list.clients.any?
puts "Found the following clients for buyer '%s':" % BUYER_NAME
clients_list.clients.each do |client|
puts "* Client name: #{client.name}"
end
else
puts "No clients were found that were associated with buyer '%s'" % BUYER_NAME
end
rescue Google::Apis::ServerError => e
raise "The following server error occured:\n%s" % e.message
rescue Google::Apis::ClientError => e
raise "Invalid client request:\n%s" % e.message
rescue Google::Apis::AuthorizationError => e
raise "Authorization error occured:\n%s" % e.message
end
end
if __FILE__ == $0
begin
first_api_request()
end
end
Real-time Bidding API
Java
Di seguito è riportato un esempio di base che mostra come utilizzare l'API Real-time Bidding con Java.
- Creare un progetto Maven
Apri il file pom.xml e aggiungi queste dipendenze:
<dependencies> <dependency> <groupId>com.google.api-client</groupId> <artifactId>google-api-client</artifactId> <version>1.32.2</version> </dependency> <dependency> <groupId>com.google.apis</groupId> <artifactId>google-api-services-pubsub</artifactId> <version>v1-rev452-1.25.0</version> </dependency> <dependency> <groupId>com.google.apis</groupId> <artifactId>google-api-services-realtimebidding</artifactId> <version>v1-rev20220503-1.32.1</version> </dependency> <dependency> <groupId>com.google.auth</groupId> <artifactId>google-auth-library-oauth2-http</artifactId> <version>1.3.0</version> </dependency> <dependency> <groupId>com.google.code.gson</groupId> <artifactId>gson</artifactId> <version>2.8.9</version> </dependency> <dependency> <groupId>com.google.http-client</groupId> <artifactId>google-http-client-jackson2</artifactId> <version>1.40.1</version> </dependency> <dependency> <groupId>joda-time</groupId> <artifactId>joda-time</artifactId> <version>2.10.13</version> </dependency> <dependency> <groupId>net.sourceforge.argparse4j</groupId> <artifactId>argparse4j</artifactId> <version>0.9.0</version> </dependency> </dependencies> - Configurare le credenziali
Tutte le chiamate all'API richiedono l'autenticazione. Crea un
Credentialutilizzando il file della chiave JSON dell'account di servizio discusso sopra.GoogleCredentials credentials = null; try (FileInputStream serviceAccountStream = new FileInputStream((JSON_FILE))) { Set<String> scopes = new HashSet<>(RealTimeBiddingScopes.all()); credentials = ServiceAccountCredentials.fromStream(serviceAccountStream).createScoped(scopes); } catch (IOException ex) { System.out.println("Can't complete authorization step. Did you specify a JSON key file?"); System.out.println(ex); System.exit(1); } - Creare un client per l'API Real-time Bidding
Puoi quindi creare il client dell'API Real-time Bidding utilizzando il pattern di Builder:
HttpRequestInitializer requestInitializer = new HttpCredentialsAdapter(credentials); httpTransport = GoogleNetHttpTransport.newTrustedTransport(); // Use the credentials to create a client for the API service. RealTimeBidding realtimeBidding = new RealTimeBidding.Builder(httpTransport, jsonFactory, requestInitializer) .setApplicationName(APPLICATION_NAME) .build(); - Eseguire un'operazione
Dopo aver creato un'istanza di un client per connetterti all'API, puoi eseguire un'operazione. Il codice seguente restituisce tutte le creatività di un determinato acquirente.
List<Creative> creatives = realtimeBidding .buyers() .creatives() .list(BUYER_NAME) .setView("FULL") .execute() .getCreatives(); if (creatives != null && creatives.size() > 0) { System.out.printf("Listing of creatives associated with buyer '%s'%n", BUYER_NAME); for (Creative creative : creatives) { System.out.printf("* Creative name: %s\n", creative.getName()); } } else { System.out.printf( "No creatives were found that were associated with buyer '%s'%n.", BUYER_NAME); }
Per informazioni più dettagliate sull'utilizzo dell'API Real-time Bidding con Java, consulta il file README negli esempi dell'API Real-time Bidding.
Python
Ecco un esempio di base che mostra come utilizzare l'API Real-time Bidding con Python.
- Scarica e installa il client Python dell'API di Google
Esempio di utilizzo di pip:
$ pip install --upgrade google-api-python-client
- Configurare le credenziali
Tutte le chiamate all'API richiedono l'autenticazione. Istantia un'istanza di
service_account.Credentialsutilizzando il file della chiave JSON dell'account di servizio discusso sopra.credentials = service_account.Credentials.from_service_account_file( KEY_FILE, scopes=[SCOPE]) - Creare un client per l'API Real-time Bidding
A questo punto, puoi creare il client dell'API Real-time Bidding utilizzando l'istanza
service_account.Credentialsautorizzata:realtimebidding = build('realtimebidding', VERSION, credentials=credentials) - Eseguire un'operazione
Dopo aver creato un'istanza di un client per connetterti all'API, puoi eseguire un'operazione. Il seguente codice restituisce tutte le creatività di un determinato acquirente.
request = realtimebidding.buyers().creatives().list(parent=BUYER_NAME) pprint.pprint(request.execute())
Per informazioni più dettagliate sull'utilizzo dell'API Buyer di Ad Exchange con Python, consulta il file README negli esempi dell'API Real-time Bidding.
PHP
Ecco un esempio di base che mostra come utilizzare l'API Real-time Bidding con PHP.
- Configurare le dipendenze
Se non l'hai ancora installato, scarica e installa Composer, quindi crea un file composer.json con contenuti come i seguenti:
{ "description": "Authorized Buyers Real-Time Bidding API PHP Samples", "require": { "php": ">=7.2", "google/apiclient": "^2.0" }, "require-dev": { "squizlabs/php_codesniffer": "3.*" }, "type": "project", "homepage": "https://github.com/googleads/authorized-buyers-rtb-api-samples/tree/master/php", "license": "Apache-2.0", "authors": [ { "name": "Google", "homepage": "https://github.com/googleads/authorized-buyers-rtb-api-samples/graphs/contributors" } ] }Infine, esegui questo comando per installare le librerie delle dipendenze:
composer install
- Configurare un cliente
Crea un
Google_Cliente utilizzalo per creare un'istanza diGoogle_Service_RealTimeBidding.$client = new Google_Client(); $client->setApplicationName('Authorized Buyers Real-time Bidding API PHP Samples'); $service = new Google_Service_RealTimeBidding($client); - Configurare le credenziali
Tutte le chiamate all'API richiedono un token di accesso valido. Configura il client in modo che svolga il flusso OAuth 2.0.
$client->setAuthConfig($keyFileLocation); $client->addScope('https://www.googleapis.com/auth/realtime-bidding'); if ($client->isAccessTokenExpired()) { $client->refreshTokenWithAssertion(); } - Eseguire un'operazione
Dopo aver creato un'istanza di un client per connetterti all'API e aver configurato OAuth 2.0, puoi utilizzarlo per effettuare una chiamata all'API. Il seguente codice restituisce tutte le creatività di un determinato acquirente:
$result = $service->buyers_creatives->listBuyersCreatives($buyerName, $queryParams); print "Creatives associated with buyer account\n"; if (empty($result['creatives'])) { print "No creatives found\n"; return; } else { foreach ($result['creatives'] as $creative) { print_r($creative); } }
Per informazioni più dettagliate sull'utilizzo dell'API Buyer di Ad Exchange con PHP, consulta il file README negli esempi dell'API Real-time Bidding.
.NET
Di seguito è riportato un esempio di base che mostra come utilizzare l'API Real-time Bidding con C#.
- Creare un nuovo progetto
Apri Visual Studio Code e crea un nuovo progetto.
- Aggiungere al progetto i riferimenti alla libreria richiesti
Nel file *.csproj del progetto, aggiungi una voce
PackageReferenceperGoogle.Apis,Google.Apis.Auth,Google.Apis.Core,Google.Apis.Oauth2.v2eGoogle.Apis.RealTimeBidding.v1. Ad esempio, l'URL potrebbe essere simile al seguente:<ItemGroup> <PackageReference Include="Google.Apis" Version="1.57.0" /> <PackageReference Include="Google.Apis.Auth" Version="1.57.0" /> <PackageReference Include="Google.Apis.Core" Version="1.57.0" /> <PackageReference Include="Google.Apis.Oauth2.v2" Version="1.57.0.1869" /> <PackageReference Include="Google.Apis.Pubsub.v1" Version="1.57.0.2667" /> <PackageReference Condition="!Exists('./Google.Apis.RealTimeBidding.v1.csproj')" Include="Google.Apis.RealTimeBidding.v1" Version="1.57.0.2680" /> <PackageReference Include="log4net" Version="2.0.13" /> <PackageReference Include="Microsoft.Extensions.Configuration" Version="3.1.4" /> <PackageReference Include="Microsoft.NETFramework.ReferenceAssemblies" Version="1.0.0"> <PrivateAssets>all</PrivateAssets> <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets> </PackageReference> <PackageReference Include="Mono.Options" Version="6.12.0.148" /> <PackageReference Include="Newtonsoft.Json" Version="13.0.1" /> </ItemGroup>Puoi trovare ulteriori informazioni su queste dipendenze all'indirizzo: https://www.nuget.org/packages/.
- Configurare le credenziali
Tutte le chiamate all'API richiedono l'autenticazione. Crea un
Credentialutilizzando l'indirizzo email e il file JSON dell'account di servizio descritti sopra.var credentialParameters = NewtonsoftJsonSerializer.Instance .Deserialize<JsonCredentialParameters>( System.IO.File.ReadAllText(ServiceKeyFilePath)); // Create the credentials. var credentialInitializer = new ServiceAccountCredential.Initializer( credentialParameters.ClientEmail) { Scopes = new[] { RealTimeBiddingService.Scope.RealtimeBidding } }.FromPrivateKey(credentialParameters.PrivateKey); var oAuth2Credentials = new ServiceAccountCredential(credentialInitializer); - Creare un client per l'API Real-time Bidding
A questo punto potrai creare il tuo
RealTimeBiddingService:var serviceInitializer = new BaseClientService.Initializer { HttpClientInitializer = oAuth2Credentials, ApplicationName = "FirstAPICall" }; var realtimebidding = new RealTimeBiddingService(serviceInitializer); - Eseguire un'operazione
Dopo aver creato un'istanza di un client per connetterti all'API, puoi eseguire un'operazione. Il codice seguente elenca le creatività per un account acquirente Authorized Buyers specificato associato alle tue credenziali.
BuyersResource.CreativesResource.ListRequest request = realtimebidding.Buyers.Creatives.List(buyerName); request.View = BuyersResource.CreativesResource.ListRequest.ViewEnum.FULL; IList<Creative> creatives = request.Execute().Creatives; foreach (Creative creative in creatives) { Console.WriteLine("* Creative name: {0}", creative.Name); }
Per informazioni più dettagliate sull'utilizzo dell'API Real-time Bidding con C#, consulta il file README negli esempi dell'API Real-time Bidding.
Ruby
Ecco un esempio di base che mostra come utilizzare l'API Real-time Bidding con Ruby.
- Scarica e installa il client Ruby dell'API di Google
Se non l'hai ancora installato, scarica e installa Bundler, poi crea un Gemfile con contenuti come i seguenti:
source "https://rubygems.org" ruby "2.6.0" gem 'google-apis-pubsub_v1', '0.10.0' gem 'google-apis-realtimebidding_v1', '~> 0.14.0'
Infine, esegui questo comando per installare le librerie delle dipendenze:
bundle
- Configurare le credenziali
Tutte le chiamate all'API richiedono l'autenticazione. Crea le credenziali utilizzando l'indirizzo email e il file JSON dell'account di servizio discussi sopra.
# Create credentials using the JSON key file. auth_options = { :json_key_io => File.open(KEY_FILE, "r"), :scope => 'https://www.googleapis.com/auth/realtime-bidding' } oauth_credentials = Google::Auth::ServiceAccountCredentials.make_creds( options=auth_options ) - Creare un client per AdExchangeBuyer
A questo punto, puoi creare il client AdExchange Buyer autorizzato utilizzando le seguenti credenziali:
# Create the service and set credentials realtimebidding = ( Google::Apis::RealtimebiddingV1::RealtimeBiddingService.new ) realtimebidding.authorization = oauth_credentials realtimebidding.authorization.fetch_access_token! - Eseguire un'operazione
Dopo aver creato un'istanza di un client per connetterti all'API, puoi eseguire un'operazione. Il codice seguente restituisce tutte le creatività di un determinato acquirente.
# Call the buyers.creatives.list method to get list of creatives for given buyer. creatives_list = realtimebidding.list_buyer_creatives( BUYER_NAME, view: 'FULL') if creatives_list.creatives.any? puts "Found the following creatives for buyer '%s':" % BUYER_NAME creatives_list.creatives.each do |creative| puts "* Creative name: #{creative.name}" end else puts "No creatives were found that were associated with buyer '%s'" % BUYER_NAME end
Per informazioni più dettagliate sull'utilizzo dell'API Real-time Bidding con Ruby, consulta il file README negli esempi dell'API Real-time Bidding.
API Ad Exchange Buyer II
Java
/*
* Copyright (c) 2017 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
package com.google.api.services.samples.adexchangebuyer.cmdline.v2_x;
import com.google.api.client.googleapis.services.json.AbstractGoogleJsonClient;
import com.google.api.services.adexchangebuyer2.v2beta1.AdExchangeBuyerII;
import com.google.api.services.adexchangebuyer2.v2beta1.model.AbsoluteDateRange;
import com.google.api.services.adexchangebuyer2.v2beta1.model.Client;
import com.google.api.services.adexchangebuyer2.v2beta1.model.Date;
import com.google.api.services.adexchangebuyer2.v2beta1.model.FilterSet;
import com.google.api.services.adexchangebuyer2.v2beta1.model.RealtimeTimeRange;
import com.google.api.services.adexchangebuyer2.v2beta1.model.RelativeDateRange;
import com.google.api.services.samples.adexchangebuyer.cmdline.BaseSample;
import java.io.IOException;
import java.util.List;
/**
* This sample illustrates how to retrieve all Bidder-level Filter Sets.
*/
public class GetAllBidderLevelFilterSets extends BaseSample {
@Override
public ClientType getClientType() {
return ClientType.ADEXCHANGEBUYERII;
}
@Override
public String getName() {
return "Get All Bidder-level Filter Sets.";
}
@Override
public String getDescription() {
return "Lists Filter Sets associated with the given Bidder.";
}
@Override
public void execute(AbstractGoogleJsonClient client) throws IOException {
AdExchangeBuyerII adXClient = (AdExchangeBuyerII) client;
String bidderResourceId = getStringInput("bidderResourceId", "Enter the Bidder's resource ID");
String ownerName = String.format("bidders/%s", bidderResourceId);
List<FilterSet> allFilterSets = adXClient.bidders().filterSets().list(ownerName).execute()
.getFilterSets();
if (allFilterSets != null && allFilterSets.size() > 0) {
System.out.println("========================================");
System.out.printf("Listing of Filter Sets associated with Bidder \"%s\"%n", ownerName);
System.out.println("========================================");
for (FilterSet filterSet : allFilterSets) {
System.out.printf("* Filter Set name: %s%n", filterSet.getName());
AbsoluteDateRange absDateRange = filterSet.getAbsoluteDateRange();
if(absDateRange != null) {
System.out.println("AbsoluteDateRange");
System.out.printf("\tStart date: %s%n",
convertDateToString(absDateRange.getStartDate()));
System.out.printf("\tEnd date: %s%n",
convertDateToString(absDateRange.getEndDate()));
}
RelativeDateRange relDateRange = filterSet.getRelativeDateRange();
if(relDateRange != null) {
Integer offset = relDateRange.getOffsetDays();
System.out.println("RelativeDateRange");
System.out.printf("\tOffset days: %s%n", offset != null ? offset : 0);
System.out.printf("\tDuration days: %s%n", relDateRange.getDurationDays());
}
RealtimeTimeRange rtTimeRange = filterSet.getRealtimeTimeRange();
if(rtTimeRange != null) {
System.out.println("RealtimeTimeRange");
System.out.printf("\tStart timestamp: %s%n", rtTimeRange.getStartTimestamp());
}
String timeSeriesGranularity = filterSet.getTimeSeriesGranularity();
if(timeSeriesGranularity != null) {
System.out.printf("Time series granularity: %s%n", timeSeriesGranularity);
}
String format = filterSet.getFormat();
if(format != null) {
System.out.printf("\tFormat: %s%n", format);
}
String environment = filterSet.getEnvironment();
if(environment != null) {
System.out.printf("Environment: %s%n", environment);
}
List<String> platforms = filterSet.getPlatforms();
if(platforms != null) {
System.out.println("Platforms:");
for(String platform : platforms) {
System.out.printf("\t%s%n", platform);
}
}
List<Integer> sellerNetworkIds = filterSet.getSellerNetworkIds();
if(filterSet.getSellerNetworkIds() != null) {
System.out.println("Seller network IDS:");
for(Integer sellerNetworkId : sellerNetworkIds) {
System.out.printf("\t%d%n", sellerNetworkId);
}
}
}
} else {
System.out.printf("No Filter Sets were found associated with Bidder \"%s\"%n", ownerName);
}
}
private String convertDateToString(Date date) {
return String.format("%d%02d%02d", date.getYear(), date.getMonth(), date.getDay());
}
}
Python
#!/usr/bin/python
#
# Copyright 2017 Google Inc. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""This example lists bidder-level filter sets."""
import argparse
import os
import pprint
import sys
sys.path.insert(0, os.path.abspath('..'))
from googleapiclient.errors import HttpError
import samples_util
_OWNER_NAME_TEMPLATE = 'bidders/{bidders_resource_id}'
DEFAULT_BIDDER_RESOURCE_ID = 'ENTER_BIDDER_RESOURCE_ID_HERE'
def main(ad_exchange_buyer, owner_name):
try:
# Construct and execute the request.
filter_sets = ad_exchange_buyer.bidders().filterSets().list(
ownerName=owner_name).execute()
print(f'Listing FilterSets for bidder: "{owner_name}".')
pprint.pprint(filter_sets)
except HttpError as e:
print(e)
if __name__ == '__main__':
parser = argparse.ArgumentParser(
description='Creates a bidder-level filter set with the specified options'
)
# Required fields.
parser.add_argument(
'-b', '--bidder_resource_id', default=DEFAULT_BIDDER_RESOURCE_ID,
help=('The resource ID of the bidders resource for which the filter '
'sets were created. This will be used to construct the ownerName '
'used as a path parameter for filter set requests. For additional '
'information on how to configure the ownerName path parameter, '
'see: https://developers.google.com/authorized-buyers/apis/'
'reference/rest/v2beta1/bidders.filterSets/list'
'#body.PATH_PARAMETERS.owner_name'))
args = parser.parse_args()
try:
service = samples_util.GetService('v2beta1')
except IOError as ex:
print(f'Unable to create adexchangebuyer service - {ex}')
print('Did you specify the key file in samples_util.py?')
sys.exit(1)
main(service, _OWNER_NAME_TEMPLATE.format(
bidders_resource_id=args.bidder_resource_id))
PHP
<?php
/**
* Copyright 2017 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
require_once __DIR__ . '/../../BaseExample.php';
/**
* This example illustrates how to retrieve all Bidder-level Filter Sets.
*/
class ListBidderLevelFilterSets extends BaseExample {
/**
* @see BaseExample::getInputParameters()
*/
protected function getInputParameters() {
return [
[
'name' => 'bidderResourceId',
'display' => 'Bidder Resource ID',
'required' => true
]
];
}
/**
* @see BaseExample::run()
*/
public function run() {
$values = $this->formValues;
$ownerName = sprintf(
'bidders/%s',
$values['bidderResourceId']
);
$result = $this->service->bidders_filterSets
->listBiddersFilterSets($ownerName);
print sprintf(
'<h2>Listing Bidder-level Filter Sets for ownerName "%s"</h2>',
$ownerName
);
if (empty($result['filterSets'])) {
print '<p>No Bidder-level Filter Sets found.</p>';
} else {
foreach ($result['filterSets'] as $filterSets) {
$this->printResult($filterSets);
}
}
}
/**
* @see BaseExample::getClientType()
*/
public function getClientType() {
return ClientType::AdExchangeBuyerII;
}
/**
* @see BaseExample::getName()
*/
public function getName() {
return 'RTB Troubleshooting: List Bidder-level Filter Sets';
}
}
.NET
/* Copyright 2017, Google Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied
* See the License for the specific language governing permissions and
* limitations under the License.
*/
using Google.Apis.AdExchangeBuyerII.v2beta1;
using Google.Apis.AdExchangeBuyerII.v2beta1.Data;
using Google.Apis.Services;
using System;
using System.Collections.Generic;
namespace Google.Apis.AdExchangeBuyer.Examples.v2_x
{
/// <summary>
/// Retrieves the bidder-level filter sets for the given bidder resource ID.
/// </summary>
public class ListBidderLevelFilterSets : ExampleBase
{
/// <summary>
/// Main method, to run this code example as a standalone application.
/// </summary>
/// <param name="args">The command line arguments</param>
public static void Main(string[] args)
{
AdExchangeBuyerIIService service = Utilities.GetV2Service();
ExampleBase example = new ListBidderLevelFilterSets();
Console.WriteLine(example.Description);
example.Run(service);
}
/// <summary>
/// Returns a description about the code example.
/// </summary>
public override string Description
{
get { return "This code example lists all bidder-level filter sets for the given " +
"bidder resource ID."; }
}
/// <summary>
/// Runs the code example.
/// </summary>
/// <param name="service">An authenticated AdExchangeBuyerIIService</param>
public override void Run(BaseClientService service)
{
AdExchangeBuyerIIService adXService = (AdExchangeBuyerIIService)service;
string bidderResourceId = "INSERT_BIDDER_RESOURCE_ID_HERE";
string ownerName = String.Format("bidders/{0}", bidderResourceId);
ListFilterSetsResponse response = adXService.Bidders.FilterSets.List(ownerName)
.Execute();
Console.WriteLine("========================================\n");
Console.WriteLine("Listing of filter sets associated with owner name \"{0}\"",
ownerName);
Console.WriteLine("========================================\n");
if (response.FilterSets.Count == 0)
{
Console.WriteLine("No filter sets found.");
} else
{
foreach (FilterSet filterSet in response.FilterSets)
{
Console.WriteLine("* Name: {0}", filterSet.Name);
AbsoluteDateRange absDateRange = filterSet.AbsoluteDateRange;
if (absDateRange != null)
{
Console.WriteLine("\tAbsoluteDateRange:");
Date startDate = absDateRange.StartDate;
Console.WriteLine("\t\tStartDate:");
Console.WriteLine("\t\t\tYear: {0}", startDate.Year);
Console.WriteLine("\t\t\tMonth: {0}", startDate.Month);
Console.WriteLine("\t\t\tDay: {0}", startDate.Day);
Date endDate = absDateRange.EndDate;
Console.WriteLine("\t\tEndDate:");
Console.WriteLine("\t\t\tYear: {0}", endDate.Year);
Console.WriteLine("\t\t\tMonth: {0}", endDate.Month);
Console.WriteLine("\t\t\tDay: {0}", endDate.Day);
}
RelativeDateRange relDateRange = filterSet.RelativeDateRange;
if (relDateRange != null)
{
Console.WriteLine("\tRelativeDateRange:");
Console.WriteLine("\t\tOffsetDays: {0}", relDateRange.OffsetDays);
Console.WriteLine("\t\tDurationDays: {0}", relDateRange.DurationDays);
}
RealtimeTimeRange rtTimeRange = filterSet.RealtimeTimeRange;
if (rtTimeRange != null)
{
Console.WriteLine("\tRealtimeTimeRange:");
Console.WriteLine("\t\tStartTimestamp: {0}", rtTimeRange.StartTimestamp);
}
String timeSeriesGranularity = filterSet.TimeSeriesGranularity;
if (timeSeriesGranularity != null)
{
Console.WriteLine("\tTimeSeriesGranularity: {0}", timeSeriesGranularity);
}
IList<String> formats = filterSet.Formats;
if (formats != null)
{
Console.WriteLine("\tFormats:");
foreach (string format in formats)
{
Console.WriteLine("\t\t{0}", format);
}
}
String environment = filterSet.Environment;
if (environment != null)
{
Console.WriteLine("\tEnvironment: {0}", environment);
}
IList<string> platforms = filterSet.Platforms;
if (platforms != null)
{
Console.WriteLine("\tPlatforms:");
foreach (string platform in platforms)
{
Console.WriteLine("\t\t{0}", platform);
}
}
IList<int?> sellerNetworkIds = filterSet.SellerNetworkIds;
if (sellerNetworkIds != null)
{
Console.WriteLine("\tSellerNetworkIds:");
foreach (int? sellerNetworkId in sellerNetworkIds)
{
Console.WriteLine("\t\t{0}", sellerNetworkId);
}
}
}
}
}
public override ClientType getClientType()
{
return ClientType.ADEXCHANGEBUYERII;
}
}
}
Ruby
#!/usr/bin/env ruby
# Encoding: utf-8
#
# Copyright:: Copyright 2017, Google Inc. All Rights Reserved.
#
# License:: Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# Lists the filter sets for a given bidder.
#
# Tags: Bidders.FilterSets.list
require 'optparse'
require_relative '../samples_util'
def list_bidder_level_filter_sets(ad_exchange_buyer, owner_name, page_size)
begin
response = ad_exchange_buyer.list_bidder_filter_sets(
owner_name, page_size: page_size
)
unless response.filter_sets.nil?
puts 'Found the following filter sets for bidder %s:' % owner_name
response.filter_sets.each do |filter_set|
puts '* Filter set name: %s' % filter_set.name
if !filter_set.absolute_date_range.nil?
abs_date_range = filter_set.absolute_date_range
start_date = abs_date_range.start_date
end_date = abs_date_range.end_date
puts "\tAbsolute date range:"
puts "\t\tStart date: %s-%s-%s" % [start_date.year, start_date.month,
start_date.day]
puts "\t\tEnd date: %s-%s-%s" % [end_date.year, end_date.month,
end_date.day]
end
unless filter_set.realtime_time_range.nil?
realtime_time_range = filter_set.realtime_time_range
puts "\tRealtime time range:"
puts "\t\tStart timestamp: %s" % realtime_time_range.start_timestamp
end
unless filter_set.relative_date_range.nil?
relative_date_range = filter_set.relative_date_range
puts "\tRelative date range:"
puts "\t\tOffset days: %s" % relative_date_range.offset_days
puts "\t\tDuration days: %s" % relative_date_range.duration_days
end
unless filter_set.time_series_granularity.nil?
puts "\tTime series granularity: %s" %
filter_set.time_series_granularity
end
unless filter_set.format.nil?
puts "\tFormat: %s" % filter_set.format
end
unless filter_set.environment.nil?
puts "\tEnvironment: %s" % filter_set.environment
end
unless filter_set.platforms.nil?
puts "\tPlatforms: %s" % filter_set.platforms.inspect
end
unless filter_set.seller_network_ids.nil?
puts "\tSeller network IDs: %s" %
filter_set.seller_network_ids.inspect
end
end
else
puts 'No filter sets found for bidder %s.' % owner_name
end
rescue Google::Apis::ServerError => e
raise "The following server error occured:\n%s" % e.message
rescue Google::Apis::ClientError => e
raise "Invalid client request:\n%s" % e.message
rescue Google::Apis::AuthorizationError => e
raise "Authorization error occured:\n%s" % e.message
end
end
if __FILE__ == $0
begin
# Retrieve the service used to make API requests.
service = get_service(ADEXCHANGEBUYER_V2BETA1)
rescue ArgumentError => e
raise 'Unable to create service, with error message: %s' % e.message
rescue Signet::AuthorizationError => e
raise ('Unable to create service, was the KEY_FILE in samples_util.rb ' +
'set? Error message: %s') % e.message
end
# Set options and default values for fields used in this example.
options = [
Option.new(
'bidder_resource_id',
('The resource ID of the bidders resource for which the filter ' +
'sets were created. This will be used to construct the ownerName ' +
'used as a path parameter for filter set requests. For additional ' +
'information on how to configure the ownerName path parameter, ' +
'see: https://developers.google.com/authorized-buyers/apis/reference/' +
'rest/v2beta1/bidders.filterSets/list#body.PATH_PARAMETERS.owner_name'),
:short_alias => 'b', :required => true,
:default_value => nil # Insert default value here.
),
Option.new(
'max_page_size',
'The maximum number of entries returned on one result page.',
:type => Integer, :short_alias => 'm', :required => true,
:default_value => MAX_PAGE_SIZE
)
]
# Parse options.
parser = Parser.new(options)
opts = parser.parse(ARGV)
owner_name = 'bidders/%s' % opts['bidder_resource_id']
list_bidder_level_filter_sets(service, owner_name, opts['max_page_size'])
end
Passaggi successivi
Leggi la guida introduttiva per scoprire di più sui campioni e sulle opzioni disponibili per sviluppare la tua soluzione.
Dopo aver configurato una libreria client, prova a estendere gli esempi di codice in base alle tue esigenze.
Per saperne di più sull'API, consulta la documentazione di riferimento della versione con cui stai lavorando.
Se hai bisogno di aiuto, visita il forum.
Se la tua applicazione deve eseguire offerte in tempo reale, leggi la documentazione del Protocollo RTB.
Consulta i suggerimenti per il rendimento.
Partecipa al sondaggio
Aiutaci a migliorare questa documentazione: facci sapere cosa ha funzionato e cosa ci è sfuggito rispondendo a un breve sondaggio.