راه اندازی اولیه

برای ادامه، مطمئن شوید که مراحل پیش‌نیازها را کامل کرده‌اید و پروژه شما را برای دسترسی به API نمایه کسب‌وکار تأیید کرده‌ایم.

API ها را فعال کنید

هشت API مرتبط با نمایه کسب و کار وجود دارد که باید در Google API Console فعال شوند:

  • Google My Business API
  • API مدیریت حساب کسب و کار من
  • My Business Lodging API
  • My Business Place Actions API
  • My Business Notifications API
  • My Business Verifications API
  • API اطلاعات کسب و کار من
  • API پرسش و پاسخ کسب و کار من

یک API را فعال کنید

اگر همه پیش نیازها را تکمیل کرده اید و به API دسترسی پیدا کرده اید، اما هنوز نمی توانید از میانبر ارائه شده استفاده کنید، می توانید API را به صورت دستی با مراحل زیر فعال کنید.

برای فعال کردن یک API برای پروژه خود، موارد زیر را انجام دهید:

  1. کتابخانه API را در Google API Console باز کنید . در صورت درخواست، یک پروژه را انتخاب کنید یا یک پروژه جدید ایجاد کنید. کتابخانه API همه API های موجود را فهرست می کند که بر اساس خانواده محصول و محبوبیت گروه بندی شده اند.
  2. اگر API مورد نظر برای فعال کردن در لیست قابل مشاهده نیست، از جستجو برای پیدا کردن آن استفاده کنید.
  3. API را که می خواهید فعال کنید انتخاب کنید، سپس روی دکمه Enable کلیک کنید.
  4. در صورت درخواست، صورتحساب را فعال کنید.
  5. اگر از شما خواسته شد، شرایط سرویس API را بپذیرید.

اگر کاربر فضای کاری Google هستید، تأیید کنید که نمایه کسب و کار Google برای حساب شما در سازمان فضای کاری Google شما روشن است . اگر نمایه کسب و کار Google برای حساب شما در سازمان فضای کاری Google شما خاموش باشد، هنگام استفاده از APIهای GBP، «خطای 403 - PERMISSION DENIED» دریافت خواهید کرد.

شناسه مشتری OAuth 2.0 را درخواست کنید

از آنجایی که برنامه شما به داده های محافظت شده و غیر عمومی دسترسی دارد، به شناسه مشتری OAuth 2.0 نیاز دارید. این به برنامه شما اجازه می‌دهد برای دسترسی به داده‌های مکان سازمانتان از طرف کاربران برنامه شما مجوز درخواست کند.

برنامه شما باید یک نشانه OAuth 2.0 با هر درخواست API نمایه کسب و کار که به داده های کاربر خصوصی دسترسی دارد ارسال کند.

اگر قبلاً این کار را انجام نداده اید، به بخش "Credentials" در Google API Console بروید و روی Create credentials > OAuth client ID کلیک کنید تا اعتبار OAuth 2.0 خود را ایجاد کنید. پس از ایجاد اعتبارنامه، می توانید شناسه مشتری خود را در صفحه اعتبارنامه ها مشاهده کنید. برای جزئیات، مانند رمز سرویس گیرنده، URI های تغییر مسیر، آدرس مبدا جاوا اسکریپت و آدرس ایمیل، روی شناسه مشتری کلیک کنید.

اصول REST را بیاموزید

دو راه برای فراخوانی API ها وجود دارد:

اگر تصمیم دارید از کتابخانه های مشتری استفاده نکنید، باید اصول REST را بدانید.

REST سبکی از معماری نرم افزار است که یک رویکرد راحت و سازگار برای درخواست و اصلاح داده ها ارائه می دهد.

اصطلاح REST مخفف " انتقال دولت نمایندگی " است. در زمینه Google API ها، به استفاده از افعال HTTP برای بازیابی و اصلاح نمایش داده های ذخیره شده توسط Google اشاره دارد.

یک سیستم RESTful منابع را در یک فروشگاه داده ذخیره می کند. یک سرویس گیرنده درخواستی را برای سرور ارسال می کند تا یک عمل خاص مانند ایجاد، بازیابی، به روز رسانی یا حذف یک منبع را انجام دهد و سرور این عمل را انجام داده و پاسخی را ارسال می کند. این پاسخ اغلب به شکل نمایش منبع مشخص شده است.

در API های RESTful Google، مشتری یک عملکرد را با یک فعل HTTP، مانند GET ، POST ، PUT ، یا DELETE مشخص می کند. مشتری یک منبع را با یک شناسه منبع یکنواخت جهانی (URI) به شکل زیر مشخص می کند:

