قبل از اینکه بتوانید از این API چه به صورت مستقیم و چه از طریق SDK استفاده کنید، باید دسترسی به Google Cloud Search API را پیکربندی کنید. این سند مراحل مورد نیاز برای استفاده از REST API Google Cloud Search API را پوشش میدهد.
۱. یک پروژه API ایجاد کنید
برای فعال کردن API، ابتدا باید یک پروژه Google Cloud ایجاد کنید. این پروژه اساس ایجاد، فعالسازی و استفاده از تمام سرویسهای Google Cloud، از جمله مدیریت APIها، فعالسازی صورتحساب، افزودن و حذف همکاران و مدیریت مجوزها را تشکیل میدهد.
کنسول گوگل کلود را باز کنید.
در بالای صفحه، روی در سمت راست «کنسول ابری گوگل» کلیک کنید. پنجرهای که پروژههای فعلی را فهرست میکند، ظاهر میشود.
روی « پروژه جدید » کلیک کنید. صفحه «پروژه جدید» ظاهر میشود.
در قسمت نام پروژه، یک نام برای پروژه وارد کنید.
(اختیاری) برای ویرایش شناسه پروژه، روی ویرایش کلیک کنید. شناسه پروژه پس از ایجاد پروژه قابل تغییر نیست، بنابراین شناسهای را انتخاب کنید که نیازهای شما را در طول عمر پروژه برآورده کند.
برای مرور مکانهای پروژه، روی «مرور» کلیک کنید.
روی مکانی برای پروژه خود کلیک کنید و روی «انتخاب» کلیک کنید.
روی ایجاد کلیک کنید. کنسول به صفحه داشبورد هدایت میشود. پروژه ظرف چند دقیقه ایجاد میشود.
برای اطلاعات بیشتر در مورد ایجاد و مدیریت پروژهها، به «ایجاد و مدیریت پروژهها» مراجعه کنید.
۲. فعال کردن API
برای دریافت اعتبارنامهها، باید API جستجوی ابری گوگل را فعال کنید و یک حساب کاربری ایجاد کنید.
- برای اطمینان از اینکه در پروژه تازه ایجاد شده هستید، روی نماد در سمت راست بنر کنسول Google Cloud کلیک کنید و پروژه تازه ایجاد شده خود را انتخاب کنید.
- روی فعال کردن APIها و خدمات کلیک کنید. صفحه «به کتابخانه API خوش آمدید» ظاهر میشود.
- به API جستجوی ابری گوگل بروید.
- روی فعال کردن کلیک کنید. صفحه «نمای کلی» ظاهر میشود.
برای اطلاعات بیشتر در مورد فعال و غیرفعال کردن APIها، به مدیریت APIها در کنسول Google Cloud مراجعه کنید.
۳. ایجاد اعتبارنامه حساب کاربری سرویس
- در کنسول گوگل کلود ، در منوی سمت چپ روی Credentials کلیک کنید. صفحه Credentials ظاهر میشود.
- از فهرست کشویی «ایجاد اعتبارنامهها »، حساب سرویس را انتخاب کنید. صفحه «ایجاد حساب سرویس» ظاهر میشود.
- در قسمت نام حساب سرویس، یک نام وارد کنید.
- (اختیاری) شناسه حساب سرویس را ویرایش کنید.
- روی ایجاد کلیک کنید. صفحه "مجوزهای حساب سرویس" ظاهر میشود.
- روی ادامه کلیک کنید. صفحه «اعطای دسترسی به این حساب کاربری برای کاربران» ظاهر میشود.
- روی «ایجاد کلید» کلیک کنید و سپس روی «انجام شد » کلیک کنید. پنجرهی «کلید خصوصی در رایانهی شما ذخیره شد» ظاهر میشود و یک کپی از کلید خصوصی در رایانهی شما دانلود میشود.
- روی بستن کلیک کنید.
برای اطلاعات بیشتر در مورد حسابهای سرویس، به حسابهای سرویس، برنامههای وب و برنامههای نصبشده مراجعه کنید.
۴. شناسایی آدرس ایمیل
- از کنسول گوگل کلود ، پروژهای که در بالای صفحه ایجاد کردهاید را انتخاب کنید.
- روی منوی ناوبری در سمت چپ بنر کنسول Google Cloud کلیک کنید.
- روی حسابهای کاربری IAM و Admin > Service کلیک کنید.
- در لیست، در قسمت «شناسه حساب سرویس»، آدرس ایمیل تولید شدهای را که حساب سرویسی را که پیکربندی کردهاید مشخص میکند، یادداشت کنید. این آدرس ایمیل هنگام افزودن منبع داده به جستجوی ابری استفاده میشود.
۵. پشتیبانی شخص ثالث را راهاندازی کنید
قبل از اینکه بتوانید هرگونه API جستجوی ابری دیگری را فراخوانی کنید، باید پشتیبانی شخص ثالث را برای جستجوی ابری گوگل راهاندازی کنید.
برای راهاندازی اولیه پشتیبانی شخص ثالث برای جستجوی ابری:
پروژه پلتفرم جستجوی ابری شما شامل اعتبارنامههای حساب سرویس است. با این حال، برای راهاندازی اولیه پشتیبانی شخص ثالث، باید اعتبارنامههای برنامه وب را ایجاد کنید. برای دستورالعملهای مربوط به نحوه ایجاد اعتبارنامههای برنامه وب، به ایجاد اعتبارنامهها مراجعه کنید. پس از تکمیل این مرحله، باید یک شناسه کلاینت و فایل مخفی کلاینت داشته باشید.
برای دریافت توکن دسترسی از محیط OAuth 2 گوگل استفاده کنید:
- روی تنظیمات کلیک کنید و اعتبارنامههای احراز هویت خودتان را بررسی کنید.
- شناسه کلاینت و رمز کلاینت را از مرحله ۱ وارد کنید.
- روی بستن کلیک کنید.
- در فیلد scopes، عبارت
https://www.googleapis.com/auth/cloud_search.settingsرا تایپ کنید و روی Authorize کلیک کنید. محیط OAuth 2 یک کد مجوز برمیگرداند. - برای توکنها روی کد مجوز اکسچنج کلیک کنید. یک توکن برگردانده میشود.
برای راهاندازی اولیه پشتیبانی شخص ثالث برای جستجوی ابری، از دستور 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) با یک مخزن داده غیر گوگلی، مانند Microsoft® SharePoint®، استفاده کنید، باید یک منبع داده ایجاد کنید. برای دستورالعملهای افزودن منبع داده، به «افزودن منبع داده برای جستجو» مراجعه کنید.
پس از تنظیم منبع داده، میتوانید طرحوارهای ایجاد و ثبت کنید تا مشخص شود جستجوی ابری گوگل چگونه باید دادهها را در مخزن نمایش دهد.