إثبات الملكية من جهة الخادم

عمليات معاودة الاتصال لعملية تحقّق من جهة الخادم هي طلبات عناوين URL، مع توسيع معلمات طلب البحث من قِبل Google، وترسلها Google إلى نظام خارجي لإعلامه بأنّه يجب منح مكافأة للمستخدم مقابل التفاعل مع إعلان بيني مقابل مكافأة أو إعلان مقابل مكافأة. توفّر عمليات معاودة الاتصال لإثبات الملكية من جانب الخادم للإعلانات مقابل مكافأة طبقة حماية إضافية ضدّ انتحال عمليات معاودة الاتصال من جانب العميل لمنح مكافآت للمستخدمين.

يوضّح هذا الدليل كيفية التحقّق من عمليات معاودة الاتصال لإثبات الملكية من جانب الخادم للإعلانات مقابل مكافأة باستخدام الـ Tink Java Apps مكتبة التشفير التابعة لجهة خارجية لضمان أنّ معلَمات طلب البحث في عملية معاودة الاتصال هي قيم مشروعة. على الرغم من استخدام Tink لأغراض هذا الدليل، يمكنك استخدام أيّ مكتبة تابعة لجهة خارجية تتيح خوارزمية ECDSA. يمكنك أيضًا اختبار الخادم باستخدام أداة الاختبار في واجهة مستخدم AdMob.

المتطلبات الأساسية

• تفعيل ميزة إثبات الملكية من جانب الخادم للإعلانات مقابل مكافأة على وحدتك الإعلانية

يتضمّن مستودع Tink Java Apps على GitHub فئة مساعِدة هي RewardedAdsVerifier لتقليل الرمز البرمجي المطلوب للتحقّق من عملية معاودة الاتصال لإثبات الملكية من جانب الخادم للإعلانات مقابل مكافأة. يتيح لك استخدام هذه الفئة التحقّق من عنوان URL لمعاودة الاتصال باستخدام الرمز البرمجي التالي.

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

إذا تمّ تنفيذ طريقة verify() بدون ظهور استثناء، تمّ التحقّق من عنوان URL لمعاودة الاتصال بنجاح. يقدّم قسم منح مكافأة للمستخدم أفضل الممارسات المتعلّقة بالوقت الذي يجب فيه منح مكافأة للمستخدمين. للاطّلاع على تفاصيل الخطوات التي تتّبعها هذه الفئة للتحقّق من عمليات معاودة الاتصال لإثبات الملكية من جانب الخادم للإعلانات مقابل مكافأة، يمكنك قراءة قسم التحقّق اليدوي من عمليات معاودة الاتصال لإثبات الملكية من جانب الخادم للإعلانات مقابل مكافأة.

مَعلمات معاودة الاتصال لإثبات الملكية من جانب الخادم

تحتوي عمليات معاودة الاتصال لإثبات الملكية من جانب الخادم على معلَمات طلب بحث تصف التفاعل مع الإعلان مقابل مكافأة. في ما يلي أسماء المَعلمات وأوصافها وأمثلة على قيمها. يتم إرسال المَعلمات بترتيب أبجدي.

مُعرّفات مصادر الإعلانات

منح مكافأة للمستخدم

من المهمّ تحقيق التوازن بين تجربة المستخدم والتحقّق من المكافأة عند تحديد وقت منح مكافأة للمستخدم. قد يحدث تأخير في وصول عمليات معاودة الاتصال من جهة الخادم إلى الأنظمة الخارجية. لذلك، ننصحك باستخدام عملية معاودة الاتصال من جهة العميل لمنح مكافأة للمستخدم على الفور، مع إجراء عملية التحقّق من جميع المكافآت عند تلقّي عمليات معاودة الاتصال من جهة الخادم. يوفّر هذا النهج تجربة مستخدم جيدة مع ضمان صحة المكافآت الممنوحة.

مع ذلك، بالنسبة إلى التطبيقات التي تكون فيها صحة المكافأة مهمّة (على سبيل المثال، إذا كانت المكافأة تؤثّر في الاقتصاد داخل اللعبة في تطبيقك) وكان التأخير في منح المكافآت مقبولاً، قد يكون الانتظار إلى حين تلقّي عملية معاودة الاتصال التي تمّ التحقّق منها من جهة الخادم هو النهج الأفضل.

البيانات المخصّصة

يجب أن تستخدم التطبيقات التي تتطلّب بيانات إضافية في عمليات معاودة الاتصال لعملية تحقّق من جهة الخادم ميزة البيانات المخصّصة للإعلانات مقابل مكافأة. يتمّ تمرير أيّ قيمة سلسلة يتمّ ضبطها على عنصر إعلان مقابل مكافأة إلى معلَمة طلب البحث custom_data في عملية معاودة الاتصال لإثبات الملكية من جانب الخادم. إذا لم يتمّ ضبط قيمة بيانات مخصّصة، لن تظهر قيمة معلَمة طلب البحث custom_data في عملية معاودة الاتصال لإثبات الملكية من جانب الخادم.

يضبط المثال التالي خيارات إثبات الملكية من جانب الخادم بعد تحميل الإعلان مقابل مكافأة:

