Valida las devoluciones de llamada de verificación del servidor (SSV)

Las devoluciones de llamada de verificación del servidor son solicitudes de URL, con parámetros de consulta que Google expande y que envía a un sistema externo para notificarle que se debe recompensar a un usuario por interactuar con un anuncio intersticial o recompensado. Las devoluciones de llamada de la SSV (verificación del servidor) de anuncios recompensados proporcionan una capa adicional de protección contra la falsificación de devoluciones de llamada del cliente para recompensar a los usuarios.

En esta guía, se muestra cómo verificar las devoluciones de llamada de SSV recompensadas con la biblioteca criptográfica de terceros Tink Java Apps para garantizar que los parámetros de consulta de la devolución de llamada sean valores legítimos. Aunque se usa Tink para los fines de esta guía, tienes la opción de usar cualquier biblioteca de terceros que admita ECDSA. También puedes probar tu servidor con la herramienta de prueba en la IU de AdMob.

Requisitos previos

Usa RewardedAdsVerifier desde la biblioteca de apps de Java de Tink

El repositorio de GitHub de Tink Java Apps incluye una clase de ayuda RewardedAdsVerifier para reducir el código necesario para verificar una devolución de llamada de SSV recompensada. El uso de esta clase te permite verificar una URL de devolución de llamada con el siguiente código.

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

Si el método verify() se ejecuta sin generar una excepción, la URL de devolución de llamada se verificó correctamente. En la sección Recompensa al usuario, se detallan las prácticas recomendadas sobre cuándo se deben recompensar a los usuarios. Para obtener un desglose de los pasos que realiza esta clase para verificar las devoluciones de llamada de la SSV de anuncios recompensados, puedes leer la sección Verificación manual de la SSV de anuncios recompensados.

Parámetros de devolución de llamada de SSV

Las devoluciones de llamada de verificación del servidor contienen parámetros de consulta que describen la interacción con el anuncio recompensado. A continuación, se muestran los nombres, las descripciones y los valores de ejemplo de los parámetros. Los parámetros se envían en orden alfabético.

Nombre del parámetro Descripción Valor de ejemplo
ad_network Es el identificador de la fuente del anuncio que publicó este anuncio. Los nombres de las fuentes de anuncios que corresponden a los valores de ID se indican en la sección Identificadores de fuentes de anuncios. 1953547073528090325
ad_unit Es el ID de unidad de anuncios de AdMob que se usó para solicitar el anuncio recompensado. 2747237135
key_id Clave que se usará para verificar la devolución de llamada de SSV. Este valor se asigna a una clave pública que proporciona el servidor de claves de AdMob. 1234567890
reward_amount Es el importe de la recompensa, tal como se especifica en la configuración de la unidad de anuncios. 5
reward_item Es el elemento de recompensa como se especifica en la configuración de la unidad de anuncios. monedas
firma Firma de la devolución de llamada de SSV que genera AdMob. MEUCIQCLJS_s4ia_sN06HqzeW7Wc3nhZi4RlW3qV0oO-6AIYdQIgGJEh-rzKreO-paNDbSCzWGMtmgJHYYW9k2_icM9LFMY
timestamp Es la marca de tiempo del momento en que se recompensó al usuario como hora de época en ms. 1507770365237823
transaction_id Es un identificador único con codificación hexadecimal para cada evento de otorgamiento de recompensas que genera AdMob. 18fa792de1bca816048293fc71035638
user_id Es el identificador de usuario que proporciona SetUserId.

Si la app no proporciona un identificador de usuario, este parámetro de consulta no estará presente en la devolución de llamada de SSV.

 1234567

Identificadores de fuentes de anuncios

IDs y nombres de las fuentes de anuncios

