- משאב: 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[] |
זה שינוי אופציונלי. צבירת מדדים. ערכי המדדים המצטברים יוצגו בשורות שבהן ה-attributeValues מוגדר כ-"RESERVED_(MetricAggregation)". |
orderBys[] |
זה שינוי אופציונלי. מציינת את סדר השורות בתגובה. |
currencyCode |
זה שינוי אופציונלי. קוד מטבע בפורמט ISO4217, למשל 'AED', 'USD', 'JPY'. אם השדה ריק, הדוח יתבסס על מטבע ברירת המחדל של הנכס. |
cohortSpec |
זה שינוי אופציונלי. קבוצה בעלת מאפיינים משותפים שמשויכת לבקשה הזו. אם הבקשה מכילה קבוצה בעלת מאפיינים משותפים, הבקשה כוללת את ה'קבוצה בעלת מאפיינים משותפים' חייב להיות קיים. |
keepEmptyRows |
זה שינוי אופציונלי. אם הערך הוא False או לא צוין, לא תוחזר כל שורה שבה כל המדדים שווים ל-0. אם הערך הוא True, השורות האלה יוחזרו אם המסנן לא מסיר אותן בנפרד. בלי קשר להגדרת לדוגמה, אם נכס אף פעם לא מתועד אירוע |
מאפיין
המאפיינים הם מאפייני הנתונים. לדוגמה, המאפיין 'עיר' מציין את העיר שממנה הגיע האירוע. ערכי המאפיינים בתגובות לדוחות הם מחרוזות. לדוגמה, העיר יכולה להיות "פריז" או 'ניו יורק'.
ייצוג JSON |
---|
{
"name": string,
"dimensionExpression": {
object ( |
שדות | |
---|---|
name |
שם המאפיין. כאן אפשר למצוא רשימה של שמות מאפיינים שנתמכים על ידי שיטות דיווח מרכזיות, כמו אם צוין יש הפניה למאפיינים מ- |
dimensionExpression |
מאפיין אחד יכול להיות תוצאה של ביטוי של מספר מאפיינים. לדוגמה, המאפיין 'מדינה, עיר': שרשור(מדינה, ", ", עיר). |
DimensionExpression
משמשת לציון מאפיין שהוא תוצאה של מספר מאפיינים. שימושים לדוגמה: 1) lowerCase(dimension) 2) concatenate(dimension1, km, 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
כדי לתאר מסננים של מאפיינים או מדדים. השדות באותו מסנן ביטוי צריכים להיות כל המאפיינים או כל המדדים.
ייצוג JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה איחוד expr . צריך לציין סוג אחד של ביטוי סינון עבור FilterExpression . expr יכול להיות רק אחת מהאפשרויות הבאות: |
|
andGroup |
ל-FilterExpressions ב- andGroup יש קשר AND. |
orGroup |
לביטויי הסינון ב-orGroup יש קשר OR. |
notExpression |
FilterExpression הוא לא notExpression |
filter |
פילטר פרימיטיבי. באותו מסנן ביטוי, כל שמות השדות של המסנן צריכים להיות כל המאפיינים או כל המדדים. |
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
סוג ההתאמה של מסנן מחרוזות
טיפוסים בני מנייה (enum) | |
---|---|
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 |
ערך מספרי או ערך תאריך. |
פעולה
הפעולה שהוחלה על מסנן מספרי
טיפוסים בני מנייה (enum) | |
---|---|
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
מייצג צבירה של מדדים.
טיפוסים בני מנייה (enum) | |
---|---|
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
כלל שלפיו יש לסדר את ערכי המאפיין של המחרוזת.
טיפוסים בני מנייה (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 ( |
שדות | |
---|---|
cohorts[] |
מגדיר את הקריטריונים לבחירה לקיבוץ משתמשים בקבוצות בעלות מאפיינים משותפים. ברוב הדוחות על קבוצות בעלות מאפיינים משותפים מוגדרת רק קבוצה אחת בעלת מאפיינים משותפים. אם ציינת כמה קבוצות בעלות מאפיינים משותפים, אפשר לזהות כל קבוצה בעלת מאפיינים משותפים בדוח לפי השם שלה. |
cohortsRange |
דוחות על קבוצות בעלות מאפיינים משותפים עוקבים אחרי קבוצות בעלות מאפיינים משותפים לאורך טווח תאריכים ארוך של דיווח. הטווח הזה מציין משך קיזוז למעקב אחרי הקבוצות בעלות המאפיינים המשותפים. |
cohortReportSettings |
הגדרות אופציונליות לדוח על קבוצה בעלת מאפיינים משותפים. |
קבוצה בעלת מאפיינים משותפים
מגדיר קריטריון לבחירת קבוצה בעלת מאפיינים משותפים. קבוצה בעלת מאפיינים משותפים היא קבוצה של משתמשים שחולקים מאפיין משותף. לדוגמה, משתמשים עם אותו מאפיין firstSessionDate
שייכים לאותה קבוצה בעלת מאפיינים משותפים.
ייצוג JSON |
---|
{
"name": string,
"dimension": string,
"dateRange": {
object ( |
שדות | |
---|---|
name |
הקצאת שם לקבוצה בעלת המאפיינים המשותפים הזאת. המאפיין |
dimension |
המאפיין ששימש את הקבוצה בעלת המאפיינים המשותפים. נדרש ותומך רק ב- |
dateRange |
הקבוצה בעלת המאפיינים המשותפים בוחרים משתמשים שתאריך המגע הראשון שלהם הוא בין תאריך ההתחלה לתאריך הסיום שמוגדר ב בבקשת קבוצה בעלת מאפיינים משותפים, חובה לציין את ה באופן כללי, הערך של |
CohortsRange
הגדרת טווח תאריכי הדיווח המורחב בדוח על קבוצה בעלת מאפיינים משותפים. מציינת את משך הקיזוז למעקב אחר הקבוצות בעלות המאפיינים המשותפים.
ייצוג JSON |
---|
{
"granularity": enum ( |
שדות | |
---|---|
granularity |
חובה. רמת הפירוט שמשמשת לפירוש הנתונים |
startOffset |
אם הערך של אם הערך של אם הערך של |
endOffset |
חובה. אם הערך של אם הערך של אם הערך של |
רמת פירוט
רמת הפירוט שמשמשת לפירוש הנתונים startOffset
ו-endOffset
בטווח תאריכי הדיווח המורחב של דוח על קבוצה בעלת מאפיינים משותפים.
טיפוסים בני מנייה (enum) | |
---|---|
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 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
taskRowCount |
פלט בלבד. מספר השורות הכולל בתוצאת הדוח. השדה הזה יאוכלס כשהמדינה תהיה פעילה. אפשר להשתמש ב |
errorMessage |
פלט בלבד. הודעת השגיאה מאוכלסת אם משימת דיווח נכשלה במהלך היצירה. |
totalRowCount |
פלט בלבד. מספר השורות הכולל באחסון ב-Google Analytics. אם רוצים להריץ שאילתות על שורות נתונים נוספות מעבר לדוח הנוכחי, אפשר ליצור משימת דוח חדשה על סמך השדה הערך לדוגמה, נניח ש- |
מדינה
מצב העיבוד.
טיפוסים בני מנייה (enum) | |
---|---|
STATE_UNSPECIFIED |
המערכת אף פעם לא תשתמש במצב שלא צוין. |
CREATING |
המערכת יוצרת את הדוח כרגע, והוא יהיה זמין בעתיד. היצירה מתבצעת מיד לאחר הקריאה ל-CreateReport. |
ACTIVE |
הדוח נוצר במלואו ומוכן לשליחת שאילתות. |
FAILED |
יצירת הדוח נכשלה. |
שיטות |
|
---|---|
|
התחלת יצירה של משימת דיווח. |
|
קבלת מטא-נתונים של דוח לגבי משימת דוח ספציפית. |
|
בתיבת הדו-שיח הזו מפורטים כל המשימות של דיווח בנכס. |
|
אחזור התוכן של משימת דיווח. |