הגדרת הגישה ל-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 Console. תיבת דו-שיח שבה מפורטים הפרויקטים הנוכחיים מופיעה.

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, בוחרים באפשרות חשבון שירות. 'יצירת חשבון שירות' מופיעה.
3. מזינים שם בשדה Service account name.
4. (אופציונלי) עורכים את מזהה חשבון השירות.
5. לוחצים על יצירה. הרשאות "הרשאות של חשבון שירות" מופיעה.
6. לוחצים על המשך. האפשרות 'הענקת גישה למשתמשים לחשבון השירות הזה' מסך מופיעה.
7. לוחצים על יצירת מפתח ואז על סיום. "מפתח פרטי שנשמר מחשב" תופיע תיבת דו-שיח ועותק של ההורדות של המפתחות הפרטיים במחשב.
8. לוחצים על סגירה.

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

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. לוחצים על סגירה.
   4. בשדה 'היקפים', מקלידים 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 אמור לייצג את הנתונים במאגר.