REST Resource: properties.reportTasks

منبع: ReportTask

پیکربندی وظیفه گزارش خاص.

نمایش JSON 
{
  "name": string,
  "reportDefinition": {
    object (ReportDefinition)
  },
  "reportMetadata": {
    object (ReportMetadata)
  }
}
فیلدها
name

string

فقط خروجی. شناسه. نام منبع وظیفه گزارش که هنگام ایجاد اختصاص داده شده است. قالب: "properties/{property}/reportTasks/{reportTask}"

reportDefinition

object ( ReportDefinition )

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

reportMetadata

object ( ReportMetadata )

فقط خروجی. فراداده گزارش برای یک وظیفه گزارش خاص، که اطلاعاتی در مورد یک گزارش ارائه می‌دهد. معمولاً شامل اطلاعات زیر است: نام منبع گزارش، وضعیت گزارش، مهر زمانی ایجاد گزارش و غیره.

تعریف گزارش

تعریف نحوه اجرای یک گزارش.

نمایش JSON 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "samplingLevel": enum (SamplingLevel)
}
فیلدها
dimensions[]

object ( Dimension )

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

metrics[]

object ( Metric )

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

dateRanges[]

object ( DateRange )

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

dimensionFilter

object ( FilterExpression )

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

metricFilter

object ( FilterExpression )

اختیاری. عبارت فیلتر معیارها. مشابه عبارت having در SQL، پس از تجمیع ردیف‌های گزارش اعمال می‌شود. ابعاد را نمی‌توان در این فیلتر استفاده کرد.

offset

string ( int64 format)

اختیاری. تعداد ردیف ردیف شروع از فضای ذخیره‌سازی گوگل آنالیتیکس. ردیف اول به عنوان ردیف ۰ شمارش می‌شود.

هنگام ایجاد یک وظیفه گزارش، پارامترهای offset و limit زیرمجموعه‌ای از ردیف‌های داده از فضای ذخیره‌سازی Google Analytics را که باید در گزارش تولید شده گنجانده شوند، تعریف می‌کنند. برای مثال، اگر در مجموع ۳۰۰۰۰۰ ردیف در فضای ذخیره‌سازی Google Analytics وجود داشته باشد، وظیفه گزارش اولیه ممکن است ۱۰۰۰۰ ردیف اول را با محدودیت ۱۰۰۰۰ و offset صفر داشته باشد. متعاقباً، یک وظیفه گزارش دیگر می‌تواند ۱۰۰۰۰ ردیف بعدی را با محدودیت ۱۰۰۰۰ و offset 10000 پوشش دهد.

limit

string ( int64 format)

اختیاری. تعداد ردیف‌هایی که در گزارش برگردانده می‌شوند. اگر مشخص نشود، ۱۰۰۰۰ ردیف برگردانده می‌شود. API حداکثر ۲۵۰۰۰۰ ردیف را در هر درخواست برمی‌گرداند، مهم نیست چند ردیف درخواست کنید. limit باید مثبت باشد.

اگر تعداد مقادیر بُعد به اندازه‌ی limit نباشد، API می‌تواند تعداد ردیف‌های کمتری نسبت به limit درخواستی برگرداند. برای مثال، کمتر از ۳۰۰ مقدار ممکن برای بُعد country وجود دارد، بنابراین هنگام گزارش‌گیری فقط بر اساس country ، نمی‌توانید بیش از ۳۰۰ ردیف دریافت کنید، حتی اگر limit روی مقدار بالاتری تنظیم کنید.

metricAggregations[]

enum ( MetricAggregation )

اختیاری. تجمیع معیارها. مقادیر تجمیع‌شده‌ی معیارها در ردیف‌هایی نمایش داده می‌شوند که در آن‌ها مقادیر بُعد روی «RESERVED_(MetricAggregation)» تنظیم شده باشند.

orderBys[]

object ( OrderBy )

اختیاری. نحوه‌ی مرتب‌سازی ردیف‌ها در پاسخ را مشخص می‌کند.

currencyCode

string

اختیاری. یک کد ارز با فرمت ISO4217، مانند "AED"، "USD"، "JPY". اگر فیلد خالی باشد، گزارش از ارز پیش‌فرض ملک استفاده می‌کند.

