מדריך למתחילים ב-Python

במדריך הזה למתחילים מוסבר איך להגדיר אפליקציה פשוטה של שורת פקודה ב-Python ששולחת בקשות ל-YouTube Data API. במדריך הזה למתחילים מוסבר איך לשלוח שתי בקשות API:

  1. כדי לאחזר מידע על ערוץ YouTube של GoogleDevelopers, תשתמשו במפתח API שמזהה את האפליקציה שלכם.
  2. תשתמשו במזהה לקוח ב-OAuth 2.0 כדי לשלוח בקשה מורשית לאחזור מידע על ערוץ YouTube שלכם.

דרישות מוקדמות

כדי להפעיל את המדריך למתחילים הזה, אתם צריכים שיהיו לכם:

  • ‫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

שלב 1: מגדירים את הפרויקט ופרטי הכניסה

יוצרים פרויקט במסוף Cloud או בוחרים פרויקט קיים. במסוף Cloud, מבצעים את המשימות הבאות בפרויקט:

  1. בחלונית הספרייה, מחפשים את YouTube Data API v3. לוחצים על ה-API ברשימה ומוודאים שהוא מופעל בפרויקט.

  2. בחלונית פרטי הכניסה, יוצרים שני פרטי כניסה:

    1. יצירת מפתח API תשתמשו במפתח ה-API כדי לשלוח בקשות API שלא דורשות הרשאת משתמש. לדוגמה, לא צריך הרשאת משתמש כדי לאחזר מידע על ערוץ YouTube ציבורי.

    2. יוצרים מזהה לקוח ב-OAuth 2.0 מגדירים את סוג האפליקציה כאפליקציה למחשב. צריך להשתמש בפרטי כניסה של OAuth 2.0 לבקשות שדורשות הרשאת משתמש. לדוגמה, אתם צריכים הרשאת משתמש כדי לאחזר מידע על ערוץ YouTube של המשתמש המאומת הנוכחי.

      מורידים את קובץ ה-JSON שמכיל את פרטי הכניסה ל-OAuth 2.0. שם הקובץ הוא client_secret_CLIENTID.json, כאשר CLIENTID הוא מזהה הלקוח של הפרויקט.

שלב 2: מגדירים ומריצים את הדוגמה

אפשר להשתמש בווידג'ט APIs Explorer בחלונית הצדדית כדי לקבל קוד לדוגמה לאחזור מידע על ערוץ YouTube של GoogleDevelopers. הבקשה הזו משתמשת במפתח API כדי לזהות את האפליקציה, והיא לא דורשת הרשאת משתמש או הרשאות מיוחדות מהמשתמש שמריץ את הדוגמה.

  1. פותחים את מאמרי העזרה של ה-method‏ channels.list ב-API.

  2. בקטע 'תרחישים נפוצים לדוגמה' בדף הזה יש טבלה עם הסבר על כמה מהדרכים הנפוצות לשימוש בשיטה. הרישום הראשון בטבלה הוא של תוצאות הרישום לפי מזהה הערוץ.

    לוחצים על סמל הקוד של הרשומה הראשונה כדי לפתוח את APIs Explorer במסך מלא ולמלא אותו.

    תמונה שמזהה את המיקום של הקישור הסימבולי לסמל הקוד בטבלה שמופיעה במסמכי התיעוד של channels.list, שבה מפורטים תרחישי השימוש בערוצים. הטקסט החלופי של התמונה מזהה אותה כסמל קוד ומציין את תרחיש השימוש שמשויך לקישור הזה.

  3. בצד שמאל של API Explorer במסך מלא מוצגים הפרטים הבאים:

    1. מתחת לכותרת Request parameters מופיעה רשימה של הפרמטרים שה-method תומכת בהם. צריך להגדיר את ערכי הפרמטרים part ו-id. ערך הפרמטר id, UC_x5XG1OV2P6uZZ5FSM9Ttw, הוא המזהה של ערוץ GoogleDevelopers ב-YouTube.

    2. מתחת לפרמטרים, יש קטע בשם Credentials. בתפריט הנפתח שבקטע הזה צריך להופיע הערך מפתח API. כדי שיהיה קל יותר להתחיל, כברירת מחדל, ב-APIs Explorer נעשה שימוש בפרטי כניסה לדמו. אבל תצטרכו להשתמש במפתח API משלכם כדי להריץ את הדוגמה באופן מקומי.

      תמונה שבה מוצג הקטע Credentials ב-APIs Explorer במסך מלא, והתפריט הנפתח שבו נבחרה האפשרות API key.

  4. בצד שמאל של APIs Explorer במסך מלא מוצגות כרטיסיות עם דוגמאות קוד בשפות שונות. לוחצים על הכרטיסייה Python.

  5. מעתיקים את דוגמת הקוד ושומרים אותה בקובץ בשם example.py.

  6. בדוגמה שהורדתם, מחפשים את המחרוזת YOUR_API_KEY ומחליפים אותה במפתח ה-API שיצרתם בשלב 1 של המדריך למתחילים.

  7. מריצים את הדוגמה משורת הפקודה. בספריית העבודה, מריצים את הפקודה:

    python example.py

  8. הדוגמה צריכה לבצע את הבקשה ולהדפיס את התשובה ל-STDOUT.

