Weryfikowanie wywołań zwrotnych po stronie serwera (SSV)

Wywołania zwrotne weryfikacji po stronie serwera to żądania adresów URL z parametrami zapytania rozszerzone przez Google, które są wysyłane przez Google do systemu zewnętrznego w celu powiadomić go, że użytkownik powinien być nagrodzony za interakcję z reklama pełnoekranowa z nagrodą. Wywołania zwrotne SSV (weryfikacja po stronie serwera) zapewniają dodatkową warstwę ochrony przed podszywaniem się w wywołaniach zwrotnych po stronie klienta; aby nagradzać użytkowników.

Z tego przewodnika dowiesz się, jak zweryfikować wywołania zwrotne SSV z nagrodą za pomocą Aplikacje w Javie Tink innych firm biblioteki kryptograficznej, by zapewnić, że parametry zapytania w wywołaniu zwrotnym będą prawidłowe wartości. Chociaż w tym przewodniku Tink jest używany, możesz korzystać z biblioteki innej firmy, która obsługuje ECDSA Serwer możesz też przetestować za pomocą testowania w interfejsie AdMob.

Zobacz w pełni działającą przykład za pomocą Sprężynowego rozruchu Java.

Wymagania wstępne

• Dodaj reklamy z nagrodą do aplikacja mobilna z pakietu SDK do reklam mobilnych Google w wersji 7.28.0 lub nowszej.

• Włącz reklamę z nagrodą po stronie serwera weryfikację jednostki reklamowej.

Korzystanie z narzędzia NagrodyAdsVerifier z biblioteki aplikacji Tink w języku Java

repozytorium Tink Java Apps na GitHubie. zawiera RewardedAdsVerifier. klasy pomocniczej, aby zmniejszyć kod wymagany do weryfikacji wywołania zwrotnego SSV z nagrodą. Użycie tej klasy umożliwia zweryfikowanie adresu URL wywołania zwrotnego za pomocą poniższego kodu.

RewardedAdsVerifier verifier = new RewardedAdsVerifier.Builder()
    .fetchVerifyingPublicKeysWith(
        RewardedAdsVerifier.KEYS_DOWNLOADER_INSTANCE_PROD)
    .build();
String rewardUrl = ...;
verifier.verify(rewardUrl);

Jeśli metoda verify() zostanie wykonana bez zgłaszania wyjątku, wywołanie zwrotne Adres URL został zweryfikowany. Pole Nagradzanie użytkowników zawiera szczegółowe informacje o sprawdzonych metodach dotyczących tego, kiedy użytkownicy powinni otrzymywać nagrody. Dla zestawienie czynności wykonywanych przez tę klasę w celu weryfikacji wywołań zwrotnych SSV z nagrodą przeczytaj artykuł Ręczna weryfikacja reklam z nagrodą SSV.

Parametry wywołania zwrotnego SSV

Wywołania zwrotne weryfikacji po stronie serwera zawierają parametry zapytania opisujące interakcji z reklamą z nagrodą. Nazwy parametrów, opisy i przykładowe wartości to wymienionych poniżej. Parametry są wysyłane w kolejności alfabetycznej.

Identyfikatory źródeł reklam

Nagradzanie użytkownika

Ważne jest zachowanie równowagi między wygodą użytkowników a weryfikacją nagród i określić, kiedy należy nagradzać użytkownika. W przypadku wywołań zwrotnych po stronie serwera mogą wystąpić opóźnienia przed które docierają do systemów zewnętrznych. Dlatego zalecamy stosowanie wywołanie zwrotne po stronie klienta, by natychmiast nagrodzić użytkownika, weryfikacji wszystkich nagród po otrzymaniu wywołań zwrotnych po stronie serwera. Ten zapewnia wygodę użytkownikom, a jednocześnie zapewnienie prawidłowości nagrody.

Jednak w aplikacjach, w których ważność nagrody jest kluczowa (na przykład wpływa na ekonomię w grze), a opóźnienia w ich przyznawaniu są akceptowalne, najlepszym rozwiązaniem jest oczekiwanie na zweryfikowane wywołanie zwrotne po stronie serwera. jak ważna jest pokora.

Dane niestandardowe

W przypadku aplikacji, które wymagają dodatkowych danych w wywołaniach zwrotnych weryfikacji po stronie serwera, należy użyć parametru niestandardowe dane reklam z nagrodą. Dowolny ciąg znaków ustawiony w reklamie z nagrodą jest przekazywany do parametru zapytania custom_data w wywołaniu zwrotnym SSV. Jeśli nie niestandardowych wartości danych, wartość parametru zapytania custom_data nie będzie w wywołaniu zwrotnym SSV.

Poniższy przykładowy kod pokazuje, jak ustawić opcje SSV po tagu reklama z nagrodą została wczytana.

