عندما يرسل تطبيقك طلبًا إلى واجهة برمجة التطبيقات في Google Search Console، يجب أن يحتوي هذا الطلب على رمز موافقة مميز. ويساعد الرمز المميز محرك البحث Google في التعرّف على تطبيقك.
نبذة عن بروتوكولات التفويض
يجب أن يستخدم تطبيقك OAuth 2.0 للسماح بالطلبات. ولا يُسمح باستخدام أي بروتوكولات أخرى للموافقة على الطلبات. إذا كان تطبيقك يستخدم ميزة تسجيل الدخول باستخدام حساب Google، ستتم معالجة بعض جوانب عملية الموافقة على الطلبات نيابةً عنك.
الموافقة على الطلبات باستخدام OAuth 2.0
يجب أن يوافق مستخدم مصادَق عليه على كلّ الطلبات الموجّهة إلى واجهة برمجة التطبيقات في Google Search Console.
تختلف تفاصيل عملية الموافقة على الطلبات لبروتوكول OAuth 2.0 نوعًا ما حسب نوع التطبيق الذي تكتبه. وتسري العملية العامة التالية على كل أنواع التطبيقات:
عند إنشاء التطبيق، يجب تسجيله باستخدام وحدة التحكم في واجهة Google API. ويوفر محرك البحث Google المعلومات التي ستحتاجها في ما بعد، مثل معرّف العميل وسر العميل.
يجب تفعيل واجهة برمجة التطبيقات لخدمة Google Search Console في وحدة التحكم في واجهة Google API. (يمكنك تخطّي هذه الخطوة إذا كانت واجهة برمجة التطبيقات غير مدرَجة في وحدة التحكم في واجهة Google API.)
إذا احتاج التطبيق الدخول إلى بيانات المستخدِم، يطلب التطبيق من Google نطاقًا معينًا للدخول.
يعرض Google شاشة الموافقة للمستخدم، ويطلب منه السماح لتطبيقك بطلب بعض بياناته.
عند موافقة المستخدِم، يمنح Google تطبيقك رمز دخول قصير الأجل.
يطلب تطبيقك بيانات المستخدِم، من خلال إرفاق رمز الدخول بالطلب.
يعرض Google البيانات المطلوبة بعد تحققه من صلاحية طلبك والرمز المميز.
تستلزم بعض التدفقات إجراء خطوات إضافية، مثل استخدام رموز مميزة للتحديث للحصول على رموز دخول جديدة. لمزيد من المعلومات التفصيلية حول العمليات المتعلقة بمختلف أنواع التطبيقات، راجِع مستندات بروتوكول OAuth 2.0 في Google.
في ما يلي معلومات عن نطاق OAuth 2.0 في واجهة برمجة التطبيقات في Google Search Console:
لطلب الدخول باستخدام بروتوكول OAuth 2.0، يحتاج التطبيق معلومات عن النطاق، بالإضافة إلى المعلومات التي يوفّرها Google عند تسجيل التطبيق (مثل معرِّف العميل وسر العميل).
نصيحة: يمكن لمكتبات عملاء Google APIs معالجة جزء من عملية السماح بالنيابة عنك. وتتوفّر هذه المكتبات للعديد من لغات البرمجة، ويمكنك الاطّلاع على صفحة المكتبات والنماذج للحصول على مزيد من التفاصيل.
متطلبات مصادقة واجهة برمجة التطبيقات لأدوات الاختبار في Search Console
الحصول على مفتاح واجهة برمجة التطبيقات واستخدامه
يجب أن تكون طلبات البيانات الموجّهة إلى Search Console Testing Tools API للحصول على بيانات علنية مزوّدة بمعرّف يمكن أن يكون مفتاح واجهة برمجة تطبيقات أو رمز دخول.
تتيح واجهة برمجة التطبيقات هذه نوعين من بيانات الاعتماد.
أنشئ بيانات الاعتماد المناسبة لمشروعك:
OAuth 2.0: عندما يطلب تطبيقك بيانات مستخدم خاصة، يجب أن يرسل رمز OAuth 2.0 المميز مع الطلب. يرسل تطبيقك أولاً معرِّف عميل، وربما سر العميل، للحصول على رمز مميّز. ويمكنك إنشاء بيانات اعتماد OAuth 2.0 لتطبيقات الويب أو حسابات الخدمة أو التطبيقات المثبّتة.
مفاتيح واجهة برمجة التطبيقات:
في حال عدم توفير رمز OAuth 2.0 المميز، يجب أن يرسل مفتاح واجهة برمجة التطبيقات.
يحدد المفتاح مشروعك ويوفر إمكانية الوصول إلى واجهة برمجة التطبيقات والحصة وتقاريره.
تتيح واجهة برمجة التطبيقات عدة أنواع من القيود المفروضة على مفاتيح واجهة برمجة التطبيقات. إذا لم يكن مفتاح واجهة برمجة التطبيقات الذي تحتاجه متوفّرًا، أنشِئ مفتاح واجهة برمجة التطبيقات في "وحدة التحكّم" بالنقر على إنشاء بيانات اعتماد
> مفتاح واجهة برمجة التطبيقات. يمكنك فرض قيود على المفتاح قبل استخدامه
في مرحلة الإنتاج من خلال النقر على تقييد المفتاح واختيار أحد
القيود.
تاريخ التعديل الأخير: 2024-07-23 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2024-07-23 (حسب التوقيت العالمي المتفَّق عليه)"],[[["\u003cp\u003eAll applications must use OAuth 2.0 for authorization when interacting with the Google Search Console API to access user data.\u003c/p\u003e\n"],["\u003cp\u003eThe authorization process involves registering your application, obtaining necessary credentials, and requesting specific scopes of access, subject to user consent.\u003c/p\u003e\n"],["\u003cp\u003eGoogle Search Console Testing Tools API requires an API key instead of an OAuth token to access its public data.\u003c/p\u003e\n"],["\u003cp\u003eAPI keys can be obtained and restricted for security via the Google API Console, while OAuth 2.0 is necessary for private user data requests.\u003c/p\u003e\n"]]],["Applications interacting with the Google Search Console API must use OAuth 2.0 for authorization. This involves registering the application with Google to obtain a client ID and secret. Applications request specific data access scopes, users grant consent, and then a short-lived access token is issued. The application then uses this token to request data. The Search Console Testing Tools API, however, requires an API key or an access token for requests, obtained via the Google API Console.\n"],null,["Search Console API auth requirements\n\nEvery request your application sends to the Google Search Console API must include an authorization token. The token also identifies your application to Google.\n\nAbout authorization protocols\n\nYour application must use [OAuth 2.0](https://developers.google.com/identity/protocols/OAuth2) to authorize requests. No other authorization protocols are supported. If your application uses [Sign In With Google](https://developers.google.com/identity/gsi/web), some aspects of authorization are handled for you.\n\nAuthorizing requests with OAuth 2.0\n\nAll requests to the Google Search Console API must be authorized by an authenticated user.\n\nThe details of the authorization process, or \"flow,\" for OAuth 2.0 vary somewhat depending on what kind of application you're writing. The following general process applies to all application types:\n\n1. When you create your application, you register it using the [Google API Console](https://console.cloud.google.com/). Google then provides information you'll need later, such as a client ID and a client secret.\n2. Activate the Google Search Console API in the Google API Console. (If the API isn't listed in the API Console, then skip this step.)\n3. When your application needs access to user data, it asks Google for a particular **scope** of access.\n4. Google displays a **consent screen** to the user, asking them to authorize your application to request some of their data.\n5. If the user approves, then Google gives your application a short-lived **access token**.\n6. Your application requests user data, attaching the access token to the request.\n7. If Google determines that your request and the token are valid, it returns the requested data.\n\nSome flows include additional steps, such as using **refresh tokens** to acquire new access tokens. For detailed information about flows for various types of applications, see Google's [OAuth 2.0 documentation](https://developers.google.com/identity/protocols/OAuth2).\n\nHere's the OAuth 2.0 scope information for the Google Search Console API:\n\n| Scope | Meaning |\n|-------------------------------------------------------|--------------------|\n| `https://www.googleapis.com/auth/webmasters` | Read/write access. |\n| `https://www.googleapis.com/auth/webmasters.readonly` | Read-only access. |\n\nTo request access using OAuth 2.0, your application needs the scope information, as well as\ninformation that Google supplies when you register your application (such as the client ID and the\nclient secret).\n\n**Tip:** The Google APIs client libraries can handle some of the authorization process for you. They are available for a variety of programming languages; check the [page with libraries and samples](/webmaster-tools/v1/libraries) for more details.\n\n*** ** * ** ***\n\nSearch Console Testing Tools API auth requirements **Note:** The Search Console Testing Tools API requires a key rather than an OAuth token.\n\nAcquiring and using an API key\n\nRequests to the Search Console Testing Tools API for public data must be accompanied by an identifier, which can\nbe an [API key](https://developers.google.com/console/help/generating-dev-keys) or an\n[access token](https://developers.google.com/accounts/docs/OAuth2).\n\nTo acquire an API key:\n\n1. Open the [Credentials page](https://console.cloud.google.com/apis/credentials) in the API Console.\n2. This API supports two types of credentials. Create whichever credentials are appropriate for your project:\n - **OAuth 2.0:** Whenever your application requests private user\n data, it must send an OAuth 2.0 token along with the request. Your\n application first sends a client ID and, possibly, a client secret to\n obtain a token. You can generate OAuth 2.0 credentials for web\n applications, service accounts, or installed applications.\n\n For more information, see the [OAuth 2.0 documentation](https://developers.google.com/identity/protocols/OAuth2).\n - **API keys:**\n\n A request that does not provide an OAuth 2.0 token must send an API\n key.\n\n The key identifies your project and provides API access, quota, and\n reports.\n\n The API supports several types of restrictions on API keys. If the API key that you\n need doesn't already exist, then create an API key in the Console by\n clicking **[Create credentials](https://console.cloud.google.com/apis/credentials) \\\u003e API key** . You can restrict the key before using it\n in production by clicking **Restrict key** and selecting one of the\n **Restrictions**.\n\nTo keep your API keys secure, follow the [best practices for\nsecurely using API keys](//cloud.google.com/docs/authentication/api-keys).\n\nAfter you have an API key, your application can append the query parameter\n`key=`\u003cvar translate=\"no\"\u003eyourAPIKey\u003c/var\u003e to all request URLs.\n\nThe API key is safe for embedding in URLs; it doesn't need any encoding."]]
