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

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

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

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

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

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

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

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

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

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

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

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

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

2. הפעלת ה-API

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

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

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

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 > חשבונות שירות.
4. ברשימה, בקטע Service account ID (מזהה חשבון שירות), שימו לב לכתובת האימייל שנוצרה שמזהה את חשבון השירות שהגדרתם. משתמשים בכתובת האימייל הזו כשמוסיפים מקור נתונים ל-Cloud Search.

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

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

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

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

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

   1. לוחצים על 'הגדרות' ומסמנים את האפשרות שימוש בפרטי הכניסה שלך לאימות.
   2. מזינים את מזהה הלקוח ואת סוד הלקוח משלב 1.
   3. לוחצים על Close.
   4. בשדה Scopes, מקלידים https://www.googleapis.com/auth/cloud_search.settings ולוחצים על Authorize. ה-Playground של 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 אמור לייצג את הנתונים במאגר.