شروع سریع Python

این راهنمای شروع سریع توضیح می‌دهد که چگونه یک برنامه خط فرمان ساده Python راه‌اندازی کنید که درخواست‌هایی به YouTube Data API ارسال می‌کند. این راه‌اندازی سریع درواقع توضیح می‌دهد که چگونه دو درخواست API ایجاد کنید:

1. برای بازیابی اطلاعات درباره کانال YouTube GoogleDevelopers، از کلید API استفاده خواهید کرد که برنامه شما را شناسایی می‌کند.
2. از شناسه کارخواه OAuth 2.0 برای ارسال درخواست مجاز استفاده خواهید کرد که اطلاعات مربوط به کانال YouTube خودتان را بازیابی می‌کند.

توجه: به‌طور کلی، می‌توانید دستورالعمل‌های مثال اول را برای هر مورد استفاده‌ای که از کلید میانای برنامه‌سازی کاربردی استفاده می‌کند، یا دستورالعمل‌های مثال دوم را برای هر مورد استفاده‌ای که نیاز به مجوز بااستفاده از OAuth 2.0 دارد، دنبال کنید. برای نمونه‌های بیشتر، ابزار موارد استفاده و نمونه‌های کد را ببینید.

پیش‌نیازها

برای اجرای این راهنمای شروع سریع، به موارد زیر نیاز دارید:

• Python 2.7 یا Python 3.5+‎

• ابزار مدیریت بسته pip

• کتابخانه کارخواهان Google APIs برای Python:

  pip install --upgrade google-api-python-client
  

• کتابخانه‌های google-auth-oauthlib و google-auth-httplib2 برای صدور مجوز کاربر.

  pip install --upgrade google-auth-oauthlib google-auth-httplib2
  

مرحله ۱: راه‌اندازی پروژه و اطلاعات کاربری

پروژه‌ای در کنسول Cloud ایجاد یا انتخاب کنید. تکالیف زیر را در کنسول Cloud برای پروژه‌تان تکمیل کنید:

1. در پانل کتابخانه، YouTube Data API v3 را جستجو کنید. روی فهرستگان آن «میانای برنامه‌سازی کاربردی» کلیک کنید و مطمئن شوید که «میانای برنامه‌سازی کاربردی» برای پروژه شما فعال باشد.

2. در پانل اطلاعات اعتباری، دو اطلاعات اعتباری ایجاد کنید:

   1. ایجاد کلید میانای API از کلید میانای API برای ایجاد درخواست‌های میانای API که به مجوز کاربر نیاز ندارند استفاده خواهید کرد. برای مثال، برای بازیابی اطلاعات مربوط به کانال عمومی YouTube، به مجوز کاربر نیاز ندارید.

   2. ایجاد شناسه کارخواه OAuth 2.0 نوع برنامه را روی برنامه رایانه‌ای تنظیم کنید. برای درخواست‌هایی که به مجوز کاربر نیاز دارند، باید از اعتبارنامه‌های OAuth 2.0 استفاده کنید. برای مثال، برای بازیابی اطلاعات درباره کانال YouTube کاربر اصیل‌سازی‌شده فعلی، به مجوز کاربر نیاز دارید.

      فایل JSON حاوی اطلاعات کاربری OAuth 2.0 را بارگیری کنید. نام فایل باید شبیه client_secret_CLIENTID.json باشد، که در آن CLIENTID شناسه کاربر برای پروژه شما است.

مرحله ۲: راه‌اندازی و اجرای نمونه

از ابزارک APIs Explorer در پانل کناری برای دریافت کد نمونه برای بازیابی اطلاعات درباره کانال YouTube GoogleDevelopers استفاده کنید. این درخواست از کلید میانای برنامه‌سازی کاربردی برای شناسایی برنامه شما استفاده می‌کند و به مجوز کاربر یا هیچ اجازه خاصی ازسوی کاربری که نمونه را اجرا می‌کند نیاز ندارد.

1. مستندات مربوط به روش channels.list میانای برنامه‌سازی کاربردی را باز کنید.

2. در آن صفحه، بخش «موارد استفاده رایج» حاوی جدولی است که چندین روش رایج استفاده از این متد را توضیح می‌دهد. اولین فهرستگان در جدول برای فهرست کردن نتایج براساس شناسه کانال است.

   روی نماد کد برای فهرستگان اول کلیک کنید تا «کاوشگر API تمام‌صفحه» باز و تکمیل شود.

   

