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

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

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

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

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

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

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

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

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

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

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

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

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

2. מפעילים את ה-API

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

1. כדי לוודא שאתם עובדים עם הפרויקט החדש שנוצר, לוחצים על הסמל שמשמאל לבאנר במסוף Google Cloud ובוחרים את הפרויקט החדש שיצרתם.
2. לוחצים על ENABLE APIS AND SERVICES. הדף "Welcome to 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. ייפתח הדף Create service account.
3. מזינים שם בשדה Service account name.
4. (אופציונלי) עורכים את מספר חשבון השירות.
5. לוחצים על יצירה. יופיע המסך 'הרשאות של חשבון שירות'.
6. לוחצים על המשך. יופיע המסך 'הענקת גישה לחשבון השירות הזה'.
7. לוחצים על יצירת מפתח ואז על סיום. תופיע תיבת הדו-שיח 'מפתח פרטי שנשמר במחשב שלך' ועותק של המפתח הפרטי יורד למחשב שלך.
8. לוחצים על Close.

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

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

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

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

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

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

כדי להפעיל תמיכה של צד שלישי ב-Cloud Search:

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

2. תוכלו להשתמש במגרש המשחקים של OAuth 2 של Google כדי לקבל אסימון גישה:

   1. לוחצים על 'הגדרות' ומסמנים את האפשרות שימוש בפרטי הכניסה שלך לצורך אימות.
   2. מזינים את מזהה הלקוח ואת סוד הלקוח משלב 1.
   3. לוחצים על Close.
   4. בשדה ההיקפים, מקלידים https://www.googleapis.com/auth/cloud_search.settings ולוחצים על Authorize. מגרש המשחקים של OAuth 2 מחזיר קוד הרשאה.
   5. לוחצים על החלפת קוד הרשאה לאסימונים. האסימון מוחזר.

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 אמור לייצג את הנתונים במאגר.