Nombre de la fuente del anuncio ID de la fuente de anuncios
Aarki (ofertas)5240798063227064260
Generación de anuncios (ofertas)1477265452970951479
AdColony15586990674969969776
AdColony (no SDK) (ofertas)4600416542059544716
AdColony (ofertas)6895345910719072481
AdFalcon3528208921554210682
Red de AdMob5450213213286189855
Cascada de la red de AdMob1215381445328257950
ADResult10593873382626181482
AMoAd17253994435944008978
AppLovin1063618907739174004
AppLovin (ofertas)1328079684332308356
Chartboost2873236629771172317
Chocolate Platform (ofertas)6432849193975106527
CrossChannel (MdotM)9372067028804390441
Evento personalizado18351550913290782395
DT Exchange*
* Antes del 21 de septiembre de 2022, esta red se llamaba "Fyber Marketplace".		2179455223494392917
EMX (ofertas)8497809869790333482
Fluct (ofertas)8419777862490735710
Ráfaga3376427960656545613
Fyber*
* Esta fuente de anuncios se usa para los informes históricos.		4839637394546996422
i-mobile5208827440166355534
Mejora Digital (ofertas)159382223051638006
Index Exchange (ofertas)4100650709078789802
InMobi7681903010231960328
InMobi (ofertas)6325663098072678541
InMobi Exchange (ofertas)5264320421916134407
IronSource6925240245545091930
ironSource Ads (ofertas)1643326773739866623
Leadbolt2899150749497968595
LG U+AD18298738678491729107
LINE Ads Network3025503711505004547
maio7505118203095108657
maio (ofertas)1343336733822567166
Media.net (ofertas)2127936450554446159
Anuncios propios mediados6060308706800320801
Meta Audience Network*
* Antes del 6 de junio de 2022, esta red se llamaba "Facebook Audience Network".		10568273599589928883
Meta Audience Network (ofertas)*
* Antes del 6 de junio de 2022, esta red se llamaba "Facebook Audience Network (ofertas)".		11198165126854996598
Mintegral1357746574408896200
Mintegral (ofertas)6250601289653372374
MobFox8079529624516381459
MobFox (ofertas)3086513548163922365
MoPub (obsoleto)10872986198578383917
myTarget8450873672465271579
Nend9383070032774777750
Nexxen (ofertas)*

* Antes del 1 de mayo de 2024, esta red se llamaba "UnrulyX".

2831998725945605450
ONE by AOL (Millennial Media)6101072188699264581
ONE by AOL (Nexage)3224789793037044399
OneTag Exchange (ofertas)4873891452523427499
OpenX (ofertas)4918705482605678398
Pangle4069896914521993236
Pangle (ofertas)3525379893916449117
PubMatic (ofertas)3841544486172445473
Campaña de reservación7068401028668408324
RhythmOne (ofertas)2831998725945605450
Rubicon (ofertas)3993193775968767067
Planeta SK734341340207269415
Sharethrough (ofertas)5247944089976324188
Smaato (ofertas)3362360112145450544
Equativ (ofertas)*

* Antes del 12 de enero de 2023, esta red se llamaba "Smart Adserver".

5970199210771591442
Sonobi (ofertas)3270984106996027150
Tapjoy7295217276740746030
Tapjoy (ofertas)4692500501762622178
Tencent GDT7007906637038700218
TripleLift (ofertas)8332676245392738510
Unity Ads4970775877303683148
Unity Ads (ofertas)7069338991535737586
Verizon Media7360851262951344112
Verve Group (ofertas)5013176581647059185
Vpon1940957084538325905
Liftoff Monetize*

* Antes del 30 de enero de 2023, esta red se llamaba "Vungle".

1953547073528090325
Liftoff Monetize (ofertas)*

* Antes del 30 de enero de 2023, esta red se llamaba "Vungle (ofertas)".

4692500501762622185
Yieldmo (ofertas)4193081836471107579
YieldOne (ofertas)3154533971590234104
Zucks5506531810221735863

Recompensa al usuario

Es importante equilibrar la experiencia del usuario y la validación de recompensas cuando se decide cuándo recompensar a un usuario. Es posible que las devoluciones de llamada del servidor experimenten retrasos antes de llegar a los sistemas externos. Por lo tanto, la práctica recomendada es usar la devolución de llamada del cliente para recompensar al usuario de inmediato y, al mismo tiempo, realizar la validación de todas las recompensas cuando se reciban las devoluciones de llamada del servidor. Este enfoque proporciona una buena experiencia del usuario y, al mismo tiempo, garantiza la validez de las recompensas otorgadas.

Sin embargo, para las aplicaciones en las que la validez de las recompensas es fundamental (por ejemplo, la recompensa afecta la economía del juego de tu app) y los retrasos en la entrega de recompensas son aceptables, esperar a la devolución de llamada verificada del servidor puede ser el mejor enfoque.

Datos personalizados

Las apps que requieren datos adicionales en las devoluciones de llamada de verificación del servidor deben usar la función de datos personalizados de los anuncios recompensados. Cualquier valor de cadena establecido en un objeto de anuncio recompensado se pasa al parámetro de consulta custom_data de la devolución de llamada de SSV. Si no se establece ningún valor de datos personalizados, el valor del parámetro de consulta custom_data no estará presente en la devolución de llamada de SSV.

En la siguiente muestra de código, se muestra cómo configurar las opciones de SSV después de que se carga el anuncio recompensado.

