قبل از اینکه بتوانید مستقیماً یا از طریق یک SDK از این API استفاده کنید، باید دسترسی به Google Cloud Search API را پیکربندی کنید. این سند مراحل مورد نیاز برای استفاده از Google Cloud Search API REST API را پوشش می دهد.
1. یک پروژه API ایجاد کنید
برای فعال کردن API، ابتدا باید یک پروژه Google Cloud ایجاد کنید. این پروژه اساس ایجاد، فعال کردن و استفاده از همه سرویسهای Google Cloud، از جمله مدیریت APIها، فعال کردن صورتحساب، افزودن و حذف همکاران و مدیریت مجوزها را تشکیل میدهد.
کنسول Google Cloud را باز کنید.
در بالای صفحه، روی
در سمت راست "Google Cloud Console" کلیک کنید. گفتگوی لیست پروژه های فعلی ظاهر می شود.روی پروژه جدید کلیک کنید. صفحه "پروژه جدید" ظاهر می شود.
نام پروژه را در قسمت Project Name وارد کنید.
(اختیاری) برای ویرایش شناسه پروژه روی Edit کلیک کنید. شناسه پروژه پس از ایجاد پروژه قابل تغییر نیست، بنابراین شناسه ای را انتخاب کنید که نیازهای شما را برای طول عمر پروژه برآورده کند.
برای مرور مکانهای پروژه، روی BROWSE کلیک کنید.
روی یک مکان برای پروژه خود کلیک کنید و روی انتخاب کلیک کنید.
روی ایجاد کلیک کنید. کنسول به صفحه داشبورد هدایت می شود. پروژه در عرض چند دقیقه ایجاد می شود.
برای اطلاعات بیشتر در مورد ایجاد و مدیریت پروژه ها، به ایجاد و مدیریت پروژه ها مراجعه کنید.
2. API را فعال کنید
شما باید Google Cloud Search API را فعال کنید و یک حساب کاربری برای دریافت اعتبار ایجاد کنید.
- برای اطمینان از اینکه در پروژه جدید ایجاد شده هستید، روی نماد در سمت راست بنر کنسول Google Cloud کلیک کنید و پروژه تازه ایجاد شده خود را انتخاب کنید.
- روی ENABLE APIS AND SERVICES کلیک کنید. صفحه "Welcome to API Library" ظاهر می شود.
- به Google Cloud Search API بروید.
- روی Enable کلیک کنید. صفحه "نمای کلی" ظاهر می شود.
برای اطلاعات بیشتر در مورد فعال و غیرفعال کردن APIها، به مدیریت APIها در کنسول Google Cloud مراجعه کنید.
3. اعتبار حساب سرویس ایجاد کنید
- در کنسول Google Cloud ، روی اعتبارنامه ها در پیمایش سمت چپ کلیک کنید. صفحه اعتبارنامه ظاهر می شود.
- از لیست کشویی Create credentials ، حساب سرویس را انتخاب کنید. صفحه "ایجاد حساب سرویس" ظاهر می شود.
- نامی را در قسمت نام حساب سرویس وارد کنید.
- (اختیاری) شناسه حساب سرویس را ویرایش کنید.
- روی ایجاد کلیک کنید. صفحه "مجوزهای حساب سرویس" ظاهر می شود.
- روی Continue کلیک کنید. صفحه "اعطای دسترسی کاربران به این حساب سرویس" ظاهر می شود.
- روی CREATE KEY کلیک کنید و روی Done کلیک کنید. گفتگوی "کلید خصوصی ذخیره شده در رایانه شما" ظاهر می شود و یک کپی از کلید خصوصی در رایانه شما بارگیری می شود.
- روی Close کلیک کنید.
برای کسب اطلاعات بیشتر در مورد حساب های خدمات، به حساب های سرویس، برنامه های کاربردی وب و برنامه های نصب شده مراجعه کنید
4. آدرس ایمیل را شناسایی کنید
- از کنسول Google Cloud ، پروژه ای را که ایجاد کرده اید در بالای صفحه انتخاب کنید.
- روی منوی پیمایش در سمت چپ بنر کنسول Google Cloud کلیک کنید.
- روی IAM و Admin > حسابهای سرویس کلیک کنید.
- در فهرست، در بخش «شناسه حساب سرویس»، آدرس ایمیل ایجاد شده را که حساب سرویسی را که پیکربندی کردهاید مشخص میکند، یادداشت کنید. این آدرس ایمیل هنگام افزودن منبع داده به جستجوی ابری استفاده می شود.
5. پشتیبانی از شخص ثالث را راه اندازی کنید
قبل از اینکه بتوانید با هر API دیگری Cloud Search تماس بگیرید، باید پشتیبانی شخص ثالث را برای Google Cloud Search راه اندازی کنید.
برای راه اندازی پشتیبانی شخص ثالث برای Cloud Search:
پروژه پلتفرم Cloud Search شما حاوی اطلاعات کاربری حساب سرویس است. با این حال، به خاطر مقداردهی اولیه پشتیبانی شخص ثالث، باید اعتبار برنامه وب را ایجاد کنید. برای دستورالعملهای مربوط به نحوه ایجاد اعتبارنامه برنامه وب، به ایجاد اعتبارنامه مراجعه کنید. پس از انجام این مرحله، باید یک شناسه مشتری و فایل مخفی مشتری داشته باشید.
از زمین بازی OAuth 2 Google برای دریافت رمز دسترسی استفاده کنید:
- روی تنظیمات کلیک کنید و User your own auth credentials را علامت بزنید.
- شناسه مشتری و رمز سرویس گیرنده را از مرحله 1 وارد کنید.
- روی Close کلیک کنید.
- در قسمت scopes،
https://www.googleapis.com/auth/cloud_search.settings
را تایپ کنید و روی تأیید کلیک کنید. زمین بازی OAuth 2 یک کد مجوز را برمی گرداند. - روی کد مجوز تبادل برای توکنها کلیک کنید. یک توکن برگردانده می شود.
برای مقداردهی اولیه پشتیبانی شخص ثالث برای 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 تماس بگیرید.
برای تأیید اینکه پشتیبانی شخص ثالث مقداردهی شده است، از 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 }
مراحل بعدی
در اینجا چند قدم بعدی وجود دارد که ممکن است بردارید:
اگر قصد دارید از Google Cloud Search با یک مخزن داده غیر Google، مانند Microsoft® SharePoint® استفاده کنید، باید یک منبع داده ایجاد کنید. برای دستورالعملهای مربوط به افزودن منبع داده، به افزودن منبع داده برای جستجو مراجعه کنید.
هنگامی که منبع داده خود را تنظیم کردید، می توانید طرحواره ای ایجاد و ثبت کنید تا شناسایی کنید جستجوی ابری Google چگونه باید داده ها را در مخزن نمایش دهد.