Package google.digitalassetlinks.v1

الفهرس

العبارات

تعرض خدمة واجهة برمجة التطبيقات هذه "البيانات"، وهي المركبات التي يستخدمها مالكو مواد العرض لنشر معلومات حول روابط مواد العرض الخاصة بهم. يمكن استخدام واجهة برمجة التطبيقات لاسترداد العبارات بطريقة بسيطة وآمنة، بدون الحاجة إلى الحصول على العبارات مباشرةً من المصادر.

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

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

قائمة

rpc List(ListRequest) returns (ListResponse)

لاسترداد قائمة بجميع العبارات من مصدر معين يطابق الهدف المحدد وسلسلة العبارة.

تضمن واجهة برمجة التطبيقات أنّ جميع العبارات التي تتضمّن مواد عرض مصدر آمنة، مثل المواقع الإلكترونية التي تستخدم بروتوكول HTTPS أو التطبيقات المتوافقة مع Android، قد تم إجراؤها بطريقة آمنة من قِبل مالك مواد العرض هذه، كما هو موضّح في المواصفات الفنية لروابط مواد العرض الرقمية. وعلى وجه التحديد، بالنسبة إلى المواقع الإلكترونية غير الآمنة (أي التي يبدأ عنوان URL فيها بـ http:// بدلاً من https://)، لا يمكن إجراء هذا الضمان.

يكون الأمر List مفيدًا للغاية في الحالات التي يريد فيها عميل واجهة برمجة التطبيقات معرفة جميع الطرق التي ترتبط بها مادتا عرض، أو تعداد كل العلاقات من مادة عرض مصدر معيّنة. مثال: ميزة تساعد المستخدمين في الانتقال إلى العناصر ذات الصلة. عند تشغيل تطبيق جوال على أحد الأجهزة، ستجعل الميزة من السهل الانتقال إلى موقع الويب المقابل أو الملف الشخصي في +Google.

AndroidAppAsset

تصف مادة عرض تطبيق Android.

اسم الحقل النوع الوصف
package_name string يتمّ تحديد مواد عرض تطبيقات Android بشكلٍ طبيعي من خلال اسم حزمة Java. على سبيل المثال، يستخدم تطبيق "خرائط Google" اسم الحزمة com.google.android.apps.maps. مطلوب
certificate CertificateInfo

بسبب عدم فرض إجراء عام على تفرد اسم الحزمة، نطلب أيضًا شهادة توقيع تؤدي إلى تعريف التطبيق بشكل فريد مع اسم الحزمة.

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

(يُرجى ملاحظة أنّ بناء الجملة لنشر العبارات والاستعلام عنها تحتوي على غوّاد نحوي للسماح لك بتحديد التطبيقات المعروفة بواسطة شهادات متعددة.) مطلوب

CertificateInfo

تصف شهادة X509.

اسم الحقل النوع الوصف
sha256_fingerprint string

تمثّل هذه السمة الملف المرجعي للشهادة SHA-265 بالأحرف الكبيرة. من شهادة PEM، يمكن الحصول عليها على النحو التالي:

$ keytool -printcert -file $CERTFILE | grep SHA256:
SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \
    42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5

أو مثل هذا:

$ openssl x509 -in $CERTFILE -noout -fingerprint -sha256
SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \
    16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5

في هذا المثال، سيكون محتوى هذا الحقل 14:6D:E9:83:C5:73: 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: 44:E5.

إذا لم تكن هذه الأدوات متاحة لك، يمكنك تحويل شهادة PEM إلى تنسيق DER وحساب تجزئة SHA-256 لتلك السلسلة وتقديم النتيجة كسلسلة سداسية عشرية (أي تمثيلات سداسية عشرية كبيرة لكل ثماني بتات، مفصولة بنقطتين).

مادة العرض

يعرّف هذا العنصر مادة العرض بشكل فريد.

الأصول الرقمية هي عبارة عن كيان على الإنترنت يمكن التعرّف عليه بسهولة ويقدّم عادةً بعض الخدمات أو المحتوى. ومن أمثلة مواد العرض المواقع الإلكترونية وتطبيقات Android وخلاصات Twitter وصفحات Plus.

اسم الحقل النوع الوصف
حقل اتحاد، واحد فقط مما يلي:
web WebAsset يجب تحديد ما إذا كانت مادة العرض على الويب.
android_app AndroidAppAsset حدِّد ما إذا كانت مادة عرض تطبيق Android.

CheckRequest

هي رسالة تُستخدَم للتحقق من توفُّر رابط مادة عرض معيّنة.

اسم الحقل النوع الوصف
source Asset المصدر الذي يستضيف قائمة العبارات. ويُستخدَم هذا لتوجيه طلب Check() إلى المصدر الصحيح.
relation string

سلسلة طلب البحث للعلاقة.

نحدد العلاقات بسلاسل التنسيق <kind>/<detail>، حيث يجب أن تكون <kind> واحدة من مجموعة فئات الأغراض المحددة مسبقًا، و<detail> هي سلسلة أبجدية رقمية صغيرة بصيغة حرة تصف حالة الاستخدام المحددة للعبارة.

راجِع مستندات واجهة برمجة التطبيقات للاطّلاع على القائمة الحالية للعلاقات المتوافقة.

لكي يتطابق طلب بحث مع رابط مادة عرض، يجب أن تتطابق سلاسل العلاقة بين طلب البحث ورابط مادة العرض تمامًا.

مثال: استعلام ذو علاقة delegate_permission/common.handle_all_urls يتطابق مع رابط مادة عرض ذي العلاقة delegate_permission/common.handle_all_urls.

target Asset مادة العرض المستهدفة للعبارة.

CheckResponse

رسالة ردّ على استدعاء CheckAssetLinks.

اسم الحقل النوع الوصف
linked bool يتم ضبط هذه السياسة على "صحيح" إذا كانت الأصول المحدّدة في الطلب مرتبطة بالعلاقة المحدّدة في الطلب. مطلوب
max_age Duration تشير هذه السمة إلى المدة التي يُعتبر بعدها الردّ صالحًا لمنع إجراء المزيد من التعديلات. مطلوب
debug_string string

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

ستكون الرسالة باللغة الإنجليزية ولا نخطط في الوقت الحالي لتقديم أي ترجمات.

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

ListRequest

هي رسالة تُستخدَم لطلب جميع العبارات المعروفة التي لها مصدر وعلاقة محدّدَين.

اسم الحقل النوع الوصف
source Asset المصدر الذي يستضيف قائمة العبارات. ويتم استخدام هذه المعلومات لتوجيه طلب List() إلى المصدر الصحيح. مطلوب
relation string

استخدم فقط الارتباطات التي تطابق العلاقة المحددة.

راجِع رسالة Statement للحصول على تعريف تفصيلي لسلاسل العلاقة.

لكي يطابق استعلام عبارة عبارة، يجب أن يكون أحد ما يلي صحيحًا:

  • تتطابق سلسلتا العلاقة بين الاستعلام والعبارة تمامًا، أو
  • سلسلة علاقة الاستعلام فارغة أو مفقودة.

مثال: استعلام ذو علاقة delegate_permission/common.handle_all_urls يتطابق مع رابط مادة عرض ذي العلاقة delegate_permission/common.handle_all_urls.

ListResponse

رسالة ردّ على طلب القائمة

اسم الحقل النوع الوصف
statements Statement قائمة بجميع العبارات المطابقة التي تم العثور عليها.
max_age Duration تشير هذه السمة إلى المدة التي يُعتبر بعدها الردّ صالحًا لمنع إجراء المزيد من التعديلات. مطلوب
debug_string string

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

ستكون الرسالة باللغة الإنجليزية ولا نخطط في الوقت الحالي لتقديم أي ترجمات.

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

العبارات

تصف هذه السمة بيانًا موثوقًا تم إجراؤه حول العلاقة بين مادة العرض المصدر ومادة العرض المستهدفة.

يتم دائمًا إنشاء العبارات باستخدام مادة العرض المصدر، سواء بشكل مباشر أو من خلال تفويضها إلى قائمة عبارات مخزّنة في مكان آخر.

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

اسم الحقل النوع الوصف
source Asset وتحتوي كل عبارة على مادة عرض مصدر. مطلوب
relation string

تحدد العلاقة استخدام العبارة على النحو الذي يريده مالك مادة العرض المصدر (أي الشخص أو الكيان الذي أصدر البيان). كل عبارة كاملة لها علاقة.

نحدد العلاقات بسلاسل التنسيق <kind>/<detail>، حيث يجب أن تكون <kind> واحدة من مجموعة فئات الأغراض المحددة مسبقًا، و<detail> هي سلسلة أبجدية رقمية صغيرة بصيغة حرة تصف حالة الاستخدام المحددة للعبارة.

راجِع مستندات واجهة برمجة التطبيقات للاطّلاع على القائمة الحالية للعلاقات المتوافقة.

مثال: delegate_permission/common.handle_all_urls REQUIRED

target Asset تحتوي كل عبارة على مادة عرض مستهدفة. مطلوب

WebAsset

يصف مادة عرض الويب.

اسم الحقل النوع الوصف
site string

ويتم تحديد مواد العرض على الويب من خلال عنوان URL يحتوي فقط على المخطّط واسم المضيف وأجزاء المنفذ. التنسيق هو

http[s]://<hostname>[:<port>]

يجب أن تكون أسماء المضيفين مؤهَّلة بالكامل: يجب أن تنتهي خلال نقطة واحدة (".").

يُسمح حاليًا باستخدام المخططين "http" و "https" فقط.

يتم تحديد أرقام المنافذ كرقم عشري، ويجب حذفها في حال استخدام أرقام المنافذ العادية: 80 لـ http و443 لـ https.

ونُطلق على عنوان URL المحدود هذا اسم "الموقع الإلكتروني". تُعتبر جميع عناوين URL التي تتشارك في المخطط واسم المضيف والمنفذ نفسه جزءًا من الموقع الإلكتروني وبالتالي تنتمي إلى مادة عرض الويب.

مثال: تحتوي مادة العرض التي تتضمّن الموقع الإلكتروني https://www.google.com على جميع عناوين URL التالية:

  • https://www.google.com/
  • https://www.google.com:443/
  • https://www.google.com/foo
  • https://www.google.com/foo?bar
  • https://www.google.com/foo#bar
  • https://user@password:www.google.com/

لا يتضمّن عناوين URL التالية:

  • http://www.google.com/ (مخطط خاطئ)
  • https://google.com/ (اسم المضيف غير متطابق)
  • https://www.google.com:444/ (المنفذ غير متطابق) مطلوب