مروری بر برنامه های دسکتاپ

Google Picker API راهی است که به کاربران اجازه می‌دهد فایل‌های Google Drive را انتخاب یا آپلود کنند. کاربران می‌توانند به برنامه‌های دسک‌تاپ شما اجازه دسترسی به داده‌های Drive خود را بدهند و روشی امن و مجاز برای تعامل با فایل‌های خود ارائه دهند.

Google Picker به عنوان یک گفتگوی "فایل باز" برای فایل های ذخیره شده در Drive عمل می کند و دارای چندین ویژگی است:

  • ظاهر و احساسی مشابه رابط کاربری Google Drive .
  • چندین نما که پیش نمایش ها و تصاویر کوچک فایل های Drive را نشان می دهد.
  • تغییر مسیر به Google Picker در یک برگه جدید در مرورگر پیش فرض کاربر.

توجه داشته باشید که Google Picker به کاربران اجازه سازماندهی، انتقال یا کپی فایل ها را از یک پوشه به پوشه دیگر نمی دهد. برای مدیریت فایل‌ها، باید از Google Drive API یا Drive UI استفاده کنید.

پیش نیازها

برنامه‌هایی که از Google Picker استفاده می‌کنند باید همه شرایط خدمات موجود را رعایت کنند. مهمتر از همه، شما باید به درستی خود را در درخواست های خود شناسایی کنید.

همچنین باید یک پروژه Google Cloud داشته باشید.

محیط خود را تنظیم کنید

برای شروع استفاده از Google Picker API، باید محیط خود را تنظیم کنید.

API را فعال کنید

قبل از استفاده از Google API، باید آنها را در پروژه Google Cloud روشن کنید. می‌توانید یک یا چند API را در یک پروژه Google Cloud روشن کنید.

یک کلید API ایجاد کنید

یک کلید API یک رشته طولانی است که شامل حروف بزرگ و کوچک، اعداد، زیرخط و خط فاصله است، مانند AIzaSyDaGmWKa4JsXZ-HjGw7ISLn_3namBGewQe . این روش احراز هویت برای دسترسی ناشناس به داده‌های در دسترس عموم استفاده می‌شود، مانند فایل‌های Google Workspace که با استفاده از تنظیمات اشتراک‌گذاری «هر کسی در اینترنت با این پیوند» به اشتراک گذاشته شده است. برای جزئیات بیشتر، به مدیریت کلیدهای API مراجعه کنید.

برای ایجاد یک کلید API:

  1. در کنسول Google Cloud، به > APIs & Services > Credentials بروید.

    به Credentials بروید

  2. روی ایجاد اعتبارنامه > کلید API کلیک کنید.
  3. کلید API جدید شما نمایش داده می شود.
    • روی Copy کلیک کنید تا کلید API خود را برای استفاده در کد برنامه خود کپی کنید. کلید API را می‌توانید در بخش «کلیدهای API» اعتبار پروژه‌تان پیدا کنید.
    • برای جلوگیری از استفاده غیرمجاز، توصیه می‌کنیم کلید API را در کجا و برای کدام APIها محدود کنید. برای جزئیات بیشتر، به افزودن محدودیت‌های API مراجعه کنید.

اعتبارنامه یک برنامه دسکتاپ را تأیید کنید

برای احراز هویت کاربران نهایی و دسترسی به داده های کاربر در برنامه خود، باید یک یا چند شناسه مشتری OAuth 2.0 ایجاد کنید. شناسه مشتری برای شناسایی یک برنامه واحد در سرورهای OAuth Google استفاده می شود. اگر برنامه شما روی چندین پلتفرم اجرا می شود، باید برای هر پلتفرم یک شناسه مشتری جداگانه ایجاد کنید.
  1. در کنسول Google Cloud، به > برویدGoogle Auth platform > مشتریان

    به مشتریان بروید

  2. روی Create Client کلیک کنید.
  3. روی نوع برنامه > برنامه دسکتاپ کلیک کنید.
  4. در قسمت نام ، نامی را برای اعتبارنامه تایپ کنید. این نام فقط در کنسول Google Cloud نشان داده می شود.
  5. روی ایجاد کلیک کنید.

    اعتبار جدید ایجاد شده در زیر "OAuth 2.0 Client IDs" ظاهر می شود.

برای اینکه برنامه‌ها مجوز فایل‌هایی را که قبلاً به آنها اعطا شده است، دریافت کنند، باید از مراحل زیر استفاده کنید:

  1. شما باید با استفاده از این دستورالعمل‌ها، یک نشانه OAuth 2.0 با drive.file ، drive ، یا محدوده drive.readonly دریافت کنید: استفاده از OAuth 2.0 برای دسترسی به APIهای Google . برای اطلاعات بیشتر در مورد دامنه‌ها، به انتخاب حوزه‌های API Google Drive مراجعه کنید.

  2. توکن OAuth 2.0 را به Drive API برای خواندن و اصلاح فایل‌هایی که کاربر قبلاً به آنها اجازه دسترسی داده است، منتقل کنید.