cohortSpec

object ( CohortSpec )

اختیاری. گروه هم‌گروهی مرتبط با این درخواست. اگر یک گروه هم‌گروهی در درخواست وجود دارد، بُعد «هم‌گروهی» باید موجود باشد.

keepEmptyRows

boolean

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

صرف نظر از این تنظیم keepEmptyRows ، فقط داده‌های ثبت‌شده توسط ویژگی Google Analytics می‌توانند در یک گزارش نمایش داده شوند.

برای مثال، اگر یک ویژگی هرگز رویداد purchase را ثبت نکند، آنگاه یک پرس‌وجو برای بُعد eventName و معیار eventCount ردیفی شامل eventName: "purchase" و eventCount: 0 نخواهد داشت.

samplingLevel

enum ( SamplingLevel )

اختیاری. سطح نمونه‌گیری گزارش.

ابعاد

ابعاد، ویژگی‌های داده‌های شما هستند. برای مثال، بُعد شهر، شهری را نشان می‌دهد که یک رویداد از آن سرچشمه می‌گیرد. مقادیر ابعاد در پاسخ‌های گزارش، رشته هستند؛ برای مثال، شهر می‌تواند «پاریس» یا «نیویورک» باشد.

نمایش JSON 
{
  "name": string,
  "dimensionExpression": {
    object (DimensionExpression)
  }
}
فیلدها
name

string

نام بُعد. برای فهرست نام‌های بُعد پشتیبانی‌شده توسط روش‌های گزارش‌گیری اصلی مانند runReport و batchRunReports به API Dimensions مراجعه کنید. برای فهرست نام‌های بُعد پشتیبانی‌شده توسط روش runRealtimeReport به Realtime Dimensions مراجعه کنید. برای فهرست نام‌های بُعد پشتیبانی‌شده توسط روش runFunnelReport به Funnel Dimensions مراجعه کنید.

اگر dimensionExpression مشخص شده باشد، name می‌تواند هر رشته‌ای باشد که شما در مجموعه کاراکترهای مجاز می‌خواهید. برای مثال، اگر یک dimensionExpression country و city را به هم متصل کند، می‌توانید آن بُعد را countryAndCity بنامید. نام‌های بُعدی که انتخاب می‌کنید باید با عبارت منظم ^[a-zA-Z0-9_]$ مطابقت داشته باشند.

ابعاد با name در dimensionFilter ، orderBys ، dimensionExpression و pivots ارجاع داده می‌شوند.

dimensionExpression

object ( DimensionExpression )

یک بُعد می‌تواند حاصل عبارتی با چندین بُعد باشد. برای مثال، بُعد "کشور، شهر": concatenate(country, ", ", city).

بیان ابعاد

برای بیان بُعدی که نتیجه فرمولی با چندین بُعد است، استفاده می‌شود. مثال‌های کاربرد: ۱) lowerCase(dimension) ۲) concatenate(dimension1, symbol, dimension2).

نمایش JSON 
{

  // Union field one_expression can be only one of the following:
  "lowerCase": {
    object (CaseExpression)
  },
  "upperCase": {
    object (CaseExpression)
  },
  "concatenate": {
    object (ConcatenateExpression)
  }
  // End of list of possible types for union field one_expression.
}
فیلدها
فیلد یونیون one_expression . یک نوع عبارت بُعد برای DimensionExpression مشخص کنید. one_expression فقط می‌تواند یکی از موارد زیر باشد:
lowerCase

object ( CaseExpression )

برای تبدیل مقدار بُعد به حروف کوچک استفاده می‌شود.

upperCase

object ( CaseExpression )

برای تبدیل مقدار بُعد به حروف بزرگ استفاده می‌شود.

concatenate

object ( ConcatenateExpression )

برای ترکیب مقادیر بُعد در یک بُعد واحد استفاده می‌شود. برای مثال، بُعد "کشور، شهر": concatenate(country, ", ", city).

عبارت موردی

برای تبدیل مقدار بُعد به یک مورد واحد استفاده می‌شود.

