پیش نیازها

این سند کارهایی را که باید قبل از نوشتن اولین درخواست مشتری خود انجام دهید، شرح می دهد.

یک حساب Google دریافت کنید

برای استفاده از این API به یک حساب Google نیاز دارید. حساب شما باید مجوز کنسول جستجوی مناسب را در یک ویژگی خاص داشته باشد تا بتوان آن متد را در آن ویژگی فراخوانی کرد. به عنوان مثال، برای اجرای searchAnalytics.query به مجوز خواندن در آن ویژگی نیاز دارید.

کنسول جستجوی گوگل را امتحان کنید

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

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

یک پروژه و اعتبار برای مشتری خود ایجاد کنید

قبل از اینکه بتوانید درخواست‌ها را به کنسول جستجوی Google ارسال کنید، باید به Google در مورد مشتری خود بگویید و دسترسی به API را فعال کنید. این کار را با استفاده از Google API Console برای ایجاد یک پروژه ، که مجموعه ای نامگذاری شده از تنظیمات و اطلاعات دسترسی API است، انجام می دهید و برنامه خود را ثبت می کنید.

همه APIهای کنسول جستجو به جز Testing Tools API به اعتبارنامه OAuth2 نیاز دارند. راهنمای شروع سریع پایتون و جاوا جزئیاتی را در مورد نحوه ایجاد یک پروژه و دریافت اعتبار برای مشتری شما ارائه می دهد.

اصول REST را درک کنید

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

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

REST اصول اولیه

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

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

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

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

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

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

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

REST در Google Search Console API

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

فرمت اکثر URI های API کنسول جستجوی گوگل چیزی شبیه به این است:

VERB https://www.googleapis.com/webmasters/v3/resourcePath?parameters

مجموعه کامل URIها و افعال استفاده شده برای هر روش در نمای کلی مرجع API کنسول جستجوی Google آورده شده است.

اصول JSON را درک کنید

Google Search Console API داده‌ها را در قالب JSON برمی‌گرداند.

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