Method: properties.getMetadata

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

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

طلب HTTP

GET https://analyticsdata.googleapis.com/v1alpha/{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)
    }
  ],
  "conversions": [
    {
      object (ConversionMetadata)
    }
  ]
}
الحقول
name

string

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

object (DimensionMetadata)

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

object (MetricMetadata)

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

object (ComparisonMetadata)

تمثّل هذه السمة أوصاف المقارنة.
conversions[]

object (ConversionMetadata)

أوصاف الإحالات الناجحة

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

يجب توفير أحد نطاقات 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,
  "category": string,
  "sections": [
    enum (Section)
  ]
}
الحقول
apiName

string

اسم هذه السمة. يمكن استخدامها في name السمة. على سبيل المثال، eventName.
uiName

string

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

string

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

string

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

boolean

تكون القيمة "صحيح" إذا كانت السمة مخصّصة لهذا الموقع. ويشمل ذلك السمات المخصّصة على مستوى المستخدِم والحدث والمنتج أو الخدمة. لمعرفة المزيد عن السمات المخصّصة، يُرجى الاطّلاع على https://support.google.com/analytics/answer/14240153. ويشمل ذلك أيضًا مجموعات القنوات المخصّصة. لمزيد من المعلومات عن مجموعات القنوات المخصّصة، يُرجى الاطّلاع على https://support.google.com/analytics/answer/13051316.
category

string

الاسم المعروض للفئة التي تنتمي إليها هذه السمة. يتم تصنيف السمات والمقاييس المشابهة معًا.
sections[]

enum (Section)

تحدّد أقسام "إحصاءات Google" التي تنطبق عليها هذه السمة.

MetricMetadata

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

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

string

اسم مقياس يمكن استخدامها في name المقياس. على سبيل المثال، eventCount.
uiName

string

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

string

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

string

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

enum (MetricType)

تمثّل هذه السمة نوع المقياس.
expression

string

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

boolean

تكون القيمة صحيحة إذا كان المقياس مقياسًا مخصّصًا لهذا الموقع.
blockedReasons[]

enum (BlockedReason)

في حال تحديد الأسباب، يتم حظر وصولك إلى هذا المقياس لهذا الموقع. ستنجح طلبات واجهة برمجة التطبيقات التي ترسلها إلى هذا الموقع لهذا المقياس، ولكن سيحتوي التقرير على أصفار فقط لهذا المقياس. سيتعذّر تنفيذ طلبات البيانات من واجهة برمجة التطبيقات التي تتضمّن فلاتر مقاييس على المقاييس المحظورة. إذا كانت الأسباب فارغة، يمكنك الوصول إلى هذا المقياس.

لمزيد من المعلومات، اطّلِع على المقالة إدارة أذونات الوصول والقيود المفروضة على البيانات.
category

string

الاسم المعروض للفئة التي تنتمي إليها هذه المقاييس. يتم تصنيف السمات والمقاييس المشابهة معًا.
sections[]

enum (Section)

تحدِّد أقسام "إحصاءات Google" التي ينطبق عليها هذا المقياس.

BlockedReason

أسباب حظر هذا المقياس

عمليات التعداد
BLOCKED_REASON_UNSPECIFIED لن يتم تحديدها أبدًا في الردّ من واجهة برمجة التطبيقات.
NO_REVENUE_METRICS في حال توفّرها، يتم حظر وصولك إلى المقاييس المتعلّقة بالأرباح لهذا الموقع، وهذا المقياس متعلّق بالأرباح.
NO_COST_METRICS في حال توفُّرها، يتم حظر وصولك إلى المقاييس المرتبطة بالتكلفة لهذا الموقع، وهذا المقياس مرتبط بالتكلفة.

ComparisonMetadata

تمثّل هذه السمة البيانات الوصفية لمقارنة واحدة.

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

string

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

string

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

string

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

ConversionMetadata

البيانات الوصفية لإحالة ناجحة واحدة

تمثيل JSON 
{
  "conversionAction": string,
  "displayName": string
}
الحقول
conversionAction

string

المعرّف الفريد لإجراء الإحالة الناجحة. يُستخدَم هذا المعرّف لتحديد الإحالات الناجحة المطلوب تضمينها في تقرير من خلال ملء الحقل conversionActions في ConversionsSpec ضمن طلب التقرير. على سبيل المثال، conversionActions/1234.
displayName

string

اسم هذه الإحالة الناجحة في واجهة مستخدِم "إحصاءات Google".