المتطلبات الأساسية لواجهة برمجة التطبيقات للفهرسة

قبل بدء استخدام واجهة برمجة التطبيقات للفهرسة، عليك تنفيذ بعض الأمور، إذا لم يسبق لك تنفيذها:

إنشاء مشروع لعميلك

قبل إرسال طلبات إلى واجهة برمجة التطبيقات للفهرسة، عليك تزويد Google بمعلومات حول عميلك وتفعيل الدخول إلى واجهة برمجة التطبيقات. ويمكنك إجراء ذلك عن طريق الاستعانة بوحدة التحكم في Google API لإنشاء مشروع، وهو مجموعة معينة من الإعدادات ومعلومات الدخول إلى واجهة برمجة التطبيقات، ولتسجيل تطبيقك.

لبدء استخدام واجهة برمجة التطبيقات للفهرسة، عليك أولاً استخدام أداة الإعداد، التي تقدم لك إرشادات خلال عملية إنشاء المشروع في وحدة التحكم في Google API وتفعيل واجهة برمجة التطبيقات وإنشاء بيانات الاعتماد.

إنشاء حساب خدمة

  1. افتح صفحة حسابات الخدمة. اختَر مشروعًا، إن طُلب منك ذلك.
  2. انقر على إنشاء حساب خدمة.
  3. في النافذة إنشاء حساب خدمة، اكتب اسمًا لحساب الخدمة، ثم اختَر تقديم مفتاح خاص جديد. إذا أردت منح التفويض على مستوى نطاق G Suite لحساب الخدمة، اختَر أيضًا تفعيل التفويض على مستوى نطاق G Suite. ثم انقر على حفظ.

يتم إنشاء زوج المفتاح العام/الخاص وتنزيله على جهازك، ويعد هذا الزوج هو النسخة الوحيدة من هذا المفتاح. وعليك حفظ هذا المفتاح بشكل آمن.

إثبات ملكية الموقع في Search Console

في هذه الخطوة، يمكنك التأكُّد من تحكمك في موقع الويب.

لإثبات ملكية موقعك:

  1. اتبِّع الخطوات الموصى بها لإثبات ملكية الموقع.
  2. بعد إثبات ملكية موقعك، افتح Search Console.
  3. انقر على الموقع الذي اثبتَّ ملكيته.
  4. اختَر تفاصيل إثبات الملكية من خلال رمز ترس "الإعدادات" بجانب الموقع الذي تم إثبات ملكيته.
  5. ضمن مالكون تم إثبات ملكيتهم، انقر على إضافة مالك.
  6. أضِف عنوان البريد الإلكتروني لحساب الخدمة باعتبارك مالك للموقع. ويمكنك العثور على عنوان البريد الإلكتروني لحساب الخدمة في موضعين:
    • حقل client_email في المفتاح الخاص بترميز JSON الذي تم تنزيله عند إنشاء مشروعك.
    • عمود معرّف حساب الخدمة في عرض حسابات الخدمة في Developer Console.

    يكون تنسيق عنوان البريد الإلكتروني على النحو التالي:

    my-service-account@project-name.google.com.iam.gserviceaccount.com

    على سبيل المثال، "my-service-account@test-project-42.google.com.iam.gserviceaccount.com".

الحصول على رمز الدخول

لاستدعاء واجهة برمجة التطبيقات للفهرسة، يجب المصادقة على الاستدعاء برمز OAuth المميز الذي تحصل عليه في مقابل مفتاحك الخاص. وتوفر Google مكتبات عميل واجهة برمجة التطبيقات للحصول على رموز OAuth المميزة الخاصة بعدد من اللغات.

المتطلبات

عند إرسال طلب إلى واجهة برمجة التطبيقات للفهرسة، يجب أن يستوفي طلبك الشروط التالية:

  1. استخدام نطاق https://www.googleapis.com/auth/indexing.
  2. استخدام أحد نقاط النهاية الموضحة في استخدام واجهة برمجة التطبيقات.
  3. تضمين رمز الدخول إلى حساب الخدمة.
  4. تحديد نص الطلب بالشكل الموضح في استخدام واجهة برمجة التطبيقات.

أمثلة

توضح الأمثلة التالية طريقة الحصول على رمز OAuth مميز للدخول:

لغة Python

يمكن الحصول على رمز OAuth مميز باستخدام مكتبة عميل واجهة Google API للغة Python:

