واجهة Postmaster Tools API هي واجهة RESTful API تتيح الوصول آليًا إلى مقاييس عدد الزيارات للرسائل الإلكترونية (مثل تقارير الرسائل غير المرغوب فيها وأخطاء التسليم وما إلى ذلك) المتاحة حاليًا من خلال واجهة مستخدم أدوات Gmail Postmaster.
- مورد REST: v2.domainStats
- مورد REST: v2.domains
- مورد REST: v2.domains.domainStats
- مورد REST: v2.domains.users
الخدمة: gmailpostmastertools.googleapis.com
لطلب هذه الخدمة، ننصح باستخدام مكتبات العميل التي توفّرها Google. إذا كان تطبيقك يحتاج إلى استخدام مكتباتك الخاصة لطلب هذه الخدمة، استخدِم المعلومات التالية عند طلب بيانات من واجهة برمجة التطبيقات.
مستند الاستكشاف
مستند الاستكشاف هو عبارة عن مواصفات يمكن أن تقرأها الآلة لوصف REST API واستخدامها. وهو يُستخدم لإنشاء مكتبات العميل ومكوّنات IDE الإضافية وغيرها من الأدوات التي تتفاعل مع Google APIs. تجدر الإشارة إلى أنّ خدمة واحدة قد تقدّم أكثر من وثيقة استكشاف. توفّر هذه الخدمة مستند الاكتشاف التالي:
نقطة نهاية الخدمة
نقطة نهاية الخدمة هي الجزء الأساسي من عنوان URL الذي يحدّد عنوان الشبكة لخدمة واجهة برمجة التطبيقات. قد يكون للخدمة الواحدة أكثر من نقطة نهاية واحدة. تحتوي هذه الخدمة على نقطة النهاية التالية، وجميع عناوين URI أدناه تكون نسبيّة لهذه النقطة:
https://gmailpostmastertools.googleapis.com
مورد REST: v2.domainStats
| الطُرق | |
|---|---|
batchQuery |
POST /v2/domainStats:batchQuery ينفّذ مجموعة من طلبات QueryDomainStats لنطاقات متعددة. |
مورد REST: v2.domains
| الطُرق | |
|---|---|
create |
POST /v2/domains تضيف هذه السمة نطاقًا إلى حساب المستخدم. |
delete |
DELETE /v2/{name=domains/*} يحذف هذا الأمر نطاقًا من حساب المستخدم. |
get |
GET /v2/{name=domains/*} يستردّ معلومات تفصيلية حول نطاق سجّلته. |
getComplianceStatus |
GET /v2/{name=domains/*/complianceStatus} يستردّ هذا الإجراء حالة التوافق لنطاق معيّن. |
getVerificationToken |
GET /v2/{name=domains/*/verificationToken} تعرض هذه الطريقة رمزًا مميّزًا لإثبات ملكية المستخدم لنطاق معيّن. |
list |
GET /v2/domains يستردّ قائمة بجميع النطاقات التي سجّلتها، بالإضافة إلى البيانات الوصفية المقابلة لها. |
verify |
POST /v2/{name=domains/*}:verify تتحقّق هذه الطريقة من ملكية المستخدم لنطاق على مستوى نظام أسماء النطاقات. |
مورد REST: v2.domains.domainStats
| الطُرق | |
|---|---|
query |
POST /v2/{parent=domains/*}/domainStats:query يستردّ قائمة بإحصاءات النطاق لنطاق معيّن وفترة زمنية محدّدة. |
مورد REST: v2.domains.users
| الطُرق | |
|---|---|
create |
POST /v2/{parent=domains/*}/users تنشئ هذه السمة مستخدمًا لديه إذن الوصول إلى نطاق. |
delete |
DELETE /v2/{name=domains/*/users/*} يحذف هذا الأمر مستخدمًا من نطاق. |
get |
GET /v2/{name=domains/*/users/*} يستردّ هذا الأمر معلومات تفصيلية عن مستخدم لديه إذن الوصول إلى نطاق. |
list |
GET /v2/{parent=domains/*}/users تعرض هذه السمة قائمة بالمستخدمين الذين يمكنهم الوصول إلى نطاق معيّن. |
patch |
PATCH /v2/{user.name=domains/*/users/*} تعدّل هذه الطريقة معلومات مستخدم في نطاق. |