درباره این codelab
1. قبل از شروع
این لبه کد به شما نشان می دهد که چگونه API های Google را جستجو و انتخاب کنید و معیارهای API را مشاهده کنید.
پیش نیازها
- امکان پیمایش در Google Cloud Console.
چیزی که یاد خواهید گرفت
- نحوه جستجو و انتخاب APIها با کتابخانه Google Cloud API و OAuth 2.0 Playground .
- نحوه مشاهده معیارهای API با Metrics Explorer و Cloud APIs & Services.
آنچه شما نیاز دارید
- یک حساب Google، مانند یک حساب Gmail یا یک حساب Google Workspace .
- دسترسی به حساب Cloud Billing یا کارت اعتباری برای استفاده آزمایشی رایگان .
2. دسترسی به API ها از کنسول Cloud
- در Cloud Console، را انتخاب کنید
منوی پیمایش > APIs & Services > Enabled APIs & services .
- در داشبورد APIs & Services ، روی + ENABLE APIS AND SERVICES کلیک کنید تا API های موجود را ببینید.
از صفحه APIs & Services ، چند راه وجود دارد که می توانید API ها را جستجو کنید. اگر نام API را می دانید، می توانید آن را در قسمت Search for APIs & Services در بالای صفحه وارد کنید. همچنین می توانید API ها را بر اساس دسته بندی با فیلترهای کنار صفحه فیلتر کنید.
- در منوی CATEGORY ، یادگیری ماشین را انتخاب کنید تا فقط APIهای یادگیری ماشین را ببینید.
- از APIهای یادگیری ماشینی، Cloud Natural Language API را انتخاب کنید تا جزئیات این API را ببینید.
- روی ENABLE کلیک کنید تا این API در پروژه مناسب فعال شود.
هنگامی که API را فعال می کنید، صفحه نمای کلی API را نشان می دهد. میتوانید معیارهای استفاده خود از این API را ببینید، زیرا اطلاعات بسیار کمی دارد زیرا اخیراً API را فعال کردهاید.
در یک کد آزمایشگاهی آینده، درباره نحوه ایجاد اعتبارنامه ها بیشتر می آموزید، اما اگر اکنون کنجکاو هستید، روی CREATE CREDENTIALS کلیک کنید و سپس به سؤالات ارائه شده پاسخ دهید.
- برای بازگشت به نمای کلی در مرحله قبل، روی MANAGE کلیک کنید.
- برای امتحان کردن API (حتی قبل از اینکه آن را فعال کنید)، روی TRY THIS API کلیک کنید.
این معمولاً شما را به صفحه ای در اسناد API می رساند. با این حال، برای برخی از API ها، هیچ راه فوری برای امتحان API وجود ندارد زیرا روش های مختلفی دارد. این مورد برای Cloud Natural Language API است.
- روش
analyzeEntitites
را انتخاب کنید.
شما باید یک صفحه وب با جزئیات در مورد روش های API و یک صفحه Try this API را ببینید.
- برای امتحان یک پرس و جو نمونه، یک شی
document
را با این پارامترها به قسمت Request body اضافه کنید. برای گسترش گزینه های فیلد، روی نمادهای + کلیک کنید. - در قسمت
content:
متن را برای تحلیل وارد کنید.
در این نمونه از Michelangelo Caravaggio, Italian painter, is known for 'The Calling of Saint Matthew'.
- در قسمت
type:
PLAIN_TEXT
انتخاب کنید.
بدنه درخواست باید به شکل زیر باشد:
برای اطلاعات بیشتر در مورد هر پارامتر، به مستندات مراجعه کنید.
- چک باکس Google OAuth 2.0 را پاک کنید و سپس روی Execute کلیک کنید تا پاسخی حاوی جزئیات مربوط به موجودیت ها دریافت کنید.
- چک باکس کلید API را پاک کنید و دوباره روی Execute کلیک کنید.
هنگامی که این بار کوئری را اجرا می کنید، با خطایی مانند این مواجه می شوید زیرا API برای اجرا به اعتبار نیاز دارد.
- چک باکس Google OAuth 2.0 را انتخاب کرده و دوباره روی Execute کلیک کنید.
OAuth 2.0 مجوزهای API را در حساب شما فراهم می کند و هشداری را به شما نشان می دهد.
اگر اجازه دسترسی را بدهید، همان پاسخی را دریافت خواهید کرد که با کلیدهای API دریافت کردید. اگر از API در یک برنامه استفاده میکنید و باید به افرادی که از اعتبار آنها اطلاع دارند اجازه دسترسی بدهید، باید از OAuth 2.0 استفاده کنید. اگر دسترسی برنامه به API برای کاربر کافی است، میتوانید به جای آن از کلیدهای API استفاده کنید.
3. معیارهای API خود را با Metrics Explorer مشاهده کنید
همانطور که در مرحله 6 Access APIها از Cloud Console نشان داده شده است، میتوانید تاریخچه تماسها برای هر API واحد را از صفحه نمای کلی API مشاهده کنید. با این حال، برای مشاهده معیارهای بیشتر برای همه استفاده از API، از Metrics Explorer استفاده کنید.
- در بخش عملیات
منوی پیمایش ، روی مانیتورینگ > کاوشگر متریک کلیک کنید.
- در منوی نوع منبع ، Consumed API را به عنوان نوع معیار انتخاب کنید. (اگر آن را نمی بینید، کادر فقط نمایش فعال را پاک کنید.)
- در منوی Metric ، یکی از معیارهای فردی APIها را انتخاب کنید، مانند Request Count ، تا ببینید چند API در دوره مورد نظر فراخوانی شده است.
- برای سفارشی کردن بیشتر خروجی، یک جمع کننده تنظیم کنید و دوره زمانی را تنظیم کنید.
4. از OAuth 2.0 Playground برای امتحان کردن API استفاده کنید
همچنین میتوانید از OAuth 2.0 Playground برای آزمایش Google API استفاده کنید. با OAuth 2.0 Playground، می توانید یک API را انتخاب کنید، آن را مجاز کنید، و سپس درخواست ارسال کنید و پاسخ ها را در پنجره کنسول OAuth 2.0 Playground ببینید.
- زمین بازی OAuth 2.0 را باز کنید.
- روی Cloud Natural Language API > https://www.googleapis.com/auth/cloud-language > https://www.googleapis.com/auth/cloud-platform > مجوز APIها را کلیک کنید.
- در صورت نیاز، وارد حساب Google خود شوید و سپس روی Allow کلیک کنید تا کد مجوز دریافت کنید.
- روی کد مجوز تبادل برای توکنها کلیک کنید.
اکنون می توانید از API درخواست دهید.
- برای بررسی همه تماسهای ممکن API، روی لیست عملیاتهای ممکن کلیک کنید.
شما قبلاً صفحه اطلاعات را برای سند analyzeEntities
API طبیعی زبان باز کرده اید، بنابراین می توانید ببینید که URL درخواست HTTP این است:
https://language.googleapis.com/v1beta2/documents:analyzeEntities
این یک درخواست POST است.
- اطلاعات Request URI را وارد کرده و بدنه درخواست را اضافه کنید.
می توانید از همان بدنه ای که در API Explorer استفاده کرده اید استفاده کنید.
- روی بستن > ارسال درخواست کلیک کنید.
شما باید نتایجی مشابه این تصویر بگیرید:
با خیال راحت با سایر APIها در OAuth 2.0 Playground آزمایش کنید.
5. پاک کن
داشتن یک کلید API نامحدود برای پروژه ها کار بدی است. اگر شخصی به آن دسترسی پیدا کند، آن شخص می تواند بدون نیاز به احراز هویت از آن استفاده کند.
برای حذف این کلید API:
- کلیک کنید
منوی پیمایش > API ها و خدمات > اعتبارنامه ها .
- در زیر کلیدهای API ، کلید حذف را انتخاب کنید و سپس کلیک کنید
.
- به طور مشابه، به جای اینکه نگران محافظت نشدن کلید خصوصی حساب سرویس خود باشید، در بخش حسابهای خدمات ، حساب سرویس را برای حذف انتخاب کنید و سپس کلیک کنید.
.
6. تبریک میگم
تبریک می گویم! شما یاد گرفتید که چگونه APIهای Google را جستجو و انتخاب کنید و معیارهای آنها را مشاهده کنید.
درباره این codelab
1. قبل از شروع
این لبه کد به شما نشان می دهد که چگونه API های Google را جستجو و انتخاب کنید و معیارهای API را مشاهده کنید.
پیش نیازها
- امکان پیمایش در Google Cloud Console.
چیزی که یاد خواهید گرفت
- نحوه جستجو و انتخاب APIها با کتابخانه Google Cloud API و OAuth 2.0 Playground .
- نحوه مشاهده معیارهای API با Metrics Explorer و Cloud APIs & Services.
آنچه شما نیاز دارید
- یک حساب Google، مانند یک حساب Gmail یا یک حساب Google Workspace .
- دسترسی به حساب Cloud Billing یا کارت اعتباری برای استفاده آزمایشی رایگان .
2. دسترسی به API ها از کنسول Cloud
- در Cloud Console، را انتخاب کنید
منوی پیمایش > APIs & Services > Enabled APIs & services .
- در داشبورد APIs & Services ، روی + ENABLE APIS AND SERVICES کلیک کنید تا API های موجود را ببینید.
از صفحه APIs & Services ، چند راه وجود دارد که می توانید API ها را جستجو کنید. اگر نام API را می دانید، می توانید آن را در قسمت Search for APIs & Services در بالای صفحه وارد کنید. همچنین می توانید API ها را بر اساس دسته بندی با فیلترهای کنار صفحه فیلتر کنید.
- در منوی CATEGORY ، یادگیری ماشین را انتخاب کنید تا فقط APIهای یادگیری ماشین را ببینید.
- از APIهای یادگیری ماشینی، Cloud Natural Language API را انتخاب کنید تا جزئیات این API را ببینید.
- روی ENABLE کلیک کنید تا این API در پروژه مناسب فعال شود.
هنگامی که API را فعال می کنید، صفحه نمای کلی API را نشان می دهد. میتوانید معیارهای استفاده خود از این API را ببینید، زیرا اطلاعات بسیار کمی دارد زیرا اخیراً API را فعال کردهاید.
در یک کد آزمایشگاهی آینده، درباره نحوه ایجاد اعتبارنامه ها بیشتر می آموزید، اما اگر اکنون کنجکاو هستید، روی CREATE CREDENTIALS کلیک کنید و سپس به سؤالات ارائه شده پاسخ دهید.
- برای بازگشت به نمای کلی در مرحله قبل، روی MANAGE کلیک کنید.
- برای امتحان کردن API (حتی قبل از اینکه آن را فعال کنید)، روی TRY THIS API کلیک کنید.
این معمولاً شما را به صفحه ای در اسناد API می رساند. با این حال، برای برخی از API ها، هیچ راه فوری برای امتحان API وجود ندارد زیرا روش های مختلفی دارد. این مورد برای Cloud Natural Language API است.
- روش
analyzeEntitites
را انتخاب کنید.
شما باید یک صفحه وب با جزئیات در مورد روش های API و یک صفحه Try this API را ببینید.
- برای امتحان یک پرس و جو نمونه، یک شی
document
را با این پارامترها به قسمت Request body اضافه کنید. برای گسترش گزینه های فیلد، روی نمادهای + کلیک کنید. - در قسمت
content:
متن را برای تحلیل وارد کنید.
در این نمونه از Michelangelo Caravaggio, Italian painter, is known for 'The Calling of Saint Matthew'.
- در قسمت
type:
PLAIN_TEXT
انتخاب کنید.
بدنه درخواست باید به شکل زیر باشد:
برای اطلاعات بیشتر در مورد هر پارامتر، به مستندات مراجعه کنید.
- چک باکس Google OAuth 2.0 را پاک کنید و سپس روی Execute کلیک کنید تا پاسخی حاوی جزئیات مربوط به موجودیت ها دریافت کنید.
- چک باکس کلید API را پاک کنید و دوباره روی Execute کلیک کنید.
هنگامی که این بار کوئری را اجرا می کنید، با خطایی مانند این مواجه می شوید زیرا API برای اجرا به اعتبار نیاز دارد.
- چک باکس Google OAuth 2.0 را انتخاب کرده و دوباره روی Execute کلیک کنید.
OAuth 2.0 مجوزهای API را در حساب شما فراهم می کند و هشداری را به شما نشان می دهد.
اگر اجازه دسترسی را بدهید، همان پاسخی را دریافت خواهید کرد که با کلیدهای API دریافت کردید. اگر از API در یک برنامه استفاده میکنید و باید به افرادی که از اعتبار آنها اطلاع دارند اجازه دسترسی بدهید، باید از OAuth 2.0 استفاده کنید. اگر دسترسی برنامه به API برای کاربر کافی است، میتوانید به جای آن از کلیدهای API استفاده کنید.
3. معیارهای API خود را با Metrics Explorer مشاهده کنید
همانطور که در مرحله 6 Access APIها از کنسول Cloud نشان داده شده است، میتوانید تاریخچه تماسها برای هر API واحد را از صفحه نمای کلی API مشاهده کنید. با این حال، برای مشاهده معیارهای بیشتر برای همه استفاده از API، از Metrics Explorer استفاده کنید.
- در بخش عملیات
منوی پیمایش ، روی مانیتورینگ > کاوشگر متریک کلیک کنید.
- در منوی نوع منبع ، Consumed API را به عنوان نوع معیار انتخاب کنید. (اگر آن را نمی بینید، کادر چک فقط نمایش فعال را پاک کنید.)
- در منوی Metric ، یکی از معیارهای جداگانه برای APIها را انتخاب کنید، مانند Request Count ، تا ببینید چند API در دوره مورد نظر فراخوانی شده است.
- برای سفارشی کردن بیشتر خروجی، یک جمع کننده تنظیم کنید و دوره زمانی را تنظیم کنید.
4. از OAuth 2.0 Playground برای امتحان کردن APIها استفاده کنید
همچنین میتوانید از OAuth 2.0 Playground برای آزمایش Google API استفاده کنید. با OAuth 2.0 Playground، می توانید یک API را انتخاب کنید، آن را مجاز کنید، و سپس درخواست ارسال کنید و پاسخ ها را در پنجره کنسول OAuth 2.0 Playground ببینید.
- زمین بازی OAuth 2.0 را باز کنید.
- روی Cloud Natural Language API > https://www.googleapis.com/auth/cloud-language > https://www.googleapis.com/auth/cloud-platform > مجوز APIها را کلیک کنید.
- در صورت نیاز، وارد حساب Google خود شوید و سپس روی Allow کلیک کنید تا کد مجوز دریافت کنید.
- روی کد مجوز تبادل برای توکنها کلیک کنید.
اکنون می توانید از API درخواست دهید.
- برای بررسی همه تماسهای ممکن API، روی لیست عملیاتهای ممکن کلیک کنید.
شما قبلاً صفحه اطلاعات را برای سند analyzeEntities
API طبیعی زبان باز کرده اید، بنابراین می توانید ببینید که URL درخواست HTTP این است:
https://language.googleapis.com/v1beta2/documents:analyzeEntities
این یک درخواست POST است.
- اطلاعات Request URI را وارد کرده و بدنه درخواست را اضافه کنید.
می توانید از همان بدنه ای که در API Explorer استفاده کرده اید استفاده کنید.
- روی بستن > ارسال درخواست کلیک کنید.
شما باید نتایجی مشابه این تصویر بگیرید:
با خیال راحت با سایر APIها در OAuth 2.0 Playground آزمایش کنید.
5. پاک کن
داشتن یک کلید API نامحدود برای پروژه ها کار بدی است. اگر شخصی به آن دسترسی پیدا کند، آن شخص می تواند بدون نیاز به احراز هویت از آن استفاده کند.
برای حذف این کلید API:
- کلیک کنید
منوی پیمایش > API ها و خدمات > اعتبارنامه ها .
- در زیر کلیدهای API ، کلید حذف را انتخاب کنید و سپس کلیک کنید
.
- به طور مشابه، به جای اینکه نگران محافظت نشدن کلید خصوصی حساب سرویس خود باشید، در بخش حسابهای خدمات ، حساب سرویس را برای حذف انتخاب کنید و سپس کلیک کنید.
.
6. تبریک میگم
تبریک می گویم! شما یاد گرفتید که چگونه APIهای Google را جستجو و انتخاب کنید و معیارهای آنها را مشاهده کنید.