ما هي واجهة برمجة تطبيقات Metadata API - نظرة عامة

يقدّم هذا المستند نظرة عامة عالية المستوى على واجهة برمجة تطبيقات البيانات الوصفية في "إحصاءات Google". للحصول على مرجع مفصّل لواجهة برمجة التطبيقات، يمكنك الاطّلاع على مرجع واجهة برمجة التطبيقات.

مقدمة

تعرض واجهة برمجة تطبيقات البيانات الوصفية قائمة الأعمدة وسماتها (أي السمات والمقاييس) المعروضة في واجهات برمجة التطبيقات لإعداد تقارير "إحصاءات Google". وتشمل السمات التي يتم عرضها اسم واجهة المستخدم والوصف ودعم الشرائح والمزيد.

يمكنك استخدام Metadata API لتنفيذ ما يلي:

  • اكتشاف الأعمدة الجديدة تلقائيًا
  • الوصول إلى جميع سمات المقاييس والسمات لواجهات برمجة التطبيقات لإعداد تقارير "إحصاءات Google"

يمكنك الاطّلاع على الاستجابة المباشرة لواجهة برمجة تطبيقات البيانات الوصفية والتعرّف على كيفية استخدام هذه البيانات من خلال قراءة دليل المطوّر.

نظرة عامة على المفاهيم

المفاهيم الأساسية التي تستند إليها Metadata API هي:

الأعمدة

يمثّل مورد العمود في واجهة برمجة تطبيقات البيانات الوصفية سمة واحدة أو مقياسًا واحدًا ويحتوي على معلومات مثل Id والسمات الأخرى لذلك العمود. وتمثل مجموعة من موارد Column جميع السمات والمقاييس الخاصة بواجهة برمجة التطبيقات لإعداد التقارير.

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

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

الوصول إلى API

لا تتطلب واجهة برمجة تطبيقات البيانات الوصفية مصادقة وتفويض. بدلاً من ذلك، الشرط الوحيد هو أن يعرّف تطبيقك نفسه في كل مرة يرسل فيها طلبًا إلى واجهة برمجة تطبيقات "إحصاءات Google". للاطّلاع على تفاصيل حول كيفية إجراء ذلك، راجِع القسم الوصول إلى واجهة برمجة التطبيقات في دليل المطوّر.

سياسات الحصص والإيقاف

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

لمعرفة تفاصيل عن كيفية التعامل مع التغييرات في أعمدة Reporting API (أي السمات والمقاييس)، يُرجى الاطّلاع على سياسة إيقاف البيانات نهائيًا. لمعرفة كيفية استخدام Metadata API للتحقق من الأعمدة التي تم إيقافها نهائيًا، يُرجى الاطّلاع على دليل Dev API للبيانات الوصفية.