محدوده مجوز

APIهای Google Photos حاوی چندین دامنه هستند که برای دسترسی به آیتم‌های رسانه و آلبوم‌ها استفاده می‌شوند. پاسخ‌هایی که از تماس‌های مختلف برمی‌گردند، بر اساس درخواست‌های توسعه‌دهنده متفاوت است.

هر درخواستی که برنامه شما به APIهای Google Photos ارسال می‌کند باید شامل یک نشانه مجوز باشد. توکن همچنین برنامه شما را در گوگل شناسایی می کند.

درباره پروتکل های مجوز

برنامه شما باید از OAuth 2.0 برای تأیید درخواست ها استفاده کند. هیچ پروتکل مجوز دیگری پشتیبانی نمی شود. اگر برنامه شما از ورود به سیستم با Google استفاده می کند، برخی از جنبه های مجوز برای شما انجام می شود.

تأیید درخواست ها با OAuth 2.0

همه درخواست‌ها به APIهای Google Photos باید توسط یک کاربر تأیید شده تأیید شوند.

جزئیات فرآیند مجوز یا "جریان" برای OAuth 2.0 بسته به نوع برنامه ای که می نویسید تا حدودی متفاوت است. فرآیند کلی زیر برای همه انواع برنامه ها اعمال می شود:

  1. هنگامی که برنامه خود را ایجاد می کنید، آن را با استفاده از Google API Console ثبت می کنید. سپس Google اطلاعاتی را که بعداً به آن نیاز خواهید داشت، مانند شناسه مشتری و راز مشتری ارائه می دهد.
  2. API های Google Photos را در Google API Console فعال کنید. (اگر API در لیست API Console نیست، از این مرحله صرفنظر کنید.)
  3. هنگامی که برنامه شما نیاز به دسترسی به داده های کاربر دارد، از Google دامنه دسترسی خاصی را می خواهد.
  4. Google یک صفحه رضایت به کاربر نمایش می دهد و از او می خواهد تا به برنامه شما اجازه دهد تا برخی از داده های خود را درخواست کند.
  5. اگر کاربر تأیید کند، گوگل به برنامه شما یک رمز دسترسی کوتاه مدت می دهد.
  6. برنامه شما با پیوست کردن رمز دسترسی به درخواست، داده های کاربر را درخواست می کند.
  7. اگر Google تشخیص دهد که درخواست شما و رمز معتبر هستند، داده‌های درخواستی را برمی‌گرداند.

برخی از جریان‌ها شامل مراحل اضافی هستند، مانند استفاده از نشانه‌های تازه‌سازی برای به دست آوردن نشانه‌های دسترسی جدید. برای اطلاعات دقیق درباره جریان‌ها برای انواع مختلف برنامه‌ها، به اسناد OAuth 2.0 Google مراجعه کنید.

در اینجا اطلاعات محدوده OAuth 2.0 برای APIهای Google Photos آمده است:

دامنه های Picker API

دامنه معنی
https://www.googleapis.com/auth/photospicker.mediaitems.readonly

دسترسی به ایجاد، دریافت و حذف جلسات، و فهرست کردن موارد رسانه برای جلسات.

محدوده کتابخانه API

دامنه معنی
https://www.googleapis.com/auth/photoslibrary.readonly

https://www.googleapis.com/auth/photoslibrary.sharing

https://www.googleapis.com/auth/photoslibrary
https://www.googleapis.com/auth/photoslibrary.appendonly

فقط دسترسی به نوشتن

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

https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata

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

در نظر گرفته شده به همراه photoslibrary.appendonly دامنه درخواست شده است.

https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata

فقط دسترسی به ویرایش

دسترسی به تغییر این جزئیات برای آلبوم‌ها و موارد رسانه ایجاد شده توسط توسعه‌دهنده:

برای درخواست دسترسی با استفاده از OAuth 2.0، برنامه شما به اطلاعات محدوده و همچنین اطلاعاتی که Google هنگام ثبت برنامه خود ارائه می دهد (مانند شناسه مشتری و رمز سرویس گیرنده) نیاز دارد.

نکته: کتابخانه های سرویس گیرنده Google APIs می توانند برخی از فرآیندهای مجوز را برای شما انجام دهند. آنها برای انواع زبان های برنامه نویسی در دسترس هستند. برای جزئیات بیشتر صفحه را با کتابخانه ها و نمونه ها بررسی کنید.

انتخاب دامنه ها

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

دامنه درخواست تدریجی

با پیروی از بهترین روش‌ها برای مجوز، برنامه شما فقط باید دامنه‌هایی را که نیاز است درخواست کند. هنگام ورود به سیستم، از درخواست همه دامنه ها برای برنامه خود از قبل خودداری کنید. در عوض، توجیهی ارائه دهید و درخواست را در متن مطرح کنید. طبق دستورالعمل‌های UX و بهترین شیوه‌ها برای ارائه اخطار و درخواست رضایت، به وضوح توضیح دهید که با داده‌های کاربران خود چه خواهید کرد و چگونه با اعطای دسترسی سود خواهند برد.

حساب های خدماتی

APIهای Google Photos از حساب‌های سرویس پشتیبانی نمی‌کنند. برنامه شما باید از سایر جریان‌های OAuth 2.0 موجود مانند OAuth 2.0 برای برنامه‌های وب سرور یا OAuth 2.0 برای برنامه‌های موبایل و دسک‌تاپ استفاده کند.