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)

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

ReportDefinition

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

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

اختیاری. تعداد ردیف ردیف شروع از «فضای ذخیره‌سازی Google Analytics». اولین ردیف به‌عنوان ردیف ۰ درنظر گرفته می‌شود.

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

string (int64 format)

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

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

enum (MetricAggregation)

اختیاری. انبوهش سنجه‌ها. مقادیر سنجه انبوهشی در ردیف‌هایی نشان داده می‌شود که dimensionValues روی «RESERVED_(MetricAggregation)» تنظیم شده است.
orderBys[]

object (OrderBy)

اختیاری. مشخص می‌کند ردیف‌ها در پاسخ چگونه مرتب شوند.
currencyCode

string

اختیاری. کد واحد پول در قالب ISO4217، مثل «AED»،‏ «USD»،‏ «JPY». اگر این فیلد خالی باشد، گزارش از ارز پیش‌فرض دارایی استفاده می‌کند.
cohortSpec

object (CohortSpec)

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

boolean

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

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

برای مثال، اگر دارایی هرگز رویداد purchase را ثبت نکند، پُرسمان برای بُعد eventName و سنجه eventCount ردیفی نخواهد داشت که حاوی eventName: «خرید» و eventCount: 0 باشد.
samplingLevel

enum (SamplingLevel)

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

ابعاد

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

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

string

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

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

ابعاد توسط name در dimensionFilter،‏ orderBys،‏ dimensionExpression، و pivots ارجاع داده شده است.
dimensionExpression

object (DimensionExpression)

یک بُعد می‌تواند نتیجه عبارتی از چندین بُعد باشد. برای مثال، بُعد «کشور، شهر»: concatenate(کشور، «، »، شهر).

DimensionExpression

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

نمایش JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "lowerCase": {
    object (CaseExpression)
  },
  "upperCase": {
    object (CaseExpression)
  },
  "concatenate": {
    object (ConcatenateExpression)
  }
  // End of mutually exclusive fields.
}
فیلدها
یک نوع عبارت بُعد برای DimensionExpression مشخص کنید. فهرست زیر شامل فیلدهای متقابلاً انحصاری است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
lowerCase

object (CaseExpression)

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

object (CaseExpression)

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

object (ConcatenateExpression)

برای ترکیب مقادیر بُعد در یک بُعد استفاده می‌شود. برای مثال، بُعد «کشور، شهر»: concatenate(کشور، «، »، شهر).
پایان فیلدهای متقابلاً انحصاری.

CaseExpression

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

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

string

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

ConcatenateExpression

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

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

string

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

string

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

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

متریک

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

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

string

نام سنجه. برای فهرست نام‌های سنجه پشتیبانی‌شده توسط روش‌های گزارش‌دهی اصلی مثل runReport و batchRunReports، سنجه‌های API را ببینید. برای فهرست نام‌های سنجه پشتیبانی‌شده توسط روش runRealtimeReport، سنجه‌های هم‌زمان را ببینید. برای فهرست نام‌های سنجه پشتیبانی‌شده توسط روش runFunnelReport، سنجه‌های قیف را ببینید.

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

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

string

عبارت ریاضی برای سنجه‌های مشتق‌شده. برای مثال، سنجه «تعداد رویداد به‌ازای هر کاربر» eventCount/totalUsers است.
invisible

boolean

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

DateRange

مجموعه‌ای پیوسته از روزها: 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 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "andGroup": {
    object (FilterExpressionList)
  },
  "orGroup": {
    object (FilterExpressionList)
  },
  "notExpression": {
    object (FilterExpression)
  },
  "filter": {
    object (Filter)
  }
  // End of mutually exclusive fields.
}
فیلدها
یک نوع عبارت فیلتر برای FilterExpression مشخص کنید. فهرست زیر شامل فیلدهای متقابلاً انحصاری است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
andGroup

object (FilterExpressionList)

‫FilterExpressions در andGroup رابطه «و» دارند.
orGroup

object (FilterExpressionList)

‫FilterExpressions در orGroup رابطه «یا» دارند.
notExpression

object (FilterExpression)

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

object (Filter)

فیلتر ابتدایی. در همان FilterExpression، همه نام‌های فیلد فیلتر باید یا همه بُعد باشند یا همه سنجه.
پایان فیلدهای متقابلاً انحصاری.

FilterExpressionList

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

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

object (FilterExpression)

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

فیلتر کردن

عبارتی برای فیلتر کردن مقادیر سنجه یا بُعد.

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  },
  "emptyFilter": {
    object (EmptyFilter)
  }
  // End of mutually exclusive fields.
}
فیلدها
fieldName

string

نام بُعد یا نام سنجه. باید نامی باشد که در ابعاد یا سنجه‌ها تعریف شده است.
یک نوع فیلتر برای Filter مشخص کنید. فهرست زیر شامل فیلدهای متقابلاً انحصاری است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
stringFilter

