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. השורה הראשונה נספרת כשורה 0.

כשיוצרים משימה של דוח, הפרמטרים offset ו-limit מגדירים את קבוצת המשנה של שורות הנתונים מהאחסון של Google Analytics שכלולות בדוח שנוצר. לדוגמה, אם יש בסך הכול 300,000 שורות באחסון של Google Analytics, ייתכן שבמשימה הראשונית של הדוח יופיעו 10,000 השורות הראשונות עם מגבלה של 10,000 ועם אופסט של 0. לאחר מכן, משימה אחרת של דוח יכולה לכסות את 10,000 השורות הבאות עם מגבלה של 10,000 ועם הזזה של 10,000.
limit

string (int64 format)

זה שינוי אופציונלי. מספר השורות שיש להחזיר בדוח. אם לא צוין ערך, המערכת מחזירה 10,000 שורות. ה-API מחזיר עד 250,000 שורות לכל בקשה, ללא קשר למספר השורות שביקשת. הערך של 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

זה שינוי אופציונלי. אם הערך הוא false או לא צוין, לא תוחזר כל שורה שבה כל המדדים שווים ל-0. אם הערך הוא true, השורות האלה יחזרו אם הן לא יוסרו בנפרד על ידי מסנן.

ללא קשר להגדרה keepEmptyRows, רק נתונים שתועדו בנכס Google Analytics יוצגו בדוח.

לדוגמה, אם בנכס אף פעם לא מתועד אירוע purchase, בשאילתה למאפיין eventName ולמדד eventCount לא תופיע שורה שמכילה את הערכים eventName:‏ "purchase" ו-eventCount: ‏ 0.
samplingLevel

enum (SamplingLevel)

זה שינוי אופציונלי. רמת הדגימה של הדוח.

מאפיין

המאפיינים הם מאפייני הנתונים. לדוגמה, המאפיין 'עיר' מציין את העיר שממנה הגיע האירוע. ערכי המאפיינים בתשובות לדוחות הם מחרוזות. לדוגמה, העיר יכולה להיות 'פריז' או 'ניו יורק'.

ייצוג ב-JSON 
{
  "name": string,
  "dimensionExpression": {
    object (DimensionExpression)
  }
}
שדות
name

string

שם המאפיין. במאפייני ה-API מופיעה רשימה של שמות המאפיינים שנתמכים בשיטות דיווח ליבה, כמו runReport ו-batchRunReports. ברשימת מאפיינים בזמן אמת מפורטת רשימת שמות המאפיינים שנתמכים בשיטה runRealtimeReport. רשימת שמות המאפיינים שנתמכים בשיטה runFunnelReport מפורטת במאמר מאפייני משפך.

אם מציינים את dimensionExpression, הערך של name יכול להיות כל מחרוזת שרוצים מתוך קבוצת התווים המותרת. לדוגמה, אם dimensionExpression מורכב מ-country ו-city, אפשר לקרוא למאפיין הזה countryAndCity. שמות המאפיינים שבוחרים חייבים להתאים לביטוי הרגולרי ^[a-zA-Z0-9_]$.

המאפיינים מופיעים כ-name ב-dimensionFilter, ב-orderBys, ב-dimensionExpression וב-pivots.
dimensionExpression

object (DimensionExpression)

מאפיין אחד יכול להיות תוצאה של ביטוי של כמה מאפיינים. לדוגמה, המאפיין 'מדינה, עיר': concatenate(country, ", ", city).

DimensionExpression

משמש לביטוי מאפיין שהוא תוצאה של נוסחה של כמה מאפיינים. דוגמאות לשימוש: 1) lowerCase(dimension)‏ 2) 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).

CaseExpression

הפונקציה משמשת להמרת ערך של מאפיין למקרה יחיד.

ייצוג ב-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

שם המדד. במדדי API מופיעה רשימה של שמות המדדים שנתמכים בשיטות דיווח ליבה כמו runReport ו-batchRunReports. רשימת שמות המדדים שנתמכים בשיטה 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. אפשר לשלוח בקשות עם עד 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 הוא NOT של 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)
  },
  "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)

מסנן לערכים ריקים, כמו '(not set)' ו-'"'.

StringFilter

המסנן למחרוזת

ייצוג ב-JSON 
{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}
שדות
matchType

enum (MatchType)

סוג ההתאמה של המסנן הזה.
value

string

ערך המחרוזת שמשמש להתאמה.
caseSensitive

boolean

אם הערך הוא True, ערך המחרוזת תלוי אותיות רישיות.

MatchType

סוג ההתאמה של מסנן מחרוזת

טיפוסים בני מנייה (enum)
MATCH_TYPE_UNSPECIFIED לא צוין
EXACT התאמה מדויקת של ערך המחרוזת.
BEGINS_WITH מתחיל בערך המחרוזת.
ENDS_WITH מסתיים בערך המחרוזת.
CONTAINS מכיל את ערך המחרוזת.
FULL_REGEXP התאמה מלאה של הביטוי הרגולרי לערך המחרוזת.
PARTIAL_REGEXP התאמה חלקית של הביטוי הרגולרי לערך המחרוזת.

InListFilter

התוצאה צריכה להיות ברשימת ערכים של מחרוזות.

ייצוג ב-JSON 
{
  "values": [
    string
  ],
  "caseSensitive": boolean
}
שדות
values[]

string

רשימת ערכי המחרוזות. השדה לא יכול להיות ריק.
caseSensitive

boolean

אם הערך הוא True, ערך המחרוזת תלוי אותיות רישיות.

NumericFilter

מסננים לערכים מספריים או לתאריכים.