نمایش JSON 
{
  "dimensionName": string
}
فیلدها
dimensionName

string

نام یک بُعد. این نام باید به نامی در فیلد ابعاد درخواست اشاره کند.

عبارت الحاقی

برای ترکیب مقادیر بُعد در یک بُعد واحد استفاده می‌شود.

نمایش JSON 
{
  "dimensionNames": [
    string
  ],
  "delimiter": string
}
فیلدها
dimensionNames[]

string

نام ابعاد. نام‌ها باید به نام‌های موجود در فیلد ابعاد درخواست اشاره داشته باشند.

delimiter

string

جداکننده‌ای که بین نام ابعاد قرار می‌گیرد.

جداکننده‌ها اغلب کاراکترهای تکی مانند "|" یا "," هستند، اما می‌توانند رشته‌های طولانی‌تری نیز باشند. اگر مقدار یک بُعد شامل جداکننده باشد، هر دو در پاسخ بدون هیچ تمایزی حضور خواهند داشت. برای مثال، اگر مقدار بُعد ۱ = "US,FR"، مقدار بُعد ۲ = "JP" و جداکننده = "," باشد، آنگاه پاسخ شامل "US,FR,JP" خواهد بود.

متریک

اندازه‌گیری‌های کمی یک گزارش. برای مثال، معیار eventCount تعداد کل رویدادها است. درخواست‌ها تا 10 معیار مجاز هستند.

نمایش JSON 
{
  "name": string,
  "expression": string,
  "invisible": boolean
}
فیلدها
name

string

نام معیار. برای فهرست نام‌های معیار پشتیبانی‌شده توسط روش‌های گزارش‌گیری اصلی مانند runReport و batchRunReports به API Metrics مراجعه کنید. برای فهرست نام‌های معیار پشتیبانی‌شده توسط روش runRealtimeReport به Realtime Metrics مراجعه کنید. برای فهرست نام‌های معیار پشتیبانی‌شده توسط روش runFunnelReport به Funnel Metrics مراجعه کنید.

اگر expression مشخص شده باشد، name می‌تواند هر رشته‌ای باشد که شما در مجموعه کاراکترهای مجاز می‌خواهید. برای مثال، اگر expression screenPageViews/sessions باشد، می‌توانید نام آن معیار را به صورت viewsPerSession بنویسید. نام معیارهایی که انتخاب می‌کنید باید با عبارت منظم ^[a-zA-Z0-9_]$ مطابقت داشته باشد.

معیارها با name در metricFilter ، orderBys و expression metric ارجاع داده می‌شوند.

expression

string

یک عبارت ریاضی برای معیارهای مشتق شده. برای مثال، معیار تعداد رویدادها به ازای هر کاربر eventCount/totalUsers است.

invisible

boolean

نشان می‌دهد که آیا یک معیار در پاسخ گزارش نامرئی است یا خیر. اگر یک معیار نامرئی باشد، آن معیار ستونی در پاسخ ایجاد نمی‌کند، اما می‌تواند در metricFilter ، orderBys یا یک expression معیار استفاده شود.

محدوده تاریخ

مجموعه‌ای پیوسته از روزها: startDate ، startDate + 1 ، ...، endDate . درخواست‌ها تا ۴ محدوده تاریخی مجاز هستند.

نمایش JSON 
{
  "startDate": string,
  "endDate": string,
  "name": string
}
فیلدها
startDate

string

تاریخ شروع جامع برای پرس‌وجو با فرمت YYYY-MM-DD . نمی‌تواند بعد از endDate باشد. فرمت NdaysAgo ، yesterday یا today نیز پذیرفته می‌شود و در این صورت، تاریخ بر اساس منطقه زمانی گزارش‌دهی ملک استنباط می‌شود.

endDate

string

تاریخ پایان جامع برای پرس‌وجو با فرمت YYYY-MM-DD . نمی‌تواند قبل از startDate باشد. فرمت NdaysAgo ، yesterday یا today نیز پذیرفته می‌شود و در این صورت، تاریخ بر اساس منطقه زمانی گزارش‌دهی ملک استنباط می‌شود.

name

string

یک نام به این محدوده تاریخ اختصاص می‌دهد. بُعد dateRange در پاسخ گزارش به این نام مقداردهی می‌شود. اگر تنظیم شود، نمی‌تواند با date_range_ یا RESERVED_ شروع شود. اگر تنظیم نشود، محدوده‌های تاریخ بر اساس اندیس صفر خود در درخواست نامگذاری می‌شوند: date_range_0 ، date_range_1 و غیره.

عبارت فیلتر

برای بیان فیلترهای ابعادی یا متریکی. فیلدهای موجود در یک FilterExpression باید یا تمام ابعادی یا تمام متریکی باشند.

نمایش JSON 
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FilterExpressionList)
  },
  "orGroup": {
    object (FilterExpressionList)
  },
  "notExpression": {
    object (FilterExpression)
  },
  "filter": {
    object (Filter)
  }
  // End of list of possible types for union field expr.
}
فیلدها
فیلد Union expr . یک نوع عبارت فیلتر برای FilterExpression مشخص کنید. expr فقط می‌تواند یکی از موارد زیر باشد:
andGroup

object ( FilterExpressionList )

عبارت‌های فیلتر (FilterExpressions) در andGroup یک رابطه‌ی AND دارند.

orGroup

object ( FilterExpressionList )

عبارت‌های فیلتر (FilterExpressions) در orGroup یک رابطه‌ی OR دارند.

notExpression

object ( FilterExpression )

FilterExpression از نوع notExpression نیست.

filter

object ( Filter )

یک فیلتر اولیه. در همان FilterExpression، نام تمام فیلدهای فیلتر باید یا تماماً ابعادی یا تماماً متریکی باشد.

لیست عبارات فیلتر

فهرستی از عبارات فیلتر.

نمایش JSON 
{
  "expressions": [
    {
      object (FilterExpression)
    }
  ]
}
فیلدها
expressions[]

object ( FilterExpression )

فهرستی از عبارات فیلتر.

فیلتر

عبارتی برای فیلتر کردن مقادیر ابعاد یا متریک.

نمایش JSON 
{
  "fieldName": string,

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  },
  "emptyFilter": {
    object (EmptyFilter)
  }
  // End of list of possible types for union field one_filter.
}
فیلدها
fieldName

string

نام بُعد یا نام معیار. باید نامی باشد که در ابعاد یا معیارها تعریف شده باشد.

فیلد اتحادیه one_filter . یک نوع فیلتر برای Filter مشخص کنید. one_filter فقط می‌تواند یکی از موارد زیر باشد:
stringFilter

object ( StringFilter )

فیلتر مرتبط با رشته‌ها

inListFilter

object ( InListFilter )

فیلتری برای مقادیر درون لیست.

numericFilter

object ( NumericFilter )

فیلتری برای مقادیر عددی یا تاریخی.

betweenFilter

object ( BetweenFilter )

فیلتری برای بین دو مقدار.

emptyFilter

object ( EmptyFilter )

فیلتری برای مقادیر خالی مانند مقادیر "(تنظیم نشده)" و "".

فیلتر رشته‌ای

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

نمایش JSON 
{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}
فیلدها
matchType

enum ( MatchType )

نوع منطبق برای این فیلتر.

value

string

مقدار رشته‌ای که برای تطبیق استفاده می‌شود.

caseSensitive

boolean

اگر درست باشد، مقدار رشته به حروف کوچک و بزرگ حساس است.

نوع تطابق

نوع تطابق یک فیلتر رشته‌ای

انوم‌ها
MATCH_TYPE_UNSPECIFIED نامشخص
EXACT تطابق دقیق با مقدار رشته.
BEGINS_WITH با مقدار رشته‌ای شروع می‌شود.
ENDS_WITH با مقدار رشته‌ای به پایان می‌رسد.
CONTAINS شامل مقدار رشته‌ای است.
FULL_REGEXP تطابق کامل برای عبارت منظم با مقدار رشته.
PARTIAL_REGEXP تطابق جزئی برای عبارت منظم با مقدار رشته.

فیلتر درون‌لیست

نتیجه باید در لیستی از مقادیر رشته‌ای باشد.

