Quickstarts نحوه راهاندازی و اجرای برنامهای را توضیح میدهد که Google Workspace API را فراخوانی میکند.
راهاندازیهای سریع Google Workspace از کتابخانههای سرویس گیرنده API برای رسیدگی به برخی از جزئیات جریان احراز هویت و مجوز استفاده میکنند. توصیه می کنیم از کتابخانه های سرویس گیرنده برای برنامه های خود استفاده کنید. این شروع سریع از یک رویکرد احراز هویت ساده استفاده می کند که برای یک محیط آزمایشی مناسب است. برای یک محیط تولید، توصیه میکنیم قبل از انتخاب اعتبارنامههای دسترسی مناسب برای برنامهتان، درباره احراز هویت و مجوز یاد بگیرید.
یک برنامه وب جاوا اسکریپت ایجاد کنید که درخواست هایی را به Google Drive API ارسال می کند.
اهداف
- محیط خود را تنظیم کنید.
- نمونه را تنظیم کنید
- نمونه را اجرا کنید.
پیش نیازها
- Node.js & npm نصب شد.
- یک پروژه Google Cloud .
- یک حساب Google با Google Drive فعال است.
محیط خود را تنظیم کنید
برای تکمیل این شروع سریع، محیط خود را تنظیم کنید.
API را فعال کنید
قبل از استفاده از Google API، باید آنها را در پروژه Google Cloud روشن کنید. میتوانید یک یا چند API را در یک پروژه Google Cloud روشن کنید.در کنسول Google Cloud، Google Drive API را فعال کنید.
صفحه رضایت OAuth را پیکربندی کنید
اگر از یک پروژه جدید Google Cloud برای تکمیل این شروع سریع استفاده میکنید، صفحه رضایت OAuth را پیکربندی کنید و خود را به عنوان کاربر آزمایشی اضافه کنید. اگر قبلاً این مرحله را برای پروژه Cloud خود انجام داده اید، به بخش بعدی بروید.
- در کنسول Google Cloud، به > APIs & Services > صفحه رضایت OAuth بروید. منو
- برای نوع User Internal را انتخاب کنید، سپس روی Create کلیک کنید.
- فرم ثبت نام برنامه را تکمیل کنید، سپس روی ذخیره و ادامه کلیک کنید.
در حال حاضر، میتوانید از افزودن دامنهها صرفنظر کنید و روی ذخیره و ادامه کلیک کنید. در آینده، وقتی برنامهای را برای استفاده خارج از سازمان Google Workspace خود ایجاد میکنید، باید نوع کاربر را به خارجی تغییر دهید و سپس محدودههای مجوز مورد نیاز برنامه خود را اضافه کنید.
- خلاصه ثبت برنامه خود را مرور کنید. برای ایجاد تغییرات، روی ویرایش کلیک کنید. اگر ثبت برنامه خوب به نظر می رسد، روی بازگشت به داشبورد کلیک کنید.
اعتبارنامه یک برنامه وب را تأیید کنید
برای احراز هویت کاربران نهایی و دسترسی به داده های کاربر در برنامه خود، باید یک یا چند شناسه مشتری OAuth 2.0 ایجاد کنید. شناسه مشتری برای شناسایی یک برنامه واحد در سرورهای OAuth Google استفاده می شود. اگر برنامه شما روی چندین پلتفرم اجرا می شود، باید برای هر پلتفرم یک شناسه مشتری جداگانه ایجاد کنید.- در کنسول Google Cloud، به > APIs & Services > Credentials بروید. منو
- روی ایجاد اعتبارنامه > شناسه مشتری OAuth کلیک کنید.
- روی نوع برنامه > برنامه وب کلیک کنید.
- در قسمت نام ، نامی را برای اعتبارنامه تایپ کنید. این نام فقط در کنسول Google Cloud نشان داده می شود.
- URI های مجاز مرتبط با برنامه خود را اضافه کنید:
- برنامههای سمت کلاینت (جاوا اسکریپت) - در زیر مبدا مجاز جاوا اسکریپت ، روی افزودن URI کلیک کنید. سپس، یک URI را برای استفاده برای درخواست های مرورگر وارد کنید. این دامنههایی را که برنامه شما میتواند درخواستهای API را به سرور OAuth 2.0 ارسال کند، مشخص میکند.
- برنامههای سمت سرور (جاوا، پایتون و موارد دیگر) - در زیر URIهای مجاز تغییر مسیر ، روی Add URI کلیک کنید. سپس، یک URI نقطه پایانی را وارد کنید که سرور OAuth 2.0 میتواند پاسخها را به آن ارسال کند.
- روی ایجاد کلیک کنید. صفحه ایجاد شده توسط سرویس گیرنده OAuth ظاهر می شود که شناسه مشتری و راز مشتری جدید شما را نشان می دهد.
به شناسه مشتری توجه کنید. اسرار مشتری برای برنامه های کاربردی وب استفاده نمی شود.
- روی OK کلیک کنید. اعتبار جدید ایجاد شده در شناسه های مشتری OAuth 2.0 ظاهر می شود.
این اعتبارنامه ها را یادداشت کنید زیرا بعداً در این شروع سریع به آنها نیاز خواهید داشت.
یک کلید API ایجاد کنید
- در کنسول Google Cloud، به > APIs & Services > Credentials بروید. منو
- روی ایجاد اعتبارنامه > کلید API کلیک کنید.
- کلید API جدید شما نمایش داده می شود.
- روی Copy کلیک کنید تا کلید API خود را برای استفاده در کد برنامه خود کپی کنید. کلید API را میتوانید در بخش «کلیدهای API» اعتبار پروژهتان پیدا کنید.
- برای بهروزرسانی تنظیمات پیشرفته و محدود کردن استفاده از کلید API، روی Restrict key کلیک کنید. برای جزئیات بیشتر، به اعمال محدودیتهای کلید API مراجعه کنید.
نمونه را تنظیم کنید
- در پوشه کاری خود، یک فایل به نام
index.html
ایجاد کنید. در فایل
index.html
کد نمونه زیر را قرار دهید:موارد زیر را جایگزین کنید:
-
YOUR_CLIENT_ID
: شناسه سرویس گیرنده ای که هنگام تأیید اعتبار برای یک برنامه وب ایجاد کردید. -
YOUR_API_KEY
: کلید API که به عنوان پیش نیاز ایجاد کردید.
-
نمونه را اجرا کنید
در پوشه کاری خود، بسته http-server را نصب کنید:
npm install http-server
در فهرست کاری خود، یک وب سرور راه اندازی کنید:
npx http-server -p 8000
- در مرورگر خود به
http://localhost:8000
بروید. - یک اعلان برای مجوز دسترسی می بینید:
- اگر قبلاً وارد حساب Google خود نشده اید، هنگامی که از شما خواسته شد وارد شوید. اگر به چندین حساب وارد شده اید، یک حساب را برای استفاده از مجوز انتخاب کنید.
- روی Accept کلیک کنید.
برنامه جاوا اسکریپت شما اجرا می شود و Google Drive API را فرا می خواند.
مراحل بعدی
،Quickstarts نحوه راهاندازی و اجرای برنامهای را توضیح میدهد که Google Workspace API را فراخوانی میکند.
راهاندازیهای سریع Google Workspace از کتابخانههای سرویس گیرنده API برای رسیدگی به برخی از جزئیات جریان احراز هویت و مجوز استفاده میکنند. توصیه می کنیم از کتابخانه های سرویس گیرنده برای برنامه های خود استفاده کنید. این شروع سریع از یک رویکرد احراز هویت ساده استفاده می کند که برای یک محیط آزمایشی مناسب است. برای یک محیط تولید، توصیه میکنیم قبل از انتخاب اعتبارنامههای دسترسی مناسب برای برنامهتان، درباره احراز هویت و مجوز یاد بگیرید.
یک برنامه وب جاوا اسکریپت ایجاد کنید که درخواست هایی را به Google Drive API ارسال می کند.
اهداف
- محیط خود را تنظیم کنید.
- نمونه را تنظیم کنید
- نمونه را اجرا کنید.
پیش نیازها
- Node.js & npm نصب شد.
- یک پروژه Google Cloud .
- یک حساب Google با Google Drive فعال است.
محیط خود را تنظیم کنید
برای تکمیل این شروع سریع، محیط خود را تنظیم کنید.
API را فعال کنید
قبل از استفاده از Google API، باید آنها را در پروژه Google Cloud روشن کنید. میتوانید یک یا چند API را در یک پروژه Google Cloud روشن کنید.در کنسول Google Cloud، Google Drive API را فعال کنید.
صفحه رضایت OAuth را پیکربندی کنید
اگر از یک پروژه جدید Google Cloud برای تکمیل این شروع سریع استفاده میکنید، صفحه رضایت OAuth را پیکربندی کنید و خود را به عنوان کاربر آزمایشی اضافه کنید. اگر قبلاً این مرحله را برای پروژه Cloud خود انجام داده اید، به بخش بعدی بروید.
- در کنسول Google Cloud، به > APIs & Services > صفحه رضایت OAuth بروید. منو
- برای نوع User Internal را انتخاب کنید، سپس روی Create کلیک کنید.
- فرم ثبت نام برنامه را تکمیل کنید، سپس روی ذخیره و ادامه کلیک کنید.
در حال حاضر، میتوانید از افزودن دامنهها صرفنظر کنید و روی ذخیره و ادامه کلیک کنید. در آینده، وقتی برنامهای را برای استفاده خارج از سازمان Google Workspace خود ایجاد میکنید، باید نوع کاربر را به خارجی تغییر دهید و سپس محدودههای مجوز مورد نیاز برنامه خود را اضافه کنید.
- خلاصه ثبت برنامه خود را مرور کنید. برای ایجاد تغییرات، روی ویرایش کلیک کنید. اگر ثبت برنامه خوب به نظر می رسد، روی بازگشت به داشبورد کلیک کنید.
اعتبارنامه یک برنامه وب را تأیید کنید
برای احراز هویت کاربران نهایی و دسترسی به داده های کاربر در برنامه خود، باید یک یا چند شناسه مشتری OAuth 2.0 ایجاد کنید. شناسه مشتری برای شناسایی یک برنامه واحد در سرورهای OAuth Google استفاده می شود. اگر برنامه شما روی چندین پلتفرم اجرا می شود، باید برای هر پلتفرم یک شناسه مشتری جداگانه ایجاد کنید.- در کنسول Google Cloud، به > APIs & Services > Credentials بروید. منو
- روی ایجاد اعتبارنامه > شناسه مشتری OAuth کلیک کنید.
- روی نوع برنامه > برنامه وب کلیک کنید.
- در قسمت نام ، نامی را برای اعتبارنامه تایپ کنید. این نام فقط در کنسول Google Cloud نشان داده می شود.
- URI های مجاز مرتبط با برنامه خود را اضافه کنید:
- برنامههای سمت کلاینت (جاوا اسکریپت) - در زیر مبدا مجاز جاوا اسکریپت ، روی افزودن URI کلیک کنید. سپس، یک URI را برای استفاده برای درخواست های مرورگر وارد کنید. این دامنههایی را که برنامه شما میتواند درخواستهای API را به سرور OAuth 2.0 ارسال کند، مشخص میکند.
- برنامههای سمت سرور (جاوا، پایتون و موارد دیگر) - در زیر URIهای مجاز تغییر مسیر ، روی Add URI کلیک کنید. سپس، یک URI نقطه پایانی را وارد کنید که سرور OAuth 2.0 میتواند پاسخها را به آن ارسال کند.
- روی ایجاد کلیک کنید. صفحه ایجاد شده توسط سرویس گیرنده OAuth ظاهر می شود که شناسه مشتری و راز مشتری جدید شما را نشان می دهد.
به شناسه مشتری توجه کنید. اسرار مشتری برای برنامه های کاربردی وب استفاده نمی شود.
- روی OK کلیک کنید. اعتبار جدید ایجاد شده در شناسه های مشتری OAuth 2.0 ظاهر می شود.
این اعتبارنامه ها را یادداشت کنید زیرا بعداً در این شروع سریع به آنها نیاز خواهید داشت.
یک کلید API ایجاد کنید
- در کنسول Google Cloud، به > APIs & Services > Credentials بروید. منو
- روی ایجاد اعتبارنامه > کلید API کلیک کنید.
- کلید API جدید شما نمایش داده می شود.
- روی Copy کلیک کنید تا کلید API خود را برای استفاده در کد برنامه خود کپی کنید. کلید API را میتوانید در بخش «کلیدهای API» اعتبار پروژهتان پیدا کنید.
- برای بهروزرسانی تنظیمات پیشرفته و محدود کردن استفاده از کلید API، روی Restrict key کلیک کنید. برای جزئیات بیشتر، به اعمال محدودیتهای کلید API مراجعه کنید.
نمونه را تنظیم کنید
- در پوشه کاری خود، یک فایل به نام
index.html
ایجاد کنید. در فایل
index.html
کد نمونه زیر را قرار دهید:موارد زیر را جایگزین کنید:
-
YOUR_CLIENT_ID
: شناسه سرویس گیرنده ای که هنگام تأیید اعتبار برای یک برنامه وب ایجاد کردید. -
YOUR_API_KEY
: کلید API که به عنوان پیش نیاز ایجاد کردید.
-
نمونه را اجرا کنید
در پوشه کاری خود، بسته http-server را نصب کنید:
npm install http-server
در فهرست کاری خود، یک وب سرور راه اندازی کنید:
npx http-server -p 8000
- در مرورگر خود به
http://localhost:8000
بروید. - یک اعلان برای مجوز دسترسی می بینید:
- اگر قبلاً وارد حساب Google خود نشده اید، هنگامی که از شما خواسته شد وارد شوید. اگر به چندین حساب وارد شده اید، یک حساب را برای استفاده از مجوز انتخاب کنید.
- روی Accept کلیک کنید.
برنامه جاوا اسکریپت شما اجرا می شود و Google Drive API را فرا می خواند.