Use the Google Ad Manager API (Beta) to read your Ad Manager data and run reports.
To make your first API request, complete the following steps:
Get access to an Ad Manager network
If you don't already have one, sign up for an Ad Manager account.
Enable the Ad Manager API
Enable the Ad Manager API in your Google API Console Project.
Authenticate
All API requests must be authenticated using OAuth2.
The Ad Manager API client libraries read credentials from Application Default Credentials . You can set these using environment variables or gcloud .
Service Account
Linux or macOS
export
GOOGLE_APPLICATION_CREDENTIALS
=
KEY_FILE_PATH
Windows
set
GOOGLE_APPLICATION_CREDENTIALS
=
KEY_FILE_PATH
User credentials
gcloud
auth
application-default
login
--scopes =
"https://www.googleapis.com/auth/admanager"
# End user credentials must specify the cloud project where the API is enabled.
gcloud
auth
application-default
set-quota-project
PROJECT_ID
For more information about choosing credential types and creating credentials, see the authentication guide .
Set up your client library
Java
For Maven:
<!--
pom.xml
-->
<dependency>
<groupId>com.google.api-ads</groupId>
<artifactId>ad-manager</artifactId>
<version>0.1.0</version>
</dependency>
For Gradle:
implementation
'com.google.api-ads:ad-manager:0.1.0'
Python
Install the client library from PyPi.
pip
install
google-ads-admanager
.NET
Install the client library from NuGet .
From the .NET CLI:
dotnet
add
package
Google.Ads.AdManager.V1
--version
1
.0.0-beta01
As a package reference:
<PackageReference
Include="Google.Ads.AdManager.V1"
Version="1.0.0-beta01"
/>
PHP
Install the client library from Composer .
composer
require
googleads/ad-manager
Ruby
Install the client library from RubyGems .
Gemfile:
gem 'google-ads-ad_manager', '~> 0.2.0'
Install:
gem
install
google-ads-ad_manager
Node.js
Install the client library from npm.
From the command line:
npm
install
@google-ads/admanager
As a package reference:
// package.json
"dependencies"
:
{
"@google-ads/admanager"
:
"^0.1.0"
}
Make your first request
Java
import
com.google.ads.admanager.v1.GetNetworkRequest
;
import
com.google.ads.admanager.v1.Network
;
import
com.google.ads.admanager.v1.NetworkName
;
import
com.google.ads.admanager.v1.NetworkServiceClient
;
public
class
SyncGetNetwork
{
public
static
void
main
(
String
[]
args
)
throws
Exception
{
syncGetNetwork
();
}
public
static
void
syncGetNetwork
()
throws
Exception
{
try
(
NetworkServiceClient
networkServiceClient
=
NetworkServiceClient
.
create
())
{
GetNetworkRequest
request
=
GetNetworkRequest
.
newBuilder
()
.
setName
(
NetworkName
.
of
(
" NETWORK_CODE
"
).
toString
())
.
build
();
Network
response
=
networkServiceClient
.
getNetwork
(
request
);
}
}
}
More examples can be found on GitHub . For additional client library information, see the Java guide .
Python
from
google.ads
import
admanager_v1
def
sample_get_network
():
# Create a client
client
=
admanager_v1
.
NetworkServiceClient
()
# Initialize request argument(s)
request
=
admanager_v1
.
GetNetworkRequest
(
name
=
"networks/ NETWORK_CODE
"
,
)
# Make the request
response
=
client
.
get_network
(
request
=
request
)
# Handle the response
print
(
response
)
More examples can be found on GitHub . For additional client library information, see the Python guide .
.NET
using
Google.Ads.AdManager.V1
;
public
sealed
partial
class
GeneratedNetworkServiceClientSnippets
{
public
void
GetNetwork
()
{
// Create client
NetworkServiceClient
networkServiceClient
=
NetworkServiceClient
.
Create
();
// Initialize request argument(s)
string
name
=
"networks/ NETWORK_CODE
"
;
// Make the request
Network
response
=
networkServiceClient
.
GetNetwork
(
name
);
}
}
More examples can be found on GitHub . For additional client library information, see the .NET guide .
PHP
< ?php
use Google\Ads\AdManager\V1\Client\NetworkServiceClient;
use Google\Ads\AdManager\V1\GetNetworkRequest;
use Google\Ads\AdManager\V1\Network;
use Google\ApiCore\ApiException;
/**
* API to retrieve a Network object.
*
* @param string $formattedName Resource name of Network.
* Format: networks/{network_code}
* Please see {@see NetworkServiceClient::networkName()} for help formatting this field.
*/
function get_network_sample(string $formattedName): void
{
// Create a client.
$networkServiceClient = new NetworkServiceClient();
// Prepare the request message.
$request = (new GetNetworkRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Network $response */
$response = $networkServiceClient->getNetwork($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
*/
function callSample(): void
{
$formattedName = NetworkServiceClient::networkName(' NETWORK_CODE
');
get_network_sample($formattedName);
}
More examples can be found on GitHub .
