सर्वर-साइड से की जाने वाली पुष्टि (SSV) के कॉलबैक की पुष्टि करना

प्लैटफ़ॉर्म चुनें: Android Android iOS Unity Flutter

सर्वर-साइड से की जाने वाली पुष्टि के कॉलबैक, यूआरएल के ऐसे अनुरोध होते हैं जिनमें Google, क्वेरी पैरामीटर जोड़ता है. Google, इन अनुरोधों को किसी बाहरी सिस्टम को भेजता है, ताकि उसे यह सूचना दी जा सके कि इनाम वाले या इनाम वाले इंटरस्टीशियल विज्ञापन के साथ इंटरैक्ट करने के लिए, किसी उपयोगकर्ता को इनाम दिया जाना चाहिए. इनाम वाले विज्ञापन के लिए, सर्वर-साइड से की जाने वाली पुष्टि (एसएसवी) के कॉलबैक, उपयोगकर्ताओं को इनाम देने के लिए, क्लाइंट-साइड कॉलबैक की स्पूफ़िंग से सुरक्षा की एक और लेयर उपलब्ध कराते हैं.

इस गाइड में, इनाम वाले विज्ञापन के लिए, सर्वर-साइड से की जाने वाली पुष्टि (एसएसवी) के कॉलबैक की पुष्टि करने का तरीका बताया गया है. इसके लिए, तीसरे पक्ष की क्रिप्टोग्राफ़िक लाइब्रेरी, Tink Java Apps का इस्तेमाल किया जाता है. इससे यह पक्का किया जा सकता है कि कॉलबैक में मौजूद क्वेरी पैरामीटर, मान्य वैल्यू हों. हालांकि, इस गाइड में Tink का इस्तेमाल किया गया है, लेकिन आपके पास ECDSA के साथ काम करने वाली किसी भी तीसरे पक्ष की लाइब्रेरी का इस्तेमाल करने का विकल्प है. आपके पास AdMob यूज़र इंटरफ़ेस (यूआई) में मौजूद टेस्टिंग टूल की मदद से, अपने सर्वर की जांच करने का विकल्प भी है.

Java spring-boot का इस्तेमाल करके, इनाम वाले विज्ञापन के लिए, सर्वर-साइड से की जाने वाली पुष्टि (एसएसवी) का उदाहरण देखें.

ज़रूरी शर्तें

• अपनी विज्ञापन यूनिट पर, इनाम वाले विज्ञापन के लिए, सर्वर-साइड से की जाने वाली पुष्टि (एसएसवी) की सुविधा चालू करें.

Tink Java Apps लाइब्रेरी से RewardedAdsVerifier का इस्तेमाल करना

Tink Java Apps की GitHub रिपॉज़िटरी में, RewardedAdsVerifier हेल्पर क्लास शामिल है. इससे, इनाम वाले विज्ञापन के लिए, सर्वर-साइड से की जाने वाली पुष्टि (एसएसवी) के कॉलबैक की पुष्टि करने के लिए ज़रूरी कोड कम हो जाता है. इस क्लास का इस्तेमाल करके, यहां दिए गए कोड की मदद से कॉलबैक यूआरएल की पुष्टि की जा सकती है.

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

अगर verify() तरीका, कोई अपवाद दिखाए बिना काम करता है, तो कॉलबैक यूआरएल की पुष्टि हो गई है. उपयोगकर्ताओं को इनाम देना सेक्शन में, इस बारे में सबसे सही तरीके बताए गए हैं कि उपयोगकर्ताओं को कब इनाम दिया जाना चाहिए. इनाम वाले विज्ञापन के लिए, सर्वर-साइड से की जाने वाली पुष्टि (एसएसवी) के कॉलबैक की पुष्टि करने के लिए, इस क्लास की ओर से किए गए चरणों के बारे में जानने के लिए, इनाम वाले विज्ञापन के लिए, सर्वर-साइड से की जाने वाली पुष्टि (एसएसवी) की मैन्युअल तरीके से पुष्टि करना सेक्शन पढ़ें.

सर्वर-साइड से की जाने वाली पुष्टि (एसएसवी) के कॉलबैक पैरामीटर