GADRewardedAd.load(withAdUnitID:"ca-app-pub-3940256099942544/1712485313",
                       request: request,
                       completionHandler: { [self] ad, error in
      if let error != error {
      rewardedAd = ad
      let options = GADServerSideVerificationOptions()
      options.customRewardString = "SAMPLE_CUSTOM_DATA_STRING"
      rewardedAd.serverSideVerificationOptions = options
    }

GADRequest *request = [GADRequest request];
[GADRewardedAd loadWithAdUnitID:@"ca-app-pub-3940256099942544/1712485313"
                        request:request
              completionHandler:^(GADRewardedAd *ad, NSError *error) {
                if (error) {
                  // Handle Error
                  return;
                }
                self.rewardedAd = ad;
                GADServerSideVerificationOptions *options =
                    [[GADServerSideVerificationOptions alloc] init];
                options.customRewardString = @"SAMPLE_CUSTOM_DATA_STRING";
                ad.serverSideVerificationOptions = options;
              }];

Ręczna weryfikacja reklamy SSV z nagrodą

Czynności wykonywane przez klasę RewardedAdsVerifier w celu zweryfikowania reklamy z nagrodą Poniżej znajdziesz opis usługi SSV. Mimo że dołączone fragmenty kodu są w języku Java jeśli korzystasz z biblioteki zewnętrznej Tink, możesz wykonać te czynności w wybranym języku, używając do tego dowolnej biblioteki zewnętrznej, która obsługuje ECDSA

Pobierz klucze publiczne

Aby zweryfikować wywołanie zwrotne SSV z nagrodą, potrzebujesz klucza publicznego dostarczonego przez AdMob.

Lista kluczy publicznych używanych do weryfikacji wywołań zwrotnych SSV z nagrodą może być pobrane z klucza AdMob Lista kluczy publicznych jest podana w postaci reprezentacji JSON w formacie podobnym do tego:

{
 "keys": [
    {
      keyId: 1916455855,
      pem: "-----BEGIN PUBLIC KEY-----\nMF...YTPcw==\n-----END PUBLIC KEY-----"
      base64: "MFkwEwYHKoZIzj0CAQYI...ltS4nzc9yjmhgVQOlmSS6unqvN9t8sqajRTPcw=="
    },
    {
      keyId: 3901585526,
      pem: "-----BEGIN PUBLIC KEY-----\nMF...aDUsw==\n-----END PUBLIC KEY-----"
      base64: "MFYwEAYHKoZIzj0CAQYF...4akdWbWDCUrMMGIV27/3/e7UuKSEonjGvaDUsw=="
    },
  ],
}

Aby pobrać klucze publiczne, połącz się z serwerem kluczy AdMob i pobierz plik klawiszy. Następujący kod wykonuje to zadanie i zapisuje JSON reprezentacja kluczy do zmiennej data.

String url = ...;
NetHttpTransport httpTransport = new NetHttpTransport.Builder().build();
HttpRequest httpRequest =
    httpTransport.createRequestFactory().buildGetRequest(new GenericUrl(url));
HttpResponse httpResponse = httpRequest.execute();
if (httpResponse.getStatusCode() != HttpStatusCodes.STATUS_CODE_OK) {
  throw new IOException("Unexpected status code = " + httpResponse.getStatusCode());
}
String data;
InputStream contentStream = httpResponse.getContent();
try {
  InputStreamReader reader = new InputStreamReader(contentStream, UTF_8);
  data = readerToString(reader);
} finally {
  contentStream.close();
}

Pamiętaj, że klucze publiczne są regularnie poddawane rotacji. Otrzymasz e-maila z informacjami o nadchodzącej rotacji. Jeśli buforujesz klucze publiczne, musisz zaktualizować klucze.

Po pobraniu kluczy publicznych należy je przeanalizować. Poniższa metoda parsePublicKeysJson pobiera ciąg znaków JSON, jak w przykładzie. powyżej jako danych wejściowych i tworzy mapowanie z wartości key_id na klucze publiczne, zapakowane jako obiekty ECPublicKey z biblioteki Tink.

private static Map<Integer, ECPublicKey> parsePublicKeysJson(String publicKeysJson)
    throws GeneralSecurityException {
  Map<Integer, ECPublicKey> publicKeys = new HashMap<>();
  try {
    JSONArray keys = new JSONObject(publicKeysJson).getJSONArray("keys");
    for (int i = 0; i < keys.length(); i++) {
      JSONObject key = keys.getJSONObject(i);
      publicKeys.put(
          key.getInt("keyId"),
          EllipticCurves.getEcPublicKey(Base64.decode(key.getString("base64"))));
    }
  } catch (JSONException e) {
    throw new GeneralSecurityException("failed to extract trusted signing public keys", e);
  }
  if (publicKeys.isEmpty()) {
    throw new GeneralSecurityException("No trusted keys are available.");
  }
  return publicKeys;
}

Pobieranie treści do zweryfikowania

Ostatnie 2 parametry zapytania wywołań zwrotnych SSV z nagrodą mają zawsze wartość signature i key_id, w tej kolejności. Pozostałe parametry zapytania określają treść do weryfikacji. Załóżmy, że skonfigurujesz w AdMob wysyłanie wywołań zwrotnych do nagrody https://www.myserver.com/mypath Fragment kodu poniżej zawiera przykład reklamy z nagrodą Wywołanie zwrotne SSV z wyróżnioną treścią do zweryfikowania.

https://www.myserver.com/path?ad_network=54...55&ad_unit=12345678&reward_amount=10&reward_item=coins
&timestamp=150777823&transaction_id=12...DEF&user_id=1234567&signature=ME...Z1c&key_id=1268887

Poniższy kod pokazuje, jak przeanalizować treść, która ma zostać zweryfikowana adresu URL wywołania zwrotnego jako tablicy UTF-8.

public static final String SIGNATURE_PARAM_NAME = "signature=";
...
URI uri;
try {
  uri = new URI(rewardUrl);
} catch (URISyntaxException ex) {
  throw new GeneralSecurityException(ex);
}
String queryString = uri.getQuery();
int i = queryString.indexOf(SIGNATURE_PARAM_NAME);
if (i == -1) {
  throw new GeneralSecurityException("needs a signature query parameter");
}
byte[] queryParamContentData =
    queryString
        .substring(0, i - 1)
        // i - 1 instead of i because of & in the query string
        .getBytes(Charset.forName("UTF-8"));

Pobieranie podpisu i identyfikatora key_id z adresu URL wywołania zwrotnego

Korzystając z wartości queryString z poprzedniego kroku, przeanalizuj analizy signature i Parametry zapytania key_id z adresu URL wywołania zwrotnego, jak pokazano poniżej:

public static final String KEY_ID_PARAM_NAME = "key_id=";
...
String sigAndKeyId = queryString.substring(i);
i = sigAndKeyId.indexOf(KEY_ID_PARAM_NAME);
if (i == -1) {
  throw new GeneralSecurityException("needs a key_id query parameter");
}
String sig =
    sigAndKeyId.substring(
        SIGNATURE_PARAM_NAME.length(), i - 1 /* i - 1 instead of i because of & */);
int keyId = Integer.valueOf(sigAndKeyId.substring(i + KEY_ID_PARAM_NAME.length()));

Przeprowadź weryfikację

Ostatnim krokiem jest weryfikacja treści adresu URL wywołania zwrotnego za pomocą atrybutu odpowiedni klucz publiczny. Użyj mapowania zwróconego z metody parsePublicKeysJson i użyj parametru key_id z wywołania zwrotnego Adres URL do pobrania klucza publicznego z tego mapowania. Następnie zweryfikuj podpis, używając taki klucz publiczny. Kroki te zostały opisane poniżej w metodzie verify.

private void verify(final byte[] dataToVerify, int keyId, final byte[] signature)
    throws GeneralSecurityException {
  Map<Integer, ECPublicKey> publicKeys = parsePublicKeysJson();
  if (publicKeys.containsKey(keyId)) {
    foundKeyId = true;
    ECPublicKey publicKey = publicKeys.get(keyId);
    EcdsaVerifyJce verifier = new EcdsaVerifyJce(publicKey, HashType.SHA256, EcdsaEncoding.DER);
    verifier.verify(signature, dataToVerify);
  } else {
    throw new GeneralSecurityException("cannot find verifying key with key ID: " + keyId);
  }
}

Jeśli metoda jest wykonywana bez zgłaszania wyjątku, adres URL wywołania zwrotnego miał postać zweryfikowano.

Najczęstsze pytania

Czy mogę zapisać w pamięci podręcznej klucz publiczny udostępniony przez serwer kluczy AdMob?

Zalecamy zapisywanie w pamięci podręcznej klucza publicznego dostarczonego przez klucz AdMob serwera, aby zmniejszyć liczbę operacji wymaganych do weryfikacji SSV . Pamiętaj jednak, że klucze publiczne są regularnie poddawane rotacji i nie należy ich mogą być przechowywane w pamięci podręcznej dłużej niż 24 godziny.

Jak często poddawana jest rotacja kluczy publicznych dostarczanych przez serwer kluczy AdMob?

Klucze publiczne przekazane przez serwer kluczy AdMob są poddawane rotacji na zmiennej harmonogram. Aby weryfikacja wywołań zwrotnych SSV nadal działała kluczy publicznych nie należy przechowywać w pamięci podręcznej dłużej niż przez 24 godziny.

Co się stanie, jeśli mój serwer będzie nieosiągalny?

Google oczekuje kodu odpowiedzi stanu powodzenia HTTP 200 OK w przypadku SSV . Jeśli serwer jest nieosiągalny lub nie zapewnia , Google spróbuje ponownie wysłać wywołania zwrotne SSV maksymalnie 5 razy jednosekundowych odstępach.

Jak sprawdzić, czy wywołania zwrotne SSV pochodzą z Google?

Użyj wstecznego wyszukiwania DNS, by sprawdzić, czy wywołania zwrotne SSV pochodzą z Google.