می توانید با استفاده از نام مستعار دوره به دوره ها با نام دیگری ارجاع دهید. نام مستعار دوره می تواند به عنوان یک نقشه بین شناسه های دوره Google Classroom و شناسه های دوره خارجی عمل کند. به عنوان مثال، می توانید نام مستعار دوره را برای مطابقت با شناسه دوره از یک سیستم اطلاعات دانشجویی (SIS) تنظیم کنید.
نام مستعار دوره دو شکل دارد: دامنه گسترده و پروژه گسترده.
نامهای مستعار در سطح دامنه از پیشوند
d:
استفاده میکنند و برای هر کسی که از API Classroom استفاده میکند قابل مشاهده است. فضای نام دامنه برای ایجاد نام مستعار مفید است که همه کاربران نیاز به دسترسی به آنها دارند، اما مختص هیچ برنامه ای نیستند. به عنوان مثال، لیست های جایگزین برای یک دوره، مانند MATH 127 و COMSCI 127، باید در فضای نام دامنه ایجاد شود. نام های مستعار در فضای نام دامنه ممکن است فقط توسط مدیران دامنه ایجاد شود، اما برای همه کاربران یک دامنه قابل مشاهده است.نام مستعار در سطح پروژه از پیشوند
p:
و فقط توسط پروژه Google Cloud که آنها را ایجاد کرده است قابل مشاهده و استفاده هستند. فضای نام پروژه توسعه دهنده برای مدیریت نام مستعار خاص یک برنامه کاربردی مفید است. به عنوان مثال، برنامهای که از شناسههای جایگزین برای دورهها استفاده میکند، میتواند نام مستعار ایجاد کند تا شناسه خود را به دورههای Classroom نگاشت کند. نام مستعار ایجاد شده در این فضای نام به یک پروژه Google Cloud خاص گره خورده است. هر کاربر یک برنامه کاربردی می تواند نام مستعار را در فضای نام پروژه توسعه دهنده آن برنامه ایجاد و مشاهده کند.
یک نام مستعار دوره را می توان به جای شناسه دوره Classroom برای هر نقطه پایانی Classroom API استفاده کرد. این بدان معنی است که می توان از نام مستعار برای خواندن و اصلاح دوره ها و اطلاعات فهرست استفاده کرد.
از نام مستعار برای همگام سازی با سیستم های اطلاعات دانش آموز استفاده کنید
شناسه داخلی SIS برای یک دوره را می توان به عنوان نام مستعار در سراسر دامنه برای دوره ثبت کرد. به این ترتیب، هر برنامهنویسی که با SIS و Classroom ادغام میشود، میتواند از شناسه SIS برای تعامل با دادههای Classroom استفاده کند.
اگر یک دوره از یک SIS ایجاد می کنید یا یک دوره را به یک SIS پیوند می دهید، توصیه می شود از شناسه دوره SIS به عنوان نام مستعار دوره استفاده شود. هنگام ایجاد یک دوره با استفاده از متد courses.create()
می توانید نام مستعار را در فیلد id
درخواست مشخص کنید. اگر نام مستعار از قبل وجود داشته باشد، ایجاد دوره با خطای 409 ALREADY_EXISTS
ناموفق است. در صورت وجود مشکل در برنامه همگامسازی، این کار از ایجاد دورههای تکراری جلوگیری میکند.
به عنوان مثال، اگر نام SIS را school
فرض کنیم و شناسه داخلی استفاده شده توسط SIS برای یک دوره خاص math_101
باشد، میتوانید نام مستعار d:school_math_101
ایجاد کنید.
یک نام مستعار برای یک دوره جدید اضافه کنید
برای افزودن نام مستعار برای یک دوره جدید، هنگام ایجاد درخواست courses.create()
course.id
به نام مستعار تنظیم کنید.
اسکریپت برنامه ها
جاوا
پایتون
یک نام مستعار برای یک دوره موجود اضافه کنید
برای افزودن نام مستعار در یک دوره موجود ، میتوانید فیلد alias
را تنظیم کنید و از متد courses.aliases.create()
استفاده کنید.
اسکریپت برنامه ها
جاوا
پایتون
بازیابی نام مستعار دوره
همانطور که در نمونه زیر نشان داده شده است، می توانید نام مستعار یک دوره را با استفاده از متد courses.aliases.list()
بازیابی کنید: