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)
    }
  ],
  "comparisons": [
    {
      object (ComparisonMetadata)
    }
  ]
}
الحقول
name

string

اسم المورد لهذه البيانات الوصفية
dimensions[]

object (DimensionMetadata)

أوصاف السمات.
metrics[]

object (MetricMetadata)

أوصاف المقاييس.
comparisons[]

object (ComparisonMetadata)

أوصاف المقارنة:

نطاقات الأذونات

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

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

ComparisonMetadata

البيانات الوصفية لمقارنة واحدة

تمثيل JSON 
{
  "apiName": string,
  "uiName": string,
  "description": string
}
الحقول
apiName

string

اسم المورد لهذه المقارنة. يمكن استخدامها في حقل comparison في المقارنة. على سبيل المثال، "comparisons/1234".
uiName

string

اسم هذه المقارنة ضمن واجهة مستخدِم "إحصاءات Google".
description

string

وصف هذه المقارنة