OAuth را راه اندازی و استفاده کنید

همه تماس‌های Local Services API باید از طریق OAuth 2.0 مجاز باشند. این به برنامه مشتری API خدمات محلی شما اجازه می‌دهد بدون نیاز به مدیریت یا ذخیره اطلاعات ورود به سیستم کاربر، به حساب تبلیغات خدمات محلی کاربر دسترسی داشته باشد.

Local Services API از پروتکل OAuth 2.0 برای احراز هویت کاربران استفاده می کند. برای کسب اطلاعات بیشتر درباره OAuth 2.0، به استفاده از OAuth 2.0 برای دسترسی به Google API مراجعه کنید.

یک پروژه کنسول Google API را برای Local Services API پیکربندی کنید

برای احراز هویت و مجوز دادن به کاربران Google Ads، باید اعتباری برای دسترسی به سرورهای OAuth 2.0 Google داشته باشید. این اعتبارنامه ها برنامه شما را برای Google شناسایی می کنند و به شما امکان می دهند توکن های OAuth را برای مدیریت کاربران Google Ads ایجاد کنید. از Google API Console برای مدیریت دسترسی به اطلاعات کاربری Google OAuth 2.0 خود استفاده کنید.

برای دریافت این مدارک، مراحل زیر را انجام دهید:

  1. یک پروژه ایجاد کنید. برای انجام این کار، به Google API Console بروید. روی ایجاد پروژه کلیک کنید، یک نام وارد کنید و روی ایجاد کلیک کنید.

  2. Local Services API را در پروژه خود فعال کنید:

    1. کتابخانه API را در Google API Console باز کنید . اگر از شما خواسته شد، پروژه خود را انتخاب کنید یا یک پروژه جدید ایجاد کنید. کتابخانه API همه API های موجود را فهرست می کند که بر اساس خانواده محصول و محبوبیت گروه بندی شده اند.

      اگر Local Services API در لیست قابل مشاهده نیست، از کادر جستجو برای پیدا کردن آن استفاده کنید.

    2. Local Services API را انتخاب کنید، سپس روی Enable کلیک کنید.

  3. نوع برنامه را انتخاب کنید. Local Services API از همان انواع برنامه هایی مانند Google Ads API استفاده می کند. برای جزئیات بیشتر در مورد نوع برنامه مورد استفاده، به انتخاب نوع برنامه مراجعه کنید.

  4. یک شناسه مشتری و راز مشتری ایجاد کنید. برای Local Services API، مراحل مشابهی را برای ایجاد شناسه مشتری و رمز سرویس گیرنده که برای Google Ads API استفاده می‌شود، دنبال کنید. مراحل برای هر دو مورد استفاده یکسان است.

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

برای فهرستی از کتابخانه های سرویس گیرنده که می توانید از آنها برای درخواست مجوز OAuth 2.0 استفاده کنید، به کتابخانه های مشتری مراجعه کنید. دستورالعمل های خاص کتابخانه را دنبال کنید تا یاد بگیرید چگونه از یک نشانه تازه سازی برای به دست آوردن یک نشانه دسترسی جدید استفاده کنید.

نحوه به دست آوردن توکن رفرش OAuth 2.0

توصیه می کنیم برای احراز هویت کاربران از کتابخانه های مشتری در تولید استفاده کنید. اگر می‌خواهید از یک کلاینت HTTP برای اهداف آزمایشی استفاده کنید، از دستورالعمل‌های زیر برای به‌دست آوردن یک نشانه بازخوانی OAuth 2.0 و یک نشانه دسترسی استفاده کنید. مراحل 1، 2، و 3 دستورالعمل‌های راه‌اندازی یک‌باره‌ای هستند که باید به‌صورت دستی انجام دهید، و مراحل 4 و 5 را می‌توان پس از آن خودکار کرد تا بدون دخالت انسان اجرا شوند، مانند کار cron.

  1. Curl را دانلود و نصب کنید ، یک ابزار خط فرمان برای ایجاد درخواست‌های وب HTTP.

  2. دستورالعمل‌های صفحه OAuth Playground را دنبال کنید تا نشانه تازه‌سازی OAuth 2.0 را دریافت کنید. از محدوده زیر برای Local Services API استفاده کنید:

    https://www.googleapis.com/auth/adwords

    این همان محدوده OAuth 2.0 است که توسط Google Ads API استفاده می شود.

    در پایان این مرحله، دو توکن دریافت می‌کنید: یک توکن تازه‌سازی و یک نشانه دسترسی. هر دوی آنها را نجات دهید.

  3. برای اطمینان از موفقیت آمیز بودن مرحله قبل، دستور زیر را در خط فرمان اجرا کنید:

    curl https://oauth2.googleapis.com/tokeninfo?access_token=<INSERT_ACCESS_TOKEN>

    اگر خروجی فرمان پیامی مانند زیر نمایش دهد، موفقیت آمیز بود:

    {
  "azp": "************-********************************.apps.googleusercontent.com",
  "aud": "************-********************************.apps.googleusercontent.com",
  "scope": "https://www.googleapis.com/auth/adwords [googleapis.com]",
  "exp": "1611183382",
  "expires_in": "3482",
  "access_type": "offline"
}

    اگر خطایی وجود دارد یا محدوده درست نیست، دوباره سعی کنید توکن ها را تولید کنید.

  4. یک نشانه دسترسی جدید بدون دخالت دستی ایجاد کنید. این مهم است زیرا نشانه های دسترسی هر ساعت منقضی می شوند. انقضای توکن‌های Refresh خیلی بیشتر طول می‌کشد، بنابراین اغلب باید زمانی که دیگر مورد نیاز نیستند، آنها را به‌صورت دستی لغو کنید.

    برای دریافت یک نشانه دسترسی جدید، دستور زیر را اجرا کنید:

    curl --data "refresh_token=<INSERT_REFRESH_TOKEN>&client_id=<INSERT_CLIENT_ID>&client_secret=<INSERT_CLIENT_SECRET>&grant_type=refresh_token" -X POST "https://oauth2.googleapis.com/token”

  5. فراخوانی API زیر را اجرا کنید:

    curl -H "Authorization: Bearer <INSERT_ACCESS_TOKEN>" https://localservices.googleapis.com/v1/accountReports:search?query=manager_customer_id:<INSERT_10_DIGIT_MANAGER_CUSTOMER_ID_WITHOUT_HYPHENS>

    اگر این تماس با موفقیت انجام شود، راه‌اندازی شما کامل شده است.