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

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

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

הערה: באופן כללי יותר, אפשר לפעול לפי ההוראות בדוגמה הראשונה לכל תרחיש שימוש שבו נעשה שימוש במפתח API, או לפי ההוראות בדוגמה השנייה לכל תרחיש שימוש שבו נדרש אישור באמצעות OAuth 2.0. דוגמאות נוספות זמינות בכלי לתרחישים לדוגמה ודוגמאות קוד.

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

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

• ‫PHP בגרסה 5.4 ואילך עם ממשק שורת הפקודה (CLI) ותוסף JSON מותקן.
• כלי ניהול התלויות של Composer מותקן באופן גלובלי
• ספריית הלקוח של Google APIs ל-PHP:
  • אם לא התקנתם בעבר את ספריית הלקוח:

    composer require google/apiclient:^2.0

  • אם כבר התקנתם את ספריית הלקוח, מומלץ לעדכן אותה כדי לוודא שיש לכם את המחלקות העדכניות ביותר של הספרייה שאתם בודקים:

    composer update google/apiclient --with-dependencies

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

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

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

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

   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 במסך מלא ולמלא אותו.

   

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

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

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

      

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

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

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

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

   php example.php

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 צריך להיות מסומן.

      

4. כמו בדוגמה הקודמת, בוחרים בכרטיסייה PHP, מעתיקים את דוגמת הקוד ושומרים אותה בקובץ example.php.

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

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

   php example.php

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

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

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

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

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

קריאה נוספת

• מאמרי העזרה של Google Developers Console
• מסמכי התיעוד של ספריית הלקוח של Google APIs ל-PHP
• ספריית הלקוח של Google APIs ל-PHP ב-GitHub ומחלקות שנוצרו באופן אוטומטי ל-YouTube API. (בדף, מאתרים את התיקייה YouTube ואת הקובץ YouTube.php.
• מאמרי העזרה של YouTube Data API