- משאב: ReportTask
- ReportDefinition
- מאפיין
- DimensionExpression
- CaseExpression
- ConcatenateExpression
- מדד
- DateRange
- FilterExpression
- FilterExpressionList
- סינון
- StringFilter
- MatchType
- InListFilter
- NumericFilter (מסנן מספרי)
- תפעול
- NumericValue
- BetweenFilter
- MetricAggregation
- OrderBy
- MetricOrderBy
- DimensionOrderBy
- OrderType
- CohortSpec
- קבוצה בעלת מאפיינים משותפים
- CohortsRange
- רמת פירוט
- CohortReportSettings
- ReportMetadata
- מדינה (State)
- שיטות
משאב: ReportTask
הגדרת משימה ספציפית של דוח.
ייצוג JSON |
---|
{ "name": string, "reportDefinition": { object ( |
שדות | |
---|---|
name |
פלט בלבד. מזהה. השם של משאב המשימה שהוקצה במהלך יצירת הדוח. פורמט: "properties/{property}/reportTasks/{reportTask}" |
reportDefinition |
זה שינוי אופציונלי. הגדרת דוח לאחזור נתוני דוח, שמתארת את המבנה של דוח. הוא כולל בדרך כלל את השדות שייכללו בדוח ואת הקריטריונים שישמשו לסינון הנתונים. |
reportMetadata |
פלט בלבד. מטא-נתונים של דוח של משימת דוח ספציפית, שמספקים מידע על הדוח. הדוח כולל בדרך כלל את המידע הבא: שם המשאב של הדוח, מצב הדוח, חותמת הזמן שהדוח נוצר וכו'. |
ReportDefinition
ההגדרה של אופן הרצת הדוח.
ייצוג JSON |
---|
{ "dimensions": [ { object ( |
שדות | |
---|---|
dimensions[] |
זה שינוי אופציונלי. המאפיינים המבוקשים והמוצגים. |
metrics[] |
זה שינוי אופציונלי. המדדים המבוקשים והוצגו. |
dateRanges[] |
זה שינוי אופציונלי. טווחי תאריכים של נתונים לקריאה. אם מבקשים מספר טווחי תאריכים, כל שורת תגובה תכיל אינדקס של טווח תאריכים מבוסס אפס. אם שני טווחי תאריכים חופפים, נתוני האירועים של הימים החופפים נכללים בשורות התגובה של שני טווחי התאריכים. בבקשה לקבוצה בעלת מאפיינים משותפים, חובה לציין |
dimensionFilter |
זה שינוי אופציונלי. מסנני מאפיינים מאפשרים לכם לבקש בדוח רק ערכי מאפיינים ספציפיים. מידע נוסף זמין במאמר יסודות השימוש במסנני מאפיינים. אי אפשר להשתמש במדדים במסנן הזה. |
metricFilter |
זה שינוי אופציונלי. סעיף הסינון של המדדים. המדיניות מיושמת אחרי צבירה של השורות בדוח, בדומה לסעיפים שונים של SQL. אי אפשר להשתמש במימדים במסנן הזה. |
offset |
זה שינוי אופציונלי. מספר השורות של שורת ההתחלה מ'אחסון ב-Google Analytics'. השורה הראשונה נספרת כשורה 0. כשיוצרים משימת דוח, הפרמטרים |
limit |
זה שינוי אופציונלי. מספר השורות שיש להחזיר בדוח. אם לא צוין אחרת, יוחזרו 10,000 שורות. ה-API מחזיר עד 250,000 שורות לבקשה, ללא קשר לכמות שתבקש. הערך כמו כן, ה-API יכול להחזיר פחות שורות מהשדה |
metricAggregations[] |
זה שינוי אופציונלי. צבירת מדדים. ערכי המדדים הנצברים יוצגו בשורות שבהן ערכי ה-dimensionValue מוגדרים כ-"RESERVED_(MetricAggregation)". |
orderBys[] |
זה שינוי אופציונלי. מציין את סדר השורות בתשובה. |
currencyCode |
זה שינוי אופציונלי. קוד מטבע בפורמט ISO4217, למשל AED, USD, JPY. אם השדה ריק, הדוח ישתמש במטבע ברירת המחדל של הנכס. |
cohortSpec |
זה שינוי אופציונלי. קבוצה בעלת מאפיינים משותפים שמשויכת לבקשה הזו. אם הבקשה מכילה קבוצה בעלת מאפיינים משותפים, המאפיין 'קבוצה בעלת מאפיינים משותפים' חייב להיכלל בה. |
keepEmptyRows |
זה שינוי אופציונלי. אם הערך הוא False או לא צוין, לא תוחזר כל שורה עם כל המדדים שווים ל-0. אם הערך הוא True, השורות האלה יוחזרו אם הן לא הוסרו בנפרד על ידי מסנן. בלי קשר להגדרה הזו של לדוגמה, אם נכס אף פעם לא מתעד אירוע |
המאפיין
המאפיינים הם מאפייני הנתונים. לדוגמה, המאפיין 'עיר' מציין את העיר שממנה הגיע האירוע. ערכי המאפיינים בתגובות לדוח הם מחרוזות. לדוגמה, העיר יכולה להיות פריז או ניו יורק.
ייצוג JSON |
---|
{
"name": string,
"dimensionExpression": {
object ( |
שדות | |
---|---|
name |
שם המאפיין. בקטע מאפייני API מופיעה רשימה של שמות המאפיינים שנתמכים בשיטות דיווח מרכזיות, כמו אם מציינים המאפיינים |
dimensionExpression |
מאפיין אחד יכול להיות תוצאה של ביטוי של כמה מאפיינים. לדוגמה, המאפיין 'מדינה, עיר': שרשור(מדינה, ", ", עיר). |
DimensionExpression
משמש לציון מאפיין שהוא תוצאה של נוסחה של כמה מאפיינים. שימושים לדוגמה: 1) lowerCase(dimension) 2) שרשור(dimension1, icon, dimension2).
ייצוג JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה איחוד one_expression . יש לציין סוג אחד של ביטוי מאפיין עבור DimensionExpression . one_expression יכול להיות רק אחד מהבאים: |
|
lowerCase |
משמש להמרת ערך של מאפיין לאותיות קטנות. |
upperCase |
משמש להמרת ערך של מאפיין לאותיות רישיות. |
concatenate |
משמש לשילוב ערכי מאפיינים למאפיין אחד. לדוגמה, המאפיין 'מדינה, עיר': שרשור(מדינה, ", ", עיר). |
CaseExpression
משמש להמרת ערך של מאפיין לאותיות גדולות או קטנות.
ייצוג JSON |
---|
{ "dimensionName": string } |
שדות | |
---|---|
dimensionName |
שם של מאפיין. השם חייב להתייחס לשם בשדה המימדים של הבקשה. |
ConcatenateExpression
משמש לשילוב ערכי מאפיינים למאפיין אחד.
ייצוג JSON |
---|
{ "dimensionNames": [ string ], "delimiter": string } |
שדות | |
---|---|
dimensionNames[] |
שמות המאפיינים. השמות חייבים לחזור לשמות בשדה המאפיינים של הבקשה. |
delimiter |
התו המפריד בין שמות המאפיינים. תווים מפרידים הם בדרך כלל תווים יחידים כמו '|' או ',', אבל הם יכולים להיות מחרוזות ארוכות יותר. אם ערך מאפיין מכיל את התו המפריד, שניהם יוצגו בתגובה ללא הבחנה. לדוגמה,אם הערך של מאפיין 1 = "US,FR", ערך של מאפיין 2 = "JP" והתו המפריד = ",", התשובה תכיל את הערכים "US,FR,JP". |
המדד
מדידות כמותיות בדוח. לדוגמה, המדד eventCount
הוא המספר הכולל של האירועים. אפשר לשלוח בקשות עד 10 מדדים.
ייצוג JSON |
---|
{ "name": string, "expression": string, "invisible": boolean } |
שדות | |
---|---|
name |
שם המדד. בקטע מדדי API מופיעה רשימה של שמות המדדים שנתמכים בשיטות דיווח מרכזיות, כמו אם מציינים ההפניה למדדים מתבצעת על ידי |
expression |
ביטוי מתמטי למדדים נגזרים. לדוגמה, המדד 'מספר האירועים לכל משתמש' הוא |
invisible |
מציין אם מדד לא גלוי בתגובת הדוח. אם מדד בלתי נראה, הוא לא יפיק עמודה בתגובה, אבל אפשר להשתמש בו ב- |
DateRange
קבוצת ימים רציפה: startDate
, startDate + 1
, ..., endDate
. אפשר לשלוח בקשות עד 4 טווחי תאריכים.
ייצוג JSON |
---|
{ "startDate": string, "endDate": string, "name": string } |
שדות | |
---|---|
startDate |
תאריך ההתחלה הכולל של השאילתה בפורמט |
endDate |
תאריך הסיום הכולל של השאילתה בפורמט |
name |
הקצאת שם לטווח התאריכים הזה. הערך של המאפיין |
FilterExpression
כדי לציין מסננים של מאפיינים או מדדים. השדות באותו FilterExpression צריכים להיות כל המאפיינים או כל המדדים.
ייצוג JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה איחוד expr . ציון סוג אחד של ביטוי סינון עבור FilterExpression . expr יכול להיות רק אחד מהבאים: |
|
andGroup |
ל-FilterExpressions ב-ו-Group יש קשר AND. |
orGroup |
ל-FilterExpressions או ל-Groups יש קשר OR. |
notExpression |
ה-FilterExpression אינו notExpression. |
filter |
מסנן פרימיטיבי. באותה FilterExpression, כל שמות השדות של המסנן צריכים להיות כל המאפיינים או כל המדדים. |
FilterExpressionList
רשימה של ביטויים לסינון.
ייצוג JSON |
---|
{
"expressions": [
{
object ( |
שדות | |
---|---|
expressions[] |
רשימה של ביטויים לסינון. |
סינון
ביטוי לסינון ערכי מאפיינים או מדדים.
ייצוג JSON |
---|
{ "fieldName": string, // Union field |
שדות | |
---|---|
fieldName |
שם המאפיין או שם המדד. חייב להיות שם שמוגדר במאפיינים או במדדים. |
שדה איחוד one_filter . ציון סוג מסנן אחד עבור Filter . one_filter יכול להיות רק אחד מהבאים: |
|
stringFilter |
מסנן שקשור למחרוזות. |
inListFilter |
מסנן לערכים ברשימה. |
numericFilter |
מסנן לערכים מספריים או לערכים של תאריכים. |
betweenFilter |
מסנן בין שני ערכים. |
StringFilter
סינון לפי מחרוזת
ייצוג JSON |
---|
{
"matchType": enum ( |
שדות | |
---|---|
matchType |
סוג ההתאמה למסנן הזה. |
value |
ערך המחרוזת ששימש להתאמה. |
caseSensitive |
אם הערך הוא True, ערך המחרוזת הוא תלוי אותיות רישיות. |
MatchType
סוג ההתאמה של מסנן מחרוזת
טיפוסים בני מנייה (enums) | |
---|---|
MATCH_TYPE_UNSPECIFIED |
לא צוין |
EXACT |
התאמה מדויקת של ערך המחרוזת. |
BEGINS_WITH |
מתחיל בערך המחרוזת. |
ENDS_WITH |
מסתיים בערך המחרוזת. |
CONTAINS |
מכיל את ערך המחרוזת. |
FULL_REGEXP |
התאמה מלאה של הביטוי הרגולרי לערך המחרוזת. |
PARTIAL_REGEXP |
התאמה חלקית של הביטוי הרגולרי לערך המחרוזת. |
InListFilter
התוצאה צריכה להופיע ברשימה של ערכי מחרוזת.
ייצוג JSON |
---|
{ "values": [ string ], "caseSensitive": boolean } |
שדות | |
---|---|
values[] |
הרשימה של ערכי המחרוזת. אי אפשר להשאיר את השדה ריק. |
caseSensitive |
אם הערך הוא True, ערך המחרוזת הוא תלוי אותיות רישיות. |
NumericFilter
מסננים לערכים מספריים או לערכים של תאריכים.
ייצוג JSON |
---|
{ "operation": enum ( |
שדות | |
---|---|
operation |
סוג הפעולה למסנן הזה. |
value |
ערך מספרי או ערך תאריך. |
פעולה
הפעולה שהוחלה על מסנן מספרי
טיפוסים בני מנייה (enums) | |
---|---|
OPERATION_UNSPECIFIED |
לא צוין. |
EQUAL |
שווה |
LESS_THAN |
פחות מ- |
LESS_THAN_OR_EQUAL |
פחות מ- או שווה ל- |
GREATER_THAN |
גדול מ- |
GREATER_THAN_OR_EQUAL |
גדול מ- או שווה ל- |
NumericValue
שמייצג מספר.
ייצוג JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה איחוד one_value . אחד מהערכים המספריים של one_value יכול להיות רק אחד מהערכים הבאים: |
|
int64Value |
ערך של מספר שלם |
doubleValue |
ערך כפול |
BetweenFilter
כדי לבטא שהתוצאה צריכה להיות בין שני מספרים (כולל).
ייצוג JSON |
---|
{ "fromValue": { object ( |
שדות | |
---|---|
fromValue |
מתחיל במספר הזה. |
toValue |
מסתיים במספר הזה. |
MetricAggregation
מייצג צבירה של מדדים.
טיפוסים בני מנייה (enums) | |
---|---|
METRIC_AGGREGATION_UNSPECIFIED |
אופרטור לא צוין. |
TOTAL |
אופרטור SUM. |
MINIMUM |
אופרטור מינימלי. |
MAXIMUM |
אופרטור מקסימלי. |
COUNT |
אופרטור ספירה. |
OrderBy
מיון לפי סדר לפי מגדיר איך השורות ימוינו בתשובה. לדוגמה, סידור שורות לפי מספר האירועים בסדר יורד, וסידור השורות לפי המחרוזת של שם האירוע בסדר שונה.
ייצוג JSON |
---|
{ "desc": boolean, // Union field |
שדות | |
---|---|
desc |
אם הערך הוא true, מיון לפי סדר יורד. |
שדה איחוד one_order_by . יש לציין סוג אחד של סידור לפי עבור OrderBy . one_order_by יכול להיות רק אחד מהבאים: |
|
metric |
מיון התוצאות לפי ערכי המדד. |
dimension |
ממיין תוצאות לפי ערכי המאפיין. |
MetricOrderBy
מיון לפי ערכי מדדים.
ייצוג JSON |
---|
{ "metricName": string } |
שדות | |
---|---|
metricName |
שם מדד בבקשה לביצוע ההזמנה לפי. |
DimensionOrderBy
מיון לפי ערכי מאפיינים.
ייצוג JSON |
---|
{
"dimensionName": string,
"orderType": enum ( |
שדות | |
---|---|
dimensionName |
שם המאפיין בבקשה לביצוע ההזמנה לפי. |
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 ( |
שדות | |
---|---|
cohorts[] |
מגדיר את קריטריוני הבחירה לקיבוץ משתמשים לקבוצות בעלות מאפיינים משותפים. ברוב הדוחות על קבוצה בעלת מאפיינים משותפים, מוגדרת רק קבוצה אחת בעלת מאפיינים משותפים. אם ציינתם מספר קבוצות בעלות מאפיינים משותפים, המערכת יכולה לזהות בדוח כל קבוצה בעלת מאפיינים משותפים לפי השם שלה. |
cohortsRange |
דוחות על קבוצות בעלות מאפיינים משותפים עוקבים אחרי קבוצות בעלות מאפיינים משותפים לאורך טווח תאריכים ארוך יותר לדיווח. הטווח הזה מציין את משך ההיסט שאחריו צריך לעקוב אחרי הקבוצות בעלות המאפיינים המשותפים. |
cohortReportSettings |
הגדרות אופציונליות לדוח על קבוצה בעלת מאפיינים משותפים. |
קבוצה בעלת מאפיינים משותפים
מגדיר קריטריונים לבחירת קבוצה בעלת מאפיינים משותפים. קבוצה בעלת מאפיינים משותפים היא קבוצה של משתמשים שחולקים מאפיין משותף. לדוגמה, משתמשים עם אותו firstSessionDate
שייכים לאותה קבוצה בעלת מאפיינים משותפים.
ייצוג JSON |
---|
{
"name": string,
"dimension": string,
"dateRange": {
object ( |
שדות | |
---|---|
name |
הקצאת שם לקבוצה בעלת המאפיינים המשותפים. הערך של המאפיין |
dimension |
המאפיין שמשמש את הקבוצה בעלת המאפיינים המשותפים. נדרש ותומך רק ב- |
dateRange |
הקבוצה בעלת המאפיינים המשותפים בוחרת משתמשים שתאריך המגע הראשון שלהם הוא בין תאריך ההתחלה לבין תאריך הסיום שהוגדר ב- בבקשה לקבוצה בעלת מאפיינים משותפים, השדה באופן כללי, |
CohortsRange
הגדרת טווח תאריכי הדיווח המורחב לדוח על קבוצה בעלת מאפיינים משותפים. מציין את משך היסט שאחריו רוצים לעקוב אחר הקבוצות בעלות המאפיינים המשותפים.
ייצוג JSON |
---|
{
"granularity": enum ( |
שדות | |
---|---|
granularity |
חובה. רמת הפירוט המשמשת לפירוש הנתונים |
startOffset |
הערך אם הערך של אם הערך של אם הערך של |
endOffset |
חובה. הערך אם הערך של אם הערך של אם הערך של |
רמת פירוט
רמת הפירוט המשמשת לפירוש הנתונים startOffset
ו-endOffset
בטווח התאריכים של הדיווח המורחב על דוח על קבוצה בעלת מאפיינים משותפים.
טיפוסים בני מנייה (enums) | |
---|---|
GRANULARITY_UNSPECIFIED |
אין לציין אף פעם. |
DAILY |
רמת פירוט יומית. בדרך כלל הערך הזה משמש אם המאפיין dateRange של קבוצה בעלת מאפיינים משותפים הוא יום אחד והבקשה מכילה cohortNthDay . |
WEEKLY |
רמת פירוט שבועית. לרוב, המאפיין 'dateRange ' של הקבוצה בעלת המאפיינים המשותפים נמשך שבוע (מתחיל ביום ראשון ומסתיים בשבת) והבקשה כוללת cohortNthWeek . |
MONTHLY |
רמת פירוט חודשית. בדרך כלל משמש אם המאפיין dateRange של הקבוצה בעלת המאפיינים המשותפים נמשך חודש והבקשה כוללת cohortNthMonth . |
CohortReportSettings
הגדרות אופציונליות של דוח על קבוצה בעלת מאפיינים משותפים.
ייצוג JSON |
---|
{ "accumulate": boolean } |
שדות | |
---|---|
accumulate |
אם הערך הוא true, המערכת צוברת את התוצאה מיום המגע הראשון עד ליום הסיום. אין תמיכה ב |
ReportMetadata
מטא-נתונים של דוח למשימת דיווח ספציפית.
ייצוג JSON |
---|
{
"creationQuotaTokensCharged": integer,
"state": enum ( |
שדות | |
---|---|
creationQuotaTokensCharged |
פלט בלבד. סך אסימוני המכסה שחויבו במהלך יצירת הדוח. מספר האסימונים הזה מבוסס על פעילות במצב |
state |
פלט בלבד. המצב הנוכחי של משימת הדוח הזו. |
beginCreatingTime |
פלט בלבד. השעה שבה בוצעה קריאה ל- חותמת זמן בפורמט "זולו" RFC3339 UTC, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
taskRowCount |
פלט בלבד. המספר הכולל של השורות בתוצאת הדוח. השדה הזה יאוכלס כשהמדינה פעילה. אפשר להשתמש ב |
errorMessage |
פלט בלבד. הודעת השגיאה תאוכלס אם משימת דוח נכשלת במהלך היצירה. |
totalRowCount |
פלט בלבד. המספר הכולל של שורות באחסון של Google Analytics. אם רוצים להריץ שאילתות על שורות נתונים נוספות מעבר לדוח הנוכחי, אפשר ליצור משימת דוח חדשה על סמך
לדוגמה, נניח שהשדה |
ארץ
מצב העיבוד.
טיפוסים בני מנייה (enums) | |
---|---|
STATE_UNSPECIFIED |
אף פעם לא ייעשה שימוש במצב שלא צוין. |
CREATING |
הדוח נמצא כרגע בשלבי יצירה ויהיה זמין בעתיד. היצירה מתרחשת מיד לאחר הקריאה ל-CreateReport. |
ACTIVE |
הדוח נוצר במלואו ומוכן לשאילתות. |
FAILED |
יצירת הדוח נכשלה. |
שיטות |
|
---|---|
|
מתחיל ליצור משימת דוח. |
|
קבלת מטא-נתונים של דוחות לגבי משימת דיווח ספציפית. |
|
רשימה של כל משימות הדיווח של נכס. |
|
אחזור התוכן של משימת דיווח. |