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

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

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

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

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

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

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

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

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

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

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

  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.

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

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

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

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

  1. במסוף Google Cloud, בוחרים את הפרויקט שיצרתם בחלק העליון של הדף.
  2. לוחצים על תפריט הניווט שמשמאל לבאנר של מסוף Google Cloud.
  3. לוחצים על IAM and Admin (ניהול ו-IAM) > Service accounts (חשבונות שירות).
  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. בשדה scopes, מקלידים https://www.googleapis.com/auth/cloud_search.settings ולוחצים על Authorize. מגרש המשחקים של OAuth 2 מחזיר קוד הרשאה.
    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 יציג את הנתונים במאגר.