نمایش JSON 
{
  "values": [
    string
  ],
  "caseSensitive": boolean
}
فیلدها
values[]

string

لیست مقادیر رشته‌ای. باید خالی نباشد.

caseSensitive

boolean

اگر درست باشد، مقدار رشته به حروف کوچک و بزرگ حساس است.

فیلتر عددی

فیلترها برای مقادیر عددی یا تاریخی.

نمایش JSON 
{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}
فیلدها
operation

enum ( Operation )

نوع عملکرد این فیلتر.

value

object ( NumericValue )

یک مقدار عددی یا یک مقدار تاریخی.

عملیات

عملیاتی که روی یک فیلتر عددی اعمال می‌شود

انوم‌ها
OPERATION_UNSPECIFIED نامشخص.
EQUAL برابر
LESS_THAN کمتر از
LESS_THAN_OR_EQUAL کمتر یا مساوی
GREATER_THAN بزرگتر از
GREATER_THAN_OR_EQUAL بزرگتر یا مساوی

مقدار عددی

برای نمایش یک عدد.

نمایش JSON 
{

  // Union field one_value can be only one of the following:
  "int64Value": string,
  "doubleValue": number
  // End of list of possible types for union field one_value.
}
فیلدها
فیلد اتحادیه one_value . یکی از مقادیر عددی one_value فقط می‌تواند یکی از موارد زیر باشد:
int64Value

string ( int64 format)

مقدار عدد صحیح

doubleValue

number

ارزش مضاعف

بین فیلتر

برای بیان اینکه نتیجه باید بین دو عدد (شامل دو عدد دیگر) باشد.

نمایش JSON 
{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}
فیلدها
fromValue

object ( NumericValue )

با این عدد شروع می‌شود.

toValue

object ( NumericValue )

با این شماره تمام می‌شود.

فیلتر خالی

این نوع هیچ فیلدی ندارد.

فیلتر برای مقادیر خالی.

تجمیع متریک

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

انوم‌ها
METRIC_AGGREGATION_UNSPECIFIED اپراتور نامشخص.
TOTAL عملگر جمع (SUM)
MINIMUM حداقل اپراتور.
MAXIMUM حداکثر اپراتور.
COUNT عملگر شمارش.

سفارش توسط

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

نمایش JSON 
{
  "desc": boolean,

  // Union field one_order_by can be only one of the following:
  "metric": {
    object (MetricOrderBy)
  },
  "dimension": {
    object (DimensionOrderBy)
  }
  // End of list of possible types for union field one_order_by.
}
فیلدها
desc

boolean

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

فیلد یونیون one_order_by . یک نوع سفارش بر اساس OrderBy را مشخص کنید. one_order_by فقط می‌تواند یکی از موارد زیر باشد:
metric

object ( MetricOrderBy )

نتایج را بر اساس مقادیر یک معیار مرتب می‌کند.

dimension

object ( DimensionOrderBy )

نتایج را بر اساس مقادیر یک بُعد مرتب می‌کند.

متریک‌ارسال‌شده توسط

بر اساس مقادیر متریک مرتب‌سازی می‌کند.

نمایش JSON 
{
  "metricName": string
}
فیلدها
metricName

string

نام معیار در درخواست سفارش.

ابعادسفارش بر اساس

بر اساس مقادیر ابعاد مرتب‌سازی می‌کند.

نمایش JSON 
{
  "dimensionName": string,
  "orderType": enum (OrderType)
}
فیلدها
dimensionName

string

نام بُعد در درخواست سفارش.

orderType

enum ( OrderType )

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

نوع سفارش

قاعده‌ای برای مرتب‌سازی مقادیر بُعد رشته‌ای بر اساس.

انوم‌ها
ORDER_TYPE_UNSPECIFIED نامشخص.
ALPHANUMERIC مرتب‌سازی الفبایی عددی بر اساس کد پوینت یونیکد. برای مثال، "2" < "A" < "X" < "b" < "z".
CASE_INSENSITIVE_ALPHANUMERIC مرتب‌سازی الفبایی-عددی غیر حساس به حروف کوچک و بزرگ بر اساس کد یونیکد حروف کوچک. برای مثال، "2" < "A" < "b" < "X" < "z".
NUMERIC مقادیر بُعد قبل از مرتب‌سازی به اعداد تبدیل می‌شوند. برای مثال، در مرتب‌سازی عددی، "25" < "100" و در مرتب‌سازی ALPHANUMERIC ، "100" < "25". مقادیر بُعد غیرعددی همگی دارای ارزش ترتیبی یکسانی در زیر تمام مقادیر عددی هستند.

کوهورت‌اسپک

مشخصات گروه‌های سنی برای گزارش گروه سنی.

گزارش‌های گروهی، یک سری زمانی از میزان ماندگاری کاربر برای هر گروه ایجاد می‌کنند. برای مثال، می‌توانید گروهی از کاربران را که در هفته اول سپتامبر جذب شده‌اند انتخاب کنید و آن گروه را برای شش هفته آینده دنبال کنید. انتخاب گروه کاربران جذب شده در هفته اول سپتامبر در شیء cohort مشخص شده است. دنبال کردن آن گروه برای شش هفته آینده در شیء cohortsRange مشخص شده است.

برای مثال‌ها، به نمونه‌های گزارش گروهی مراجعه کنید.

پاسخ گزارش می‌تواند یک سری زمانی هفتگی را نشان دهد که در آن مثلاً برنامه شما ۶۰٪ از این گروه را پس از سه هفته و ۲۵٪ از این گروه را پس از شش هفته حفظ کرده است. این دو درصد را می‌توان با معیار cohortActiveUsers/cohortTotalUsers محاسبه کرد و در ردیف‌های جداگانه‌ای در گزارش قرار خواهند گرفت.

نمایش JSON 
{
  "cohorts": [
    {
      object (Cohort)
    }
  ],
  "cohortsRange": {
    object (CohortsRange)
  },
  "cohortReportSettings": {
    object (CohortReportSettings)
  }
}
فیلدها
cohorts[]

object ( Cohort )

معیارهای انتخاب را برای گروه‌بندی کاربران در گروه‌های مختلف تعریف می‌کند.

بیشتر گزارش‌های هم‌گروهی فقط یک هم‌گروه را تعریف می‌کنند. اگر چندین هم‌گروه مشخص شده باشد، هر هم‌گروه را می‌توان در گزارش با نامش شناسایی کرد.

cohortsRange

object ( CohortsRange )

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

cohortReportSettings

object ( CohortReportSettings )

تنظیمات اختیاری برای گزارش گروه.

گروه

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

نمایش JSON 
{
  "name": string,
  "dimension": string,
  "dateRange": {
    object (DateRange)
  }
}
فیلدها
name

string

یک نام به این گروه اختصاص می‌دهد. cohort بُعد در پاسخ گزارش با این نام مقداردهی می‌شود. اگر تنظیم شود، نمی‌تواند با cohort_ یا RESERVED_ شروع شود. اگر تنظیم نشود، گروه‌ها با اندیس مبتنی بر صفر خود مانند cohort_0 ، cohort_1 و غیره نامگذاری می‌شوند.

dimension

string

بُعدی که توسط گروه استفاده می‌شود. الزامی است و فقط از firstSessionDate پشتیبانی می‌کند.

dateRange

object ( DateRange )

گروه، کاربرانی را انتخاب می‌کند که تاریخ اولین تماس آنها بین تاریخ شروع و تاریخ پایان تعریف شده در dateRange باشد. این dateRange محدوده کامل داده‌های رویداد موجود در گزارش گروه را مشخص نمی‌کند. در یک گزارش گروه، این dateRange توسط جزئیات و آفست موجود در cohortsRange گسترش می‌یابد؛ داده‌های رویداد برای محدوده تاریخ گزارش‌دهی گسترده در گزارش گروه وجود دارد.

در یک درخواست هم‌گروهی، این dateRange الزامی است و dateRanges در RunReportRequest یا RunPivotReportRequest باید نامشخص باشند.