Google Picker را نمایش دهید

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

برای اجازه دادن به کاربران برای دسترسی به فایل‌های اضافی یا انتخاب فایل‌ها برای استفاده در جریان برنامه دسک‌تاپ، این مراحل را دنبال کنید:

  1. برای باز کردن صفحه دسترسی OAuth 2.0 در یک برگه مرورگر جدید با استفاده از این دستورالعمل ها به حوزه drive.file دسترسی پیدا کنید: استفاده از OAuth 2.0 برای دسترسی به API های Google . برای اطلاعات بیشتر در مورد دامنه‌ها، به انتخاب حوزه‌های API Google Drive مراجعه کنید.

    توجه داشته باشید که فقط محدوده drive.file برای برنامه های دسکتاپ مجاز است و نمی توان آن را با هیچ محدوده دیگری ترکیب کرد.

  2. URL برای برگه مرورگر جدید همه پارامترهای رشته پرس و جو استاندارد OAuth را می پذیرد.

    شما باید پارامترهای URL prompt و trigger_onepick را به درخواست URL مجوز OAuth 2.0 خود اضافه کنید. همچنین می‌توانید Google Picker را با چندین پارامتر اختیاری سفارشی کنید:

    پارامتر توضیحات وضعیت
    prompt=consent درخواست دسترسی به فایل مورد نیاز
    trigger_onepick=true Google Picker را فعال کنید. مورد نیاز
    allow_multiple=true اگر درست است، به کاربر اجازه دهید چندین فایل را انتخاب کند. اختیاری
    mimetypes= MIMETYPES لیستی از انواع MIME جدا شده با کاما برای فیلتر کردن نتایج جستجو. اگر تنظیم نشود، فایل‌های مربوط به انواع MIME در نمای نمایش داده می‌شوند. اختیاری
    file_ids= FILE_IDS فهرستی از شناسه‌های فایل جدا شده با کاما برای فیلتر کردن نتایج جستجو. اگر تنظیم نشود، همه فایل ها در نمای نمایش داده می شوند. اختیاری

    نمونه زیر یک درخواست URL مجوز OAuth 2.0 را نشان می دهد:

    https://accounts.google.com/o/oauth2/v2/auth? \
    client_id=CLIENT_ID \
    &scope=https://www.googleapis.com/auth/drive.file \
    &redirect_uri=REDIRECT_URI \
    &response_type=code \
    &access_type=offline \
    &prompt=consent \
    &trigger_onepick=true
    

    موارد زیر را جایگزین کنید:

    • CLIENT_ID : شناسه مشتری برنامه دسک‌تاپ شما.

    • REDIRECT_URI : جایی که سرور مجوز، مرورگر کاربر را پس از احراز هویت موفقیت‌آمیز هدایت می‌کند. به عنوان مثال، https://www.cymbalgroup.com/oauth2callback .

      redirect_uri مشخص شده باید یک URL عمومی HTTPS باشد. اگر می‌خواهید از پروتکل سفارشی یا URL لوکال هاست برای redirect_uri خود استفاده کنید، باید از یک URL عمومی HTTPS استفاده کنید که سپس به پروتکل سفارشی یا URL localhost هدایت می‌شود.

  3. هنگامی که کاربر اجازه دسترسی داد و فایل های مربوطه را انتخاب کرد، OAuth به redirect_uri مشخص شده در درخواست با پارامترهای URL زیر ضمیمه شده است:

    • picked_file_ids : اگر کاربر اجازه دسترسی داده و فایل‌ها را انتخاب کند، فهرستی از شناسه‌های فایل انتخابی جدا شده با کاما.

    • code : رمز دسترسی یا کد دسترسی بر اساس پارامتر response_type تنظیم شده در درخواست. این پارامتر شامل یک کد مجوز جدید است.

    • scope : محدوده (های) موجود در درخواست.

    • error : اگر کاربر درخواست را در جریان رضایت لغو کند، یک خطا نشان داده می شود.

    نمونه زیر یک پاسخ URL مجوز OAuth 2.0 را نشان می دهد:

    https://REDIRECT_URI?picked_file_ids=PICKED_FILE_IDS&code=CODE&scope=SCOPES
    
  4. برنامه‌ها باید کد مجوز مرحله 3 را با توکن OAuth 2.0 جدید مبادله کنند. برای اطلاعات بیشتر، کد مجوز Exchange را برای بازخوانی و دسترسی به نشانه‌ها ببینید.

  5. سپس برنامه‌ها می‌توانند از شناسه‌های فایل از پارامتر URL در مرحله 3 و نشانه OAuth 2.0 به‌دست‌آمده در مرحله 4 برای فراخوانی Drive API استفاده کنند. برای اطلاعات بیشتر، نمای کلی Google Drive API را ببینید.