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

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

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

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

1. פותחים את מסוף Google Cloud.

2. בחלק העליון של הדף, לוחצים על משמאל ל-Google Cloud Console. מופיעה תיבת דו-שיח עם רשימת הפרויקטים הנוכחיים.

3. לוחצים על פרויקט חדש. יופיע המסך 'פרויקט חדש'.

4. מזינים שם לפרויקט בשדה Project Name (שם הפרויקט).

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

6. כדי לעיין במיקומים של הפרויקט, לוחצים על עיון.

7. לוחצים על מיקום לפרויקט ואז על בחירה.

8. לוחצים על יצירה. המסוף יעבור לדף לוח הבקרה. הפרויקט נוצר תוך כמה דקות.

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

2. הפעלת ה-API

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

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

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

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

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

1. במסוף Google Cloud, לוחצים על Credentials (פרטי כניסה) בתפריט הניווט שמימין. יופיע הדף 'פרטי הכניסה'.
2. ברשימה הנפתחת Create credentials, בוחרים באפשרות Service account. מופיע הדף 'יצירת חשבון שירות'.
3. כותבים שם בשדה Service account name.
4. (אופציונלי) עורכים את מזהה חשבון השירות.
5. לוחצים על יצירה. מופיע המסך 'הרשאות של חשבון שירות'.
6. לוחצים על המשך. מופיע המסך 'הענקת גישה לחשבון השירות הזה'.
7. לוחצים על CREATE KEY ואז על Done. מופיעה תיבת דו-שיח עם הכיתוב Private key saved to your computer (המפתח הפרטי נשמר במחשב שלך), ועובר למחשב שלכם עותק של המפתח הפרטי.
8. לוחצים על סגירה.

מידע נוסף על חשבונות שירות זמין במאמר חשבונות שירות, אפליקציות אינטרנט ואפליקציות מותקנות

4. זיהוי כתובת אימייל

1. במסוף Google Cloud, בוחרים את הפרויקט שיצרתם בראש הדף.
2. לוחצים על תפריט הניווט שמימין לבאנר של מסוף Google Cloud.
3. לוחצים על IAM ואדמין > חשבונות שירות.
4. ברשימה, בקטע Service account ID (מזהה חשבון שירות), רושמים את כתובת האימייל שנוצרה ומזהה את חשבון השירות שהגדרתם. כתובת האימייל הזו משמשת להוספת מקור נתונים ל-Cloud Search.

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

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

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

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

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

2. משתמשים ב-Google's OAuth 2 playground כדי לקבל אסימון גישה:

   1. לוחצים על סמל ההגדרות ומסמנים את התיבה שימוש בפרטי הכניסה שלכם לאימות.
   2. מזינים את מזהה הלקוח ואת הסוד של הלקוח משלב 1.
   3. לוחצים על סגירה.
   4. בשדה 'היקפים', מקלידים https://www.googleapis.com/auth/cloud_search.settings ולוחצים על הרשאה. ה-OAuth 2 playground מחזיר קוד הרשאה.
   5. לוחצים על Exchange authorization code for tokens (החלפת קוד הרשאה באסימונים). מוחזר טוקן.

3. כדי לאתחל תמיכה בצד שלישי ב-Cloud Search, משתמשים בפקודת curl הבאה. חשוב להחליף את [YOUR_ACCESS_TOKEN] באסימון שהתקבל בשלב 2.

   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. לדוגמה:

   {
   name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY"
   }
   

   אם הניסיון לא מצליח, פנו לתמיכה של Cloud Search.

4. משתמשים ב-operations.get כדי לוודא שתמיכת הצד השלישי אותחלה:

   curl \
   'https://cloudsearch.googleapis.com/v1/operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY?key=
   [YOUR_API_KEY]' \
   --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
   --header 'Accept: application/json' \
   --compressed
   

   כשהאתחול של הצד השלישי מסתיים, הוא מכיל את השדה done שמוגדר לערך true. לדוגמה:

   {
   name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY"
   done: true
   }
   

השלבים הבאים

הנה כמה שלבים אפשריים:

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

2. אחרי שמגדירים את מקור הנתונים, אפשר ליצור ולרשום סכימה כדי לציין איך Google Cloud Search צריך לייצג את הנתונים במאגר.