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
}
שדות
dimensions[]

object (Dimension)

זה שינוי אופציונלי. המאפיינים המבוקשים והמוצגים.
metrics[]

object (Metric)

זה שינוי אופציונלי. המדדים המבוקשים והוצגו.
dateRanges[]

object (DateRange)

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

object (FilterExpression)

זה שינוי אופציונלי. מסנני מאפיינים מאפשרים לכם לבקש בדוח רק ערכי מאפיינים ספציפיים. מידע נוסף זמין במאמר יסודות השימוש במסנני מאפיינים. אי אפשר להשתמש במדדים במסנן הזה.
metricFilter

object (FilterExpression)

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

זה שינוי אופציונלי. צבירת מדדים. ערכי המדדים הנצברים יוצגו בשורות שבהן ערכי ה-dimensionValue מוגדרים כ-"RESERVED_(MetricAggregation)".
orderBys[]

object (OrderBy)

זה שינוי אופציונלי. מציין את סדר השורות בתשובה.
currencyCode

string

זה שינוי אופציונלי. קוד מטבע בפורמט ISO4217, למשל AED, USD, JPY. אם השדה ריק, הדוח ישתמש במטבע ברירת המחדל של הנכס.
cohortSpec

object (CohortSpec)

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

boolean

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

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

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

המאפיין

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

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

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

DimensionExpression

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

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

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 ב-ו-Group יש קשר AND.
orGroup

object (FilterExpressionList)

ל-FilterExpressions או ל-Groups יש קשר 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

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

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

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

NumericFilter

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

ייצוג 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 גדול מ- או שווה ל-

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

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

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

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

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

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

CohortReportSettings

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

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

boolean

אם הערך הוא true, המערכת צוברת את התוצאה מיום המגע הראשון עד ליום הסיום. אין תמיכה בRunReportRequest.

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.

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

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