این dateRange معمولاً باید با جزئیات گروه هم‌تراز شود. اگر CohortsRange از جزئیات روزانه استفاده کند، این dateRange می‌تواند یک روز باشد. اگر CohortsRange از جزئیات هفتگی استفاده کند، این dateRange می‌تواند با مرز هفته، از یکشنبه شروع و شنبه پایان یابد، هم‌تراز شود. اگر CohortsRange از جزئیات ماهانه استفاده کند، این dateRange می‌تواند با یک ماه، از اولین روز ماه شروع و در آخرین روز ماه پایان یابد، هم‌تراز شود.

کوهورت‌رنج

محدوده تاریخ گزارش‌دهی گسترده را برای گزارش هم‌گروهی پیکربندی می‌کند. مدت زمان جبرانی را برای دنبال کردن هم‌گروه‌ها مشخص می‌کند.

نمایش JSON 
{
  "granularity": enum (Granularity),
  "startOffset": integer,
  "endOffset": integer
}
فیلدها
granularity

enum ( Granularity )

الزامی. جزئیات مورد استفاده برای تفسیر startOffset و endOffset برای محدوده تاریخ گزارش‌دهی گسترده برای گزارش هم‌گروهی.

startOffset

integer

startOffset تاریخ شروع محدوده تاریخ گزارش‌دهی توسعه‌یافته برای گزارش هم‌گروهی را مشخص می‌کند. startOffset معمولاً روی 0 تنظیم می‌شود تا گزارش‌ها حاوی داده‌هایی از اکتساب هم‌گروهی به جلو باشند.

اگر granularity DAILY باشد، تاریخ startDate ) محدوده تاریخ گزارش‌دهی توسعه‌یافته، برابر startDate گروه به علاوه روزهای startOffset خواهد بود.

اگر granularity به WEEKLY باشد، تاریخ startDate ) محدوده تاریخ گزارش‌دهی توسعه‌یافته برابر است startDate گروه به علاوه‌ی startOffset * 7 روز.

اگر granularity MONTHLY باشد، تاریخ startDate ) محدوده تاریخ گزارش‌دهی توسعه‌یافته برابر است startDate گروه به علاوه‌ی startOffset * 30 روز.

endOffset

integer

الزامی. endOffset تاریخ پایان محدوده تاریخ گزارش‌دهی توسعه‌یافته برای گزارش هم‌گروهی را مشخص می‌کند. endOffset می‌تواند هر عدد صحیح مثبتی باشد، اما معمولاً روی ۵ تا ۱۰ تنظیم می‌شود تا گزارش‌ها حاوی داده‌های مربوط به هم‌گروهی برای چند دوره زمانی جزئی‌تر بعدی باشند.

اگر granularity DAILY باشد، endDate محدوده تاریخ گزارش‌دهی توسعه‌یافته endDate گروه به علاوه روزهای endOffset خواهد بود.

اگر granularity WEEKLY باشد، تاریخ endDate ) محدوده تاریخ گزارش‌دهی توسعه‌یافته برابر endDate گروه به علاوه‌ی endOffset * 7 روز است.

اگر granularity MONTHLY باشد، تاریخ endDate محدوده تاریخ گزارش توسعه یافته، endDate گروه به اضافه endOffset * 30 روز است.

دانه‌بندی

جزئیات مورد استفاده برای تفسیر startOffset و endOffset برای محدوده تاریخ گزارش گسترده برای گزارش گروهی.

انوم‌ها
GRANULARITY_UNSPECIFIED هرگز نباید مشخص شود.
DAILY جزئیات روزانه. معمولاً اگر dateRange مربوط به گروه، یک روز باشد و درخواست شامل cohortNthDay باشد، استفاده می‌شود.
WEEKLY جزئیات هفتگی. معمولاً اگر dateRange مربوط به گروه، یک هفته طول بکشد (از یکشنبه شروع و در شنبه پایان می‌یابد) و درخواست شامل cohortNthWeek باشد، استفاده می‌شود.
MONTHLY جزئیات ماهانه. معمولاً اگر dateRange مربوط به گروه، مدت زمان یک ماه داشته باشد و درخواست شامل cohortNthMonth باشد، استفاده می‌شود.

تنظیمات گزارش گروهی

تنظیمات اختیاری گزارش هم‌گروهی.

نمایش JSON 
{
  "accumulate": boolean
}
فیلدها
accumulate

