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

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

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

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

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

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

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

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

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

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

1. כדי לוודא שאתם נמצאים בפרויקט החדש שנוצר, לחצו על הסמל משמאל לבאנר של מסוף Google Cloud ובחרו את הפרויקט החדש שיצרתם.
2. לוחצים על הפעלת ממשקי API ושירותים. הדף 'ברוכים הבאים לספריית API' מופיע.
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. נותנים שם בשדה שם חשבון השירות.
4. (אופציונלי) עורכים את מספר החשבון של השירות.
5. לוחצים על יצירה. מופיע המסך 'הרשאות חשבון שירות'.
6. לוחצים על המשך. מופיע המסך "הענקת גישה למשתמשים בחשבון השירות הזה".
7. לוחצים על CREATE KEY ואז על Done. תופיע תיבת הדו-שיח 'מפתח פרטי שנשמר במחשב', ועותק של המפתח הפרטי ירד למחשב.
8. לוחצים על Close.

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

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

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

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

כדי לקרוא ל-Cloud Search APIs אחרים, צריך להפעיל תמיכה של צד שלישי ב-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. לוחצים על קוד הרשאה של Exchange עבור אסימונים. אסימון מוחזר.

3. כדי להתחיל את התמיכה של צד שלישי ב-Cloud Search, השתמשו בפקודה הבאה של צד שלישי. אל תשכחו להחליף את [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 צריך לייצג את הנתונים במאגר.