सर्वर-साइड से की जाने वाली पुष्टि (एसएसवी) के कॉलबैक में, क्वेरी पैरामीटर शामिल होते हैं. इनमें इनाम वाले विज्ञापन के साथ इंटरैक्शन की जानकारी होती है. पैरामीटर के नाम, ब्यौरे, और उदाहरण के तौर पर दी गई वैल्यू यहां दी गई हैं. पैरामीटर, वर्णमाला के क्रम में भेजे जाते हैं.

विज्ञापन सोर्स आइडेंटिफ़ायर

उपयोगकर्ता को इनाम देना

उपयोगकर्ता को इनाम कब देना है, यह तय करते समय, उपयोगकर्ता अनुभव और इनाम की पुष्टि के बीच संतुलन बनाए रखना ज़रूरी है. सर्वर-साइड कॉलबैक को बाहरी सिस्टम तक पहुंचने में देरी हो सकती है. इसलिए, हमारा सुझाव है कि उपयोगकर्ता को तुरंत इनाम देने के लिए, क्लाइंट-साइड कॉलबैक का इस्तेमाल करें. साथ ही, सर्वर-साइड कॉलबैक मिलने पर, सभी इनामों की पुष्टि करें. इस तरीके से, उपयोगकर्ताओं को बेहतर अनुभव मिलता है. साथ ही, यह पक्का किया जा सकता है कि दिए गए इनाम मान्य हों.

हालांकि, ऐसे ऐप्लिकेशन जिनके लिए इनाम की वैधता ज़रूरी है (उदाहरण के लिए, इनाम से आपके ऐप्लिकेशन की इन-गेम इकॉनमी पर असर पड़ता है) और इनाम देने में देरी हो सकती है, तो पुष्टि किए गए सर्वर-साइड कॉलबैक का इंतज़ार करना सबसे सही तरीका हो सकता है.

कस्टम डेटा

ऐसे ऐप्लिकेशन जिनमें सर्वर-साइड से की जाने वाली पुष्टि (एसएसवी) के कॉलबैक में, ज़्यादा डेटा की ज़रूरत होती है उन्हें इनाम वाले विज्ञापनों की कस्टम डेटा सुविधा का इस्तेमाल करना चाहिए. इनाम वाले विज्ञापन ऑब्जेक्ट पर सेट की गई कोई भी स्ट्रिंग वैल्यू, सर्वर-साइड से की जाने वाली पुष्टि (एसएसवी) के कॉलबैक के custom_data क्वेरी पैरामीटर को पास की जाती है. अगर कोई कस्टम डेटा वैल्यू सेट नहीं की जाती है, तो सर्वर-साइड से की जाने वाली पुष्टि (एसएसवी) के कॉलबैक में, custom_data क्वेरी पैरामीटर वैल्यू मौजूद नहीं होगी.

यहां दिए गए उदाहरण में, इनाम वाला विज्ञापन लोड होने के बाद, सर्वर-साइड से की जाने वाली पुष्टि (एसएसवी) के विकल्प सेट किए गए हैं:

RewardedAd.load(MainActivity.this, "AD_UNIT_ID",
    new AdRequest.Builder().build(),  new RewardedAdLoadCallback() {
  @Override
  public void onAdLoaded(RewardedAd ad) {
    Log.d(TAG, "Ad was loaded.");
    rewardedAd = ad;
    ServerSideVerificationOptions options = new ServerSideVerificationOptions
        .Builder()
        .setCustomData("SAMPLE_CUSTOM_DATA_STRING")
        .build();
    rewardedAd.setServerSideVerificationOptions(options);
  }
  @Override
  public void onAdFailedToLoad(LoadAdError loadAdError) {
    Log.d(TAG, loadAdError.toString());
    rewardedAd = null;
  }
});

RewardedAd.load(this, "AD_UNIT_ID",
    AdRequest.Builder().build(), object : RewardedAdLoadCallback() {
  override fun onAdLoaded(ad: RewardedAd) {
    Log.d(TAG, "Ad was loaded.")
    rewardedInterstitialAd = ad
    val options = ServerSideVerificationOptions.Builder()
        .setCustomData("SAMPLE_CUSTOM_DATA_STRING")
        .build()
    rewardedAd.setServerSideVerificationOptions(options)
  }

  override fun onAdFailedToLoad(adError: LoadAdError) {
    Log.d(TAG, adError?.toString())
    rewardedAd = null
  }
})