RewardedAd.load(
  adUnitId: "_adUnitId",
  request: AdRequest(),
  rewardedAdLoadCallback: RewardedAdLoadCallback(
    onAdLoaded: (ad) {
      ServerSideVerificationOptions _options =
          ServerSideVerificationOptions(
            customData: 'SAMPLE_CUSTOM_DATA_STRING',
          );
      ad.setServerSideOptions(_options);
      _rewardedAd = ad;
    },
    onAdFailedToLoad: (error) {},
  ),
);
rewarded_ad_snippets.dart

استبدِل SAMPLE_CUSTOM_DATA_STRING ببياناتك المخصّصة.

إذا أردت ضبط سلسلة المكافأة المخصّصة، عليك إجراء ذلك قبل عرض الإعلان.

التحقّق اليدوي من عمليات معاودة الاتصال لإثبات الملكية من جانب الخادم للإعلانات مقابل مكافأة

في ما يلي الخطوات التي تتّبعها فئة RewardedAdsVerifier للتحقّق من عملية معاودة الاتصال لإثبات الملكية من جانب الخادم للإعلانات مقابل مكافأة. على الرغم من أنّ مقتطفات الرموز البرمجية المضمّنة مكتوبة بلغة Java و تستخدِم مكتبة Tink التابعة لجهة خارجية، يمكنك تنفيذ هذه الخطوات باللغة التي تختارها، باستخدام أيّ مكتبة تابعة لجهة خارجية تتيح ECDSA.

جلب المفاتيح العامة

للتحقّق من عملية معاودة الاتصال لإثبات الملكية من جانب الخادم للإعلانات مقابل مكافأة، تحتاج إلى مفتاح عام يقدّمه AdMob.

يمكن جلب قائمة بالمفاتيح العامة التي سيتمّ استخدامها للتحقّق من عمليات معاودة الاتصال لإثبات الملكية من جانب الخادم للإعلانات مقابل مكافأة من خادم مفاتيح 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 بالمفاتيح العامة، التي يتمّ تغليفها كعناصر ECPublicKey من مكتبة 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;
}

الحصول على المحتوى الذي سيتمّ التحقّق منه

آخر معلَمتَي طلب بحث في عمليات معاودة الاتصال لإثبات الملكية من جانب الخادم للإعلانات مقابل مكافأة هما دائمًا 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

يوضّح الرمز البرمجي أدناه كيفية تحليل المحتوى الذي سيتمّ التحقّق منه من عنوان URL لمعاودة الاتصال كمصفوفة بايت بتنسيق 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 من عنوان URL لمعاودة الاتصال

باستخدام قيمة queryString من الخطوة السابقة، حلِّل معلَمتَي طلب البحث signature وkey_id من عنوان URL لمعاودة الاتصال كما هو موضّح أدناه:

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

إجراء عملية التحقّق

الخطوة الأخيرة هي التحقّق من محتوى عنوان URL لمعاودة الاتصال باستخدام المفتاح العام المناسب. استخدِم الربط الذي تمّ عرضه من طريقة parsePublicKeysJson واستخدِم معلَمة key_id من عنوان URL لمعاودة الاتصال للحصول على المفتاح العام من هذا الربط. بعد ذلك، تحقَّق من التوقيع باستخدام هذا المفتاح العام. يتمّ توضيح هذه الخطوات أدناه في طريقة 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);
  }
}

إذا تمّ تنفيذ الطريقة بدون ظهور استثناء، تمّ التحقّق من عنوان URL لمعاودة الاتصال بنجاح.

الأسئلة الشائعة

هل يمكنني تخزين المفتاح العام الذي يقدّمه خادم مفاتيح AdMob مؤقتًا؟

ننصحك بتخزين المفتاح العام الذي يقدّمه خادم مفاتيح AdMob مؤقتًا لتقليل عدد العمليات المطلوبة للتحقّق من عمليات معاودة الاتصال لإثبات الملكية من جانب الخادم. مع ذلك، يُرجى العِلم أنّه يتمّ تدوير المفاتيح العامة بانتظام ويجب عدم تخزينها مؤقتًا لأكثر من 24 ساعة.

ما هو معدّل تدوير المفاتيح العامة التي يقدّمها خادم مفاتيح AdMob؟

يتمّ تدوير المفاتيح العامة التي يقدّمها خادم مفاتيح AdMob وفقًا لجدول زمني متغيّر. لضمان استمرار عمل التحقّق من عمليات معاودة الاتصال لإثبات الملكية من جانب الخادم على النحو المطلوب، يجب عدم تخزين المفاتيح العامة مؤقتًا لأكثر من 24 ساعة.

ماذا يحدث إذا تعذّر الوصول إلى الخادم؟

تتوقّع Google رمز استجابة لحالة النجاح HTTP 200 OK لعمليات معاودة الاتصال لإثبات الملكية من جانب الخادم. إذا تعذّر الوصول إلى الخادم أو لم يقدّم الاستجابة المتوقّعة، ستعيد Google محاولة إرسال عمليات معاودة الاتصال لإثبات الملكية من جانب الخادم بحدّ أقصى خمس مرّات على فترات ثانية واحدة.

كيف يمكنني التأكّد من أنّ عمليات معاودة الاتصال لإثبات الملكية من جانب الخادم واردة من Google؟

استخدِم بحث نظام أسماء النطاقات العكسي للتأكّد من أنّ عمليات معاودة الاتصال لإثبات الملكية من جانب الخادم صادرة من Google.