יצירת מפתח API
תשתמשו במפתח ה-API כדי לשלוח בקשות API שלא דורשות הרשאת משתמש. לדוגמה, לא צריך הרשאת משתמש כדי לאחזר מידע על ערוץ YouTube ציבורי.
יצירת מזהה לקוח ב-OAuth 2.0
מגדירים את סוג האפליקציה לאפליקציית אינטרנט. צריך להשתמש בפרטי כניסה של OAuth 2.0 לבקשות שדורשות הרשאת משתמש. לדוגמה, צריך הרשאת משתמש כדי לאחזר מידע על ערוץ YouTube של המשתמש שאומת כרגע.
בשדה מקורות מורשים של JavaScript, מזינים את כתובת ה-URL
http://localhost:8000. אפשר להשאיר את השדה Authorized redirect URIs (כתובות URI מורשות להפניה אוטומטית) ריק.
שלב 2: הגדרה והרצה של הדוגמה
משתמשים בווידג'ט APIs Explorer בחלונית הצדדית כדי לקבל קוד לדוגמה לאחזור מידע על ערוץ YouTube של GoogleDevelopers. הבקשה הזו משתמשת במפתח API כדי לזהות את האפליקציה, והיא לא דורשת הרשאת משתמש או הרשאות מיוחדות מהמשתמש שמפעיל את הדוגמה.
בקטע 'תרחישים נפוצים לדוגמה' בדף הזה יש טבלה עם הסברים על כמה דרכים נפוצות לשימוש בשיטה. הרישום הראשון בטבלה
מיועד לתוצאות של רישום לפי מזהה ערוץ.
לוחצים על סמל הקוד של הרישום הראשון כדי לפתוח את Google APIs Explorer ולמלא אותו.
בצד ימין של API Explorer במסך מלא מוצגים הדברים הבאים:
מתחת לכותרת Request parameters מופיעה רשימה של פרמטרים שהשיטה תומכת בהם. צריך להגדיר את ערכי הפרמטרים part ו-id. ערך הפרמטר id, UC_x5XG1OV2P6uZZ5FSM9Ttw, הוא המזהה של ערוץ YouTube של GoogleDevelopers.
מתחת לפרמטרים, יש קטע בשם Credentials (פרטי כניסה). בתפריט הנפתח בקטע הזה אמור להופיע הערך API key. כברירת מחדל, הכלי APIs Explorer משתמש בפרטי כניסה להדגמה כדי שיהיה קל יותר להתחיל. אבל תצטרכו להשתמש במפתח API משלכם כדי להריץ את הדוגמה באופן מקומי.
בצד שמאל של API Explorer במסך המלא מוצגות כרטיסיות עם דוגמאות קוד בשפות שונות. לוחצים על הכרטיסייה JavaScript.
מעתיקים את הקוד לדוגמה ושומרים אותו בקובץ בשם example.html.
בדוגמה שהורדתם, מחפשים את המחרוזת YOUR_API_KEY ומחליפים אותה במפתח ה-API שיצרתם בשלב 1 של המדריך למתחילים.
מפעילים את שרת האינטרנט באמצעות הפקודה הבאה מספריית העבודה:
Python 2.x
python -m SimpleHTTPServer 8000
Python 3.x
python -m http.server 8000
פותחים את הקובץ example.html בדפדפן. פותחים גם את הכלים למפתחים בדפדפן, כמו 'הכלים למפתחים' בדפדפן Chrome.
לוחצים על הלחצן load בדף כדי לטעון את ספריית הלקוח של Google APIs ל-JavaScript. אחרי שלוחצים על הלחצן, אמורה להופיע הערה במסוף המפתחים שמציינת שהלקוח של GAPI נטען.
לוחצים על הלחצן execute (הפעלה) כדי לשלוח את בקשת ה-API. אחרי כן, תגובת ה-API תוצג במסוף של המפתח.
שלב 3: הפעלת בקשה מורשית
בשלב הזה, תשנו את דוגמת הקוד כך שבמקום לאחזר מידע על ערוץ YouTube של GoogleDevelopers, היא תאחזר מידע על ערוץ YouTube שלכם. הבקשה הזו מחייבת הרשאת משתמש.
חוזרים למאמרי העזרה של ה-API בנושא השיטה channels.list.
בקטע 'תרחישי שימוש נפוצים', לוחצים על סמל הקוד של הרשימה השלישית בטבלה. תרחיש השימוש הזה הוא קריאה לשיטה list עבור 'הערוץ שלי'.
שוב, בצד ימין של הכלי APIs Explorer במסך מלא, תופיע רשימה של פרמטרים ואחריה הקטע Credentials. עם זאת, יש שני שינויים מהדוגמה שבה אחזרתם מידע על הערוץ GoogleDevelopers:
בקטע הפרמטרים, במקום להגדיר את ערך הפרמטר id, צריך להגדיר את ערך הפרמטר mine ל-true. הפקודה הזו מורה לשרת ה-API לאחזר מידע על הערוץ של המשתמש שאומת כרגע.
בנוסף, אם לוחצים על הקישור הצגת היקפי הרשאות, היקף ההרשאות https://www.googleapis.com/auth/youtube.readonly אמור להיות מסומן.
כמו בדוגמה הקודמת, בוחרים בכרטיסייה JavaScript, מעתיקים את דוגמת הקוד ושומרים אותה ב-example.html.
בקוד, מחפשים את המחרוזת YOUR_CLIENT_ID ומחליפים אותה במזהה הלקוח שיצרתם בשלב 1 במדריך למתחילים הזה.
מפעילים את שרת האינטרנט באמצעות הפקודה הבאה מספריית העבודה:
Python 2.x
python -m SimpleHTTPServer 8000
Python 3.x
python -m http.server 8000
עוברים אל http://localhost:8000/example.html בדפדפן.
פותחים את הכלים למפתחים בדפדפן, כמו הכלים למפתחים בדפדפן Chrome.
לוחצים על הלחצן authorize and load (אישור וטעינה) בדף כדי לטעון את ספריית הלקוח של Google APIs ל-JavaScript ולהתחיל את תהליך ההרשאה.
תתבקשו לתת לאפליקציה הרשאה לקרוא נתונים מחשבון YouTube שלכם.
אם תעניקו את ההרשאה, במסוף המפתחים יוצגו הודעות שמציינות שהכניסה בוצעה בהצלחה ושהלקוח של ה-API נטען.
לוחצים על הלחצן execute (הפעלה) כדי לשלוח את בקשת ה-API. אחרי כן, תגובת ה-API תוצג במסוף של המפתח.
[null,null,["עדכון אחרון: 2025-08-21 (שעון UTC)."],[[["\u003cp\u003eThis guide demonstrates making two types of requests to the YouTube Data API: one using an API key for public data and another using OAuth 2.0 for user-specific data.\u003c/p\u003e\n"],["\u003cp\u003eTo begin, you must set up a project in the API Console, enable the YouTube Data API v3, and create both an API key and an OAuth 2.0 client ID, which will each serve a different purpose.\u003c/p\u003e\n"],["\u003cp\u003eThe guide uses the \u003ccode\u003echannels.list\u003c/code\u003e method to first retrieve information about the GoogleDevelopers YouTube channel using the API key and second retrieve information about the authenticated user's own channel using OAuth 2.0 credentials.\u003c/p\u003e\n"],["\u003cp\u003eThe sample code provided in the guide uses JavaScript, and the instructions include details for starting a local web server to run and test the API requests in a browser environment.\u003c/p\u003e\n"],["\u003cp\u003eThe process involves replacing placeholder values for the API key and OAuth 2.0 client ID in the downloaded sample code, which is necessary for the requests to succeed, and also prompts for user authorization.\u003c/p\u003e\n"]]],["This guide demonstrates making YouTube Data API requests. First, set up a project in the API Console, enabling the YouTube Data API and creating an API key and an OAuth 2.0 client ID. Then, use the APIs Explorer to generate code for retrieving channel information, replacing placeholders with your API key or client ID. Run a web server and use a browser to send requests, first using the API key, and then, modifying the code to require user authorization with OAuth 2.0 to retrieve information about the user's own channel.\n"],null,["# JavaScript Quickstart\n\nThis quickstart guide explains how to set up a simple page that makes requests\nto the YouTube Data API. This quickstart actually explains how to make two API\nrequests:\n\n1. You will use an API key, which identifies your application, to retrieve information about the GoogleDevelopers YouTube channel.\n2. You will use an OAuth 2.0 client ID to submit an *authorized* request that retrieves information about your own YouTube channel.\n\n| **Note:** More generally, you can follow the instructions for the first example for any use case that uses an API key or the instructions for the second example for any use case that requires authorization using OAuth 2.0. See the [use cases and code samples tool](/youtube/v3/code_samples/code_snippets) for more examples.\n\nPrerequisites\n-------------\n\nTo run this quickstart, you'll need:\n\n- Python 2.4 or greater (to provide a web server)\n- Access to the internet and a web browser.\n- A Google account.\n\nStep 1: Set up your project and credentials\n-------------------------------------------\n\nCreate or select a project in the [API Console](https://console.cloud.google.com/). Complete the following tasks in the API Console for your project:\n\n1. In the [library panel](https://console.developers.google.com/apis/library),\n search for the YouTube Data API v3. Click into the listing for that API and\n make sure the API is enabled for your project.\n\n2. In the [credentials\n panel](https://console.developers.google.com/apis/credentials),\n create two credentials:\n\n 1. **Create an API key**\n You will use the API key to make API requests that do\n not require user authorization. For example, you do not need user\n authorization to retrieve information about a public YouTube channel.\n\n 2. **Create an OAuth 2.0 client ID**\n\n Set the application type to **Web application**. You need to use OAuth\n 2.0 credentials for requests that require user authorization. For\n example, you need user authorization to retrieve information about the\n currently authenticated user's YouTube channel.\n\n In the **Authorized JavaScript origins** field, enter the URL\n `http://localhost:8000`. You can leave the **Authorized redirect URIs**\n field blank.\n\nStep 2: Set up and run the sample\n---------------------------------\n\nUse the APIs Explorer widget in the side panel to obtain sample code for\nretrieving information about the GoogleDevelopers YouTube channel. This request\nuses an API key to identify your application, and it does not require user\nauthorization or any special permissions from the user running the sample.\n\n1. Open the documentation for the API's [channels.list](/youtube/v3/docs/channels/list) method.\n2. On that page, the \"Common use cases\" section contains a table that explains\n several common ways that the method is used. The first listing in the table\n is for listing results by channel ID.\n\n Click the code symbol for the first listing to open and populate the\n fullscreen APIs Explorer.\n\n3. The left side of the fullscreen APIs Explorer shows the following:\n\n 1. Below the **Request parameters** header, there is a list of parameters\n that the method supports. The `part` and `id` parameter values should\n be set. The `id` parameter value, `UC_x5XG1OV2P6uZZ5FSM9Ttw`, is the\n ID for the GoogleDevelopers YouTube channel.\n\n 2. Below the parameters, there is a section named **Credentials** . The\n pulldown menu in that section should display the value **API key**. The\n APIs Explorer uses demo credentials by default to make it easier to get\n started. But you'll use your own API key to run the sample locally.\n\n4. The right side of the fullscreen APIs Explorer shows tabs with code samples\n in different languages. Select the **JavaScript** tab.\n\n5. Copy the code sample and save it in a file named\n `example.html`.\n\n6. In the sample that you downloaded, find the `YOUR_API_KEY` string and\n replace that with the API key that you created in step 1 of this quickstart.\n\n7. Start the web server using the following command from your working\n directory:\n\n ### Python 2.x\n\n python -m SimpleHTTPServer 8000\n\n ### Python 3.x\n\n python -m http.server 8000\n\n8. Open the example.html file in your browser. Also open the browser's\n developer tools, such as the \"Developer Tools\" in the Chrome browser.\n\n 1. Click the **load** button on the page to load the Google APIs Client\n Library for JavaScript. After you click the button, the developer\n console should display a note indicating that the GAPI client loaded.\n\n 2. Click the **execute** button to send the API request. The developer's\n console should then display the API response.\n\nStep 3: Run an authorized request\n---------------------------------\n\nIn this step, you'll modify your code sample so that instead of retrieving\ninformation about the GoogleDevelopers YouTube channel, it retrieves information\nabout *your* YouTube channel. This request does require user authorization.\n\n1. Go back to the documentation for the API's\n [channels.list](/youtube/v3/docs/channels/list) method.\n\n2. In the \"Common use cases\" section, click the code symbol for the third\n listing in the table. That use case is to call the `list` method for \"my\n channel.\"\n\n3. Again, in the left side of the fullscreen APIs Explorer, you will see a\n list of parameters followed by the **Credentials** section. However, there\n are two changes from the example where you retrieved information about the\n GoogleDevelopers channel:\n\n 1. In the parameters section, instead of the `id` parameter value being\n set, the `mine` parameter value should be set to `true`. This instructs\n the API server to retrieve information about the currently authenticated\n user's channel.\n\n 2. In the **Credentials** section, the pulldown menu should select the\n option for **Google OAuth 2.0**.\n\n In addition, if you click the **Show scopes** link, the\n **https://www.googleapis.com/auth/youtube.readonly** scope should be\n checked.\n\n4. As with the previous example, select the **JavaScript** tab,\n copy the code sample, and save it to `example.html`.\n\n In the code, find the `YOUR_CLIENT_ID` string and replace it with the\n client ID that you created in step 1 of this quickstart.\n5. Start the web server using the following command from your working\n directory:\n\n ### Python 2.x\n\n python -m SimpleHTTPServer 8000\n\n ### Python 3.x\n\n python -m http.server 8000\n\n6. Go to `http://localhost:8000/example.html` file in your browser.\n Open the browser's developer tools, such as the \"Developer Tools\" in the\n Chrome browser.\n\n7. Click the **authorize and load** button on the page to load the Google\n APIs Client Library for JavaScript and initiate the authorization flow.\n You should be prompted to grant the application permission to read data\n from your YouTube account.\n\n If you grant the permission, the developer's console should display\n messages indicating that sign-in was successful and that the API client\n loaded.\n8. Click the **execute** button to send the API request. The developer's\n console should then display the API response.\n\nFurther reading\n---------------\n\n- [Google Developers Console help documentation](/console/help/new)\n- [Google APIs Client Library for JavaScript documentation](/api-client-library/javascript)\n- [YouTube Data API reference documentation](/youtube/v3/docs)"]]
