Method: properties.reportTasks.query

محتوای یک کار گزارش را بازیابی می کند. پس از درخواست reportTasks.create ، می‌توانید پس از فعال شدن گزارش، محتوای گزارش را بازیابی کنید. اگر وضعیت گزارش ACTIVE نباشد، این روش یک خطا برمی‌گرداند. یک پاسخ پرس و جو مقادیر سطر و ستون جدولی گزارش را برمی گرداند.

درخواست HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/reportTasks/*}:query

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

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

پارامترها
name

string

مورد نیاز. نام منبع گزارش قالب: properties/{property}/reportTasks/{report}

درخواست بدن

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

نمایندگی JSON 
{
  "offset": string,
  "limit": string
}
فیلدها
offset

string ( int64 format)

اختیاری. تعداد ردیف ردیف شروع در گزارش. ردیف اول به عنوان ردیف 0 محاسبه می شود.

هنگام صفحه بندی، اولین درخواست افست را مشخص نمی کند. یا به طور معادل، افست را روی 0 تنظیم می کند. اولین درخواست اولین limit ردیف ها را برمی گرداند. درخواست دوم افست را تا limit درخواست اول تنظیم می کند. درخواست دوم limit دوم ردیف ها را برمی گرداند.

برای اطلاعات بیشتر در مورد این پارامتر صفحه بندی، صفحه بندی را ببینید.

limit

string ( int64 format)

اختیاری. تعداد ردیف هایی که باید از گزارش برگردند. اگر مشخص نشده باشد، 10000 ردیف برگردانده می شود. API حداکثر 250000 سطر را در هر درخواست برمی گرداند، مهم نیست که چقدر درخواست کنید. limit باید مثبت باشد

API همچنین می‌تواند ردیف‌های کمتری را نسبت به limit درخواستی برگرداند، اگر مقادیر ابعاد به اندازه limit وجود نداشته باشد. تعداد ردیف های موجود برای QueryReportTaskRequest بیشتر توسط محدودیت ReportTask مرتبط محدود می شود. یک پرس و جو می تواند اکثر ردیف های ReportTask.limit را بازیابی کند. به عنوان مثال، اگر ReportTask دارای محدودیت 1000 باشد، یک درخواست reportTasks.query با offset=900 و limit=500 حداکثر 100 ردیف برمی‌گردد.

برای اطلاعات بیشتر در مورد این پارامتر صفحه بندی، صفحه بندی را ببینید.

بدن پاسخگو

محتوای گزارش مربوط به یک کار گزارش.

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

نمایندگی JSON 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "metadata": {
    object (ResponseMetaData)
  }
}
فیلدها
dimension Headers[]

object ( DimensionHeader )

ستون های ابعاد را توصیف می کند. تعداد DimensionHeader و ترتیب DimensionHeaders با ابعاد موجود در ردیف ها مطابقت دارد.

metric Headers[]

object ( MetricHeader )

ستون های متریک را توصیف می کند. تعداد MetricHeader و ترتیب MetricHeaders با معیارهای موجود در ردیف ها مطابقت دارد.

rows[]

object ( Row )

ردیف هایی از ترکیبات ارزش ابعاد و مقادیر متریک در گزارش.

totals[]

object ( Row )

در صورت درخواست، مجموع مقادیر معیارها.

maximums[]

object ( Row )

در صورت درخواست، حداکثر مقادیر معیارها.

minimums[]

object ( Row )

در صورت درخواست، حداقل مقادیر معیارها.

row Count

integer

تعداد کل ردیف ها در نتیجه پرس و جو.

metadata

object ( ResponseMetaData )

فراداده برای گزارش

محدوده مجوز

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

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

ResponseMetaData

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

نمایندگی JSON 
{
  "dataLossFromOtherRow": boolean,
  "samplingMetadatas": [
    {
      object (SamplingMetadata)
    }
  ],
  "schemaRestrictionResponse": {
    object (SchemaRestrictionResponse)
  },
  "currencyCode": string,
  "timeZone": string,
  "emptyReason": string,
  "subjectToThresholding": boolean
}
فیلدها
data Loss From Other Row

boolean

اگر درست باشد، نشان می دهد که برخی از سطل های ترکیب ابعاد در ردیف "(سایر)" قرار گرفته اند. این می تواند برای گزارش های کاردینالیتی بالا اتفاق بیفتد.

پارامتر فراداده dataLossFromOtherRow بر اساس جدول داده های انبوه استفاده شده در گزارش پر می شود. پارامتر بدون توجه به فیلترها و محدودیت‌های موجود در گزارش به‌طور دقیق تکمیل می‌شود.

به عنوان مثال، ردیف (سایر) را می توان از گزارش حذف کرد زیرا درخواست حاوی فیلتر در sessionSource = google است. اگر از دست دادن داده از ردیف دیگر در داده های انبوه ورودی استفاده شده برای تولید این گزارش وجود داشته باشد، این پارامتر همچنان پر می شود.

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

sampling Metadatas[]

object ( SamplingMetadata )

اگر نتایج این گزارش نمونه برداری شده باشد، درصد رویدادهای استفاده شده در این گزارش را توصیف می کند. برای هر محدوده تاریخ، یک samplingMetadatas پر شده است. هر samplingMetadatas با یک محدوده تاریخ مطابقت دارد تا محدوده‌های تاریخ در درخواست مشخص شود.

اما اگر از نتایج نمونه برداری نشود، این فیلد تعریف نمی شود.

schema Restriction Response

object ( SchemaRestrictionResponse )

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

currency Code

string

کد ارز استفاده شده در این گزارش. در نظر گرفته شده برای قالب‌بندی معیارهای ارز مانند purchaseRevenue برای تجسم استفاده شود. اگر currencyCode در درخواست مشخص شده بود، این پارامتر پاسخ، پارامتر درخواست را بازتاب می دهد. در غیر این صورت، این پارامتر پاسخ، کد ارز فعلی ویژگی است.

کدهای ارز رمزگذاری رشته ای انواع ارز از استاندارد ISO 4217 ( https://en.wikipedia.org/wiki/ISO_4217) هستند. به عنوان مثال "USD"، "EUR"، "JPY". برای کسب اطلاعات بیشتر، به https://support.google.com/analytics/answer/9796179 مراجعه کنید.

time Zone

string

منطقه زمانی فعلی ملک. در نظر گرفته شده برای تفسیر ابعاد مبتنی بر زمان مانند hour و minute استفاده شود. قالب بندی شده به عنوان رشته های پایگاه داده منطقه زمانی IANA ( https://www.iana.org/time-zones) . به عنوان مثال "آمریکا/نیویورک" یا "آسیا/توکیو".

empty Reason

string

اگر دلیل خالی مشخص شده باشد، گزارش به این دلیل خالی است.

subject To Thresholding

boolean

اگر subjectToThresholding درست باشد، این گزارش مشمول آستانه گذاری می شود و فقط داده هایی را برمی گرداند که حداقل آستانه تجمع را داشته باشند. ممکن است درخواستی مشمول آستانه آستانه باشد و هیچ داده ای در گزارش وجود نداشته باشد و این زمانی اتفاق می افتد که همه داده ها بالاتر از آستانه باشند. برای اطلاعات بیشتر، آستانه داده ها و درباره جمعیت شناسی و علایق را ببینید.

SchemaRestrictionResponse

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

نمایندگی JSON 
{
  "activeMetricRestrictions": [
    {
      object (ActiveMetricRestriction)
    }
  ]
}
فیلدها
active Metric Restrictions[]

object ( ActiveMetricRestriction )

همه محدودیت‌ها به طور فعال در ایجاد گزارش اعمال می‌شوند. برای مثال، purchaseRevenue همیشه دارای نوع محدودیت REVENUE_DATA است. با این حال، این محدودیت پاسخ فعال فقط در صورتی پر می شود که نقش سفارشی کاربر، دسترسی به REVENUE_DATA را ممنوع کند.

ActiveMetricRestriction

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

نمایندگی JSON 
{
  "restrictedMetricTypes": [
    enum (RestrictedMetricType)
  ],
  "metricName": string
}
فیلدها
restricted Metric Types[]

enum ( RestrictedMetricType )

دلیل محدودیت این معیار

metric Name

string

نام معیار محدود شده.

RestrictedMetricType

دسته‌بندی داده‌هایی که ممکن است از مشاهده آن‌ها در برخی ویژگی‌های Google Analytics منع شده باشید.

Enums
RESTRICTED_METRIC_TYPE_UNSPECIFIED نوع نامشخص
COST_DATA معیارهای هزینه مانند adCost .
REVENUE_DATA معیارهای درآمد مانند purchaseRevenue .
،

محتوای یک کار گزارش را بازیابی می کند. پس از درخواست reportTasks.create ، می‌توانید پس از فعال شدن گزارش، محتوای گزارش را بازیابی کنید. اگر وضعیت گزارش ACTIVE نباشد، این روش یک خطا برمی‌گرداند. یک پاسخ پرس و جو مقادیر سطر و ستون جدولی گزارش را برمی گرداند.

درخواست HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/reportTasks/*}:query

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

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

پارامترها
name

string

مورد نیاز. نام منبع گزارش قالب: properties/{property}/reportTasks/{report}

درخواست بدن

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

نمایندگی JSON 
{
  "offset": string,
  "limit": string
}
فیلدها
offset

string ( int64 format)

اختیاری. تعداد ردیف ردیف شروع در گزارش. ردیف اول به عنوان ردیف 0 محاسبه می شود.

هنگام صفحه بندی، اولین درخواست افست را مشخص نمی کند. یا به طور معادل، افست را روی 0 تنظیم می کند. اولین درخواست اولین limit ردیف ها را برمی گرداند. درخواست دوم افست را تا limit درخواست اول تنظیم می کند. درخواست دوم limit دوم ردیف ها را برمی گرداند.

برای اطلاعات بیشتر در مورد این پارامتر صفحه بندی، صفحه بندی را ببینید.

limit

string ( int64 format)

اختیاری. تعداد ردیف هایی که باید از گزارش برگردند. اگر مشخص نشده باشد، 10000 ردیف برگردانده می شود. API حداکثر 250000 سطر را در هر درخواست برمی گرداند، مهم نیست که چقدر درخواست کنید. limit باید مثبت باشد

API همچنین می‌تواند ردیف‌های کمتری را نسبت به limit درخواستی برگرداند، اگر مقادیر ابعاد به اندازه limit وجود نداشته باشد. تعداد ردیف های موجود برای QueryReportTaskRequest بیشتر توسط محدودیت ReportTask مرتبط محدود می شود. یک پرس و جو می تواند اکثر ردیف های ReportTask.limit را بازیابی کند. به عنوان مثال، اگر ReportTask دارای محدودیت 1000 باشد، یک درخواست reportTasks.query با offset=900 و limit=500 حداکثر 100 ردیف برمی‌گردد.

برای اطلاعات بیشتر در مورد این پارامتر صفحه بندی، صفحه بندی را ببینید.

بدن پاسخگو

محتوای گزارش مربوط به یک کار گزارش.

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

نمایندگی JSON 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "metadata": {
    object (ResponseMetaData)
  }
}
فیلدها
dimension Headers[]

object ( DimensionHeader )

ستون های ابعاد را توصیف می کند. تعداد DimensionHeader و ترتیب DimensionHeaders با ابعاد موجود در ردیف ها مطابقت دارد.

metric Headers[]

object ( MetricHeader )

ستون های متریک را توصیف می کند. تعداد MetricHeader و ترتیب MetricHeaders با معیارهای موجود در ردیف ها مطابقت دارد.

rows[]

object ( Row )

ردیف هایی از ترکیبات ارزش ابعاد و مقادیر متریک در گزارش.

totals[]

object ( Row )

در صورت درخواست، مجموع مقادیر معیارها.

maximums[]

object ( Row )

در صورت درخواست، حداکثر مقادیر معیارها.

minimums[]

object ( Row )

در صورت درخواست، حداقل مقادیر معیارها.

row Count

integer

تعداد کل ردیف ها در نتیجه پرس و جو.

metadata

object ( ResponseMetaData )

فراداده برای گزارش

محدوده مجوز

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

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

ResponseMetaData

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

نمایندگی JSON 
{
  "dataLossFromOtherRow": boolean,
  "samplingMetadatas": [
    {
      object (SamplingMetadata)
    }
  ],
  "schemaRestrictionResponse": {
    object (SchemaRestrictionResponse)
  },
  "currencyCode": string,
  "timeZone": string,
  "emptyReason": string,
  "subjectToThresholding": boolean
}
فیلدها
data Loss From Other Row

boolean

اگر درست باشد، نشان می دهد که برخی از سطل های ترکیب ابعاد در ردیف "(سایر)" قرار گرفته اند. این می تواند برای گزارش های کاردینالیتی بالا اتفاق بیفتد.

پارامتر فراداده dataLossFromOtherRow بر اساس جدول داده های انبوه استفاده شده در گزارش پر می شود. پارامتر بدون توجه به فیلترها و محدودیت‌های موجود در گزارش به‌طور دقیق تکمیل می‌شود.

به عنوان مثال، ردیف (سایر) را می توان از گزارش حذف کرد زیرا درخواست حاوی فیلتری در sessionSource = google است. اگر از دست دادن داده از ردیف دیگر در داده های انبوه ورودی استفاده شده برای تولید این گزارش وجود داشته باشد، این پارامتر همچنان پر می شود.

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

sampling Metadatas[]

object ( SamplingMetadata )

اگر نتایج این گزارش نمونه برداری شده باشد، درصد رویدادهای استفاده شده در این گزارش را توصیف می کند. برای هر محدوده تاریخ، یک samplingMetadatas پر شده است. هر samplingMetadatas با یک محدوده تاریخ مطابقت دارد تا محدوده‌های تاریخ در درخواست مشخص شود.

اما اگر از نتایج نمونه برداری نشود، این فیلد تعریف نمی شود.

schema Restriction Response

object ( SchemaRestrictionResponse )

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

currency Code

string

کد ارز استفاده شده در این گزارش. در نظر گرفته شده برای قالب‌بندی معیارهای ارز مانند purchaseRevenue برای تجسم استفاده شود. اگر currencyCode در درخواست مشخص شده بود، این پارامتر پاسخ، پارامتر درخواست را بازتاب می دهد. در غیر این صورت، این پارامتر پاسخ، کد ارز فعلی ویژگی است.

کدهای ارز رمزگذاری رشته ای انواع ارز از استاندارد ISO 4217 ( https://en.wikipedia.org/wiki/ISO_4217) هستند. به عنوان مثال "USD"، "EUR"، "JPY". برای کسب اطلاعات بیشتر، به https://support.google.com/analytics/answer/9796179 مراجعه کنید.

time Zone

string

منطقه زمانی فعلی ملک. در نظر گرفته شده برای تفسیر ابعاد مبتنی بر زمان مانند hour و minute استفاده شود. قالب بندی شده به عنوان رشته های پایگاه داده منطقه زمانی IANA ( https://www.iana.org/time-zones) . به عنوان مثال "آمریکا/نیویورک" یا "آسیا/توکیو".

empty Reason

string

اگر دلیل خالی مشخص شده باشد، گزارش به این دلیل خالی است.

subject To Thresholding

boolean

اگر subjectToThresholding درست باشد، این گزارش مشمول آستانه گذاری می شود و فقط داده هایی را برمی گرداند که حداقل آستانه تجمع را داشته باشند. ممکن است درخواستی مشمول آستانه آستانه باشد و هیچ داده ای در گزارش وجود نداشته باشد و این زمانی اتفاق می افتد که همه داده ها بالاتر از آستانه باشند. برای اطلاعات بیشتر، آستانه داده ها و درباره جمعیت شناسی و علایق را ببینید.

SchemaRestrictionResponse

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

نمایندگی JSON 
{
  "activeMetricRestrictions": [
    {
      object (ActiveMetricRestriction)
    }
  ]
}
فیلدها
active Metric Restrictions[]

object ( ActiveMetricRestriction )

همه محدودیت‌ها به طور فعال در ایجاد گزارش اعمال می‌شوند. برای مثال، purchaseRevenue همیشه دارای نوع محدودیت REVENUE_DATA است. با این حال، این محدودیت پاسخ فعال فقط در صورتی پر می شود که نقش سفارشی کاربر، دسترسی به REVENUE_DATA را ممنوع کند.

ActiveMetricRestriction

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

نمایندگی JSON 
{
  "restrictedMetricTypes": [
    enum (RestrictedMetricType)
  ],
  "metricName": string
}
فیلدها
restricted Metric Types[]

enum ( RestrictedMetricType )

دلیل محدودیت این معیار

metric Name

string

نام معیار محدود شده.

RestrictedMetricType

دسته‌بندی داده‌هایی که ممکن است از مشاهده آن‌ها در برخی ویژگی‌های Google Analytics منع شده باشید.

Enums
RESTRICTED_METRIC_TYPE_UNSPECIFIED نوع نامشخص
COST_DATA معیارهای هزینه مانند adCost .
REVENUE_DATA معیارهای درآمد مانند purchaseRevenue .
،

محتوای یک کار گزارش را بازیابی می کند. پس از درخواست reportTasks.create ، می‌توانید پس از فعال شدن گزارش، محتوای گزارش را بازیابی کنید. اگر وضعیت گزارش ACTIVE نباشد، این روش یک خطا برمی‌گرداند. یک پاسخ پرس و جو مقادیر سطر و ستون جدولی گزارش را برمی گرداند.

درخواست HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/reportTasks/*}:query

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

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

پارامترها
name

string

مورد نیاز. نام منبع گزارش قالب: properties/{property}/reportTasks/{report}

درخواست بدن

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

نمایندگی JSON 
{
  "offset": string,
  "limit": string
}
فیلدها
offset

string ( int64 format)

اختیاری. تعداد ردیف ردیف شروع در گزارش. ردیف اول به عنوان ردیف 0 محاسبه می شود.

هنگام صفحه بندی، اولین درخواست افست را مشخص نمی کند. یا به طور معادل، افست را روی 0 تنظیم می کند. اولین درخواست اولین limit ردیف ها را برمی گرداند. درخواست دوم افست را تا limit درخواست اول تنظیم می کند. درخواست دوم limit دوم ردیف ها را برمی گرداند.

برای اطلاعات بیشتر در مورد این پارامتر صفحه بندی، صفحه بندی را ببینید.

limit

string ( int64 format)

اختیاری. تعداد ردیف هایی که باید از گزارش برگردند. اگر مشخص نشده باشد، 10000 ردیف برگردانده می شود. API حداکثر 250000 سطر را در هر درخواست برمی گرداند، مهم نیست که چقدر درخواست کنید. limit باید مثبت باشد

API همچنین می‌تواند ردیف‌های کمتری را نسبت به limit درخواستی برگرداند، اگر مقادیر ابعاد به اندازه limit وجود نداشته باشد. تعداد ردیف های موجود برای QueryReportTaskRequest بیشتر توسط محدودیت ReportTask مرتبط محدود می شود. یک پرس و جو می تواند اکثر ردیف های ReportTask.limit را بازیابی کند. به عنوان مثال، اگر ReportTask دارای محدودیت 1000 باشد، یک درخواست reportTasks.query با offset=900 و limit=500 حداکثر 100 ردیف برمی‌گردد.

برای اطلاعات بیشتر در مورد این پارامتر صفحه بندی، صفحه بندی را ببینید.

بدن پاسخگو

محتوای گزارش مربوط به یک کار گزارش.

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

نمایندگی JSON 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "metadata": {
    object (ResponseMetaData)
  }
}
فیلدها
dimension Headers[]

object ( DimensionHeader )

ستون های ابعاد را توصیف می کند. تعداد DimensionHeader و ترتیب DimensionHeaders با ابعاد موجود در ردیف ها مطابقت دارد.

metric Headers[]

object ( MetricHeader )

ستون های متریک را توصیف می کند. تعداد MetricHeader و ترتیب MetricHeaders با معیارهای موجود در ردیف ها مطابقت دارد.

rows[]

object ( Row )

ردیف هایی از ترکیبات ارزش ابعاد و مقادیر متریک در گزارش.

totals[]

object ( Row )

در صورت درخواست، مجموع مقادیر معیارها.

maximums[]

object ( Row )

در صورت درخواست، حداکثر مقادیر معیارها.

minimums[]

object ( Row )

در صورت درخواست، حداقل مقادیر معیارها.

row Count

integer

تعداد کل ردیف ها در نتیجه پرس و جو.

metadata

object ( ResponseMetaData )

فراداده برای گزارش

محدوده مجوز

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

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

ResponseMetaData

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

نمایندگی JSON 
{
  "dataLossFromOtherRow": boolean,
  "samplingMetadatas": [
    {
      object (SamplingMetadata)
    }
  ],
  "schemaRestrictionResponse": {
    object (SchemaRestrictionResponse)
  },
  "currencyCode": string,
  "timeZone": string,
  "emptyReason": string,
  "subjectToThresholding": boolean
}
فیلدها
data Loss From Other Row

boolean

اگر درست باشد، نشان می دهد که برخی از سطل های ترکیب ابعاد در ردیف "(سایر)" قرار گرفته اند. این می تواند برای گزارش های کاردینالیتی بالا اتفاق بیفتد.

پارامتر فراداده dataLossFromOtherRow بر اساس جدول داده های انبوه استفاده شده در گزارش پر می شود. پارامتر بدون توجه به فیلترها و محدودیت‌های موجود در گزارش به‌طور دقیق تکمیل می‌شود.

به عنوان مثال، ردیف (سایر) را می توان از گزارش حذف کرد زیرا درخواست حاوی فیلتری در sessionSource = google است. اگر از دست دادن داده از ردیف دیگر در داده های انبوه ورودی استفاده شده برای تولید این گزارش وجود داشته باشد، این پارامتر همچنان پر می شود.

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

sampling Metadatas[]

object ( SamplingMetadata )

اگر نتایج این گزارش نمونه برداری شده باشد، درصد رویدادهای استفاده شده در این گزارش را توصیف می کند. برای هر محدوده تاریخ، یک samplingMetadatas پر شده است. هر samplingMetadatas با یک محدوده تاریخ مطابقت دارد تا محدوده‌های تاریخ در درخواست مشخص شود.

اما اگر از نتایج نمونه برداری نشود، این فیلد تعریف نمی شود.

schema Restriction Response

object ( SchemaRestrictionResponse )

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

currency Code

string

کد ارز استفاده شده در این گزارش. در نظر گرفته شده برای قالب‌بندی معیارهای ارز مانند purchaseRevenue برای تجسم استفاده شود. اگر currencyCode در درخواست مشخص شده بود، این پارامتر پاسخ، پارامتر درخواست را بازتاب می دهد. در غیر این صورت، این پارامتر پاسخ، کد ارز فعلی ویژگی است.

کدهای ارز رمزگذاری رشته ای انواع ارز از استاندارد ISO 4217 ( https://en.wikipedia.org/wiki/ISO_4217) هستند. به عنوان مثال "USD"، "EUR"، "JPY". برای کسب اطلاعات بیشتر، به https://support.google.com/analytics/answer/9796179 مراجعه کنید.

time Zone

string

منطقه زمانی فعلی ملک. در نظر گرفته شده برای تفسیر ابعاد مبتنی بر زمان مانند hour و minute استفاده شود. قالب بندی شده به عنوان رشته های پایگاه داده منطقه زمانی IANA ( https://www.iana.org/time-zones) . به عنوان مثال "آمریکا/نیویورک" یا "آسیا/توکیو".

empty Reason

string

اگر دلیل خالی مشخص شده باشد، گزارش به این دلیل خالی است.

subject To Thresholding

boolean

اگر subjectToThresholding درست باشد، این گزارش مشمول آستانه گذاری می شود و فقط داده هایی را برمی گرداند که حداقل آستانه تجمع را داشته باشند. ممکن است درخواستی مشمول آستانه آستانه باشد و هیچ داده ای در گزارش وجود نداشته باشد و این زمانی اتفاق می افتد که همه داده ها بالاتر از آستانه باشند. برای اطلاعات بیشتر، آستانه داده ها و درباره جمعیت شناسی و علایق را ببینید.

SchemaRestrictionResponse

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

نمایندگی JSON 
{
  "activeMetricRestrictions": [
    {
      object (ActiveMetricRestriction)
    }
  ]
}
فیلدها
active Metric Restrictions[]

object ( ActiveMetricRestriction )

همه محدودیت‌ها به طور فعال در ایجاد گزارش اعمال می‌شوند. برای مثال، purchaseRevenue همیشه دارای نوع محدودیت REVENUE_DATA است. با این حال، این محدودیت پاسخ فعال فقط در صورتی پر می شود که نقش سفارشی کاربر، دسترسی به REVENUE_DATA را ممنوع کند.

ActiveMetricRestriction

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

نمایندگی JSON 
{
  "restrictedMetricTypes": [
    enum (RestrictedMetricType)
  ],
  "metricName": string
}
فیلدها
restricted Metric Types[]

enum ( RestrictedMetricType )

دلیل محدودیت این معیار

metric Name

string

نام معیار محدود شده.

RestrictedMetricType

دسته‌بندی داده‌هایی که ممکن است از مشاهده آن‌ها در برخی ویژگی‌های Google Analytics منع شده باشید.

Enums
RESTRICTED_METRIC_TYPE_UNSPECIFIED نوع نامشخص
COST_DATA معیارهای هزینه مانند adCost .
REVENUE_DATA معیارهای درآمد مانند purchaseRevenue .
،

محتوای یک کار گزارش را بازیابی می کند. پس از درخواست reportTasks.create ، می‌توانید پس از فعال شدن گزارش، محتوای گزارش را بازیابی کنید. اگر وضعیت گزارش ACTIVE نباشد، این روش یک خطا برمی‌گرداند. یک پاسخ پرس و جو مقادیر سطر و ستون جدولی گزارش را برمی گرداند.

درخواست HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/reportTasks/*}:query

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

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

پارامترها
name

string

مورد نیاز. نام منبع گزارش قالب: properties/{property}/reportTasks/{report}

درخواست بدن

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

نمایندگی JSON 
{
  "offset": string,
  "limit": string
}
فیلدها
offset

string ( int64 format)

اختیاری. تعداد ردیف ردیف شروع در گزارش. ردیف اول به عنوان ردیف 0 محاسبه می شود.

هنگام صفحه بندی، اولین درخواست افست را مشخص نمی کند. یا به طور معادل، افست را روی 0 تنظیم می کند. اولین درخواست اولین limit ردیف ها را برمی گرداند. درخواست دوم افست را تا limit درخواست اول تنظیم می کند. درخواست دوم limit دوم ردیف ها را برمی گرداند.

برای اطلاعات بیشتر در مورد این پارامتر صفحه بندی، صفحه بندی را ببینید.

limit

string ( int64 format)

اختیاری. تعداد ردیف هایی که باید از گزارش برگردند. اگر مشخص نشده باشد، 10000 ردیف برگردانده می شود. API حداکثر 250000 سطر را در هر درخواست برمی گرداند، مهم نیست که چقدر درخواست کنید. limit باید مثبت باشد

API همچنین می‌تواند ردیف‌های کمتری را نسبت به limit درخواستی برگرداند، اگر مقادیر ابعاد به اندازه limit وجود نداشته باشد. تعداد ردیف های موجود برای QueryReportTaskRequest بیشتر توسط محدودیت ReportTask مرتبط محدود می شود. یک پرس و جو می تواند اکثر ردیف های ReportTask.limit را بازیابی کند. به عنوان مثال، اگر ReportTask دارای محدودیت 1000 باشد، یک درخواست reportTasks.query با offset=900 و limit=500 حداکثر 100 ردیف برمی‌گردد.

برای اطلاعات بیشتر در مورد این پارامتر صفحه بندی، صفحه بندی را ببینید.

بدن پاسخگو

محتوای گزارش مربوط به یک کار گزارش.

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

نمایندگی JSON 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "metadata": {
    object (ResponseMetaData)
  }
}
فیلدها
dimension Headers[]

object ( DimensionHeader )

ستون های ابعاد را توصیف می کند. تعداد DimensionHeader و ترتیب DimensionHeaders با ابعاد موجود در ردیف ها مطابقت دارد.

metric Headers[]

object ( MetricHeader )

ستون های متریک را توصیف می کند. تعداد MetricHeader و ترتیب MetricHeaders با معیارهای موجود در ردیف ها مطابقت دارد.

rows[]

object ( Row )

ردیف هایی از ترکیبات ارزش ابعاد و مقادیر متریک در گزارش.

totals[]

object ( Row )

در صورت درخواست، مجموع مقادیر معیارها.

maximums[]

object ( Row )

در صورت درخواست، حداکثر مقادیر معیارها.

minimums[]

object ( Row )

در صورت درخواست، حداقل مقادیر معیارها.

row Count

integer

تعداد کل ردیف ها در نتیجه پرس و جو.

metadata

object ( ResponseMetaData )

فراداده برای گزارش

محدوده مجوز

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

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

ResponseMetaData

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

نمایندگی JSON 
{
  "dataLossFromOtherRow": boolean,
  "samplingMetadatas": [
    {
      object (SamplingMetadata)
    }
  ],
  "schemaRestrictionResponse": {
    object (SchemaRestrictionResponse)
  },
  "currencyCode": string,
  "timeZone": string,
  "emptyReason": string,
  "subjectToThresholding": boolean
}
فیلدها
data Loss From Other Row

boolean

اگر درست باشد، نشان می دهد که برخی از سطل های ترکیب ابعاد در ردیف "(سایر)" قرار گرفته اند. این می تواند برای گزارش های کاردینالیتی بالا اتفاق بیفتد.

پارامتر فراداده dataLossFromOtherRow بر اساس جدول داده های انبوه استفاده شده در گزارش پر می شود. پارامتر بدون توجه به فیلترها و محدودیت‌های موجود در گزارش به‌طور دقیق تکمیل می‌شود.

به عنوان مثال، ردیف (سایر) را می توان از گزارش حذف کرد زیرا درخواست حاوی فیلتر در sessionSource = google است. اگر از دست دادن داده از ردیف دیگر در داده های انبوه ورودی استفاده شده برای تولید این گزارش وجود داشته باشد، این پارامتر همچنان پر می شود.

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

sampling Metadatas[]

object ( SamplingMetadata )

اگر نتایج این گزارش نمونه برداری شده باشد، درصد رویدادهای استفاده شده در این گزارش را توصیف می کند. برای هر محدوده تاریخ، یک samplingMetadatas پر شده است. هر samplingMetadatas با یک محدوده تاریخ مطابقت دارد تا محدوده‌های تاریخ در درخواست مشخص شود.

اما اگر از نتایج نمونه برداری نشود، این فیلد تعریف نمی شود.

schema Restriction Response

object ( SchemaRestrictionResponse )

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

currency Code

string

کد ارز استفاده شده در این گزارش. در نظر گرفته شده برای قالب‌بندی معیارهای ارز مانند purchaseRevenue برای تجسم استفاده شود. اگر currencyCode در درخواست مشخص شده بود، این پارامتر پاسخ، پارامتر درخواست را بازتاب می دهد. در غیر این صورت، این پارامتر پاسخ، کد ارز فعلی ویژگی است.

کدهای ارز رمزگذاری رشته ای انواع ارز از استاندارد ISO 4217 ( https://en.wikipedia.org/wiki/ISO_4217) هستند. به عنوان مثال "USD"، "EUR"، "JPY". برای کسب اطلاعات بیشتر، به https://support.google.com/analytics/answer/9796179 مراجعه کنید.

time Zone

string

منطقه زمانی فعلی ملک. در نظر گرفته شده برای تفسیر ابعاد مبتنی بر زمان مانند hour و minute استفاده شود. قالب بندی شده به عنوان رشته های پایگاه داده منطقه زمانی IANA ( https://www.iana.org/time-zones) . به عنوان مثال "آمریکا/نیویورک" یا "آسیا/توکیو".

empty Reason

string

اگر دلیل خالی مشخص شده باشد، گزارش به این دلیل خالی است.

subject To Thresholding

boolean

اگر subjectToThresholding درست باشد، این گزارش مشمول آستانه گذاری می شود و فقط داده هایی را برمی گرداند که حداقل آستانه تجمع را داشته باشند. ممکن است درخواستی مشمول آستانه آستانه باشد و هیچ داده ای در گزارش وجود نداشته باشد و این زمانی اتفاق می افتد که همه داده ها بالاتر از آستانه باشند. برای اطلاعات بیشتر، آستانه داده ها و درباره جمعیت شناسی و علایق را ببینید.

SchemaRestrictionResponse

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

نمایندگی JSON 
{
  "activeMetricRestrictions": [
    {
      object (ActiveMetricRestriction)
    }
  ]
}
فیلدها
active Metric Restrictions[]

object ( ActiveMetricRestriction )

همه محدودیت‌ها به طور فعال در ایجاد گزارش اعمال می‌شوند. برای مثال، purchaseRevenue همیشه دارای نوع محدودیت REVENUE_DATA است. با این حال، این محدودیت پاسخ فعال فقط در صورتی پر می شود که نقش سفارشی کاربر، دسترسی به REVENUE_DATA را ممنوع کند.

ActiveMetricRestriction

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

نمایندگی JSON 
{
  "restrictedMetricTypes": [
    enum (RestrictedMetricType)
  ],
  "metricName": string
}
فیلدها
restricted Metric Types[]

enum ( RestrictedMetricType )

دلیل محدودیت این معیار

metric Name

string

نام معیار محدود شده.

RestrictedMetricType

دسته‌بندی داده‌هایی که ممکن است از مشاهده آن‌ها در برخی ویژگی‌های Google Analytics منع شده باشید.

Enums
RESTRICTED_METRIC_TYPE_UNSPECIFIED نوع نامشخص
COST_DATA معیارهای هزینه مانند adCost .
REVENUE_DATA معیارهای درآمد مانند purchaseRevenue .