MetricMetadata

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

نمایندگی JSON
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "type": enum (MetricType),
  "expression": string,
  "customDefinition": boolean,
  "blockedReasons": [
    enum (BlockedReason)
  ],
  "category": string
}
فیلدها
api Name

string

یک نام متریک قابل استفاده به name متریک . به عنوان مثال، eventCount .

ui Name

string

نام این معیار در رابط کاربری Google Analytics. به عنوان مثال، Event count .

description

string

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

deprecated Api Names[]

string

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

type

enum ( MetricType )

نوع این متریک

expression

string

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

custom Definition

boolean

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

blocked Reasons[]

enum ( BlockedReason )

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

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

category

string

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

BlockedReason

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

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