שלב 3: מריצים בקשה מורשית

בשלב הזה תשנו את דוגמת הקוד כך שבמקום לאחזר מידע על ערוץ YouTube של GoogleDevelopers, היא תאחזר מידע על ערוץ YouTube שלכם. הבקשה הזו דורשת הרשאת משתמש.

  1. חוזרים למאמרי העזרה של ה-API של השיטה channels.list.

  2. בקטע "Common use cases", לוחצים על סמל הקוד של הרשומה השלישית בטבלה. תרחיש לדוגמה כזה הוא קריאה ל-method‏ list עבור "הערוץ שלי".

  3. שוב, בצד ימין של הכלי APIs Explorer במסך מלא, תופיע רשימה של פרמטרים ואחריה הקטע Credentials. עם זאת, יש שני שינויים מהדוגמה שבה אחזרתם מידע על הערוץ GoogleDevelopers:

    1. בקטע הפרמטרים, במקום להגדיר את ערך הפרמטר id, צריך להגדיר את ערך הפרמטר mine כ-true. הפקודה הזו מורה לשרת ה-API לאחזר מידע על הערוץ של המשתמש שאומת כרגע.

    2. בקטע Credentials (פרטי כניסה), בתפריט הנפתח, בוחרים באפשרות Google OAuth 2.0.

      בנוסף, אם לוחצים על הקישור Show scopes, ההיקף https://www.googleapis.com/auth/youtube.readonly צריך להיות מסומן.

      תמונה שבה מוצגים היקפי ההרשאות בכלי APIs Explorer במסך מלא, והאפשרות להשתמש בפרטי הכניסה של Google OAuth 2.0 מסומנת.

  4. כמו בדוגמה הקודמת, בוחרים בכרטיסייה Python, מעתיקים את דוגמת הקוד ושומרים אותה ב-example.py.

    בקוד, מוצאים את המחרוזת YOUR_CLIENT_SECRET_FILE.json ומחליפים אותה במיקום של קובץ סוד הלקוח שהורדתם בשלב 1 של המדריך למתחילים.

  5. מריצים את הדוגמה משורת הפקודה. בספריית העבודה, מריצים את הפקודה:

    python example.py

  6. מעתיקים את כתובת ה-URL מהמסוף ופותחים אותה בדפדפן.

    אם עדיין לא התחברתם לחשבון Google, תתבקשו להתחבר. אם אתם מחוברים לכמה חשבונות Google, תתבקשו לבחור חשבון אחד שבו תרצו להשתמש לצורך ההרשאה.

  7. לוחצים על הכפתור כדי לתת לאפליקציה גישה להיקפי ההרשאות שצוינו בדוגמת הקוד.

  8. מעתיקים את קוד האימות מהדפדפן ומדביקים אותו במסוף. אחרי כן אפשר לסגור את הכרטיסייה בדפדפן שבה השתמשתם לתהליך האימות.

    התגובה מה-API אמורה להיות מודפסת שוב ב-STDOUT.

קריאה נוספת