boolean

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

سطح نمونه‌برداری

دسته بندی سطوح نمونه گیری برای درخواست ها.

انوم‌ها
SAMPLING_LEVEL_UNSPECIFIED نوع نامشخص.
LOW سطح نمونه‌برداری ۱۰ میلیون را برای ویژگی‌های استاندارد و ۱۰۰ میلیون را برای ویژگی‌های Google Analytics 360 اعمال می‌کند.
MEDIUM منحصر به ویژگی‌های گوگل آنالیتیکس ۳۶۰ با سطح نمونه‌گیری ۱ میلیارد.
UNSAMPLED منحصر به ویژگی‌های گوگل آنالیتیکس ۳۶۰ است. کاوش‌های نمونه‌برداری نشده دقیق‌تر هستند و می‌توانند بینش‌هایی را آشکار کنند که در کاوش‌های استاندارد قابل مشاهده نیستند. برای کسب اطلاعات بیشتر، به https://support.google.com/analytics/answer/10896953 مراجعه کنید.

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

فراداده گزارش برای یک وظیفه گزارش خاص.

نمایش JSON 
{
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "taskRowCount": integer,
  "errorMessage": string,
  "totalRowCount": integer
}
فیلدها
creationQuotaTokensCharged

integer

فقط خروجی. کل توکن‌های سهمیه‌ای که هنگام ایجاد گزارش شارژ شده‌اند. از آنجا که این تعداد توکن بر اساس فعالیت از حالت CREATING محاسبه می‌شود، شارژ این توکن‌ها پس از ورود یک وظیفه گزارش به حالت ACTIVE یا FAILED ثابت خواهد شد.

state

enum ( State )

فقط خروجی. وضعیت فعلی برای این گزارش.

beginCreatingTime

string ( Timestamp format)

فقط خروجی. زمانی که reportTasks.create فراخوانی شده و گزارش به حالت CREATING رسیده است.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

taskRowCount

integer

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

errorMessage

string

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

totalRowCount

integer

فقط خروجی. تعداد کل ردیف‌ها در فضای ذخیره‌سازی گوگل آنالیتیکس. اگر می‌خواهید ردیف‌های داده اضافی فراتر از گزارش فعلی را جستجو کنید، می‌توانند یک وظیفه گزارش جدید را بر اساس totalRowCount آغاز کنند.

taskRowCount تعداد ردیف‌هایی را که به‌طور خاص مربوط به گزارش فعلی هستند نشان می‌دهد، در حالی که totalRowCount تعداد کل ردیف‌ها را در تمام داده‌های بازیابی شده از حافظه Google Analytics در بر می‌گیرد.

برای مثال، فرض کنید taskRowCount گزارش فعلی برابر با ۲۰ است که داده‌های ۲۰ ردیف اول را نمایش می‌دهد. همزمان، totalRowCount برابر با ۳۰ است که نشان‌دهنده وجود داده‌ها برای هر ۳۰ ردیف است. taskRowCount می‌تواند برای صفحه‌بندی ۲۰ ردیف اولیه استفاده شود. برای گسترش گزارش و گنجاندن داده‌های هر ۳۰ ردیف، می‌توان یک task گزارش جدید با استفاده از totalRowCount ایجاد کرد تا به مجموعه کامل داده‌های ۳۰ ردیف دسترسی پیدا کند.

ایالت

وضعیت پردازش.

انوم‌ها
STATE_UNSPECIFIED حالت نامشخص هرگز استفاده نخواهد شد.
CREATING این گزارش در حال حاضر در حال ایجاد است و در آینده در دسترس خواهد بود. ایجاد بلافاصله پس از فراخوانی CreateReport رخ می‌دهد.
ACTIVE گزارش به طور کامل ایجاد شده و آماده پرس و جو است.
FAILED ایجاد گزارش ناموفق بود.

روش‌ها

create

 ایجاد یک وظیفه گزارش را آغاز می‌کند.

get

 فراداده‌های گزارش مربوط به یک وظیفه گزارش خاص را دریافت می‌کند.

list

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

query

 محتوای یک وظیفه گزارش را بازیابی می‌کند.