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 
{

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

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

  // 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 נמצאים ביחס 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,

  // 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

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

  // 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

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

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

MetricAggregation

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

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

OrderBy

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

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

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

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

טיפוסים בני מנייה (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)

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

הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-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 בדוח הנוכחי הוא 20, כך שהנתונים מוצגים מ-20 השורות הראשונות. במקביל, הערך של totalRowCount הוא 30, מה שמצביע על כך שיש נתונים בכל 30 השורות. אפשר להשתמש ב-taskRowCount כדי להציג את 20 השורות הראשונות בדפים. כדי להרחיב את הדוח ולכלול נתונים מכל 30 השורות, אפשר ליצור משימת דוח חדשה באמצעות totalRowCount כדי לגשת לנתונים של כל 30 השורות.

מדינה (State)

מצב העיבוד.

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

Methods

create

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

get

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

list

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

query

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