Method: properties.getMetadata

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

على سبيل المثال، إذا تمّ تسجيل مقياس مخصَّص باسم المَعلمة levels_unlocked في أحد المواقع، ستتضمّن استجابة البيانات الوصفية customEvent:levels_unlocked. البيانات الوصفية العامة هي سمات ومقاييس تنطبق على أي موقع مثل country وtotalUsers.

طلب HTTP

GET https://analyticsdata.googleapis.com/v1beta/{name=properties/*/metadata}

يستخدم عنوان URL بنية تحويل الترميز gRPC.

معلمات المسار

المَعلمات
name

string

مطلوبة. اسم مورد البيانات الوصفية المطلوب استرداده. ويتم تحديد حقل الاسم هذا في مسار عنوان URL وليس في معلمات عناوين URL. الموقع هو معرّف رقمي لموقع "إحصاءات Google 4" (GA4). للمزيد من المعلومات، اطّلِع على مكان العثور على رقم تعريف الموقع.

مثال: properties/1234/metadata

اضبط رقم تعريف الموقع على 0 للسمات والمقاييس الشائعة في جميع المواقع. في هذا الوضع الخاص، لن تعرِض هذه الطريقة السمات والمقاييس المخصّصة.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

السمات والمقاييس والمقارنات المقبولة حاليًا في طرق إعداد التقارير.

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON
{
  "name": string,
  "dimensions": [
    {
      object (DimensionMetadata)
    }
  ],
  "metrics": [
    {
      object (MetricMetadata)
    }
  ]
}
الحقول
name

string

اسم المورد الخاص بهذه البيانات الوصفية.

dimensions[]

object (DimensionMetadata)

أوصاف السمات.

metrics[]

object (MetricMetadata)

تمثّل هذه السمة أوصاف المقاييس.

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics