Method: properties.getMetadata

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

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

طلب HTTP

GET https://analyticsdata.googleapis.com/v1alpha/{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

DimensionMetadata

لشرح سمة معيّنة.

تمثيل JSON 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "customDefinition": boolean
}
الحقول
apiName

string

اسم هذه السمة. قابلة للاستخدام في السمة name الخاصة بالسمة. مثلاً: eventName
uiName

string

اسم هذه السمة ضمن واجهة مستخدم "إحصاءات Google". مثلاً: Event name
description

string

وصف لطريقة استخدام هذه السمة واحتسابها.
deprecatedApiNames[]

string

أسماء لا تزال قابلة للاستخدام ولكن تم إيقافها نهائيًا لهذه السمة. في حال تعبئة هذه السمة، تكون متاحة إما عن طريق apiName أو أحد deprecatedApiNames لفترة زمنية معيّنة. بعد فترة الإيقاف النهائي، ستتوفّر السمة بحلول apiName فقط.
customDefinition

boolean

صحيح إذا كانت السمة عبارة عن سمة مخصّصة لهذا الموقع.

MetricMetadata

يشرح مقياسًا.

تمثيل JSON 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "type": enum (MetricType),
  "expression": string,
  "customDefinition": boolean
}
الحقول
apiName

string

اسم مقياس. قابلة للاستخدام في name الخاص بـ المقياس. مثلاً: eventCount
uiName

string

اسم هذا المقياس في واجهة مستخدِم "إحصاءات Google". مثلاً: Event count
description

string

تمثّل هذه السمة وصفًا لطريقة استخدام هذا المقياس وحسابه.
deprecatedApiNames[]

string

أسماء لا تزال قابلة للاستخدام ولكن تم إيقافها نهائيًا لهذا المقياس. في حال تعبئة هذا المقياس، يكون متوفّرًا عن طريق apiName أو أحد deprecatedApiNames لفترة زمنية معيَّنة. بعد فترة الإيقاف النهائي، سيتوفّر المقياس فقط بحلول apiName.
type

enum (MetricType)

نوع هذا المقياس
expression

string

التعبير الحسابي لهذا المقياس المشتق. يمكن استخدامها في حقل المقياس expression للتقارير المقابلة. معظم المقاييس ليست تعبيرات، وبالنسبة إلى عدم التعبيرات، هذا الحقل فارغ.
customDefinition

boolean

صحيح إذا كان المقياس مقياسًا مخصَّصًا لهذا الموقع.