Method: properties.getMetadata

فراداده‌های مربوط به ابعاد و معیارهای موجود در روش‌های گزارش‌دهی را برمی‌گرداند. برای بررسی ابعاد و معیارها استفاده می‌شود. در این روش، یک شناسه ویژگی Google Analytics در درخواست مشخص می‌شود و پاسخ فراداده شامل ابعاد و معیارهای سفارشی و همچنین فراداده جهانی است.

برای مثال، اگر یک معیار سفارشی با نام پارامتر levels_unlocked در یک ویژگی ثبت شود، پاسخ Metadata شامل customEvent:levels_unlocked خواهد بود. متادیتای جهانی، ابعاد و معیارهایی هستند که برای هر ویژگی مانند country و totalUsers قابل استفاده هستند.

درخواست HTTP

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

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

پارامترهای مسیر

پارامترها
name

string

الزامی. نام منبع فراداده‌ای که باید بازیابی شود. این فیلد نام در مسیر URL مشخص شده است و نه در پارامترهای URL. ویژگی (Property) یک شناسه ویژگی عددی گوگل آنالیتیکس است. برای کسب اطلاعات بیشتر، به محل یافتن شناسه ویژگی (Property ID) خود مراجعه کنید.

مثال: properties/1234/metadata

برای ابعاد و معیارهای مشترک بین همه ویژگی‌ها، شناسه ویژگی را روی ۰ تنظیم کنید. در این حالت خاص، این متد ابعاد و معیارهای سفارشی را برنمی‌گرداند.

درخواست بدنه

بدنه درخواست باید خالی باشد.

بدنه پاسخ

ابعاد، معیارها و مقایسه‌هایی که در حال حاضر در روش‌های گزارش‌دهی پذیرفته شده‌اند.

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

نمایش 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

مقایسهفراداده

فراداده برای یک مقایسه واحد.

نمایش JSON 
{
  "apiName": string,
  "uiName": string,
  "description": string
}
فیلدها
apiName

string

نام منبع این مقایسه. قابل استفاده در فیلد comparison Comparison . برای مثال، 'comparisons/1234'.

uiName

string

نام این مقایسه در رابط کاربری گوگل آنالیتیکس.

description

string

توضیحات این مقایسه