Package google.digitalassetlinks.v1

فهرست مطالب

بیانیه

این سرویس API "بیانات" را ارائه می دهد، که وسایل نقلیه ای هستند که توسط صاحبان دارایی برای انتشار اطلاعات مربوط به پیوندهای دارایی خود استفاده می کنند. API را می توان برای بازیابی عبارات به روشی ساده و ایمن، بدون نیاز به دریافت مستقیم عبارات از منابع استفاده کرد.

همه اظهارات بازگردانده شده توسط این API از طرف دارایی های دیجیتال (به عنوان مثال، وب سایت ها یا برنامه های Android) در مورد سایر دارایی های دیجیتال انجام شده است. هر عبارت حاوی یک دارایی منبع، یک دارایی هدف و یک یا چند رابطه است.

این رابطه رابطه بین دو دارایی را همانطور که توسط دارایی منبع ادعا شده است، توصیف می کند. نمونه ای برای چنین روابطی تفویض امتیازات یا مجوزها است.

فهرست کنید

rpc List( ListRequest ) returns ( ListResponse )

فهرستی از تمام عبارات را از یک منبع مشخص که با هدف و رشته دستور مشخص شده مطابقت دارند، بازیابی می کند.

API تضمین می‌کند که همه اظهارات دارای دارایی منبع امن، مانند وب‌سایت‌های HTTPS یا برنامه‌های Android، به روشی ایمن توسط مالک آن دارایی‌ها، همانطور که در مشخصات طراحی فنی پیوندهای دارایی دیجیتال توضیح داده شده است، ارائه شده است. به طور خاص، باید در نظر داشته باشید که برای وب‌سایت‌های ناامن (یعنی جایی که URL به جای http:// با https:// شروع می‌شود)، نمی‌توان این تضمین را انجام داد.

دستور List در مواردی که مشتری API می‌خواهد همه راه‌هایی را که دو دارایی با هم مرتبط هستند بداند یا همه روابط را از یک دارایی منبع خاص برشمرد، بسیار مفید است. مثال: قابلیتی که به کاربران کمک می کند به موارد مرتبط پیمایش کنند. هنگامی که یک برنامه تلفن همراه در دستگاهی اجرا می شود، این ویژگی باعث می شود تا به وب سایت مربوطه یا نمایه +Google پیمایش کنید.

AndroidAppAsset

یک دارایی برنامه اندروید را توصیف می کند.

نام زمینه تایپ کنید شرح
package_name string دارایی های برنامه Android به طور طبیعی با نام بسته جاوای خود شناسایی می شوند. برای مثال، برنامه Google Maps از نام بسته com.google.android.apps.maps استفاده می کند. ضروری
certificate 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 خواهد بود. 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 آن رشته را محاسبه کنید و نتیجه را به عنوان یک رشته هگزا (یعنی نمایش های هگزادسیمال بزرگ هر اکتت که با دو نقطه از هم جدا شده اند) نشان دهید. ).

دارایی

منحصر به فرد دارایی را شناسایی می کند.

دارایی دیجیتال یک موجودیت آنلاین قابل شناسایی و آدرس پذیر است که معمولاً برخی از خدمات یا محتوا را ارائه می دهد. نمونه هایی از دارایی ها وب سایت ها، برنامه های اندروید، فیدهای توییتر و صفحات پلاس هستند.

نام زمینه تایپ کنید شرح
فیلد اتحادیه، فقط یکی از موارد زیر:
web WebAsset اگر این یک دارایی وب است، تنظیم کنید.
android_app AndroidAppAsset اگر این دارایی برنامه Android باشد، تنظیم کنید.

CheckRequest

پیامی که برای بررسی وجود یک پیوند دارایی خاص استفاده می شود.

نام زمینه تایپ کنید شرح
source Asset منبع میزبان لیست بیانیه. این برای هدایت فراخوانی Check() به منبع مناسب استفاده می شود.
relation string

رشته پرس و جو برای رابطه.

ما روابط را با رشته‌هایی با قالب <kind>/<detail> شناسایی می‌کنیم، که در آن <kind> باید یکی از مجموعه‌ای از مقوله‌های هدف از پیش تعریف شده باشد، و <detail> یک رشته حروف عددی با حروف کوچک آزاد است که کاربرد خاص را توصیف می‌کند. مورد بیانیه

