Method: properties.checkCompatibility

این روش سازگاری ابعاد و معیارهایی را فهرست می‌کند که می‌توانند به درخواست گزارش اضافه شوند و سازگاری را حفظ کنند. اگر ابعاد و معیارهای درخواست ناسازگار باشند، این روش با شکست مواجه می‌شود.

در Google Analytics، گزارش‌ها در صورت درخواست ابعاد و/یا معیارهای ناسازگار با شکست مواجه می‌شوند. در آن صورت، باید ابعاد و/یا معیارها را از گزارش ناسازگار حذف کنید تا زمانی که گزارش سازگار باشد.

گزارش‌های Realtime و Core قوانین سازگاری متفاوتی دارند. این روش سازگاری را برای گزارش های Core بررسی می کند.

درخواست HTTP

POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:checkCompatibility

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

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

پارامترها
property

string

شناسه دارایی Google Analytics GA4 که رویدادهای آن ردیابی می شوند. برای کسب اطلاعات بیشتر، ببینید شناسه ملک خود را از کجا پیدا کنید . property باید همان مقدار درخواست runReport شما باشد.

مثال: خواص/1234

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "compatibilityFilter": enum (Compatibility)
}
فیلدها
dimensions[]

object ( Dimension )

ابعاد در این گزارش. dimensions باید همان مقدار درخواست runReport شما باشد.

metrics[]

object ( Metric )

معیارهای موجود در این گزارش metrics باید همان مقدار درخواست runReport شما باشد.

dimensionFilter

object ( FilterExpression )

بند فیلتر ابعاد. dimensionFilter باید همان مقدار درخواست runReport شما باشد.

metricFilter

object ( FilterExpression )

بند فیلتر معیارها. metricFilter باید همان مقدار درخواست runReport شما باشد

compatibilityFilter

enum ( Compatibility )

ابعاد و معیارها را در پاسخ به این سازگاری فیلتر می کند. معمولاً به‌عنوان ”compatibilityFilter”: “COMPATIBLE” فقط برای برگرداندن ابعاد و معیارهای سازگار.

بدن پاسخگو

پاسخ سازگاری با سازگاری هر بعد و متریک.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "dimensionCompatibilities": [
    {
      object (DimensionCompatibility)
    }
  ],
  "metricCompatibilities": [
    {
      object (MetricCompatibility)
    }
  ]
}
فیلدها
dimensionCompatibilities[]

object ( DimensionCompatibility )

سازگاری هر بعد

metricCompatibilities[]

object ( MetricCompatibility )

سازگاری هر معیار

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

سازگاری

انواع سازگاری برای یک بعد یا متریک.

Enums
COMPATIBILITY_UNSPECIFIED سازگاری نامشخص
COMPATIBLE بعد یا متریک سازگار است. این بعد یا متریک را می توان با موفقیت به یک گزارش اضافه کرد.
INCOMPATIBLE بعد یا متریک ناسازگار است. این بعد یا متریک را نمی توان با موفقیت به گزارش اضافه کرد.

سازگاری ابعاد

سازگاری برای یک بعد.

نمایندگی JSON 
{
  "dimensionMetadata": {
    object (DimensionMetadata)
  },
  "compatibility": enum (Compatibility)
}
فیلدها
dimensionMetadata

object ( DimensionMetadata )

فراداده ابعاد حاوی نام API برای این اطلاعات سازگاری است. فراداده ابعاد همچنین حاوی اطلاعات مفید دیگری مانند نام و توضیحات رابط کاربری است.

compatibility

enum ( Compatibility )

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

سازگاری متریک

سازگاری برای یک متریک واحد

نمایندگی JSON 
{
  "metricMetadata": {
    object (MetricMetadata)
  },
  "compatibility": enum (Compatibility)
}
فیلدها
metricMetadata

object ( MetricMetadata )

فراداده متریک حاوی نام API برای این اطلاعات سازگاری است. فراداده متریک همچنین حاوی اطلاعات مفید دیگری مانند نام و توضیحات رابط کاربری است.

compatibility

enum ( Compatibility )

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