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. לדוגמה, למאפיין country יש פחות מ-300 ערכים אפשריים, ולכן כשמדווחים על 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

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

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

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

object (DimensionExpression)

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

DimensionExpression

משמשת לציון מאפיין שהוא תוצאה של מספר מאפיינים. שימושים לדוגמה: 1) lowerCase(dimension) 2) concatenate(dimension1, icon, 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)

לביטויי הסינון ב-orGroup יש קשר OR.
notExpression

object (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

אם הערך הוא 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)

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

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

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

ייצוג ב-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 יצירת הדוח נכשלה.

שיטות

create

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

get

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

list

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

query

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