Java

Google udostępnia bibliotekę klienta Java do interakcji z interfejsem API Ad Managera. Zalecamy używanie biblioteki klienta z Apache Maven lub Gradle.

Aby rozpocząć, utwórz nowy projekt w wybranym IDE lub dodaj zależność do istniejącego projektu. Google publikuje artefakty biblioteki klienta w centralnym repozytorium Maven jako com.google.api-ads/ad-manager.

Maven 

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

Gradle 

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

Konfigurowanie danych logowania

Biblioteka klienta Java używa protokołu OAuth2 i domyślnego uwierzytelniania aplikacji (ADC) do uwierzytelniania.

ADC wyszukuje dane uwierzytelniające w następujących lokalizacjach (w podanej kolejności):

  1. Zmienna środowiskowa GOOGLE_APPLICATION_CREDENTIALS.
  2. Dane logowania użytkownika skonfigurowane za pomocą interfejsu wiersza poleceń Google Cloud (gcloud CLI).
  3. Konto usługi dołączone do zasobu Google Cloud, gdy jest on uruchomiony w Google Cloud.

Informacje o tworzeniu i konfigurowaniu danych logowania ADC znajdziesz w artykule na temat uwierzytelniania.

Wysyłanie pierwszego żądania

Każda usługa ma obiekt ServiceClient z metodami synchronicznymi i asynchronicznymi dla każdej metody REST. Ten przykład odczytuje Network synchronicznie.

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

Przykłady innych metod i zasobów znajdziesz w repozytorium GitHub googleapis/google-cloud-java.

Logowanie żądań i odpowiedzi HTTP

Klasa com.google.api.client.http.HttpTransport wysyła wszystkie żądania HTTP. Ta klasa używa java.util.logging (JUL) do rejestrowania szczegółów żądań i odpowiedzi HTTP, w tym adresów URL, nagłówków i treści.

Aby włączyć logowanie, ustaw loger dla tej klasy na poziom logu CONFIG lub wyższy. Czynności, które musisz wykonać, różnią się w zależności od używanej implementacji logowania.

LIP

Aby włączyć logowanie, ustaw w pliku logging.properties wartość com.google.api.client.http.level na CONFIG lub wyższą.

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

Możesz też włączyć logowanie w kodzie 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

Jeśli do logowania używasz Log4j, możesz użyć adaptera logowania Log4j JDK do logowania komunikatów JUL. Można to skonfigurować za pomocą SystemProperty lub Log4jBridgeHandler i pliku JUL logging.properties.

Właściwość systemu

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

Moduł obsługi mostu Log4j

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

Te ustawienia powodują zapisywanie logów interfejsu API Ad Managera w dowolnym obiekcie Logger o poziomie CONFIG lub wyższym. Poniższy przykładowy plik log4j2.xml konfiguruje logger, który zapisuje dane w 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>

Obsługuj błędy

Wszystkie błędy interfejsu API Ad Managera są podklasami ApiException w bibliotece klienta Java.

Metoda ApiException.getReason() zwraca ciąg znaków, który jednoznacznie identyfikuje typy błędów. Użyj go, aby określić, jak postępować z błędem.

Wszystkie błędy z wyjątkiem 404 Not Found i 401 Unauthorized zawierają ErrorDetails z dodatkowymi informacjami. W przypadku błędów 400 Bad Request ErrorDetails zawiera obiekt BadRequest z listą 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();
    }
  }
}

Błędy interfejsu API Ad Managera zawierają też unikalny identyfikator request_id, który możesz podać zespołowi pomocy, aby uzyskać pomoc w rozwiązaniu problemu. Ten przykład wyodrębnia request_id.

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

Tworzenie nazw zasobów

Biblioteka klienta udostępnia klasy pomocnicze do tworzenia nazw zasobów na podstawie identyfikatorów.

import com.google.ads.admanager.v1.OrderName;

// ...

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

Konfigurowanie ustawień serwera proxy

Biblioteka klienta Java uwzględnia ustawienia właściwości systemowych http.proxyHost i https.proxyHost. Więcej informacji o tych ustawieniach znajdziesz w artykule Java networking and Proxies (Sieci i serwery proxy w języku Java).