Java

AI-generated Key Takeaways

outlined_flag

• Google provides a Java client library for interacting with the Ad Manager API, which is recommended for use with Apache Maven or Gradle.

• The Java client library uses OAuth2 and Application Default Credentials (ADC) for authentication, searching for credentials in specific locations.

• You can make requests using the ServiceClient object for each service, with examples provided for synchronous methods.

• To log HTTP requests and responses, configure the java.util.logging logger for com.google.api.client.http.HttpTransport to a CONFIG level or higher, with options for JUL and Log4j.

• Ad Manager API errors are subclasses of ApiException and include ErrorDetails with unique error codes and request IDs for troubleshooting.

Google provides a Java client library for interacting with the Ad Manager API. We recommend using the client library with Apache Maven or Gradle.

To get started, create a new project in the IDE of your choice or add the dependency to an existing project. Google publishes client library artifacts to the Maven central repository as com.google.api-ads/ad-manager .

 <!--  
pom.xml  
-->
<dependency>  
<groupId>com.google.api-ads</groupId>  
<artifactId>ad-manager</artifactId>  
<version>0.1.0</version>
</dependency> 

  implementation 
  
 'com.google.api-ads:ad-manager:0.1.0' 
 

Configure credentials

The Java client library uses OAuth2 and Application Default Credentials (ADC) to authenticate.

ADC searches for credentials in order in the following locations:

1. GOOGLE_APPLICATION_CREDENTIALS environment variable.
2. User credentials set up through the Google Cloud CLI (gcloud CLI).
3. When running on Google Cloud, the service account attached to the Google Cloud resource.

For creating and configuring your ADC credentials, see Authentication .

Make your first request

Each service has a ServiceClient object with both synchronous and asynchronous methods for each REST method. The following example reads a Network synchronously.

  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 
 ); 
  
 } 
  
 } 
 } 
 
  SyncGetNetwork 
 . 
 java 
 
 
 

For examples of other methods and resources, see the GitHub repository googleapis/google-cloud-java .

Log HTTP requests and responses

The com.google.api.client.http.HttpTransport class makes all HTTP requests. This class uses java.util.logging (JUL) for logging HTTP request and response details, including URL, headers, and content.

To enable logging, set the logger for this class to a log level of CONFIG or higher. The steps for this differ depending on which logging implementation you use.

 handlers=java.util.logging.ConsoleHandler
com.google.api.client.http.level=CONFIG
java.util.logging.ConsoleHandler.level=CONFIG 

  import 
  
 com.google.api.client.http.HttpTransport 
 ; 
 import 
  
 java.util.logging.ConsoleHandler 
 ; 
 import 
  
 java.util.logging.Level 
 ; 
 import 
  
 java.util.logging.Logger 
 ; 
 public 
  
 static 
  
 void 
  
 enableLogging 
 () 
  
 { 
  
 Logger 
  
 logger 
  
 = 
  
 Logger 
 . 
 getLogger 
 ( 
 HttpTransport 
 . 
 class 
 . 
 getName 
 ()); 
  
 logger 
 . 
 setLevel 
 ( 
 Level 
 . 
 CONFIG 
 ); 
  
 ConsoleHandler 
  
 handler 
  
 = 
  
 new 
  
 ConsoleHandler 
 (); 
  
 handler 
 . 
 setLevel 
 ( 
 Level 
 . 
 CONFIG 
 ); 
  
 logger 
 . 
 addHandler 
 ( 
 handler 
 ); 
 } 
 

 -Djava.util.logging.manager=org.apache.logging.log4j.jul.LogManager 

 handlers = org.apache.logging.log4j.jul.Log4jBridgeHandler
org.apache.logging.log4j.jul.Log4jBridgeHandler.propagateLevels = true 

 <?xml  
version="1.0"  
encoding="UTF-8"?>
<Configuration>  
<Appenders>  
<Console  
name="Console"  
target="SYSTEM_OUT">  
<PatternLayout  
pattern="%m%n"/>  
</Console>  
</Appenders>  
<Loggers>  
<Logger  
name="com.google.api.client.http.HttpTransport"  
level="debug">  
<AppenderRef  
ref="Console"/>  
</Logger>  
<Root  
level="error">  
<AppenderRef  
ref="Console"/>  
</Root>  
</Loggers>
</Configuration> 

Handle errors

All Ad Manager API errors are subclasses of ApiException in the Java client library.

All errors except 404 Not Found and 401 Unauthorized contain ErrorDetails with additional information.

Parse errors

The error reason field uniquely identifies error types. Use this field to determine how to handle the error.

  ErrorDetails 
  
 errorDetails 
  
 = 
  
 apiException 
 . 
 getErrorDetails 
 (); 
 if 
  
 ( 
 errorDetails 
  
 != 
  
 null 
 ) 
  
 { 
  
 // Unique error code in UPPER_SNAKE_CASE. 
  
 String 
  
 errorCode 
  
 = 
  
 errorDetails 
 . 
 getReason 
 (); 
 } 
 

Ad Manager API errors also include a unique request_id you can provide to support for assistance with troubleshooting. The following example extracts the request_id .

  ErrorDetails 
  
 errorDetails 
  
 = 
  
 apiException 
 . 
 getErrorDetails 
 (); 
 if 
  
 ( 
 errorDetails 
  
 != 
  
 null 
 && 
 errorDetails 
 . 
 getRequestInfo 
 () 
  
 != 
  
 null 
 ) 
  
 { 
  
 // Unique request identifier. 
  
 String 
  
 requestId 
  
 = 
  
 errorDetails 
 . 
 getRequestInfo 
 (). 
 getRequestId 
 (); 
 } 
 

Construct resource names

The client library provides helper classes for building resource names from IDs.

  import 
  
 com.google.ads.admanager.v1.OrderName 
 ; 
 // ... 
 //  Constructs a String in the format: 
 //  "networks/{networkCode}/orders/{orderId}" 
 OrderName 
 . 
 of 
 ( 
 "123" 
 , 
  
 "789" 
 ); 
 

Configure proxy settings

The Java client library respects both http.proxyHost and https.proxyHost System Property settings. For more details on these settings, see Java networking and Proxies .