अगर आपको कस्टम इनाम स्ट्रिंग सेट करनी है, तो आपको विज्ञापन दिखाने से पहले ऐसा करना होगा.

इनाम वाले विज्ञापन के लिए, सर्वर-साइड से की जाने वाली पुष्टि (एसएसवी) की मैन्युअल तरीके से पुष्टि करना

इनाम वाले विज्ञापन के लिए, सर्वर-साइड से की जाने वाली पुष्टि (एसएसवी) की पुष्टि करने के लिए, RewardedAdsVerifier क्लास की ओर से किए गए चरणों के बारे में यहां बताया गया है. हालांकि, शामिल किए गए कोड स्निपेट Java में हैं और इनमें तीसरे पक्ष की लाइब्रेरी, Tink का इस्तेमाल किया गया है. फिर भी, इन चरणों को अपनी पसंद की भाषा में लागू किया जा सकता है. इसके लिए, ECDSA के साथ काम करने वाली किसी भी तीसरे पक्ष की लाइब्रेरी का इस्तेमाल किया जा सकता है.

सार्वजनिक कुंजियां फ़ेच करना

इनाम वाले विज्ञापन के लिए, सर्वर-साइड से की जाने वाली पुष्टि (एसएसवी) के कॉलबैक की पुष्टि करने के लिए, आपको AdMob से मिली सार्वजनिक कुंजी की ज़रूरत होती है.

AdMob की सर्वर कुंजी से, सार्वजनिक कुंजियों की सूची फ़ेच की जा सकती है. इस सूची का इस्तेमाल, इनाम वाले विज्ञापन के लिए, सर्वर-साइड से की जाने वाली पुष्टि (एसएसवी) के कॉलबैक की पुष्टि करने के लिए किया जा सकता है. सार्वजनिक कुंजियों की सूची, JSON फ़ॉर्मैट में दी जाती है. इसका फ़ॉर्मैट, यहां दिए गए उदाहरण जैसा होता है:

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

सार्वजनिक कुंजियां वापस पाने के लिए, AdMob की सर्वर कुंजी से कनेक्ट करें और कुंजियां डाउनलोड करें. यहां दिया गया कोड, इस टास्क को पूरा करता है और कुंजियों के JSON फ़ॉर्मैट को 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();
}

ध्यान दें कि सार्वजनिक कुंजियां, समय-समय पर रोटेट की जाती हैं. आपको आने वाले रोटेशन के बारे में बताने के लिए एक ईमेल मिलेगा. अगर सार्वजनिक कुंजियों को कैश किया जा रहा है, तो आपको यह ईमेल मिलने पर, कुंजियों को अपडेट करना चाहिए.

सार्वजनिक कुंजियां फ़ेच करने के बाद, उन्हें पार्स करना होगा. यहां दिया गया parsePublicKeysJson तरीका, इनपुट के तौर पर JSON स्ट्रिंग लेता है. जैसे, ऊपर दिया गया उदाहरण. इसके बाद, यह key_id वैल्यू से सार्वजनिक कुंजियों की मैपिंग बनाता है. इन कुंजियों को, Tink लाइब्रेरी से ECPublicKey ऑब्जेक्ट के तौर पर एनकैप्सुलेट किया जाता है.

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

पुष्टि किया जाने वाला कॉन्टेंट पाना

इनाम वाले विज्ञापन के लिए, सर्वर-साइड से की जाने वाली पुष्टि (एसएसवी) के कॉलबैक के आखिरी दो क्वेरी पैरामीटर हमेशा signature और key_id, होते हैं. ये इसी क्रम में होते हैं. बाकी क्वेरी पैरामीटर, पुष्टि किए जाने वाले कॉन्टेंट की जानकारी देते हैं. मान लें कि आपने AdMob को इनाम वाले कॉलबैक, https://www.myserver.com/mypath पर भेजने के लिए कॉन्फ़िगर किया है. यहां दिए गए स्निपेट में, इनाम वाले विज्ञापन के लिए, सर्वर-साइड से की जाने वाली पुष्टि (एसएसवी) के कॉलबैक का एक उदाहरण दिया गया है. इसमें, पुष्टि किए जाने वाले कॉन्टेंट को हाइलाइट किया गया है.

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

