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
}
زمینه های
dimensions[]

object ( Dimension )

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

metrics[]

object ( Metric )

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

dateRanges[]

object ( DateRange )

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

dimensionFilter

object ( FilterExpression )

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

metricFilter

object ( FilterExpression )

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

offset

string ( int64 format)

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

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

limit

string ( int64 format)

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

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

metricAggregations[]

enum ( MetricAggregation )

اختیاری. تجمیع معیارها مقادیر متریک انبوه در ردیف‌هایی نشان داده می‌شوند که در آن dimensionValues ​​روی "RESERVED_(MetricAggregation)" تنظیم شده است.

orderBys[]

object ( OrderBy )

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

currencyCode

string

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

cohortSpec

object ( CohortSpec )

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

keepEmptyRows

boolean

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

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

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

بعد، ابعاد، اندازه

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

نمایندگی JSON
{
  "name": string,
  "dimensionExpression": {
    object (DimensionExpression)
  }
}
زمینه های
name

string

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

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

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

dimensionExpression

object ( DimensionExpression )

یک بعد می تواند نتیجه بیان چند بعد باشد. به عنوان مثال، بعد "کشور، شهر": concatenate(کشور، "، "، شهر).

DimensionExpression

برای بیان یک بعد که حاصل فرمول چند بعد است استفاده می شود. کاربردهای مثال: 1) حروف کوچک (بعد) 2) الحاق (بعد 1، نماد، بعد 2).

نمایندگی 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(کشور، "، "، شهر).

Case Expression

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

نمایندگی JSON
{
  "dimensionName": string
}
زمینه های
dimensionName

string

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

ConcatenateExpression

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

نمایندگی JSON
{
  "dimensionNames": [
    string
  ],
  "delimiter": string
}
زمینه های
dimensionNames[]

string

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

delimiter

string

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

جداکننده ها اغلب کاراکترهای منفرد هستند مانند "|" یا ""، اما می تواند رشته های طولانی تر باشد. اگر یک مقدار بعد حاوی جداکننده باشد، هر دو بدون هیچ تمایزی در پاسخ وجود خواهند داشت. به عنوان مثال، اگر مقدار بعد 1 = "US,FR"، مقدار بعد 2 = "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 متریک ارجاع می شوند.

expression

string

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

invisible

boolean

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

محدوده زمانی

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

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

برای بیان فیلترهای ابعاد یا متریک. فیلدهای موجود در همان 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.
}
زمینه های
expr فیلد اتحادیه یک نوع بیان فیلتر را برای FilterExpression مشخص کنید. expr می تواند تنها یکی از موارد زیر باشد:
andGroup

object ( FilterExpressionList )

FilterExpressions در andGroup یک رابطه AND دارند.

orGroup

object ( FilterExpressionList )

FilterExpressions در orGroup یک رابطه OR دارند.

notExpression

object ( FilterExpression )

FilterExpression از notExpression نیست.

filter

object ( Filter )

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

FilterExpressionList

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

نمایندگی 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)
  }
  // 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 )

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

StringFilter

فیلتر رشته

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

enum ( MatchType )

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

value

string

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

caseSensitive

boolean

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

MatchType

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

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

InListFilter

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

نمایندگی JSON
{
  "values": [
    string
  ],
  "caseSensitive": boolean
}
زمینه های
values[]

string

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

caseSensitive

boolean

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

فیلتر عددی

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

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

enum ( Operation )

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

value

object ( NumericValue )

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

عمل

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

Enums
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 )

با این عدد به پایان می رسد.

MetricAggregation

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

Enums
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 )

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

MetricOrderBy

بر اساس مقادیر متریک مرتب می شود.

نمایندگی JSON
{
  "metricName": string
}
زمینه های
metricName

string

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

DimensionOrderBy

بر اساس مقادیر ابعاد مرتب می شود.

نمایندگی JSON
{
  "dimensionName": string,
  "orderType": enum (OrderType)
}
زمینه های
dimensionName

string

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

orderType

enum ( OrderType )

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

نوع سفارش

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

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

CohortSpec

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

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

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

پاسخ گزارش می تواند یک سری زمانی هفتگی را نشان دهد که در آن برنامه شما پس از سه هفته 60٪ و بعد از شش هفته 25٪ از این گروه را حفظ کرده است. این دو درصد را می‌توان با متریک 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 می‌تواند هر عدد صحیح مثبت باشد، اما معمولاً بین 5 تا 10 تنظیم می‌شود تا گزارش‌ها حاوی داده‌های مربوط به همگروهی برای چندین دوره زمانی دقیق بعدی باشند.

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

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

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

دانه دانه بودن

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

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

CohortReport Settings

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

نمایندگی JSON
{
  "accumulate": boolean
}
زمینه های
accumulate

boolean

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

گزارش متادیتا

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

نمایندگی 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 را شروع کرد.

یک مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

taskRowCount

integer

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

errorMessage

string

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

totalRowCount

integer

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

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

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

حالت

وضعیت پردازش

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

مواد و روش ها

create

 ایجاد یک کار گزارش را آغاز می کند.

get

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

list

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

query

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