Method: properties.getMetadata

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

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

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

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

پارامترها
name

string

مورد نیاز. نام منبع فراداده برای بازیابی. این فیلد نام در مسیر URL و نه پارامترهای URL مشخص شده است. Property یک شناسه عددی Google Analytics GA4 Property است. برای کسب اطلاعات بیشتر، ببینید شناسه ملک خود را از کجا پیدا کنید .

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

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

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

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

string

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

uiName

string

نام این مقایسه در رابط کاربری Google Analytics.

description

string

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