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

enum (MetricAggregation)

זה שינוי אופציונלי. צבירת מדדים. ערכי המדדים המצטברים יוצגו בשורות שבהן ה-attributeValues מוגדר כ-"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 לא תהיה שורה שכוללת את שם האירוע: 'purchase' ו-eventCount: 0.

מאפיין

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

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

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

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

FilterExpression הוא לא notExpression
filter

object (Filter)

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

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 מיון אלפאנומרי לפי נקודת קוד ב-Unicode. לדוגמה, המספר '2' < א' < X < ב' < "z".
CASE_INSENSITIVE_ALPHANUMERIC מיון אלפאנומרי ללא תלות ברישיות לפי נקודה קוד Unicode של אותיות קטנות. לדוגמה, המספר '2' < א' < ב' < 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.

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 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
taskRowCount

integer

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

string

פלט בלבד. הודעת השגיאה מאוכלסת אם משימת דיווח נכשלה במהלך היצירה.
totalRowCount

integer

פלט בלבד. מספר השורות הכולל באחסון ב-Google Analytics. אם רוצים להריץ שאילתות על שורות נתונים נוספות מעבר לדוח הנוכחי, אפשר ליצור משימת דוח חדשה על סמך השדה totalRowCount.

הערך taskRowCount מייצג את מספר השורות שקשורות באופן ספציפי לדוח הנוכחי, ואילו totalRowCount מייצג את מספר השורות הכולל בכל הנתונים שאוחזרו מהאחסון ב-Google Analytics.

לדוגמה, נניח ש-taskRowCount בדוח הנוכחי הוא 20, ומוצגים בו הנתונים מ-20 השורות הראשונות. בו-זמנית, הערך totalRowCount הוא 30, שמציין את נוכחות הנתונים בכל 30 השורות. אפשר להשתמש ברכיב taskRowCount כדי לחלק את העמודים ב-20 השורות הראשונות. כדי להרחיב את הדוח ולכלול נתונים מכל 30 השורות, אפשר ליצור משימת דוח חדשה באמצעות totalRowCount כדי לקבל גישה לקבוצה המלאה של 30 השורות שערך הנתונים.

מדינה

מצב העיבוד.

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

שיטות

create

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

get

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

list

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

query

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