Method: properties.getMetadata

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

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

درخواست HTTP

GET https://analyticsdata.googleapis.com/v1alpha/{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)
    }
  ],
  "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

ابعادفراداده

یک بُعد را توضیح می‌دهد.

نمایش JSON 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "customDefinition": boolean,
  "category": string,
  "sections": [
    enum (Section)
  ]
}
فیلدها
apiName

string

نام این بُعد. قابل استفاده در name بُعد . برای مثال، eventName .

uiName

string

نام این بُعد در رابط کاربری گوگل آنالیتیکس. برای مثال، 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 )

بخش‌های گوگل آنالیتیکس که این بُعد به آنها اعمال می‌شود را مشخص می‌کند.

متریکفراداده

یک معیار را توضیح می‌دهد.

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

نام این معیار در رابط کاربری گوگل آنالیتیکس. برای مثال، Event count .

description

string

شرح نحوه استفاده و محاسبه این معیار.

deprecatedApiNames[]

string

هنوز قابل استفاده است اما نام‌های منسوخ‌شده‌ای برای این معیار وجود دارد. در صورت پر شدن، این معیار برای مدتی توسط apiName یا یکی از deprecatedApiNames در دسترس خواهد بود. پس از دوره‌ی منسوخ شدن، این معیار فقط توسط apiName در دسترس خواهد بود.

type

enum ( MetricType )

نوع این معیار.

expression

string

عبارت ریاضی برای این معیار مشتق شده. می‌تواند در فیلد expression Metric برای گزارش‌های معادل استفاده شود. اکثر معیارها عبارت نیستند و برای غیرعبارات، این فیلد خالی است.

customDefinition

boolean

اگر معیار، یک معیار سفارشی برای این ویژگی باشد، صحیح است.

blockedReasons[]

enum ( BlockedReason )

اگر دلایل مشخص شده باشند، دسترسی شما به این معیار برای این ویژگی مسدود می‌شود. درخواست‌های API از شما به این ویژگی برای این معیار با موفقیت انجام می‌شود؛ با این حال، گزارش فقط شامل صفر برای این معیار خواهد بود. درخواست‌های API با فیلترهای معیار روی معیارهای مسدود شده با شکست مواجه می‌شوند. اگر دلایل خالی باشند، شما به این معیار دسترسی دارید.

برای کسب اطلاعات بیشتر، به مدیریت دسترسی و محدودیت داده‌ها مراجعه کنید.

category

string

نام نمایشی دسته‌بندی که این معیارها به آن تعلق دارند. ابعاد و معیارهای مشابه با هم دسته‌بندی می‌شوند.

sections[]

enum ( Section )

بخش‌های گوگل آنالیتیکس که این معیار روی آنها اعمال می‌شود را مشخص می‌کند.

BlockedReason

توجیهاتی برای مسدود شدن این معیار.

انوم‌ها
BLOCKED_REASON_UNSPECIFIED هرگز در پاسخ API مشخص نخواهد شد.
NO_REVENUE_METRICS در صورت وجود، دسترسی شما به معیارهای مرتبط با درآمد برای این ملک مسدود شده است و این معیار مربوط به درآمد است.
NO_COST_METRICS در صورت وجود، دسترسی شما به معیارهای مرتبط با هزینه برای این ملک مسدود شده است و این معیار مربوط به هزینه است.

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

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

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

string

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

uiName

string

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

description

string

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

تبدیلفراداده

فراداده برای یک تبدیل واحد.

نمایش JSON 
{
  "conversionAction": string,
  "displayName": string
}
فیلدها
conversionAction

string

شناسه منحصر به فرد عمل تبدیل. این شناسه برای مشخص کردن اینکه کدام تبدیل‌ها باید در گزارش گنجانده شوند، با پر کردن فیلد conversionActions در ConversionsSpec درخواست گزارش، استفاده می‌شود. به عنوان مثال، 'conversionActions/1234'.

displayName

string

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