استدعاء واجهة برمجة التطبيقات

يوضّح هذا المستند كيفية استخدام واجهة برمجة التطبيقات لإثبات ملكية المواقع الإلكترونية من Google.

استدعاء واجهة برمجة التطبيقات

تنسيق الطلب

يتم ربط معظم عمليات "إثبات ملكية الموقع الإلكتروني" المتوافقة مع أفعال HTTP باستخدام REST مباشرةً (GET وPOST وPUT وDELETE)، كما هو موضّح في عمليات واجهة برمجة التطبيقات لإثبات ملكية المواقع الإلكترونية من Google.

في ما يلي التنسيق المحدّد لمعرّفات الموارد المنتظمة (URI) لواجهة برمجة التطبيقات الخاصة بخدمة Google Site:

https://www.googleapis.com/siteVerification/v1/webResource/resourceID?parameters

حيث resourceID هو معرّف أحد موارد الويب، تكون parameters أي معلَمات يجب تطبيقها على طلب البحث. تختلف المعلمات الفعلية التي تستخدمها باختلاف العملية التي تجريها. وبالإضافة إلى ذلك، إذا كنت تستخدم OAuth 2.0، يجب ضبط access_token في هذه المعلمات.

لا تتطلب طلبات البحث في القائمة إدخال resourceID، لذا يكون التنسيق على النحو التالي:

https://www.googleapis.com/siteVerification/v1/webResource?parameters

يمكنك إجراء استدعاءات لعملية getToken من خلال معرّف الموارد المنتظم (URI) الفريد الخاص بها. صيغة طلب getToken هي:

https://www.googleapis.com/siteVerification/v1/token?parameters

تنسيق البيانات

تعرض واجهة برمجة التطبيقات لإثبات ملكية المواقع من Google البيانات بتنسيق JSON.

JSON (JavaScript Object Notation) هو تنسيق بيانات شائع مستقل عن اللغة، ويقدم تمثيلاً نصيًا بسيطًا لبنية البيانات العشوائية. لمزيد من المعلومات، يمكنك الاطّلاع على json.org.

ملخّص العمليات

يمكنك استدعاء ست طرق مختلفة في ما يخص المجموعات والموارد في Google Site Verification API، كما هو موضّح في الجدول التالي. عناوين URL لواجهة برمجة التطبيقات نسبية إلى https://www.googleapis.com/siteVerification/v1.

العملية الوصف عنوان URL والبنية
list

يتم إدراج جميع الموارد ضمن مجموعة "المستخدم" التي تمت مصادقتها.

GET /webResource

يُرجى الاطّلاع على مثال طلب القائمة.
إدراج

إثبات ملكية موقع إلكتروني أو نطاق في حال نجاح ذلك، يتم إدراج مورد ويب جديد في مجموعة المستخدمين.

نص الطلب: راجِع مورد الويب.

معلَمة طلب البحث: verificationMethod. طريقة إثبات الملكية التي يمكن استخدامها لهذا الطلب. القيم المحتملة: FILE، META، ANALYTICS، TAG_MANAGER، DNS_TXT، DNS_CNAME

POST /webResource

يمكنك الاطّلاع على مثال طلب الطلب.
الحصول

الحصول على أحدث البيانات لأحد موارد الويب.

GET /webResource/resourceID

الاطّلاع على مثال على طلب الحصول على
تحديث

يعدّل قائمة المالكين لمورد معيّن.

نص الطلب: راجِع مورد الويب.

ملاحظات:

  • لا يمكنك إزالة المستخدم الذي تمت المصادقة عليه من قائمة المالكين باستخدام التحديث. استخدم حذف بدلاً من ذلك.
  • يمكنك الإزالة من قائمة المالكين أي مستخدم ليس لديه رمز التحقق المميز على الموقع.

PUT /webResource/resourceID

يمكنك الاطّلاع على مثال على طلب التعديل.
حذف

إزالة مورد من مجموعة المستخدم (يثبت أن الموقع الإلكتروني ينتمي إلى المستخدم).

ملاحظات:

  • يجب أولاً إزالة جميع رموز التحقق المميزة للمستخدم الذي تمت المصادقة عليه من الموقع الإلكتروني أو النطاق قبل طلب حذف. إذا ظلت أي رموز مميزة متوفرة، يتم عرض رسالة الخطأ HTTP 400 (طلب غير صحيح).
  • لا يؤثر الحذف إلا في بيانات الملكية للمستخدم الذي تمت المصادقة عليه. يحتفظ جميع المستخدمين الآخرين، سواء تم تفويضهم أو تم التحقق منهم بشكل مستقل، بملكية الملكية بعد الحذف.

DELETE /webResource/resourceID

يمكنك الاطّلاع على مثال على طلب الحذف.
getToken

يحصل هذا الإعداد على الرمز المميّز لإثبات الملكية المطلوب وضعه على موقع المستخدم الإلكتروني الذي تمت المصادقة عليه.

