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.1.0</version>
</dependency>
Gradle
implementation 'com.google.api-ads:ad-manager:0.1.0'
Konfigurowanie danych logowania
Biblioteka klienta Java używa do uwierzytelniania protokołu OAuth2 i domyślnego uwierzytelniania aplikacji (ADC).
ADC wyszukuje dane logowania w następujących lokalizacjach:
- Zmienna środowiskowa
GOOGLE_APPLICATION_CREDENTIALS. - Dane logowania użytkownika skonfigurowane za pomocą interfejsu wiersza poleceń Google Cloud (gcloud CLI).
- Gdy usługa jest uruchomiona w Google Cloud, konto usługi jest powiązane z zasobem Google Cloud.
Informacje o tworzeniu i konfigurowaniu danych logowania ADC znajdziesz w artykule Uwierzytelnianie.
Wysyłanie pierwszego żądania
Każda usługa ma obiekt ServiceClient z metodami synchronicznymi i asynchronicznymi dla każdej metody REST. Poniższy 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.
Rejestrowanie żą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 adresu URL, nagłówków i
treści.
Aby włączyć rejestrowanie, ustaw rejestrator dla tej klasy na poziom rejestrowania CONFIG lub wyższy. Kroki różnią się w zależności od używanej implementacji rejestrowania.
LIP
Aby włączyć rejestrowanie, 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ć rejestrowanie 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 rejestrowania używasz Log4j, możesz użyć
adaptera rejestrowania Log4j JDK
do rejestrowania komunikatów JUL. Możesz to skonfigurować za pomocą SystemProperty lub używając Log4jBridgeHandler i pliku logging.properties JUL.
Właściwość systemu
-Djava.util.logging.manager=org.apache.logging.log4j.jul.LogManager
Log4j Bridge Handler
handlers = org.apache.logging.log4j.jul.Log4jBridgeHandler
org.apache.logging.log4j.jul.Log4jBridgeHandler.propagateLevels = true
Te ustawienia zapisują logi interfejsu API Ad Managera w dowolnym rejestratorze o poziomie CONFIG lub wyższym. Poniższy przykład pliku log4j2.xml konfiguruje rejestrator, 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 klasy ApiException w bibliotece klienta Java.
Wszystkie błędy z wyjątkiem 404 Not Found i 401 Unauthorized zawierają ErrorDetails z dodatkowymi informacjami.
Błędy analizy
Pole przyczyny błędu jednoznacznie identyfikuje typy błędów. Użyj tego pola, aby określić, jak obsługiwać błąd.
ErrorDetails errorDetails = apiException.getErrorDetails();
if (errorDetails != null) {
// Unique error code in UPPER_SNAKE_CASE.
String errorCode = errorDetails.getReason();
}
Błędy interfejsu API Ad Managera zawierają też unikalny request_id, który możesz podać zespołowi pomocy, aby uzyskać pomoc w rozwiązywaniu problemów. Poniższy 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 systemu http.proxyHost i https.proxyHost. Więcej informacji o tych ustawieniach znajdziesz w artykule
Java networking and Proxies.