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 Dimensions מופיעים שמות המאפיינים שנתמכים על ידי שיטות הדיווח העיקריות, כמו 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, אפשר לקרוא למדד הזה name = 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_. אם לא מגדירים שם, טווחי התאריכים מקבלים שם לפי האינדקס שלהם בבקשה (החל מ-0): 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

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

סינון לפי ערכים ריקים. תואם לערכי מאפיינים שהם ערכים של "" או (not set). אפשר להשתמש במסנן הזה כדי להתאים שורות עם ערכי מאפיינים חסרים או לא מאוכלסים, או לשלב אותו עם notExpression כדי להחריג אותן מדוח בלי לסנן בנפרד לפי "" וגם לפי (not set).

MetricAggregation

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

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

OrderBy

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

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

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