קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
כדי להשתמש ב-Google Cloud Search API ישירות או דרך SDK, צריך להגדיר גישה ל-API הזה. במסמך הזה מוסבר איך להשתמש ב-Google Cloud Search API REST API.
1. יצירת פרויקט API
כדי להפעיל את ה-API, קודם צריך ליצור פרויקט ב-Google Cloud. הפרויקט הזה הוא הבסיס ליצירה, להפעלה ולשימוש של כל שירותי Google Cloud, כולל ניהול ממשקי API, הפעלת החיוב, הוספה והסרה של שותפי עריכה וניהול הרשאות.
בחלק העליון של הדף, לוחצים על arrow_drop_down משמאל ל-Google Cloud Console. מופיעה תיבת דו-שיח עם רשימת הפרויקטים הנוכחיים.
לוחצים על פרויקט חדש. יופיע המסך 'פרויקט חדש'.
מזינים שם לפרויקט בשדה Project Name (שם הפרויקט).
(אופציונלי) לוחצים על עריכה כדי לערוך את מזהה הפרויקט. אי אפשר לשנות את מזהה הפרויקט אחרי שהוא נוצר, לכן חשוב לבחור מזהה שיענה על הצרכים שלכם למשך חיי הפרויקט.
כדי לעיין במיקומים של הפרויקט, לוחצים על עיון.
לוחצים על מיקום לפרויקט ואז על בחירה.
לוחצים על יצירה. המסוף יעבור לדף לוח הבקרה. הפרויקט נוצר תוך כמה דקות.
במסוף Google Cloud, לוחצים על Credentials (פרטי כניסה) בתפריט הניווט שמימין. יופיע הדף 'פרטי הכניסה'.
ברשימה הנפתחת Create credentials, בוחרים באפשרות Service account. מופיע הדף 'יצירת חשבון שירות'.
כותבים שם בשדה Service account name.
(אופציונלי) עורכים את מזהה חשבון השירות.
לוחצים על יצירה. מופיע המסך 'הרשאות של חשבון שירות'.
לוחצים על המשך. מופיע המסך 'הענקת גישה לחשבון השירות הזה'.
לוחצים על CREATE KEY ואז על Done. מופיעה תיבת דו-שיח עם הכיתוב Private key saved to your computer (המפתח הפרטי נשמר במחשב שלך), ועובר למחשב שלכם עותק של המפתח הפרטי.
לוחצים על תפריט הניווט שמימין לבאנר של מסוף Google Cloud.
לוחצים על IAM ואדמין > חשבונות שירות.
ברשימה, בקטע Service account ID (מזהה חשבון שירות), רושמים את כתובת האימייל שנוצרה ומזהה את חשבון השירות שהגדרתם. כתובת האימייל הזו משמשת להוספת מקור נתונים ל-Cloud Search.
5. הפעלת תמיכה של צד שלישי
כדי שתוכלו לקרוא לממשקי API אחרים של Cloud Search, אתם צריכים לאתחל תמיכה בצד שלישי ב-Google Cloud Search.
כדי לאתחל תמיכה בצד שלישי ב-Cloud Search:
פרויקט הפלטפורמה של Cloud Search מכיל פרטי כניסה של חשבון שירות. עם זאת, כדי להפעיל תמיכה בצד שלישי, צריך ליצור פרטי כניסה לאפליקציית אינטרנט. הוראות ליצירת פרטי כניסה לאפליקציות אינטרנט מפורטות במאמר יצירת פרטי כניסה. בסיום השלב הזה, אמור להיות לכם קובץ עם מזהה לקוח וסוד לקוח.
אם אתם מתכננים להשתמש ב-Google Cloud Search עם מאגר נתונים שאינו של Google, כמו Microsoft® SharePoint®, אתם צריכים ליצור מקור נתונים. הוראות להוספת מקור נתונים מפורטות במאמר הוספת מקור נתונים לחיפוש.
אחרי שמגדירים את מקור הנתונים, אפשר ליצור ולרשום סכימה כדי לציין איך Google Cloud Search צריך לייצג את הנתונים במאגר.
[[["התוכן קל להבנה","easyToUnderstand","thumb-up"],["התוכן עזר לי לפתור בעיה","solvedMyProblem","thumb-up"],["סיבה אחרת","otherUp","thumb-up"]],[["חסרים לי מידע או פרטים","missingTheInformationINeed","thumb-down"],["התוכן מורכב מדי או עם יותר מדי שלבים","tooComplicatedTooManySteps","thumb-down"],["התוכן לא עדכני","outOfDate","thumb-down"],["בעיה בתרגום","translationIssue","thumb-down"],["בעיה בדוגמאות/בקוד","samplesCodeIssue","thumb-down"],["סיבה אחרת","otherDown","thumb-down"]],["עדכון אחרון: 2025-08-04 (שעון UTC)."],[],[],null,["You must configure access to the Google Cloud Search API before you can\nuse this API either directly or through an SDK. This document\ncovers the steps required to use the Google Cloud Search API REST API.\n\n1. Create an API project\n\nTo enable the API, you must first create an Google Cloud project. This\nproject forms the basis for creating, enabling, and using all Google Cloud\nservices, including managing APIs, enabling billing, adding and\nremoving collaborators, and managing permissions.\n\n1. Open the [Google Cloud console](https://console.cloud.google.com/apis/dashboard).\n\n2. At the top of the page, click\n arrow_drop_down\n to the right of \"Google Cloud Console.\" A dialog listing current projects\n appears.\n\n3. Click **NEW PROJECT**. The \"New Project\" screen appears.\n\n4. Enter a project name in the **Project Name** field.\n\n5. (optional) Click **Edit** to edit the Project ID. The project ID can't be\n changed after the project is created, so choose an\n ID that meets your needs for the lifetime of the project.\n\n6. To browse locations for the project, click **BROWSE**.\n\n7. Click on a location for your project and click **Select**.\n\n8. Click **Create**. The console navigates to the Dashboard page. The project\n is created within a few minutes.\n\nFor further information on creating and managing projects, refer to\n[Creating and Managing Projects](https://support.google.com/cloud#topic=6158848).\n\n2. Enable the API\n\nYou need to enable the Google Cloud Search API and create a service account to\nobtain credentials.\n\n1. To ensure you are on the newly created project, click the arrow_drop_down icon to the right of the Google Cloud console banner and select your newly-created project.\n2. Click **ENABLE APIS AND SERVICES**. The \"Welcome to API Library\" page appears.\n3. Navigate to the [Google Cloud Search API](https://console.cloud.google.com/apis/api/cloudsearch.googleapis.com).\n4. Click **Enable**. The \"Overview\" page appears.\n\nFor further information on enabling and disabling APIs, refer to\n[Manage APIs in the Google Cloud console](https://support.google.com/cloud/answer/6326510)\n| **Note:** Different Cloud Search APIs require different accounts to execute (admin, service, and user). For further information, refer to the [reference documentation](/workspace/cloud-search/docs/reference) for the method you want to call.\n\n3. Create service account credentials\n\n1. In the [Google Cloud console](https://console.cloud.google.com/apis/library), click **Credentials** in the left navigation. The Credential page appears.\n2. From the **Create credentials** drop-down list, select **Service account**. The \"Create service account\" page appears.\n3. Enter a name in the **Service account name** field.\n4. (optional) Edit the service account ID.\n5. Click **Create**. A \"Service account permissions\" screen appears.\n6. Click **Continue**. A \"Grant users access to this service account\" screen appears.\n7. Click **CREATE KEY** and click **Done**. A \"Private key saved to your computer\" dialog appears and a copy of the private key downloads to your computer.\n8. Click **Close**.\n\nFor further information on service accounts, refer to\n[Service accounts, web applications, and installed applications](https://support.google.com/cloud/answer/6158849#serviceaccounts)\n\n4. Identify email address\n\n1. From the [Google Cloud console](https://console.cloud.google.com/apis/dashboard), select the project you created at the top of the page.\n2. Click the Navigation menu to the left of the Google Cloud console banner.\n3. Click **IAM and Admin** \\\u003e **Service accounts**.\n4. In the list, under \"Service account ID,\" make note of the generated email address that identifies the service account you configured. This email address is used when adding a data source to Cloud Search.\n\n5. Initialize third-party support\n\nBefore you can call any other Cloud Search APIs, you must initialize third-party\nsupport for Google Cloud Search.\n| **Note:** If you successfully executed the Cloud Search tutorial, you have already initialized third-party support for Cloud Search and can skip this step.\n\nTo initialize third-party support for Cloud Search:\n\n1. Your Cloud Search platform project contains service account credentials.\n However, for the sake of initializing third-party support, you must create web\n application credentials. For instructions on how to create web application\n credentials, refer to\n [Create credentials](/workspace/guides/create-credentials).\n Upon completing this step, you should have a client ID and client secret file.\n\n2. Use\n [Google's OAuth 2 playground](https://developers.google.com/oauthplayground/)\n to obtain an access token:\n\n 1. Click settings and check **User your own auth credentials**.\n 2. Enter the client ID and client secret from step 1.\n 3. Click **Close**.\n 4. In the scopes field, type `https://www.googleapis.com/auth/cloud_search.settings` and click **Authorize**. The OAuth 2 playground returns an authorization code.\n 5. Click **Exchange authorization code for tokens**. A token is returned.\n3. To initialize third-party support for Cloud Search, use the following curl\n command. Be sure to substitute `[YOUR_ACCESS_TOKEN]` with the token obtained in\n step 2.\n\n curl --request POST \\\n 'https://cloudsearch.googleapis.com/v1:initializeCustomer' \\\n --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \\\n --header 'Accept: application/json' \\\n --header 'Content-Type: application/json' \\\n --data '{}' \\\n --compressed\n\n If successful, the response body contains an instance of\n [`operation`](/workspace/cloud-search/docs/reference/rest/v1/operations#Operation). For\n example: \n\n {\n name: \"operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY\"\n }\n\n If unsuccessful, contact Cloud Search support.\n4. Use [operations.get](/workspace/cloud-search/docs/reference/rest/v1/operations/get) to verify that\n third-party support is initialized:\n\n curl \\\n 'https://cloudsearch.googleapis.com/v1/operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY?key=\n [YOUR_API_KEY]' \\\n --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \\\n --header 'Accept: application/json' \\\n --compressed\n\n When the third-party initialization is complete, it contains the\n field `done` set to `true`. For example: \n\n {\n name: \"operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY\"\n done: true\n }\n\nNext Steps\n\nHere are few next steps you might take:\n\n1. If you plan on using Google Cloud Search with a non-Google data repository,\n such as Microsoft® SharePoint®, you\n must create a data source. For instructions on\n adding a data source, refer to\n [Add a data source to search](https://support.google.com/a/answer/7056471).\n\n2. Once you set up your data source, you can\n [create and register schema](/workspace/cloud-search/docs/guides/schema-guide) to identify\n how Google Cloud Search should represent the data in the repository."]]