APIs Explorer را نمایش دهید و یک متد را اجرا کنید

در اکثر صفحات اسناد، APIs Explorer فشرده در سمت راست صفحه قابل مشاهده است. اگر APIs Explorer قابل مشاهده نیست، روی Try it کلیک کنید! برای نمایش نسخه فشرده APIs Explorer.

اگر آن را امتحان کنید! در سمت راست صفحه مستندات مرجع ظاهر نمی شود، این روش توسط APIs Explorer پشتیبانی نمی شود. برای مثال، APIs Explorer با APIهایی که به حساب‌های سرویس نیاز دارند، سازگار نیست، بنابراین در صفحات اسناد آن APIها ظاهر نمی‌شود.

نمایش نسخه توسعه یافته APIs Explorer

نسخه توسعه‌یافته APIs Explorer شامل cURL، HTTP و احتمالاً نمونه‌های کد دیگر است. برای نمایش نسخه توسعه یافته APIs Explorer، روی تمام صفحه صفحه کلیک کنید.

یک روش را اجرا کنید

APIs Explorer به شما امکان می دهد پارامترهای مورد نیاز، پارامترهای اختیاری، و در صورت وجود، یک بدنه درخواست برای روش های API را وارد کنید. برای بسیاری از روش‌های REST، مانند روش‌های فهرست، فقط باید یک یا دو فیلد را پر کنید تا بتوانید متد را اجرا کنید. برای مثال، روش books.volumes.list Books API فقط به یک پارامتر query ( q ) برای فهرست کردن کتاب‌ها نیاز دارد. برای امتحان روش books.volumes.list :

  1. به books.volumes.list .
  2. اگر APIs Explorer نمایش داده نشد، روی Try it کلیک کنید!
  3. در قسمت q ، Hunger Games (بدون هیچ نقل قول یا کاراکتر خاصی) را تایپ کنید.
  4. به پایین بروید و روی Execute کلیک کنید.
  5. (اختیاری) یک صفحه ورود به سیستم Google از شما می خواهد که یک حساب Google انتخاب کنید.
  6. (اختیاری) یک گفتگوی مجوز Google از شما می‌پرسد که آیا «مدیریت کتاب‌هایتان» اشکالی ندارد. روی Allow کلیک کنید. نتایج زیر دکمه Execute ظاهر می شوند.

اگر APIs Explorer نتیجه 200 را نشان دهد، روش موفق بوده است.

عیب یابی مشکلات APIs Explorer

شما یک خطای 401 یا 403 دریافت کردید

اگر هنگام اجرای یک روش با استفاده از APIs Explorer خطای 401 یا 403 دریافت می کنید، احتمالاً به دلیل مشکل یکی از موارد زیر است:

  • شما از نوع مجوز اشتباه استفاده می کنید (کلید API به جای OAuth 2.0). نوع مجوز را تغییر دهید.
  • شما از OAuth 2.0 استفاده می کنید، اما با دامنه بسیار باریک. سعی کنید از دامنه وسیع تری استفاده کنید.

گفتگوی مجوز ظاهر نمی شود

APIs Explorer از یک پنجره بازشو برای دسترسی به داده های خصوصی شما استفاده می کند. اگر مرورگر شما پنجره‌های بازشو را مسدود کند، این پنجره ظاهر نمی‌شود و نمی‌توانید اجازه دسترسی بدهید.

اگر در کادر گفتگوی مجوز روی Allow کلیک کردید و هیچ اتفاقی نیفتاد، تنظیمات بازشو مرورگر خود را برای فعال کردن پنجره‌های بازشو تغییر دهید.