Method: properties.checkCompatibility

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

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

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

درخواست HTTP

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

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

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

پارامترها
property

string

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

مثال: ویژگی‌ها/۱۲۳۴

درخواست بدنه

بدنه درخواست شامل داده‌هایی با ساختار زیر است:

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

سازگاری

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

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

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

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

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

object ( DimensionMetadata )

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

compatibility

enum ( Compatibility )

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

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

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

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

object ( MetricMetadata )

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

compatibility

enum ( Compatibility )

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