from oauth2client.service_account import ServiceAccountCredentials
import httplib2

SCOPES = [ "https://www.googleapis.com/auth/indexing" ]
ENDPOINT = "https://indexing.googleapis.com/v3/urlNotifications:publish"

# service_account_file.json is the private key that you created for your service account.
JSON_KEY_FILE = "service_account_file.json"

credentials = ServiceAccountCredentials.from_json_keyfile_name(JSON_KEY_FILE, scopes=SCOPES)

http = credentials.authorize(httplib2.Http())

// Define contents here. This example shows a simple update request. Other types
// of requests are described in the next step.
content = "{
  \"url\": \"http://example.com/jobs/42\",
  \"type\": \"URL_UPDATED"
}"

response, content = http.request(ENDPOINT, method="POST", body=content)

لغة جافا

يمكن الحصول على رمز OAuth مميز باستخدام مكتبة عميل واجهة برمجة التطبيقات للغة جافا:

String scopes = "https://www.googleapis.com/auth/indexing";
String endPoint = "https://indexing.googleapis.com/v3/urlNotifications:publish";

JsonFactory jsonFactory = new JacksonFactory();

// service_account_file.json is the private key that you created for your service account.
InputStream in = IOUtils.toInputStream("service_account_file.json");

GoogleCredential credentials =
  GoogleCredential.fromStream(in, this.httpTransport, jsonFactory).createScoped(Collections.singleton(scopes));

GenericUrl genericUrl = new GenericUrl(endPoint);
HttpRequestFactory requestFactory = this.httpTransport.createRequestFactory();

// Define content here. The structure of the content is described in the next step.
String content = "{"
  + "\"url\": \"http://example.com/jobs/42\","
  + "\"type\": \"URL_UPDATED\","
  + "}";

HttpRequest request =
  requestFactory.buildPostRequest(genericUrl, ByteArrayContent.fromString("application/json", content));

credentials.initialize(request);
HttpResponse response = request.execute();
int statusCode = response.getStatusCode();

لغة PHP

يمكن الحصول على رمز OAuth مميز باستخدام مكتبة عميل واجهة برمجة التطبيقات للغة PHP:

require_once 'google-api-php-client/vendor/autoload.php';

$client = new Google_Client();

// service_account_file.json is the private key that you created for your service account.
$client->setAuthConfig('service_account_file.json');
$client->addScope('https://www.googleapis.com/auth/indexing');

// Get a Guzzle HTTP Client
$httpClient = $client->authorize();
$endpoint = 'https://indexing.googleapis.com/v3/urlNotifications:publish';

// Define contents here. The structure of the content is described in the next step.
$content = "{
  \"url\": \"http://example.com/jobs/42\",
  \"type\": \"URL_UPDATED"
}";

$response = $httpClient->post($endpoint, [ 'body' => $content ]);
$status_code = $response->getStatusCode();

Node.js

يمكن الحصول على رمز OAuth مميز باستخدام مكتبة عميل Node.js:

var request = require("request");
var google = require("googleapis");
var key = require("./service_account.json");

const jwtClient = new google.auth.JWT(
  key.client_email,
  null,
  key.private_key,
  ["https://www.googleapis.com/auth/indexing"],
  null
);

jwtClient.authorize(function(err, tokens) {
  if (err) {
    console.log(err);
    return;
  }
  let options = {
    url: "https://indexing.googleapis.com/v3/urlNotifications:publish",
    method: "POST",
    // Your options, which must include the Content-Type and auth headers
    headers: {
      "Content-Type": "application/json"
    },
    auth: { "bearer": tokens.access_token },
    // Define contents here. The structure of the content is described in the next step.
    json: {
      "url": "http://example.com/jobs/42",
      "type": "URL_UPDATED"
    };
  request(options, function (error, response, body) {
    // Handle the response
    console.log(body);
  });
});

بالإضافة إلى عرض طريقة الحصول على الرمز المميز، توضح هذه الأمثلة الموضع الذي يمكنك فيه إضافة نص رسالة الطلب. لمزيد من المعلومات عن أنواع عمليات الاستدعاء التي يمكنك إجراؤها وبنية نصوص رسائل عمليات الاستدعاء هذه، راجِع استخدام واجهة برمجة التطبيقات.

إرسال تعليقات حول...