3. سمت راست «کاوشگر میاناهای برنامه‌سازی کاربردی تمام‌صفحه» موارد زیر را نشان می‌دهد:

   1. در زیر سرصفحه پارامترهای درخواست، فهرستی از پارامترهایی وجود دارد که روش پشتیبانی می‌کند. مقادیر پارامتر part و id باید تنظیم شود. مقدار پارامتر id، UC_x5XG1OV2P6uZZ5FSM9Ttw، شناسه کانال YouTube مربوط به GoogleDevelopers است.

   2. در زیر پارامترها، بخشی به نام اطلاعات اعتباری وجود دارد. منوِ کرکره‌ای در آن بخش باید مقدار کلید میانای برنامه‌سازی کاربردی را نمایش دهد. APIs Explorer به‌طور پیش‌فرض از اعتبارنامه‌های نمایشی استفاده می‌کند تا شروع کار آسان‌تر شود. اما برای اجرای نمونه به‌صورت محلی، از کلید API خودتان استفاده خواهید کرد.

      

4. سمت چپ «کاوشگر API تمام‌صفحه» برگه‌هایی را با نمونه‌های کد به زبان‌های مختلف نشان می‌دهد. برگه Python را انتخاب کنید.

5. نمونه کد را کپی کنید و آن را در فایلی با نام example.py ذخیره کنید.

6. در نمونه‌ای که بارگیری کردید، رشته YOUR_API_KEY را پیدا کنید و آن را با کلید میانای برنامه‌سازی کاربردی که در مرحله ۱ این شروع سریع ایجاد کردید جایگزین کنید.

7. نمونه را از خط فرمان اجرا کنید. در دایرکتوری کاری‌تان، این دستور را اجرا کنید:

   python example.py

8. نمونه باید درخواست را اجرا کند و پاسخ را در STDOUT چاپ کند.

مرحله ۳: اجرای درخواست مجاز

در این مرحله، نمونه کد خود را به‌گونه‌ای تغییر می‌دهید که به‌جای بازیابی اطلاعات درباره کانال YouTube GoogleDevelopers، اطلاعات مربوط به کانال YouTube خودتان را بازیابی کند. این درخواست به مجوز کاربر نیاز دارد.

1. به اسناد مربوط به روش channels.list میانای برنامه‌سازی کاربردی برگردید.

2. در بخش «موارد استفاده رایج»، روی نماد کد برای سومین فهرستگان در جدول کلیک کنید. این مورد استفاده برای فراخوانی روش list برای «کانال من» است.

3. دوباره، در سمت راست «کاوشگر میاناهای برنامه‌سازی کاربردی» تمام‌صفحه، فهرستی از پارامترها را خواهید دید که پس‌از آن بخش اعتبارنامه‌ها قرار دارد. بااین‌حال، دو تغییر نسبت‌به نمونه‌ای که اطلاعات مربوط به کانال GoogleDevelopers را بازیابی کردید وجود دارد:

   1. در بخش پارامترها، به‌جای تنظیم مقدار پارامتر id، مقدار پارامتر mine باید روی true تنظیم شود. این دستور به سرور API می‌گوید اطلاعات مربوط به کانال کاربر اصالت‌سنجی‌شده فعلی را بازیابی کند.

   2. در بخش اطلاعات کاربری، منوِ کرکره‌ای باید گزینه Google OAuth 2.0 را انتخاب کند.

      علاوه‌براین، اگر روی پیوند نمایش محدوده‌ها کلیک کنید، محدوده https://www.googleapis.com/auth/youtube.readonly باید علامت زده شود.

      

4. مانند مثال قبلی، برگه Python را انتخاب کنید، نمونه کد را کپی کنید، و آن را در example.py ذخیره کنید.

   در کد، رشته YOUR_CLIENT_SECRET_FILE.json را پیدا کنید و آن را با مکان فایل رمز کارخواه که در مرحله ۱ این شروع سریع بارگیری کردید جایگزین کنید.

5. نمونه را از خط فرمان اجرا کنید. در دایرکتوری کاری‌تان، این دستور را اجرا کنید:

   python example.py

6. نشانی وب را از کنسول کپی کنید و آن را در مرورگرتان باز کنید.

   اگر قبلاً به سیستم حساب Google خود وارد نشده باشید، از شما خواسته می‌شود به سیستم وارد شوید. اگر به سیستم چند حساب Google وارد شده باشید، از شما خواسته می‌شود یک حساب را برای استفاده در فرایند صدور مجوز انتخاب کنید.

7. برای اعطای دسترسی برنامه به محدوده‌های مشخص‌شده در نمونه کد، روی دکمه کلیک کنید.

8. کد اصالت‌سنجی را از مرورگر کپی کنید و آن را در پایانه جای‌گذاری کنید. سپس می‌توانید برگه مرورگر مورداستفاده برای جریان اصالت‌سنجی را ببندید.

   پاسخ API باید دوباره در STDOUT چاپ شود.

مطالعه بیشتر

• مستندات راهنمای Google Developers Console
• مستندات کتابخانه کارخواه Google APIs برای Python
• مستندات PyDoc مربوط به YouTube Data API
• اسناد مرجع YouTube Data API