ייצוג ב-JSON 
{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}
שדות
operation

enum (Operation)

סוג הפעולה של המסנן הזה.
value

object (NumericValue)

ערך מספרי או ערך תאריך.

פעולה

הפעולה שחלה על מסנן מספרי

טיפוסים בני מנייה (enum)
OPERATION_UNSPECIFIED לא צוין.
EQUAL שווה
LESS_THAN פחות מ-
LESS_THAN_OR_EQUAL קטן מ- או שווה ל-
GREATER_THAN גדול מ-
GREATER_THAN_OR_EQUAL גדול מ- או שווה ל-

NumericValue

כדי לייצג מספר.

ייצוג ב-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

ערך כפול

BetweenFilter

כדי לציין שהתוצאה צריכה להיות בין שני מספרים (כולל).

ייצוג ב-JSON 
{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}
שדות
fromValue

object (NumericValue)

המספר הזה מופיע בהתחלה.
toValue

object (NumericValue)

מסתיים במספר הזה.

EmptyFilter

אין שדות לסוג הזה.

סינון לפי ערכים ריקים.

MetricAggregation

מייצג צבירה של מדדים.

טיפוסים בני מנייה (enum)
METRIC_AGGREGATION_UNSPECIFIED אופרטור לא צוין.
TOTAL אופרטור SUM.
MINIMUM אופרטור מינימלי.
MAXIMUM אופרטור מקסימלי.
COUNT אופרטור ספירה.

OrderBy

תנאי הסינון מגדירים את אופן המיון של השורות בתגובה. לדוגמה, מיון שורות לפי ספירת אירועים יורדת הוא מיון אחד, ומיון שורות לפי מחרוזת שם האירוע הוא מיון אחר.

ייצוג ב-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

אם הערך הוא True, מתבצע מיון בסדר יורד.
שדה האיחוד 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)

קובע את הכלל לסדר של ערכי המאפיינים.

OrderType

הכלל לפיו יתבצע הסדר של ערכי המאפיין מסוג מחרוזת.

טיפוסים בני מנייה (enum)
ORDER_TYPE_UNSPECIFIED לא צוין.
ALPHANUMERIC מיון אלפאנומרי לפי מיקום תו (code point) ב-Unicode. לדוגמה, '2' < 'A' < 'X' < 'b' < 'z'.
CASE_INSENSITIVE_ALPHANUMERIC מיון אלפאנומרי ללא תלות ברישיות לפי מיקום תו (code point) של Unicode באותיות קטנות. לדוגמה, '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)

בדוחות של קבוצות בעלות מאפיינים משותפים מוצגת פעילות של קבוצות בעלות מאפיינים משותפים בטווח תאריכים מורחב. הטווח הזה מציין את משך ההשהיה (offset) לצורך מעקב אחרי קבוצות האנשים.
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

הגדרת טווח התאריכים המורחב לדיווח בדוח 'קבוצת משתמשים בעלת מאפיינים משותפים'. מציין את משך ההשהיה (offset) לצורך מעקב אחרי קבוצות האנשים.

ייצוג ב-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 בטווח התאריכים המורחב לדיווח בדוח על קבוצה בעלת מאפיינים משותפים.

טיפוסים בני מנייה (enum)
GRANULARITY_UNSPECIFIED אף פעם לא צריך לציין את הערך הזה.
DAILY רמת פירוט יומית. משתמשים באפשרות הזו בדרך כלל אם הערך של dateRange בקבוצה בעלת המאפיינים המשותפים הוא יום אחד והבקשה מכילה את הערך cohortNthDay.
WEEKLY רמת פירוט שבועית. משתמשים באפשרות הזו בדרך כלל אם משך dateRange של הקבוצה בעלת המאפיינים המשותפים הוא שבוע (מתחיל ביום ראשון ומסתיים ביום שבת) והבקשה מכילה את cohortNthWeek.
MONTHLY רמת פירוט חודשית. משתמשים באפשרות הזו בדרך כלל אם משך dateRange של הקבוצה בעלת המאפיינים המשותפים הוא חודש והבקשה מכילה את cohortNthMonth.

CohortReportSettings

הגדרות אופציונליות של דוח קבוצה בעלת מאפיינים משותפים.

ייצוג ב-JSON 
{
  "accumulate": boolean
}
שדות
accumulate

boolean

אם הערך הוא True, התוצאה מצטברת מיום החשיפה הראשון ליום הסיום. לא נתמך ב-RunReportRequest.

SamplingLevel

קטגוריות של רמות דגימה לבקשות.

טיפוסים בני מנייה (enum)
SAMPLING_LEVEL_UNSPECIFIED סוג לא צוין.
LOW רמת הדגימה היא 10 מיליון אירועים בנכסים רגילים ו-100 מיליון אירועים בנכסי 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.

חותמת זמן בפורמט UTC 'Zulu' של RFC3339, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "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 שורות של נתונים.

מדינה

מצב העיבוד.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED אף פעם לא ייעשה שימוש במצב לא מוגדר.
CREATING הדוח נמצא בתהליך יצירה וייהיה זמין בעתיד. היצירה מתבצעת מיד אחרי הקריאה ל-CreateReport.
ACTIVE הדוח נוצר במלואו ומוכן לשליחת שאילתות.
FAILED יצירת הדוח נכשלה.

Methods

create

 האירוע הזה מפעיל את יצירת המשימה של הדוח.

get

 אחזור מטא-נתונים של דוח לגבי משימה ספציפית של דוח.

list

 רשימה של כל משימות הדוחות בנכס.

query

 אחזור התוכן של משימה של דיווח.