הגדרת הגישה ל-Google Cloud Search API

כדי להשתמש ב-Google Cloud Search API ישירות או דרך SDK, צריך להגדיר גישה אליו. במסמך הזה מפורטים השלבים הנדרשים ל-Cloud Search API בארכיטקטורת REST.

1. יצירת פרויקט API

כדי להפעיל את ה-API, קודם צריך ליצור פרויקט בענן ב-Google Cloud. הפרויקט הזה הוא הבסיס לשימוש בשירותי Google Cloud, לניהול ממשקי API ולהגדרת הרשאות.

1. פותחים את מסוף Google Cloud.
2. לוחצים על התפריט הנפתח של הפרויקט משמאל ל-מסוף Google Cloud ובוחרים באפשרות NEW PROJECT (פרויקט חדש).
3. מזינים שם בשדה Project Name (שם הפרויקט).
4. (אופציונלי) לוחצים על עריכה כדי לשנות את מזהה הפרויקט. אי אפשר לשנות את המזהה הזה אחרי שיוצרים אותו.
5. לוחצים על עיון כדי לבחור מיקום, ואז לוחצים על בחירה.
6. לוחצים על יצירה. בדרך כלל הפרויקט מוכן תוך כמה דקות.

למידע נוסף, קראו את המאמר בנושא יצירה וניהול של פרויקטים.

2. הפעלת ה-API

מפעילים את Cloud Search API ויוצרים חשבון שירות כדי לקבל פרטי כניסה.

1. בוחרים את הפרויקט החדש מהתפריט הנפתח בבאנר של מסוף Google Cloud.
2. לוחצים על ENABLE APIS AND SERVICES.
3. מחפשים את Google Cloud Search API ובוחרים אותו.
4. לוחצים על הפעלה.

מידע נוסף מופיע במאמר ניהול ממשקי API במסוף Google Cloud.

הערה: שיטות שונות של Cloud Search API דורשות סוגים שונים של חשבונות (אדמין, שירות או משתמש). פרטים נוספים מופיעים במאמרי העזרה.

3. יצירת פרטי כניסה לחשבון שירות

1. במסוף Google Cloud, לוחצים על Credentials (פרטי כניסה) בתפריט הניווט שמימין.
2. בתפריט הנפתח Create credentials, בוחרים באפשרות Service account.
3. כותבים שם בשדה Service account name.
4. (אופציונלי) עורכים את מזהה חשבון השירות.
5. לוחצים על יצירה והמשך.
6. לוחצים על Done כדי להגיע לרשימה 'Service accounts'.
7. לוחצים על כתובת האימייל של חשבון השירות החדש ואז בוחרים בכרטיסייה Keys.
8. לוחצים על ADD KEY (הוספת מפתח) > Create new key (יצירת מפתח חדש).
9. בוחרים באפשרות JSON ולוחצים על Create (יצירה). המפתח הפרטי יורד למחשב.

למידע נוסף, קראו את המאמר חשבונות שירות.

4. זיהוי כתובת האימייל בחשבון השירות

1. במסוף Google Cloud, בוחרים את הפרויקט.
2. לוחצים על תפריט הניווט > IAM & Admin > Service Accounts.
3. רושמים את כתובת האימייל של חשבון השירות. צריך את זה כדי להוסיף מקור נתונים ל-Cloud Search.

5. הפעלת תמיכה של צד שלישי

צריך לאתחל את התמיכה בצד שלישי ב-Google Cloud Search לפני שקוראים ל-API אחר של Cloud Search.

הערה: אם השלמתם את המדריך ל-Cloud Search, כבר הפעלתם תמיכה בצד שלישי ואפשר לדלג על השלב הזה.

כדי לאתחל תמיכה בצד שלישי:

1. יוצרים פרטי כניסה לאפליקציית אינטרנט בפרויקט של פלטפורמת Cloud Search. איך יוצרים פרטי כניסה צריך את מזהה הלקוח ואת הסוד של הלקוח.
2. מקבלים אסימון גישה באמצעות OAuth 2.0 Playground:
   1. לוחצים על OAuth 2.0 Configuration (סמל ההגדרות) ומסמנים את התיבה Use your own OAuth credentials (שימוש בפרטי הכניסה שלכם ב-OAuth).
   2. מזינים את מזהה הלקוח ואת הסוד של הלקוח.
   3. בשדה 'היקפים', מזינים https://www.googleapis.com/auth/cloud_search.settings ולוחצים על Authorize APIs (אישור ממשקי API).
   4. לוחצים על Exchange authorization code for tokens (החלפת קוד הרשאה באסימונים).

3. מריצים את פקודת ה-curl הבאה ומחליפים את [YOUR_ACCESS_TOKEN] באסימון שלכם:

   curl --request POST \
   'https://cloudsearch.googleapis.com/v1:initializeCustomer' \
     --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --data '{}' \
     --compressed
   

   אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול את operation. אם הפעולה נכשלת, פנו לתמיכה של Cloud Search.

4. כדי לאמת את ההפעלה, משתמשים ב-operations.get:

   curl 'https://cloudsearch.googleapis.com/v1/operations/<var>operation_name</var>?key=[YOUR_API_KEY]' \
   --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
   --header 'Accept: application/json' \
   --compressed
   

   האתחול מסתיים כשערך המשתנה done הוא true.

השלבים הבאים

1. כדי להשתמש ב-Cloud Search עם מאגר שאינו של Google, כמו Microsoft® SharePoint®, צריך ליצור מקור נתונים. איך מוסיפים מקור נתונים לחיפוש
2. אחרי שמגדירים את מקור הנתונים, צריך ליצור סכימה ולרשום אותה כדי להגדיר איך Cloud Search מייצג את הנתונים.