object (StringFilter)

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

object (InListFilter)

فیلتری برای مقادیر موجود در فهرست.
numericFilter

object (NumericFilter)

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

object (BetweenFilter)

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

object (EmptyFilter)

فیلتری برای مقادیر خالی مثل مقادیر (not set) و "".
پایان فیلدهای متقابلاً انحصاری.

StringFilter

فیلتر رشته

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

enum (MatchType)

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

string

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

boolean

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

MatchType

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

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

InListFilter

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

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

string

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

boolean

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

NumericFilter

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

نمایش 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 بزرگ‌تر یا مساوی

NumericValue

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

نمایش JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "int64Value": string,
  "doubleValue": number
  // End of mutually exclusive fields.
}
فیلدها
یکی از مقادیر عددی فهرست زیر شامل فیلدهای متقابلاً انحصاری است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
int64Value

string (int64 format)

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

number

مقدار دوبرابر
پایان فیلدهای متقابلاً انحصاری.

BetweenFilter

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

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

object (NumericValue)

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

object (NumericValue)

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

EmptyFilter

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

برای مقادیر خالی فیلتر کنید. با مقادیر بُعدی که "" یا (not set) مقدار است مطابقت دارد. از این فیلتر برای مطابقت دادن ردیف‌ها با مقادیر بُعدی که وجود ندارد یا پر نشده است استفاده کنید، یا آن را با notExpression ترکیب کنید تا بدون فیلتر کردن جداگانه برای "" و (not set)، آن‌ها را از گزارش حذف کنید.

MetricAggregation

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

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

OrderBy

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

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "metric": {
    object (MetricOrderBy)
  },
  "dimension": {
    object (DimensionOrderBy)
  }
  // End of mutually exclusive fields.
}
فیلدها
desc

boolean

اگر درست باشد، براساس ترتیب نزولی مرتب می‌کند.
یک نوع ترتیب براساس OrderBy مشخص کنید. فهرست زیر شامل فیلدهای متقابلاً انحصاری است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
metric

object (MetricOrderBy)

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

object (DimensionOrderBy)

نتایج را براساس مقادیر بُعد مرتب می‌کند.
پایان فیلدهای متقابلاً انحصاری.

MetricOrderBy

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

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

string

نام سنجه در درخواست برای مرتب کردن براساس آن.

DimensionOrderBy

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

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

string

نام بُعد در درخواست ترتیب براساس آن.
orderType

enum (OrderType)

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

OrderType

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

شمارشی‌ها
ORDER_TYPE_UNSPECIFIED نامشخص.
ALPHANUMERIC مرتب‌سازی الفباعددی براساس نقطه کد «یونی‌کد». برای مثال، «2» < «A» < «X» < «b» < «z».
CASE_INSENSITIVE_ALPHANUMERIC مرتب‌سازی الفباعددی غیرحساس به حروف بزرگ و کوچک براساس نقطه کد یونی‌کد حروف کوچک. برای مثال، «2» < «A» < «b» < «X» < «z».
NUMERIC مقادیر بُعد قبل‌از مرتب‌سازی به عدد تبدیل می‌شوند. برای مثال، در مرتب‌سازی «عددی»، «۲۵» < «۱۰۰»، و در مرتب‌سازی ALPHANUMERIC،‏ «۱۰۰» < «۲۵». همه مقادیر بُعد غیرعددی دارای مقدار ترتیب یکسان در زیر همه مقادیر عددی هستند.

CohortSpec

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

گزارش‌های گروه هم‌نسل یک سری زمانی از ماندگاری کاربر برای گروه هم‌نسل ایجاد می‌کند. برای مثال، می‌توانید گروه کاربران جذب‌شده در هفته اول سپتامبر را انتخاب کنید و آن گروه را برای شش هفته آینده دنبال کنید. انتخاب کاربران جذب‌شده در هفته اول هم‌گروه سپتامبر در شیء 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 می‌تواند با یک ماه هماهنگ شود، از اولین روز ماه شروع شود و در آخرین روز ماه پایان یابد.

CohortsRange

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

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

enum (Granularity)

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

integer

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

اگر 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 باشد استفاده می‌شود.

CohortReportSettings

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

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

boolean

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

SamplingLevel

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

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

ReportMetadata

فراداده‌های گزارش برای یک تکلیف گزارش خاص.

نمایش 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-نرمال‌سازی می‌شود و از ۰، ۳، ۶، یا ۹ رقم کسری استفاده می‌کند. انحراف‌های غیر از «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

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

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

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

ایالت

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

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

روش‌ها

create

 ایجاد تکلیف گزارش را آغاز می‌کند.

get

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

list

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

query

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