برای لیست فعلی روابط پشتیبانی شده به اسناد API ما مراجعه کنید.

برای اینکه یک پرس و جو با پیوند دارایی مطابقت داشته باشد، هر دو رشته رابطه پرس و جو و پیوند دارایی باید دقیقاً مطابقت داشته باشند.

مثال: یک پرس و جو با رابطه delegate_permission/common.handle_all_urls یک پیوند دارایی را با رابطه delegate_permission/common.handle_all_urls مطابقت می دهد.

target Asset دارایی هدف بیانیه.

CheckResponse

پیام پاسخ برای تماس CheckAssetLinks.

نام زمینه تایپ کنید شرح
linked bool اگر دارایی های مشخص شده در درخواست با رابطه مشخص شده در درخواست به هم مرتبط باشند، روی true تنظیم کنید. ضروری
max_age Duration از زمان ارائه، چه مدت دیگر پاسخ باید معتبر در نظر گرفته شود و به‌روزرسانی‌های بیشتر ممنوع شود. ضروری
debug_string string

پیام قابل خواندن توسط انسان حاوی اطلاعاتی است که برای کمک به کاربران نهایی در درک، بازتولید و اشکال زدایی نتیجه است.

پیام به زبان انگلیسی خواهد بود و ما در حال حاضر قصد نداریم ترجمه ای ارائه دهیم.

لطفاً توجه داشته باشید که هیچ تضمینی در مورد محتوا یا قالب این رشته وجود ندارد. هر جنبه ای از آن ممکن است بدون اطلاع قبلی تغییر کند. شما نباید سعی کنید این داده ها را به صورت برنامه نویسی تجزیه کنید. اگر احساس می کنید که باید این کار را انجام دهید زیرا اطلاعات مورد نیاز شما توسط API در معرض دید دیگری قرار نمی گیرد، لطفاً ابتدا با ما تماس بگیرید.

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

پیام قابل خواندن توسط انسان حاوی اطلاعاتی است که برای کمک به کاربران نهایی در درک، بازتولید و اشکال زدایی نتیجه است.

پیام به زبان انگلیسی خواهد بود و ما در حال حاضر قصد نداریم ترجمه ای ارائه دهیم.

لطفاً توجه داشته باشید که هیچ تضمینی در مورد محتوا یا قالب این رشته وجود ندارد. هر جنبه ای از آن ممکن است بدون اطلاع قبلی تغییر کند. شما نباید سعی کنید این داده ها را به صورت برنامه نویسی تجزیه کنید. اگر احساس می کنید که باید این کار را انجام دهید زیرا اطلاعات مورد نیاز شما توسط API در معرض دید دیگری قرار نمی گیرد، لطفاً ابتدا با ما تماس بگیرید.

بیانیه

بیانیه قابل اعتمادی را که در مورد رابطه بین دارایی منبع و دارایی هدف بیان شده است، توصیف می کند.

بیانیه ها همیشه توسط دارایی منبع، مستقیماً یا با تفویض اختیار به فهرست بیانیه ای که در جای دیگری ذخیره می شود، ساخته می شوند.

برای تعاریف دقیق تر بیانیه ها و دارایی ها، لطفاً به صفحه فرود اسناد API ما مراجعه کنید.

نام زمینه تایپ کنید شرح
source Asset هر بیانیه دارای منبع دارایی است. ضروری
relation string

این رابطه، استفاده از بیانیه را به عنوان مورد نظر صاحب دارایی مبدأ (یعنی شخص یا نهادی که بیانیه را صادر کرده است) مشخص می کند. هر عبارت کامل یک رابطه دارد.

ما روابط را با رشته‌هایی با قالب <kind>/<detail> شناسایی می‌کنیم، که در آن <kind> باید یکی از مجموعه‌ای از مقوله‌های هدف از پیش تعریف شده باشد، و <detail> یک رشته حروف عددی با حروف کوچک آزاد است که کاربرد خاص را توصیف می‌کند. مورد بیانیه

برای لیست فعلی روابط پشتیبانی شده به اسناد API ما مراجعه کنید.

مثال: delegate_permission/common.handle_all_urls REQUIRED

target Asset هر بیانیه دارایی هدف دارد. ضروری

دارایی وب

یک دارایی وب را توصیف می کند.

نام زمینه تایپ کنید شرح
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/ (پورت مطابقت ندارد) ضروری است