private void LoadRewardedAd(string adUnitId)
{
  // Send the request to load the ad.
  AdRequest adRequest = new AdRequest();
  RewardedAd.Load(adUnitId, adRequest, (RewardedAd rewardedAd, LoadAdError error) =>
  {
    // If the operation failed with a reason.
    if (error != null)
    {
        Debug.LogError("Rewarded ad failed to load an ad with error : " + error);
        return;
    }

    var options = new ServerSideVerificationOptions
                          .Builder()
                          .SetCustomData("SAMPLE_CUSTOM_DATA_STRING")
                          .Build()
    rewardedAd.SetServerSideVerificationOptions(options);
  });
}

Si deseas establecer la cadena de recompensa personalizada, debes hacerlo antes de mostrar el anuncio.

Verificación manual de los SSV recompensados

A continuación, se describen los pasos que realiza la clase RewardedAdsVerifier para verificar una SSV recompensada. Aunque los fragmentos de código incluidos están en Java y aprovechan la biblioteca de terceros de Tink, puedes implementar estos pasos en el lenguaje que elijas con cualquier biblioteca de terceros que admita ECDSA.

Cómo recuperar claves públicas

Para verificar una devolución de llamada de SSV recompensada, necesitas una clave pública que te proporcione AdMob.

Se puede recuperar una lista de claves públicas que se usarán para validar las devoluciones de llamada de SSV recompensadas desde el servidor de claves de AdMob. La lista de claves públicas se proporciona como una representación JSON con un formato similar al siguiente:

{
 "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=="
    },
  ],
}

Para recuperar las claves públicas, conéctate al servidor de claves de AdMob y descárgalas. El siguiente código realiza esta tarea y guarda la representación JSON de las claves en la variable 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();
}

Ten en cuenta que las claves públicas se rotan con frecuencia. Recibirás un correo electrónico para informarte sobre una próxima rotación. Si almacenas en caché claves públicas, debes actualizarlas cuando recibas este correo electrónico.

Una vez que se recuperen las claves públicas, se deben analizar. El método parsePublicKeysJson que se muestra a continuación toma una cadena JSON, como el ejemplo anterior, como entrada y crea una asignación de valores key_id a claves públicas, que se encapsulan como objetos ECPublicKey de la biblioteca de 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;
}

Cómo obtener el contenido que se debe verificar

Los últimos dos parámetros de consulta de las devoluciones de llamada de SSV recompensadas siempre son signature y key_id, en ese orden. Los parámetros de consulta restantes especifican el contenido que se verificará. Supongamos que configuraste AdMob para que envíe devoluciones de llamada de recompensas a https://www.myserver.com/mypath. En el siguiente fragmento, se muestra un ejemplo de devolución de llamada de SSV recompensada con el contenido que se debe verificar destacado.

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

En el siguiente código, se muestra cómo analizar el contenido que se verificará desde una URL de devolución de llamada como un array de bytes 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"));

Cómo obtener la firma y el key_id de la URL de devolución de llamada

Con el valor queryString del paso anterior, analiza los parámetros de consulta signature y key_id de la URL de devolución de llamada como se muestra a continuación:

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

Realiza la verificación

El último paso es verificar el contenido de la URL de devolución de llamada con la clave pública adecuada. Toma la asignación que se muestra del método parsePublicKeysJson y usa el parámetro key_id de la URL de devolución de llamada para obtener la clave pública de esa asignación. Luego, verifica la firma con esa clave pública. Estos pasos se demuestran a continuación en el método 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);
  }
}

Si el método se ejecuta sin generar una excepción, la URL de devolución de llamada se verificó correctamente.

PREGUNTAS FRECUENTES

¿Puedo almacenar en caché la clave pública que proporciona el servidor de claves de AdMob?
Te recomendamos que almacenes en caché la clave pública que proporciona el servidor de claves de AdMob para reducir la cantidad de operaciones necesarias para validar las devoluciones de llamada de SSV. Sin embargo, ten en cuenta que las claves públicas se rotan con frecuencia y no deben almacenarse en caché durante más de 24 horas.
¿Con qué frecuencia se rotan las claves públicas que proporciona el servidor de claves de AdMob?
Las claves públicas que proporciona el servidor de claves de AdMob se rotan en un programa variable. Para garantizar que la verificación de las devoluciones de llamada de SSV siga funcionando según lo previsto, las claves públicas no deben almacenarse en caché por más de 24 horas.
¿Qué sucede si no se puede acceder a mi servidor?
Google espera un código de respuesta de estado de éxito HTTP 200 OK para las devoluciones de llamada de SSV. Si no se puede acceder a tu servidor o no proporciona la respuesta esperada, Google volverá a intentar enviar devoluciones de llamada de SSV hasta cinco veces en intervalos de un segundo.
¿Cómo puedo verificar que las devoluciones de llamada de SSV provienen de Google?
Usa la búsqueda de DNS inversa para verificar que las devoluciones de llamada de SSV provengan de Google.