यहां दिए गए कोड में, कॉलबैक यूआरएल से पुष्टि किए जाने वाले कॉन्टेंट को 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"));

कॉलबैक यूआरएल से सिग्नेचर और key_id पाना

पिछले चरण से मिली queryString वैल्यू का इस्तेमाल करके, कॉलबैक यूआरएल से signature और key_id क्वेरी पैरामीटर को पार्स करें. इसके लिए, यहां दिया गया तरीका अपनाएं:

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

पुष्टि करना

आखिरी चरण में, कॉलबैक यूआरएल के कॉन्टेंट की पुष्टि, सही सार्वजनिक कुंजी से की जाती है. parsePublicKeysJson तरीके से मिले मैपिंग का इस्तेमाल करें. साथ ही, उस मैपिंग से सार्वजनिक कुंजी पाने के लिए, कॉलबैक यूआरएल से key_id पैरामीटर का इस्तेमाल करें. इसके बाद, उस सार्वजनिक कुंजी से सिग्नेचर की पुष्टि करें. 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);
  }
}

अगर यह तरीका, कोई अपवाद दिखाए बिना काम करता है, तो कॉलबैक यूआरएल की पुष्टि हो गई है.

अक्सर पूछे जाने वाले सवाल

क्या मैं AdMob की सर्वर कुंजी से मिली सार्वजनिक कुंजी को कैश कर सकता/सकती हूं?

हमारा सुझाव है कि आप AdMob की सर्वर कुंजी से मिली सार्वजनिक कुंजी को कैश करें. इससे, सर्वर-साइड से की जाने वाली पुष्टि (एसएसवी) के कॉलबैक की पुष्टि करने के लिए ज़रूरी कार्रवाइयों की संख्या कम हो जाएगी. हालांकि, ध्यान दें कि सार्वजनिक कुंजियां, समय-समय पर रोटेट की जाती हैं. इसलिए, इन्हें 24 घंटे से ज़्यादा समय के लिए कैश नहीं किया जाना चाहिए.

AdMob की सर्वर कुंजी से मिली सार्वजनिक कुंजियां, कितनी बार रोटेट की जाती हैं?

AdMob की सर्वर कुंजी से मिली सार्वजनिक कुंजियां, अलग-अलग शेड्यूल के हिसाब से रोटेट की जाती हैं. यह पक्का करने के लिए कि सर्वर-साइड से की जाने वाली पुष्टि (एसएसवी) के कॉलबैक की पुष्टि, उम्मीद के मुताबिक काम करती रहे, सार्वजनिक कुंजियों को 24 घंटे से ज़्यादा समय के लिए कैश नहीं किया जाना चाहिए.

अगर मेरे सर्वर तक नहीं पहुंचा जा सकता, तो क्या होगा?

Google को सर्वर-साइड से की जाने वाली पुष्टि (एसएसवी) के कॉलबैक के लिए, HTTP 200 OK स्टेटस कोड के साथ, सफलता का जवाब चाहिए. अगर आपके सर्वर तक नहीं पहुंचा जा सकता या वह उम्मीद के मुताबिक जवाब नहीं देता है, तो Google, सर्वर-साइड से की जाने वाली पुष्टि (एसएसवी) के कॉलबैक को एक-एक सेकंड के अंतराल पर, पांच बार भेजने की कोशिश करेगा.

मैं यह कैसे पुष्टि कर सकता/सकती हूं कि सर्वर-साइड से की जाने वाली पुष्टि (एसएसवी) के कॉलबैक, Google से आ रहे हैं?

रिवर्स डीएनएस लुकअप का इस्तेमाल करके, यह पुष्टि करें कि सर्वर-साइड से की जाने वाली पुष्टि (एसएसवी) के कॉलबैक, Google से आ रहे हैं.