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

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