میتوانید دکمه اشتراکگذاری کلاس را برای رفع نیازهای وبسایت خود، مانند تغییر اندازه دکمه و تکنیک بارگذاری، اضافه و سفارشی کنید. با افزودن دکمه اشتراکگذاری Classroom به وبسایت خود، به کاربران خود اجازه میدهید محتوای شما را در کلاسهای خود به اشتراک بگذارند و ترافیک سایت شما را هدایت کنند.
شروع شدن
یک دکمه ساده
سادهترین روش برای قرار دادن دکمه اشتراکگذاری Classroom در صفحه شما، گنجاندن منبع لازم جاوا اسکریپت و افزودن یک برچسب دکمه اشتراکگذاری است:
<script src="https://apis.google.com/js/platform.js" async defer></script>
<g:sharetoclassroom url="http://url-to-share" size="32"></g:sharetoclassroom>
اسکریپت باید با استفاده از پروتکل HTTPS بارگیری شود و می تواند از هر نقطه ای از صفحه بدون محدودیت وارد شود. برای اطلاعات بیشتر، پرسشهای متداول را ببینید.
همچنین میتوانید با تنظیم ویژگی class روی g-sharetoclassroom
، و پیشوند کردن هر ویژگی دکمه با data-
از یک تگ اشتراکگذاری معتبر HTML5 استفاده کنید.
<div class="g-sharetoclassroom" data-size="32" data-url="..." ></div>
بهطور پیشفرض، اسکریپت ارائهشده از DOM عبور میکند و برچسبهای اشتراکگذاری را بهعنوان دکمه ارائه میکند. میتوانید با استفاده از JavaScript API ، زمان رندر را در صفحات بزرگ بهبود بخشید تا فقط یک عنصر را در صفحه مرور کنید، یا یک عنصر خاص را بهعنوان دکمه اشتراکگذاری رندر کنید.
اجرای به تعویق افتاد با پارامترهای onLoad
و تگ اسکریپت
پارامتر تگ اسکریپت parsetags
را روی onload
(پیشفرض) یا explicit
برای تعیین زمان اجرای کد دکمه تنظیم کنید. برای تعیین پارامترهای تگ اسکریپت، از نحو زیر استفاده کنید:
<script >
window.___gcfg = {
parsetags: 'onload'
};
</script>
<script src="https://apis.google.com/js/platform.js" async defer></script>
پیکربندی
تنظیم URL برای اشتراکگذاری در Classroom
نشانی اینترنتی که در Classroom به اشتراک گذاشته میشود با ویژگی url
دکمه تعیین میشود. این ویژگی به صراحت URL مورد نظر را برای اشتراک گذاری تعریف می کند و باید برای نمایش دکمه اشتراک گذاری تنظیم شود.
پارامترهای برچسب اسکریپت
این پارامترها در یک عنصر <script />
تعریف شده اند که باید قبل از بارگیری اسکریپت platform.js
اجرا شود. پارامترها مکانیسم بارگیری دکمه را کنترل می کنند که در کل صفحه وب استفاده می شود.
پارامترهای مجاز عبارتند از:
- در حال بارگذاری
- همه دکمه های اشتراک گذاری در صفحه به طور خودکار پس از بارگیری صفحه نمایش داده می شوند. به مثال اجرای معوق در بارگذاری مراجعه کنید.
- صریح
- دکمههای اشتراکگذاری فقط با تماسهای صریح به
gapi.sharetoclassroom.go
یاgapi.sharetoclassroom.render
ارائه میشوند.
وقتی از بار صریح در ارتباط با go و رندر فراخوانیهایی که به کانتینرهای خاصی در صفحه شما اشاره میکنند استفاده میکنید، از عبور اسکریپت از کل DOM جلوگیری میکنید که میتواند زمان رندر دکمه را بهبود بخشد. نمونه های gapi.sharetoclassroom.go
و gapi.sharetoclassroom.render
را ببینید.
ویژگی های برچسب را به اشتراک بگذارید
این پارامترها تنظیمات هر دکمه را کنترل می کنند. میتوانید این پارامترها را بهعنوان جفتهای attribute=value
در تگهای دکمه اشتراکگذاری یا بهعنوان جفتهای key:value
در تماس با gapi.sharetoclassroom.render
تنظیم کنید.
صفت | ارزش | پیش فرض | شرح |
---|---|---|---|
body | رشته | خالی | متن متن مورد را برای اشتراکگذاری روی Classroom تنظیم میکند. |
courseid | رشته | خالی | اگر مشخص شده باشد، شناسه دوره را در منوی «انتخاب کلاس» که پس از کلیک کاربر روی دکمه اشتراکگذاری نمایش داده میشود، از پیش انتخاب کنید. کاربر می تواند این مقدار از پیش انتخاب شده را در صورت نیاز تغییر دهد. |
itemtype | announcement ، assignment ، material یا question | خالی | این به طور خودکار پس از اینکه کاربر یک دوره را انتخاب کرد (یا بلافاصله اگر courseid نیز مشخص شده باشد) گفتگوی ایجاد را نشان می دهد. اگر دانشآموزی کلاسی را انتخاب کند، یا معلمی کلاسی را انتخاب کند که در آن دانشآموز است، این مقدار نادیده گرفته میشود. |
locale | برچسب زبان سازگار با RFC 3066 | en-US | زبان aria-label دکمه را برای اهداف دسترسی تنظیم می کند. این روی زبان گفتگوی اشتراکگذاری که با کلیک کاربر روی دکمه ظاهر میشود، تأثیری نمیگذارد: که تحت تأثیر تنظیمات برگزیده مرورگر کاربر است. |
onsharecomplete | رشته | خالی | اگر مشخص شده باشد، نام یک تابع را در فضای نام جهانی تنظیم می کند که وقتی کاربر به اشتراک گذاری پیوند شما را پایان می دهد، فراخوانی می شود. اگر آرگومان های خود را از طریق پارامترها به gapi.sharetoclassroom.render منتقل کنید، می توانید از خود یک تابع نیز استفاده کنید. این ویژگی در اینترنت اکسپلورر کار نمی کند ( به زیر مراجعه کنید ) |
onsharestart | رشته | خالی | اگر مشخص شده باشد، نام یک تابع را در فضای نام جهانی تنظیم می کند که با باز شدن گفتگوی اشتراک گذاری فراخوانی می شود. اگر آرگومان های خود را از طریق پارامترها به gapi.sharetoclassroom.render منتقل کنید، می توانید از خود یک تابع نیز استفاده کنید. این ویژگی در اینترنت اکسپلورر کار نمی کند ( به زیر مراجعه کنید ). |
size | بین المللی | خالی | اندازه دکمه اشتراک گذاری را بر حسب پیکسل تنظیم می کند. اگر اندازه حذف شود، دکمه از 32 استفاده می کند. |
theme | classic ، dark یا light | classic | نماد دکمه را برای موضوع انتخاب شده تنظیم می کند. |
title | رشته | خالی | عنوان مورد را برای اشتراک گذاری روی Classroom تنظیم می کند. |
url | URL برای اشتراک گذاری | خالی | URL را برای اشتراک گذاری در Classroom تنظیم می کند. اگر این ویژگی را با استفاده از gapi.sharetoclassroom.render تنظیم کنید، نباید از URL فرار کنید. |
دستورالعمل های دکمه اشتراک گذاری کلاس درس
نمایش دکمه اشتراکگذاری کلاس باید با دستورالعملهای اندازه حداقل حداکثر و الگوهای رنگ/دکمه مربوطه مطابقت داشته باشد. این دکمه از اندازه های مختلف، از حداقل اندازه 32 پیکسل تا حداکثر 96 پیکسل پشتیبانی می کند.
موضوع | مثال |
---|---|
کلاسیک | |
تاریک | |
سبک |
سفارشی سازی
ما ترجیح می دهیم به هیچ وجه نماد را تغییر ندهید یا بازسازی نکنید. با این حال، اگر چندین نماد اجتماعی شخص ثالث را با هم در برنامه خود نمایش دهید، می توانید نماد Classroom را مطابق با سبک برنامه خود سفارشی کنید. اگر این کار را انجام میدهید، لطفاً مطمئن شوید که همه دکمهها با استفاده از یک سبک مشابه سفارشی شدهاند و هر گونه سفارشیسازی از دستورالعملهای علامتگذاری Classroom پیروی میکند. اگر میخواهید ظاهر و رفتار دکمه اشتراکگذاری را کاملاً کنترل کنید، میتوانید اشتراکگذاری را از طریق یک URL با ساختار زیر آغاز کنید: https://classroom.google.com/share?url={url-to-share}
.
JavaScript API
دکمه اشتراک گذاری جاوا اسکریپت دو تابع رندر دکمه را در فضای نام gapi.sharetoclassroom
تعریف می کند. اگر رندر خودکار را با تنظیم parsetag ها به صورت explicit
غیرفعال کنید، باید یکی از این توابع را فراخوانی کنید.
روش | شرح |
---|---|
gapi.sharetoclassroom.render( container, parameters ) | ظرف مشخص شده را به عنوان دکمه اشتراکگذاری ارائه میکند.
|
gapi.sharetoclassroom.go( opt_container ) | همه برچسبها و کلاسهای دکمه اشتراکگذاری را در ظرف مشخص شده ارائه میکند. این تابع باید فقط در صورتی استفاده شود که parsetags به صورت explicit تنظیم شده باشد، که ممکن است به دلایل عملکرد این کار را انجام دهید.
|
مثال ها
صفحه اصلی
<html>
<head>
<title>Classroom demo: Basic page</title>
<link href="http://www.example.com" />
<script src="https://apis.google.com/js/platform.js" async defer>
</script>
</head>
<body>
<g:sharetoclassroom size=32 url="http://google.com"></g:sharetoclassroom>
</body>
</html>
تگها را بهصراحت در زیر مجموعهای از DOM بارگیری کنید
<html>
<head>
<title>Demo: Explicit load of a Classroom share button</title>
<link href="http://www.example.com" />
<script>
window.___gcfg = {
parsetags: 'explicit'
};
</script>
<script src="https://apis.google.com/js/platform.js">
</script>
</head>
<body>
<div id="content">
<div class="g-sharetoclassroom" data-size="32" data-url="..." ></div>
</div>
<script>
gapi.sharetoclassroom.go("content");
</script>
</body>
</html>
رندر صریح
<html>
<head>
<title>Demo: Explicit render of a Classroom share button</title>
<link href="http://www.example.com" />
<script>
window.___gcfg = {
parsetags: 'explicit'
};
function renderWidget() {
gapi.sharetoclassroom.render("widget-div",
{"url": "http://www.google.com"} );
}
</script>
<script src="https://apis.google.com/js/platform.js">
</script>
</head>
<body>
<a href="#" onClick="renderWidget();">Render the Classroom share button</a>
<div id="widget-div"></div>
</body>
</html>
سوالات متداول
سوالات متداول زیر به ملاحظات فنی و جزئیات پیاده سازی می پردازد. برای منابع بیشتر، به سؤالات متداول عمومی مراجعه کنید.
چگونه یکپارچهسازی دکمه اشتراکگذاری Classroom خود را آزمایش کنم؟
میتوانید حسابهای آزمایشی Classroom را برای آزمایش اشتراکگذاری در Classroom از ادغام خود درخواست کنید .
آیا می توانم چندین دکمه را در یک صفحه قرار دهم که همگی URL های متفاوتی را به اشتراک بگذارند؟
آره. از مشخصه url
همانطور که در پارامترهای تگ اشتراک گذاری مشخص شده است برای نشان دادن URL مورد نظر برای اشتراک گذاری در Classroom استفاده کنید.
دکمه اشتراک گذاری را کجا باید در صفحاتم قرار دهم؟
شما صفحه خود و کاربران خود را بهتر می شناسید، بنابراین توصیه می کنیم دکمه را در هر کجا که فکر می کنید موثرتر است قرار دهید. بالای صفحه، نزدیک عنوان صفحه، و نزدیک به اشتراک گذاری لینک ها اغلب مکان خوبی است. همچنین قرار دادن دکمه اشتراک گذاری در انتهای و ابتدای یک قطعه از محتوای ایجاد شده می تواند موثر باشد.
آیا اثر تاخیری از موقعیت تگ <script>
در صفحه وجود دارد؟
نه، تأثیر تأخیر قابل توجهی از قرار دادن تگ <script>
وجود ندارد. با این حال، با قرار دادن برچسب در پایین سند، درست قبل از برچسب بستن </body>
، ممکن است سرعت بارگذاری صفحه را بهبود بخشید.
آیا تگ <script>
باید قبل از تگ اشتراک گذاری گنجانده شود؟
نه، تگ <script>
را می توان در هر جایی از صفحه قرار داد.
آیا قبل از اینکه تگ <script>
دیگری یکی از متدهای بخش JavaScript API را فراخوانی کند، باید تگ <script>
گنجانده شود؟
بله، اگر از هر یک از متدهای جاوا اسکریپت API استفاده می کنید، باید بعد از گنجاندن <script>
در صفحه قرار گیرند. همچنین نمیتوانید async defer
با هیچ یک از روشهای API جاوا اسکریپت استفاده کنید.
آیا باید از ویژگی url
استفاده کنم؟
ویژگی url
مورد نیاز است. عدم تنظیم صریح url
باعث میشود دکمه اشتراکگذاری نمایش داده نشود. برای اطلاعات بیشتر ، URL هدف را به اشتراک بگذارید .
برخی از کاربران من هنگام مشاهده صفحات با دکمه اشتراکگذاری، هشدار امنیتی دریافت میکنند. چگونه از شر این خلاص شوم؟
کد دکمه اشتراکگذاری به یک اسکریپت از سرورهای Google نیاز دارد. ممکن است با قرار دادن اسکریپت از طریق http://
در صفحهای که از طریق https://
بارگذاری شده است، این خطا را دریافت کنید. توصیه می کنیم https://
برای گنجاندن اسکریپت استفاده کنید:
<script src="https://apis.google.com/js/platform.js" async defer></script>
چه مرورگرهای وب پشتیبانی می شوند؟
دکمه اشتراکگذاری Classroom از همان مرورگرهای وب مانند رابط وب Classroom، مرورگرهایی مانند Chrome، Firefox®، Internet Explorer® یا Safari® پشتیبانی میکند. توجه: توابع مشخص شده برای onsharestart و onsharecomplete برای کاربران اینترنت اکسپلورر فراخوانی نمی شوند.
با کلیک روی دکمه اشتراکگذاری Classroom چه دادههایی به Classroom ارسال میشود؟
وقتی کاربر روی دکمه اشتراکگذاری کلیک میکند، از او خواسته میشود با حساب G Suite for Education خود وارد سیستم شوند. پس از احراز هویت، حساب کاربری و ویژگی url
برای تکمیل پست به Classroom ارسال می شود.