Method: properties.getMetadata

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

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

طلب HTTP

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

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

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

المعلمات
name

string

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

مثال: 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

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