O Google oferece uma biblioteca de cliente Java para interagir com a API Ad Manager. Recomendamos usar a biblioteca de cliente com o Apache Maven ou o Gradle.
Para começar, crie um projeto no ambiente de desenvolvimento integrado da sua escolha ou adicione a dependência a um projeto atual. O Google publica artefatos de biblioteca de cliente no repositório Maven central como com.google.api-ads/ad-manager.
Maven
<!-- pom.xml -->
<dependency>
<groupId>com.google.api-ads</groupId>
<artifactId>ad-manager</artifactId>
<version>0.56.0</version>
</dependency>
Gradle
implementation 'com.google.api-ads:ad-manager:0.56.0'
Configurar credenciais
A biblioteca de cliente Java usa o OAuth2 e as Application Default Credentials (ADC) para autenticação.
O ADC procura credenciais na seguinte ordem:
- Variável de ambiente
GOOGLE_APPLICATION_CREDENTIALS. - Credenciais do usuário configuradas pela CLI do Google Cloud (CLI gcloud).
- Ao executar no Google Cloud, a conta de serviço anexada ao recurso do Google Cloud.
Para criar e configurar suas credenciais do ADC, consulte Autenticação.
Faça sua primeira solicitação
Cada serviço tem um objeto ServiceClient com métodos síncronos e assíncronos para cada método REST. O exemplo a seguir lê um Network
de forma síncrona.
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);
}
}
}
Para exemplos de outros métodos e recursos, consulte o repositório do GitHub
googleapis/google-cloud-java.
Registrar solicitações e respostas HTTP
A classe com.google.api.client.http.HttpTransport faz todas as solicitações HTTP.
Essa classe usa
java.util.logging
(JUL) para registrar detalhes de solicitações e respostas HTTP, incluindo URL, cabeçalhos e
conteúdo.
Para ativar o registro, defina o logger dessa classe como um nível de registro de
CONFIG ou superior. As etapas variam de acordo com a implementação de
registro em log usada.
JUL
Para ativar o registro, defina com.google.api.client.http.level como CONFIG ou
mais alto no arquivo logging.properties.
handlers=java.util.logging.ConsoleHandler
com.google.api.client.http.level=CONFIG
java.util.logging.ConsoleHandler.level=CONFIG
Você também pode ativar o registro no seu código Java.
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);
}
Log4j
Se você usa o Log4j para geração de registros, é possível usar o
adaptador Log4j JDK do Logging
para registrar mensagens JUL. Isso pode ser configurado usando um SystemProperty ou
usando o Log4jBridgeHandler e um arquivo logging.properties do JUL.
Propriedade do sistema
-Djava.util.logging.manager=org.apache.logging.log4j.jul.LogManager
Gerenciador de ponte do Log4j
handlers = org.apache.logging.log4j.jul.Log4jBridgeHandler
org.apache.logging.log4j.jul.Log4jBridgeHandler.propagateLevels = true
Essas configurações gravam registros da API Ad Manager em qualquer Logger com um nível de
CONFIG ou superior. O exemplo de arquivo log4j2.xml a seguir configura um
registrador que grava em System.out.
<?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>
Solucionar erros
Todos os erros da API Ad Manager são subclasses de ApiException na biblioteca de cliente Java.
O método ApiException.getReason() retorna uma string que identifica de forma exclusiva
tipos de erros. Use isso para determinar como lidar com o erro.
Todos os erros, exceto 404 Not Found e 401 Unauthorized, contêm ErrorDetails com informações adicionais. Para erros de 400 Bad Request, ErrorDetails contém um objeto BadRequest com uma lista de FieldViolations.
try {
// ...
} catch (ApiException apiException) {
// HTTP status code enum
com.google.api.gax.rpc.StatusCode statusCode = apiException.getStatusCode();
// Unique identifier for the type of error
String errorCode = apiException.getReason();
// Human readable error message
String errorMessage = apiException.getMessage();
// Additional information is available in ErrorDetails.
ErrorDetails errorDetails = apiException.getErrorDetails();
if (errorDetails != null) {
// Additional information for 400 Bad Request errors
if (errorDetails.getBadRequest() != null) {
// List of field violations
List<BadRequest.FieldViolation> fieldViolations =
errorDetails.getBadRequest().getFieldViolationsList();
}
}
}
Os erros da API Ad Manager também incluem um request_id exclusivo que você pode
fornecer ao suporte para receber ajuda com a
solução de problemas. O exemplo a seguir extrai o
request_id.
ErrorDetails errorDetails = apiException.getErrorDetails();
if (errorDetails != null && errorDetails.getRequestInfo() != null) {
// Unique request identifier.
String requestId = errorDetails.getRequestInfo().getRequestId();
}
Construir nomes de recursos
A biblioteca de cliente fornece classes auxiliares para criar nomes de recursos com base em IDs.
import com.google.ads.admanager.v1.OrderName;
// ...
// Constructs a String in the format:
// "networks/{networkCode}/orders/{orderId}"
OrderName.of("123", "789");
Definir as configurações de proxy
A biblioteca de cliente Java respeita as configurações de propriedades do sistema http.proxyHost e https.proxyHost. Para mais detalhes sobre essas configurações, consulte
Redes Java e proxies.