- درخواست HTTP
- پارامترهای مسیر
- درخواست بدن
- بدن پاسخگو
- محدوده مجوز
- DimensionMetadata
- MetricMetadata
- آن را امتحان کنید!
ابردادهها را برای ابعاد و معیارهای موجود در روشهای گزارشدهی برمیگرداند. برای بررسی ابعاد و معیارها استفاده می شود. در این روش، Google Analytics GA4 Property Identifier در درخواست مشخص میشود و پاسخ ابرداده شامل ابعاد و معیارهای سفارشی و همچنین فراداده جهانی است.
به عنوان مثال، اگر یک معیار سفارشی با نام پارامتر levels_unlocked
در یک ویژگی ثبت شود، پاسخ Metadata حاوی customEvent:levels_unlocked
خواهد بود. فراداده جهانی ابعاد و معیارهایی هستند که برای هر ویژگی مانند country
و totalUsers
قابل اعمال هستند.
درخواست HTTP
GET https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/metadata}
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
پارامترها | |
---|---|
name | مورد نیاز. نام منبع فراداده برای بازیابی. این فیلد نام در مسیر URL و نه پارامترهای URL مشخص شده است. Property یک شناسه عددی Google Analytics GA4 Property است. برای کسب اطلاعات بیشتر، ببینید شناسه ملک خود را از کجا پیدا کنید . مثال: properties/1234/metadata شناسه ویژگی را برای ابعاد و معیارهای مشترک برای همه ویژگیها روی 0 تنظیم کنید. در این حالت ویژه، این روش ابعاد و معیارهای سفارشی را بر نمی گرداند. |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
ابعاد و معیارهایی که در حال حاضر در روش های گزارش پذیرفته شده است.
نمایندگی JSON | |
---|---|
{ "name": string, "dimensions": [ { object ( |
فیلدها | |
---|---|
name | نام منبع این فراداده. |
dimensions[] | توضیحات ابعاد |
metrics[] | توضیحات متریک |
محدوده مجوز
به یکی از حوزه های 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 } |
فیلدها | |
---|---|
apiName | نام این بعد قابل استفاده به |
uiName | نام این بعد در رابط کاربری Google Analytics. به عنوان مثال، |
description | شرح نحوه استفاده و محاسبه این بعد. |
deprecatedApiNames[] | هنوز نامهای قابل استفاده اما منسوخ برای این بعد. اگر پر شده باشد، این بعد توسط |
customDefinition | اگر بعد یک بعد سفارشی برای این ویژگی باشد درست است. |
MetricMetadata
یک متریک را توضیح می دهد.
نمایندگی JSON | |
---|---|
{
"apiName": string,
"uiName": string,
"description": string,
"deprecatedApiNames": [
string
],
"type": enum ( |
فیلدها | |
---|---|
apiName | یک نام متریک قابل استفاده به |
uiName | نام این معیار در رابط کاربری Google Analytics. به عنوان مثال، |
description | شرح نحوه استفاده و محاسبه این معیار. |
deprecatedApiNames[] | نامهایی هنوز قابل استفاده اما منسوخ شده برای این معیار. اگر پر شده باشد، این معیار توسط |
type | نوع این متریک |
expression | عبارت ریاضی برای این متریک مشتق شده. می تواند در فیلد |
customDefinition | اگر متریک یک معیار سفارشی برای این ویژگی باشد درست است. |