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 الخاص بـ Comparison على سبيل المثال، "comparisons/1234"
uiName

string

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

string

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