https://apiName.googleapis.com/apiVersion/resourcePath?parameters

از آنجایی که همه منابع API دارای URI های منحصر به فرد قابل دسترسی با HTTP هستند، REST ذخیره داده را فعال می کند و برای کار با زیرساخت های توزیع شده وب بهینه شده است.

ممکن است تعاریف روش در مستندات استانداردهای HTTP 1.1 مفید باشد. آنها شامل مشخصات GET ، POST ، PUT و DELETE هستند.

REST در APIهای نمایه کسب و کار

عملیات APIهای نمایه کسب‌وکار مستقیماً به افعال HTTP REST نگاشت می‌شوند.

قالب خاص برای APIهای نمایه کسب و کار در URI زیر نشان داده شده است:

https://apiName.googleapis.com/apiVersion/resourcePath?parameters

مجموعه کامل URI های مورد استفاده برای هر عملیات پشتیبانی شده در APIها در مستندات مرجع APIs Profile Business ظاهر می شود.

مسیرهای منبع بر اساس نقطه پایانی متفاوت است.

به عنوان مثال، مسیر منبع به یک حساب کاربری مانند مثال زیر ظاهر می شود:

accounts/accountId

مسیر منبع برای یک مکان به شکل زیر ظاهر می شود:

locations/locationId

اصول JSON را یاد بگیرید

APIهای نمایه کسب‌وکار داده‌ها را در قالب JSON برمی‌گردانند.

نشان‌گذاری شی جاوا اسکریپت ( JSON ) یک قالب داده رایج و مستقل از زبان است که یک نمایش متنی ساده از ساختارهای داده دلخواه را ارائه می‌کند. برای اطلاعات بیشتر، به json.org مراجعه کنید.

یک درخواست HTTP ساده ایجاد کنید

می‌توانید از OAuth 2.0 Playground برای آزمایش APIهای نمایه کسب‌وکار استفاده کنید. از آنجایی که APIهای Business Profile APIهای عمومی نیستند، برای استفاده از آن در Playground باید چند مرحله اضافی انجام دهید. برای ادامه برنامه وب به شناسه مشتری نیاز دارید.

  1. به کنسول API Google بروید و پروژه خود را باز کنید. اگر شناسه سرویس گیرنده OAuth برای برنامه های وب ندارید، اکنون یکی ایجاد کنید:
    1. از لیست کشویی Create credentials ، شناسه مشتری OAuth را انتخاب کنید.
    2. برای نوع برنامه ، روی برنامه وب کلیک کنید.

    3. موارد زیر را به عنوان یک URI تغییر مسیر معتبر اضافه کنید:

       https://developers.google.com/oauthplayground
    4. روی ایجاد کلیک کنید.
  2. شناسه مشتری را در کلیپ بورد کپی کنید.
  3. به زمین بازی OAuth 2.0 بروید.
  4. روی نماد چرخ دنده کلیک کنید تا گزینه های پیکربندی باز شود و تغییرات زیر را اعمال کنید:
    1. جریان OAuth را روی Client-side تنظیم کنید.
    2. Use your own OAuth credentials را انتخاب کنید.
    3. در شناسه مشتری OAuth خود جایگذاری کنید.
  5. گزینه های پیکربندی را ببندید.

  6. در بخش «مرحله 1 - APIها را انتخاب و تأیید کنید»، محدوده زیر را برای APIهای نمایه کسب‌وکار در قسمت Input your own scopes جای‌گذاری کنید:

    https://www.googleapis.com/auth/business.manage
  7. روی Authorize APIs کلیک کنید.
  8. وقتی از شما خواسته شد روی Accept کلیک کنید.

  9. در بخش «Step 2 - Configure request to API»، URI زیر را در قسمت Request URI جای‌گذاری کنید:

    https://mybusinessaccountmanagement.googleapis.com/v1/accounts
  10. روی ارسال درخواست کلیک کنید. پاسخ باید وضعیت 200 OK را نشان دهد.

برای اطلاعات بیشتر در مورد نحوه ایجاد انواع درخواست‌ها، به مرجع APIs Profile Business مراجعه کنید.

کتابخانه های مشتری

کتابخانه های سرویس گیرنده Business Profile APIs از عملکرد API های Business Profile پشتیبانی می کنند. آنها عملکرد مشترک همه APIهای Google را ارائه می دهند، مانند انتقال HTTP، مدیریت خطا، احراز هویت و تجزیه JSON.

برای دانلود کتابخانه های مشتری، کتابخانه ها را ببینید.