نص الطلب:

  • identifier: عنوان URL للموقع الإلكتروني أو اسم النطاق.
  • type: نوع المورد المراد إثبات ملكيته القيم المحتملة: SITE، INET_DOMAIN.
  • verificationMethod: طريقة الاستخدام عند إثبات ملكية موقعك الإلكتروني. القيم المحتملة: FILE، META، ANALYTICS، TAG_MANAGER، DNS_TXT، DNS_CNAME

POST /token

يمكنك الاطّلاع على مثال على طلب getToken.

أمثلة على طلبات البيانات من واجهة برمجة التطبيقات

ويفترض هذا القسم أنك (مطوّر البرامج) هو المستخدم الذي تمت المصادقة عليه أيضًا، كما هو الحال عند تجربة واجهة برمجة التطبيقات لأول مرة باستخدام بيانات الاختبار الخاصة بك.

إثبات ملكية موقع إلكتروني جديد

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

  1. عليك أولاً طلب رمز مميز للتحقُّق عن طريق طلب getToken.
  2. ضَع الرمز المميّز على موقعك الإلكتروني بأي طريقة تختارها.
  3. اطلب من Google إثبات ملكيتك للموقع الإلكتروني، باستخدام عملية إدراج.

getToken (يتطلب تفويضًا)

POST https://www.googleapis.com/siteVerification/v1/token?access_token=oauth2-token

الطلب:

POST https://www.googleapis.com/siteVerification/v1/token?access_token=oauth2-token
Content-Type: application/json

{
  "verificationMethod": "FILE",
  "site": {
    "identifier": "http://www.example.com",
    "type": "SITE"
  }
}

الرد:

{
  "token": "google12cfc68677988bb4.html",
  "method": "FILE"
}

إدراج (يتطلب تفويضًا)

POST https://www.googleapis.com/siteVerification/v1/webResource?verificationMethod=FILE&access_token=oauth2-token

الطلب:

POST https://www.googleapis.com/siteVerification/v1/webResource?verificationMethod=FILE&access_token=oauth2-token
Content-Type: application/json

{
  "site": {
    "identifier": "http://www.example.com",
    "type": "SITE"
  }
}

الرد:

{
  "owners": [
    "myself@example.com",
  ],
  "id": "http%3A%2F%2Fwww.example.com%2F",
  "site": {
    "identifier": "http://www.example.com/",
    "type": "SITE"
  }
}

استرداد المعلومات لموارد الويب التي تم التحقق منها

يمكنك استرداد القائمة الكاملة للمواقع الإلكترونية والنطاقات التي تم إثبات ملكيتها من خلال طلب القائمة. يمكنك استرداد المعلومات لمورد ويب واحد عن طريق طلب الحصول.

القائمة (تتطلب تفويضًا)

GET https://www.googleapis.com/siteVerification/v1/webResource?access_token=oauth2-token

الطلب:

GET https://www.googleapis.com/siteVerification/v1/webResource?access_token=oauth2-token

الرد:

{
  "items": [
    {
      "owners": [
        "myself@example.com",
      ],
      "id": "http%3A%2F%2Fwww.example.com%2F",
      "site": {
        "identifier": "http://www.example.com/site1",
        "type": "SITE"
      }
    },
    {
      "owners": [
        "myself@example.com",
      ],
      "id": "http%3A%2F%2Fwww.example.com%2F",
      "site": {
        "identifier": "http://www.example.com/site2",
        "type": "SITE"
      }
    }
  ]
}

الحصول على (يتطلب تفويضًا)

GET https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

الطلب:

GET https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

الرد:

{
  "owners": [
    "myself@example.com",
  ],
  "id": "http%3A%2F%2Fwww.example.com%2F",
  "site": {
    "identifier": "http://www.example.com/",
    "type": "SITE"
  }
}

تعديل معلومات إثبات الهوية

يمكنك تفويض الملكية وإبطالها من خلال طلب تعديل. يمكنك إزالة الملكية من خلال طلب حذف.

تحديث (يتطلب تفويضًا)

PUT https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

الطلب:

PUT https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token
Content-Type: application/json

{
  "owners": [
    "myself@example.com",
    "another@example.com",
  ],
  "id": "http%3A%2F%2Fwww.example.com%2F",
  "site": {
    "identifier": "http://www.example.com",
    "type": "SITE"
  }
}

الرد:

{
  "owners": [
    "myself@example.com",
    "another@example.com",
  ],
  "id": "http%3A%2F%2Fwww.example.com%2F",
  "site": {
    "identifier": "http://www.example.com/",
    "type": "SITE"
  }
}

حذف (يتطلب تفويضًا)

DELETE https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

الطلب:

DELETE https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

الرد:

رمز حالة HTTP 204 (بدون محتوى)، والتي تشير إلى نجاح العملية.