- בקשת HTTP
- גוף הבקשה
- גוף התשובה
- היקפי ההרשאות
- ReportRequest
- דגימה
- מאפיין
- DimensionFilterClause
- FilterLogicalOperator
- DimensionFilter
- אופרטור
- מדד
- MetricType
- MetricFilterClause
- MetricFilter
- אופרטור
- OrderBy
- OrderType
- SortOrder
- פילוח
- DynamicSegment
- SegmentDefinition
- SegmentFilter
- SimpleSegment
- OrFiltersForSegment
- SegmentFilterClause
- SegmentDimensionFilter
- אופרטור
- SegmentMetricFilter
- היקף
- אופרטור
- SequenceSegment
- SegmentSequenceStep
- MatchType
- טבלת צירים
- CohortGroup
- קבוצה בעלת מאפיינים משותפים
- סוג
- דיווח
- ColumnHeader
- MetricHeader
- MetricHeaderEntry
- PivotHeader
- PivotHeaderEntry
- ReportData
- ReportRow
- DateRangeValues
- PivotValueRegion
- ResourceQuotasRemaining
- רוצים לנסות?
מחזירה את נתוני Analytics.
בקשת HTTP
POST https://analyticsreporting.googleapis.com/v4/reports:batchGet
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON | |
---|---|
{
"reportRequests": [
{
object( |
שדות | |
---|---|
reportRequests[] |
לבקשות, לכל בקשה תהיה תגובה נפרדת. אפשר לשלוח עד 5 בקשות. כל הבקשות צריכות לכלול את אותם פריטי |
useResourceQuotas |
מפעיל מכסות מבוססות-משאבים, (ברירת המחדל היא |
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:
מחלקת התגובה הראשית שמכילה את הדוחות מהקריאה ל-batchGet
של Reporting API.
ייצוג JSON | |
---|---|
{ "reports": [ { object( |
שדות | |
---|---|
reports[] |
תשובות שמתאימות לכל אחת מהבקשות. |
queryCost |
סכום אסימוני מכסת המשאבים שנוכו לצורך ביצוע השאילתה. כולל את כל התשובות. |
resourceQuotasRemaining |
הכמות של מכסת המשאבים שנותרה בנכס. |
היקפי ההרשאות
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
ReportRequest
מחלקת הבקשה הראשית שמציינת את בקשת Reporting API.
ייצוג JSON | |
---|---|
{ "viewId": string, "dateRanges": [ { object( |
שדות | |
---|---|
viewId |
מזהה התצוגה המפורטת ב-Analytics שממנו יש לאחזר נתונים. כל ReportRequest במסגרת שיטת |
dateRanges[] |
טווחי התאריכים בבקשה. הבקשה יכולה לכלול עד 2 טווחי תאריכים. התשובה תכיל קבוצה של ערכי מדדים לכל שילוב של המאפיינים עבור כל טווח תאריכים בבקשה. כך, אם קיימים שני טווחי תאריכים, תתבצע שתי קבוצות של ערכי מדדים, אחת לטווח התאריכים המקורי והשנייה לטווח התאריכים השני. אין לציין את השדה |
samplingLevel |
גודל המדגם הרצוי של הדוח. אם לא צוין השדה |
dimensions[] |
המאפיינים המבוקשים. לבקשות יכולים להיות 9 מאפיינים בסך הכול. |
dimensionFilterClauses[] |
הסעיפים של סינון המאפיינים לסינון ערכי מאפיינים. הם משולבים באופן לוגי עם האופרטור |
metrics[] |
המדדים המבוקשים. בבקשות חייבות לציין לפחות מדד אחד. הבקשות יכולות לכלול עד 10 מדדים. |
metricFilterClauses[] |
סעיף סינון המדדים. הם משולבים באופן לוגי עם האופרטור |
filtersExpression |
מסננים של מאפיינים או מדדים שמגבילים את הנתונים המוחזרים עבור הבקשה שלכם. כדי להשתמש במאפיין |
orderBys[] |
סדר המיון בשורות הפלט. כדי להשוות בין שתי שורות, המערכת מחילה את הרכיבים הבאים לפי הסדר עד שיימצא הבדל. כל טווחי התאריכים בפלט מקבלים אותו סדר השורות. |
segments[] |
מפלחים את הנתונים שהוחזרו עבור הבקשה. הגדרת פלח עוזרת לבחון קבוצת משנה של בקשת הפלח. בקשה יכולה להכיל עד ארבעה קטעים. כל ReportRequest במסגרת שיטת |
pivots[] |
הגדרות הציר. לבקשות יכולים להיות עד 2 צירים. |
cohortGroup |
קבוצה בעלת מאפיינים משותפים שמשויכת לבקשה הזו. אם יש בבקשה קבוצה בעלת מאפיינים משותפים, המאפיין |
pageToken |
אסימון המשך לקבלת הדף הבא של התוצאות. הוספת הפרמטר הזה לבקשה תחזיר את השורות שאחרי ה-pageToken. ה-pageToken צריך להיות הערך שהוחזר בפרמטר nextPageToken בתגובה לבקשה Reports.batchGet. |
pageSize |
גודל הדף מיועד לדפים, ומציין את המספר המקסימלי של שורות שהוחזרו. גודל הדף צריך להיות >= 0. שאילתה מחזירה את ברירת המחדל של 1,000 שורות. ממשק ה-API הראשי לדיווח של Analytics מחזיר עד 100,000 שורות לבקשה, ללא קשר לכמות שתבקש. הוא יכול גם להחזיר פחות שורות ממה שביקשת, אם אין מספיק פלחי מאפיינים ממה שציפיתם. לדוגמה, יש פחות מ-300 ערכים אפשריים למאפיין |
includeEmptyRows |
אם הערך מוגדר כ-False, התשובה לא תכלול שורות אם כל המדדים שאוחזרו שווים לאפס. ברירת המחדל היא FALSE, שתחריג את השורות האלה. |
hideTotals |
אם היא מוגדרת כ-True, המערכת מסתירה את סך כל המדדים בכל השורות התואמות, בכל טווח תאריכים. ערך ברירת המחדל False ויחזיר את הסכומים הכוללים. |
hideValueRanges |
אם קובעים את ההגדרה True, המערכת מסתירה את ערכי המינימום והמקסימום בכל השורות התואמות. ברירת המחדל היא False וטווחי הערכים מוחזרים. |
דגימות
ערכים של רמת הדגימה.
טיפוסים בני מנייה (enums) | |
---|---|
SAMPLING_UNSPECIFIED |
אם לא צוין השדה samplingLevel , ייעשה שימוש ברמת הדגימה DEFAULT . |
DEFAULT |
הפונקציה מחזירה תגובה בגודל דגימה שמאזן את המהירות והדיוק. |
SMALL |
התוצאה היא תגובה מהירה עם דגימה קטנה יותר. |
LARGE |
מחזירה תגובה מדויקת יותר באמצעות דגימה גדולה. עם זאת, ייתכן שכתוצאה מכך התגובה תהיה איטית יותר. |
המאפיין
מאפיינים הם מאפייני הנתונים. לדוגמה, המאפיין ga:city
מציין את העיר, למשל, פריז או ניו יורק, שממנה הגיע הביקור באתר.
ייצוג JSON | |
---|---|
{ "name": string, "histogramBuckets": [ string ] } |
שדות | |
---|---|
name |
שם המאפיין שרוצים לאחזר, לדוגמה |
histogramBuckets[] |
אם השדה לא ריק, אנחנו מציבים את ערכי המאפיינים בקטגוריות אחרי המחרוזת ל-int64. ערכי מאפיין שאינם ייצוג המחרוזת של ערך אינטגרלי יומרו לאפס. ערכי הקטגוריה חייבים להיות בסדר עולה. כל קטגוריה סגורה בקצה התחתון ופתוחה בקצה העליון. הקטגוריה "first" כוללת את כל הערכים פחות מהגבול הראשון, הקטגוריה "האחרונה" כוללת את כל הערכים עד אינסוף. ערכי מאפיינים שנכללים בקטגוריה משתנים לערך חדש של מאפיין. לדוגמה, אם מוצגת רשימה של '0, 1, 3, 4, 7', נחזיר את הקטגוריות הבאות:
הערה: אם מחילים מוטציה של היסטוגרמה על מימד כלשהו ומשתמשים במאפיין הזה במיון, צריך להשתמש בסוג המיון '<50', '1001+', '121-1000', '50-120' והסדר עולה של "<50", "50-120", "121-1000", "1001+" הלקוח צריך לבקש במפורש |
DimensionFilterClause
קבוצה של מסנני מאפיינים. כדי לציין את אופן השילוב הלוגי של המסננים, מגדירים את ערך האופרטור.
ייצוג JSON | |
---|---|
{ "operator": enum( |
שדות | |
---|---|
operator |
האופרטור לשילוב של כמה מסנני מאפיינים. אם לא צוין, הוא נחשב כ- |
filters[] |
קבוצת המסננים החוזרת. הם משולבים באופן לוגי בהתאם לאופרטור שצוין. |
FilterLogicalOperator
האופן שבו המסננים משולבים באופן לוגי.
טיפוסים בני מנייה (enums) | |
---|---|
OPERATOR_UNSPECIFIED |
אופרטור לא צוין. הוא נחשב OR . |
OR |
האופרטור הלוגי OR . |
AND |
האופרטור הלוגי AND . |
DimensionFilter
מסנן המאפיינים מציין את אפשרויות הסינון של מאפיין.
ייצוג JSON | |
---|---|
{
"dimensionName": string,
"not": boolean,
"operator": enum( |
שדות | |
---|---|
dimensionName |
המאפיין שלפיו רוצים לסנן. DimensionsFilter חייב להכיל מאפיין. |
not |
אופרטור לוגי |
operator |
איך להתאים את המאפיין לביטוי. ברירת המחדל היא REGEXP. |
expressions[] |
מחרוזות או ביטוי רגולרי להתאמה. רק הערך הראשון ברשימה ישמש להשוואה, אלא אם האופרטור הוא |
caseSensitive |
האם ההתאמה צריכה להיות תלוית אותיות רישיות? ברירת המחדל היא False. |
מפעיל
סוגי התאמה שונים נתמכים.
טיפוסים בני מנייה (enums) | |
---|---|
OPERATOR_UNSPECIFIED |
אם סוג ההתאמה לא צוין, הוא יטופל כ-REGEXP . |
REGEXP |
הביטוי של ההתאמה נחשב לביטוי רגולרי. לא כל סוגי ההתאמה מטופלים כביטויים רגולריים. |
BEGINS_WITH |
תואם לערך שמתחיל בביטוי ההתאמה שצוין. |
ENDS_WITH |
תואם לערכים שמסתיימים בביטוי ההתאמה שסופק. |
PARTIAL |
התאמה למחרוזת משנה. |
EXACT |
הערך צריך להיות תואם באופן מלא לביטוי ההתאמה. |
NUMERIC_EQUAL |
מסננים להשוואה של מספרים שלמים. המערכת מתעלמת מהתלות של אותיות רישיות (case-sensitivity) בהגדרות האלה, והביטוי נחשב למחרוזת שמייצגת מספר שלם. התנאים לכשל:
|
NUMERIC_GREATER_THAN |
בודקת אם המאפיין גדול המספר מבחינה מספרית מביטוי ההתאמה. צריך לקרוא את התיאור של NUMERIC_EQUALS למידע על ההגבלות. |
NUMERIC_LESS_THAN |
בודקת אם המאפיין קטן המספר מבחינה מספרית מביטוי ההתאמה. צריך לקרוא את התיאור של NUMERIC_EQUALS למידע על ההגבלות. |
IN_LIST |
אפשרות זו משמשת לציון מסנן מאפיינים שהביטוי שלו יכול לקבל כל ערך מרשימת ערכים נבחרת. כך תוכלו להימנע מהערכה של כמה מסננים של מאפיינים בהתאמה מדויקת, שהמערכת בודקת אם מופעלת בהם האופרטור OR בכל שורת תגובה. למשל:
כל שורת תגובה שהמאפיין הזה כולל את הערך א', ב' או ג', תואמת ל'מסנן המאפיין' הזה. |
המדד
מדדים הם האומדנים הכמותיים. לדוגמה, המדד ga:users
מציין את המספר הכולל של המשתמשים בתקופת הזמן המבוקשת.
ייצוג JSON | |
---|---|
{
"expression": string,
"alias": string,
"formattingType": enum( |
שדות | |
---|---|
expression |
ביטוי של מדד בבקשה. ביטוי מורכב ממספר אחד או יותר וממדד אחד או יותר. האופרטורים שבהם אפשר להשתמש כוללים את סימן הפלוס (+), מינוס (-), השלילה (Unary -), חילוק ב- (/), הכפלה ב- (*), סוגריים, מספרים קרדינלים חיוביים (0-9). האופרטורים יכולים לכלול ספרות אחרי הנקודה העשרונית ומוגבל ל-1024 תווים. לדוגמה |
alias |
כינוי לביטוי המדד הוא שם חלופי לביטוי. ניתן להשתמש בכתובת החלופית לסינון ולמיון. השדה הזה הוא אופציונלי והוא שימושי אם הביטוי הוא לא מדד יחיד, אלא ביטוי מורכב שלא ניתן להשתמש בו בסינון ובמיון. הכינוי משמש גם בכותרת עמודת התגובה. |
formattingType |
מציין את הפורמט של ביטוי המדד, לדוגמה |
MetricType
סוגי המדדים.
טיפוסים בני מנייה (enums) | |
---|---|
METRIC_TYPE_UNSPECIFIED |
לא צוין סוג המדד. |
INTEGER |
מדד מסוג מספר שלם. |
FLOAT |
מדד צף. |
CURRENCY |
מדד מטבע. |
PERCENT |
אחוז. |
TIME |
מדד זמן בפורמט HH:MM:SS . |
MetricFilterClause
מייצג קבוצה של מסנני מדדים. כדי לציין את אופן השילוב הלוגי של המסננים, מגדירים את ערך האופרטור.
ייצוג JSON | |
---|---|
{ "operator": enum( |
שדות | |
---|---|
operator |
האופרטור לשילוב מסננים של כמה מדדים. אם לא צוין, הוא נחשב כ- |
filters[] |
קבוצת המסננים החוזרת. הם משולבים באופן לוגי בהתאם לאופרטור שצוין. |
MetricFilter
הערך MetricFilter מציין את המסנן של המדד.
ייצוג JSON | |
---|---|
{
"metricName": string,
"not": boolean,
"operator": enum( |
שדות | |
---|---|
metricName |
המדד שלפיו יתבצע הסינון. מסנן מדדים חייב להכיל שם של מדד. שם מדד יכול להיות כינוי שהוגדר קודם לכן כמדד, או להיות ביטוי של מדד. |
not |
אופרטור לוגי |
operator |
האם המדד |
comparisonValue |
הערך שאליו יש להשוות. |
מפעיל
אפשרויות שונות של סוגי השוואה.
טיפוסים בני מנייה (enums) | |
---|---|
OPERATOR_UNSPECIFIED |
אם האופרטור לא צוין, המערכת תתייחס אליו בתור EQUAL . |
EQUAL |
האם ערך המדד צריך להיות שווה בדיוק לערך ההשוואה. |
LESS_THAN |
האם ערך המדד צריך להיות נמוך מערך ההשוואה. |
GREATER_THAN |
האם ערך המדד צריך להיות גדול מערך ההשוואה. |
IS_MISSING |
הפונקציה בודקת אם המדד חסר. לא נלקחת בחשבון השוואה של ValueValue. |
OrderBy
מציין את אפשרויות המיון.
ייצוג JSON | |
---|---|
{ "fieldName": string, "orderType": enum( |
שדות | |
---|---|
fieldName |
השדה שלפיו רוצים למיין. סדר המיון שמוגדר כברירת מחדל הוא בסדר עולה. דוגמה: |
orderType |
סוג ההזמנה. ערך ברירת המחדל של orderType הוא |
sortOrder |
סדר המיון של השדה. |
OrderType
OrderType קובע איך נקבע סדר המיון.
טיפוסים בני מנייה (enums) | |
---|---|
ORDER_TYPE_UNSPECIFIED |
סוג הזמנה שלא צוין יטופל כמיון המבוסס על ערך. |
VALUE |
סדר המיון מבוסס על הערך בעמודה שנבחרה. הוא מתייחס רק לטווח התאריכים הראשון. |
DELTA |
סדר המיון מבוסס על ההפרש בין הערכים בעמודה שנבחרה משני טווחי התאריכים הראשונים. ניתן להשתמש רק אם יש שני טווחי תאריכים בדיוק. |
SMART |
סדר המיון מבוסס על הערך המשוקלל של העמודה שנבחרה. אם לעמודה יש פורמט n/d, אפשר יהיה להשתמש בערך המשוקלל של היחס הזה (n + totals.n)/(d + totals.d) רק עבור מדדים שמייצגים יחסים. |
HISTOGRAM_BUCKET |
סוג סדר ההיסטוגרמה רלוונטי רק לעמודות מימדים עם קטגוריות היסטוגרמה שאינן ריקות. |
DIMENSION_AS_INTEGER |
אם הממדים הם מספרים באורך קבוע, מיון רגיל יפעל בצורה תקינה. אפשר להשתמש בפונקציה DIMENSION_AS_INTEGER אם המאפיינים הם מספרים באורך משתנה. |
SortOrder
סדר המיון של המיון.
טיפוסים בני מנייה (enums) | |
---|---|
SORT_ORDER_UNSPECIFIED |
אם סדר המיון לא צוין, ברירת המחדל היא עולה. |
ASCENDING |
מיון בסדר עולה. השדה ימוין בסדר עולה. |
DESCENDING |
מיון בסדר יורד. השדה ימוין בסדר יורד. |
פילוח
הגדרת הפלח, אם צריך לפלח את הדוח. פלח הוא קבוצת משנה של נתונים ב-Google Analytics. לדוגמה, מתוך קבוצה כוללת של משתמשים, אפשר ליצור פלח של משתמשים מעיר או ממדינה מסוימות.
ייצוג JSON | |
---|---|
{ // Union field |
שדות | ||
---|---|---|
שדה איחוד dynamicOrById . אפשר להגדיר את הפלח באופן דינמי באמצעות פילוח דינמי או על ידי שימוש במזהה של פלח מובנה או פלח מותאם אישית. dynamicOrById יכול להיות רק אחד מהבאים: |
||
dynamicSegment |
הגדרת פלח דינמי בבקשה. |
|
segmentId |
מזהה הפלח של פלח מובנה או פלח בהתאמה אישית, לדוגמה |
DynamicSegment
הגדרת פלח דינמי להגדרת הפלח בתוך הבקשה. פלח יכול לבחור משתמשים, ביקורים או את שניהם.
ייצוג JSON | |
---|---|
{ "name": string, "userSegment": { object( |
שדות | |
---|---|
name |
שם הפלח הדינמי. |
userSegment |
פלח משתמשים כדי לבחור משתמשים שייכללו בפלח. |
sessionSegment |
פלח של ביקורים כדי לבחור את הסשנים שייכללו בפלח. |
SegmentDefinition
הגדרת פלח מגדירה את הפלח כקבוצה של מסנני פלח שמשולבים יחד עם פעולת AND
לוגית.
ייצוג JSON | |
---|---|
{
"segmentFilters": [
{
object( |
שדות | |
---|---|
segmentFilters[] |
פלח מוגדר באמצעות קבוצה של מסנני פלחים שמשולבים יחד עם פעולת |
SegmentFilter
segmentFilter מגדיר את הפלח כפלח פשוט או כפלח של רצף. תנאי פשוט לפלח מכיל תנאים של מאפיינים ומדדים לבחירת הסשנים או המשתמשים. תנאי של פלח רצף יכול לשמש לבחירת משתמשים או סשנים על סמך תנאים רציפים.
ייצוג JSON | |
---|---|
{ "not": boolean, // Union field |
שדות | ||
---|---|---|
not |
אם הערך הוא True, יש להתאים את ההשלמה של מקטע פשוט או קטע רצף. לדוגמה, כדי להתאים את כל הביקורים שמקורם ב "ניו יורק", נוכל להגדיר את הפלח באופן הבא:
|
|
שדה איחוד simpleOrSequence . האם זה מקטע פשוט או הגדרה של פלח רצף. simpleOrSequence יכול להיות רק אחד מהבאים: |
||
simpleSegment |
תנאי פילוח פשוטים כוללים תנאי אחד או יותר של מאפיין/מדד, שניתן לשלב |
|
sequenceSegment |
תנאי הרצף כוללים שלב אחד או יותר, כאשר כל שלב מוגדר לפי תנאי אחד או יותר של מאפיין/מדד. אפשר לשלב כמה שלבים עם אופרטורים של רצף מיוחדים. |
SimpleSegment
תנאי פילוח פשוטים כוללים תנאי אחד או יותר של מאפיין/מדד, שניתן לשלב.
ייצוג JSON | |
---|---|
{
"orFiltersForSegment": [
{
object( |
שדות | |
---|---|
orFiltersForSegment[] |
רשימה של קבוצות של מסנני פלחים שמשולבות עם האופרטור הלוגי |
OrFiltersForSegment
רשימה של מסנני פלחים בקבוצה OR
משולבת עם האופרטור הלוגי OR.
ייצוג JSON | |
---|---|
{
"segmentFilterClauses": [
{
object( |
שדות | |
---|---|
segmentFilterClauses[] |
רשימת מסנני פלחים לשילוב עם אופרטור |
SegmentFilterClause
סעיף הסינון שמשמש להגדרת פלח יכול להיות כל מדד או מסנן מאפיין.
ייצוג JSON | |
---|---|
{ "not": boolean, // Union field |
שדות | ||
---|---|---|
not |
תואם להשלמה ( |
|
שדה איחוד dimensionOrMetricFilter . מסנן של מאפיינים או מדדים. dimensionOrMetricFilter יכול להיות רק אחד מהבאים: |
||
dimensionFilter |
מסנן מאפיינים להגדרת הפלח. |
|
metricFilter |
מסנן מדדים להגדרת הפלח. |
SegmentDimensionFilter
מסנן המאפיינים מציין את אפשרויות הסינון של מאפיין.
ייצוג JSON | |
---|---|
{
"dimensionName": string,
"operator": enum( |
שדות | |
---|---|
dimensionName |
שם המאפיין שעליו המערכת מחילה את המסנן. |
operator |
האופרטור שבו יש להשתמש כדי להתאים את המאפיין לביטויים. |
caseSensitive |
אם ההתאמה תהיה תלוית אותיות רישיות, המערכת תתעלם מאופרטור |
expressions[] |
רשימת הביטויים, רק הרכיב הראשון משמש לכל האופרטורים |
minComparisonValue |
ערכי השוואה מינימליים לסוג התאמה אחד ( |
maxComparisonValue |
ערכי השוואה מקסימליים עבור סוג התאמה אחד ( |
מפעיל
סוגי התאמה שונים נתמכים.
טיפוסים בני מנייה (enums) | |
---|---|
OPERATOR_UNSPECIFIED |
אם סוג ההתאמה לא צוין, הוא יטופל כ-REGEXP. |
REGEXP |
הביטוי של ההתאמה נחשב לביטוי רגולרי. כל שאר סוגי ההתאמה לא יטופלו כביטויים רגולריים. |
BEGINS_WITH |
תואם לערכים שמתחילים בביטוי ההתאמה שסופק. |
ENDS_WITH |
תואם לערכים שמסתיימים בביטוי ההתאמה שסופק. |
PARTIAL |
התאמה למחרוזת משנה. |
EXACT |
הערך צריך להיות תואם באופן מלא לביטוי ההתאמה. |
IN_LIST |
אפשרות זו משמשת לציון מסנן מאפיינים שהביטוי שלו יכול לקבל כל ערך מרשימת ערכים נבחרת. כך תוכלו להימנע מהערכה של כמה מסננים של מאפיינים בהתאמה מדויקת, שהמערכת בודקת אם מופעלת בהם האופרטור OR בכל שורת תגובה. למשל:
כל שורת תגובה שהמאפיין הזה כולל את הערך א', ב' או ג', תואמת ל'מסנן המאפיין' הזה. |
NUMERIC_LESS_THAN |
מסננים להשוואה של מספרים שלמים. המערכת מתעלמת מהתלות של אותיות רישיות (case-sensitivity) בהגדרות האלה, והביטוי נחשב למחרוזת שמייצגת מספר שלם. התנאים לכשל:
בודקת אם המאפיין קטן המספר מבחינה מספרית מביטוי ההתאמה. |
NUMERIC_GREATER_THAN |
בודקת אם המאפיין גדול המספר מבחינה מספרית מביטוי ההתאמה. |
NUMERIC_BETWEEN |
בודקת אם המאפיין הוא מספרי בין המינימום והמקסימום של ביטוי ההתאמה, והגבולות לא נכללים. |
SegmentMetricFilter
מסנן מדדים שישמש בתנאי סינון של פלח.
ייצוג JSON | |
---|---|
{ "scope": enum( |
שדות | |
---|---|
scope |
היקף המדד מגדיר את הרמה שבה אותו מדד מוגדר. היקף המדד שצוין חייב להיות שווה להיקף הראשי או גדול ממנו, כפי שהוגדר במודל הנתונים. ההיקף הראשי מוגדר לפי בחירת המשתמשים או הסשנים בפלח. |
metricName |
המדד שלפיו יתבצע הסינון. השדה |
operator |
מציין את הפעולה שצריך לבצע כדי להשוות בין המדד. ערך ברירת המחדל הוא |
comparisonValue |
הערך שאליו יש להשוות. אם האופרטור הוא |
maxComparisonValue |
אפשר להשתמש בערך השוואה מקסימלי רק עבור אופרטור אחד ( |
היקף
ההיקף של המדד מגדיר את הרמה שבה המדד הזה מוגדר – PRODUCT
, HIT
, SESSION
או USER
. ניתן לדווח על ערכי מדדים גם בהיקפים גדולים יותר מההיקף הראשי שלהם. למשל: ניתן לדווח על ga:pageviews
ועל ga:transactions
ברמת SESSION
ו-USER
על ידי חיבור שלהם לכל היט שמתרחש בסשנים האלה או למשתמשים האלה.
טיפוסים בני מנייה (enums) | |
---|---|
UNSPECIFIED_SCOPE |
אם לא צוין היקף, ברירת המחדל של היקף התנאי היא USER או SESSION , בהתאם להיקף שבו הפלח מנסה לבחור משתמשים או סשנים. |
PRODUCT |
היקף המוצרים. |
HIT |
היקף ההיט. |
SESSION |
היקף ברמת הסשן. |
USER |
היקף המשתמשים. |
מפעיל
אפשרויות שונות של סוגי השוואה.
טיפוסים בני מנייה (enums) | |
---|---|
UNSPECIFIED_OPERATOR |
אופרטור שלא צוין מטופל כאופרטור LESS_THAN . |
LESS_THAN |
הפונקציה בודקת אם הערך של המדד נמוך מערך ההשוואה. |
GREATER_THAN |
הפונקציה בודקת אם ערך המדד גדול מערך ההשוואה. |
EQUAL |
שווה לאופרטור. |
BETWEEN |
בין אופרטור, גם המינימום וגם המקסימום אינם מוגבלים. נשתמש ב-LT וב-GT לצורך השוואה. |
SequenceSegment
תנאי הרצף כוללים שלב אחד או יותר, כאשר כל שלב מוגדר לפי תנאי אחד או יותר של מאפיין/מדד. אפשר לשלב כמה שלבים עם אופרטורים של רצף מיוחדים.
ייצוג JSON | |
---|---|
{
"segmentSequenceSteps": [
{
object( |
שדות | |
---|---|
segmentSequenceSteps[] |
רשימת השלבים ברצף. |
firstStepShouldMatchFirstHit |
אם הוא מוגדר, התנאי של השלב הראשון חייב להתאים להתאמה הראשונה של המבקר (בטווח התאריכים). |
SegmentSequenceStep
הגדרה של רצף קטעים.
ייצוג JSON | |
---|---|
{ "orFiltersForSegment": [ { object( |
שדות | |
---|---|
orFiltersForSegment[] |
רצף מצוין באמצעות רשימת מסננים מקובצים או מסננים שמשולבים עם האופרטור |
matchType |
מציין אם השלב קודם לשלב הבא, או אם הוא יכול להתרחש בכל זמן לפני השלב הבא. |
MatchType
סוג ההתאמה של הרצף.
טיפוסים בני מנייה (enums) | |
---|---|
UNSPECIFIED_MATCH_TYPE |
סוג התאמה שלא צוין נחשב כהתאמה קודמת. |
PRECEDES |
האופרטור מציין שהשלב הקודם קודם לשלב הבא. |
IMMEDIATELY_PRECEDES |
האופרטור מציין שהשלב הקודם מיד לפני השלב הבא. |
ציר
הציר מתאר את הקטע שבבקשה. הציר עוזר לארגן מחדש את המידע שבדוחות מסוימים בטבלה על ידי יצירת ציר בנתונים לפי מאפיין שני.
ייצוג JSON | |
---|---|
{ "dimensions": [ { object( |
שדות | |
---|---|
dimensions[] |
רשימת מאפיינים להצגה כעמודות צירים. לכל ציר יכולים להיות 4 מאפיינים לכל היותר. מאפייני ציר הם חלק מההגבלה על המספר הכולל של מאפיינים שמותרים בבקשה. |
dimensionFilterClauses[] |
מאפייני DimensionsFilterClauses משולבים באופן לוגי עם אופרטור |
metrics[] |
מדדי הציר. מדדי ציר הם חלק מההגבלה על המספר הכולל של המדדים שמותרים בבקשה. |
startGroup |
אם נשלחה בקשה ל-k מדדים, התגובה תכלול כמה עמודות תלויות-נתונים של k עמודות בדוח. למשל, אם תציבו בטבלת צירים את המאפיין האפשרויות הבאות מאפשרות לבחור אילו מהקבוצות של k עמודות ייכללו בתגובה. |
maxGroupCount |
מציין את המספר המקסימלי של קבוצות שיוחזרו. ערך ברירת המחדל הוא 10, וגם הערך המקסימלי הוא 1,000. |
CohortGroup
מגדיר קבוצה בעלת מאפיינים משותפים. למשל:
"cohortGroup": {
"cohorts": [{
"name": "cohort 1",
"type": "FIRST_VISIT_DATE",
"dateRange": { "startDate": "2015-08-01", "endDate": "2015-08-01" }
},{
"name": "cohort 2"
"type": "FIRST_VISIT_DATE"
"dateRange": { "startDate": "2015-07-01", "endDate": "2015-07-01" }
}]
}
ייצוג JSON | |
---|---|
{
"cohorts": [
{
object( |
שדות | |
---|---|
cohorts[] |
ההגדרה של הקבוצה בעלת המאפיינים המשותפים. |
lifetimeValue |
הפעלת ערך חיי המשתמש (LTV). ערך חיי המשתמש מודד את ערך חיי המשתמש של משתמשים שצורפו דרך ערוצים שונים. מידע נוסף זמין בקטעים ניתוח קבוצות משתמשים וערך חיי המשתמש אם הערך של הפרמטרLTV הוא FALSE:
כאשר ערך חיי המשתמש הוא TRUE:
|
קבוצה בעלת מאפיינים משותפים
מגדיר קבוצה בעלת מאפיינים משותפים. קבוצה בעלת מאפיינים משותפים היא קבוצה של משתמשים שחולקים מאפיין משותף. לדוגמה, כל המשתמשים שתאריך הרכישה שלהם זהה שייכים לאותה קבוצה בעלת מאפיינים משותפים.
ייצוג JSON | |
---|---|
{ "name": string, "type": enum( |
שדות | |
---|---|
name |
שם ייחודי של הקבוצה בעלת המאפיינים המשותפים. אם לא הוגדר שם, המערכת תיצור באופן אוטומטי ערכים cohort_[1234...]. |
type |
סוג הקבוצה בעלת המאפיינים המשותפים. נכון לעכשיו, הסוג הנתמך היחיד הוא |
dateRange |
משתמשים בקבוצה בעלת מאפיינים משותפים |
סוג
הסוג של הקבוצה בעלת המאפיינים המשותפים.
טיפוסים בני מנייה (enums) | |
---|---|
UNSPECIFIED_COHORT_TYPE |
אם לא צוין סוג, הוא יטופל כ-FIRST_VISIT_DATE . |
FIRST_VISIT_DATE |
קבוצות בעלות מאפיינים משותפים שנבחרו על סמך תאריך הביקור הראשון. |
דיווח
תגובת הנתונים שתואמת לבקשה.
ייצוג JSON | |
---|---|
{ "columnHeader": { object( |
שדות | |
---|---|
columnHeader |
כותרות העמודות. |
data |
נתוני תשובות. |
nextPageToken |
אסימון דף לאחזור דף התוצאות הבא ברשימה. |
ColumnHeader
כותרות עמודות.
ייצוג JSON | |
---|---|
{
"dimensions": [
string
],
"metricHeader": {
object( |
שדות | |
---|---|
dimensions[] |
שמות המאפיינים בתשובה. |
metricHeader |
כותרות המדדים של המדדים בתשובה. |
MetricHeader
הכותרות של המדדים.
ייצוג JSON | |
---|---|
{ "metricHeaderEntries": [ { object( |
שדות | |
---|---|
metricHeaderEntries[] |
כותרות של המדדים בתשובה. |
pivotHeaders[] |
כותרות של ה-pivots בתשובה. |
MetricHeaderEntry
כותרת של המדדים.
ייצוג JSON | |
---|---|
{
"name": string,
"type": enum( |
שדות | |
---|---|
name |
שם הכותרת. |
type |
סוג המדד, לדוגמה |
PivotHeader
הכותרות של כל אחד ממקטעי הצירים המוגדרים בבקשה.
ייצוג JSON | |
---|---|
{
"pivotHeaderEntries": [
{
object( |
שדות | |
---|---|
pivotHeaderEntries[] |
כותרת אחת של קטע על ציר. |
totalPivotGroupsCount |
המספר הכולל של הקבוצות בטבלת הציר הזה. |
PivotHeaderEntry
הכותרות של כל עמודת מדדים, שתואמות למדדים שהתבקשו בקטע הצירים של התגובה.
ייצוג JSON | |
---|---|
{
"dimensionNames": [
string
],
"dimensionValues": [
string
],
"metric": {
object( |
שדות | |
---|---|
dimensionNames[] |
שם המאפיינים בתגובה של הצירים. |
dimensionValues[] |
הערכים של המאפיינים בציר. |
metric |
כותרת המדד של המדד בציר. |
ReportData
חלק הנתונים בדוח.
ייצוג JSON | |
---|---|
{ "rows": [ { object( |
שדות | |
---|---|
rows[] |
לכל שילוב ייחודי של מאפיינים יש שורת ReportRow אחת. |
totals[] |
לכל טווח תאריכים מבוקש, עבור קבוצת כל השורות שתואמות לשאילתה, כל פורמט של ערך מבוקש מקבל סכום כולל. הסכום הכולל של פורמט ערך מחושב על ידי סיכום המדדים שהוזכרו בפורמט הערך, ולאחר מכן הערכת הפורמט של הערך כביטוי סקלרי. למשל: ה'סיכומים' של |
rowCount |
המספר הכולל של השורות התואמות לשאילתה הזו. |
minimums[] |
ערכי המינימום והמקסימום שמוצגים בכל השורות התואמות. שתיהן ריקות אם |
maximums[] |
ערכי המינימום והמקסימום שמוצגים בכל השורות התואמות. שתיהן ריקות אם |
samplesReadCounts[] |
אם התוצאות נדגמו, הפונקציה הזו מחזירה את המספר הכולל של הדגימות שנקראו, רשומה אחת לכל טווח תאריכים. אם התוצאות לא נדגמו, השדה הזה לא יוגדר. פרטים נוספים זמינים במדריך למפתחים. |
samplingSpaceSizes[] |
אם התוצאות נדגמו, הפונקציה הזו מחזירה את המספר הכולל של המדגמים הקיימים, רשומה אחת לכל טווח תאריכים. אם התוצאות לא נדגמו, השדה הזה לא יוגדר. פרטים נוספים זמינים במדריך למפתחים. |
isDataGolden |
הערך מציין אם התשובה לבקשה הזו מוזהבת או לא. הנתונים זהובים אם אותה בקשה בדיוק לא תניב תוצאות חדשות אם תתבקשו לעשות זאת בשלב מאוחר יותר. |
dataLastRefreshed |
הפעם האחרונה שבה הנתונים בדוח עודכנו. כל ההיטים שהתקבלו לפני חותמת הזמן הזו נכללים בחישוב של הדוח. חותמת זמן בפורמט 'זולו' לפי RFC3339 UTC, מדויקת לננו-שניות. דוגמה: |
ReportRow
שורה בדוח.
ייצוג JSON | |
---|---|
{
"dimensions": [
string
],
"metrics": [
{
object( |
שדות | |
---|---|
dimensions[] |
רשימת המאפיינים המבוקשים. |
metrics[] |
רשימת המדדים לכל טווח תאריכים מבוקש. |
DateRangeValues
משמש להחזרת רשימת מדדים של שילוב יחיד של DateRange / מאפיין
ייצוג JSON | |
---|---|
{
"values": [
string
],
"pivotValueRegions": [
{
object( |
שדות | |
---|---|
values[] |
כל ערך תואם לכל מדד בבקשה. |
pivotValueRegions[] |
הערכים של כל אזור ציר. |
PivotValueRegion
הערכים של המדדים באזור הצירים.
ייצוג JSON | |
---|---|
{ "values": [ string ] } |
שדות | |
---|---|
values[] |
הערכים של המדדים בכל אחד מאזורי הצירים. |
ResourceQuotasRemaining
האסימונים למכסת המשאבים שנותרו בנכס אחרי השלמת הבקשה.
ייצוג JSON | |
---|---|
{ "dailyQuotaTokensRemaining": number, "hourlyQuotaTokensRemaining": number } |
שדות | |
---|---|
dailyQuotaTokensRemaining |
מכסת המשאבים היומית נותרת. |
hourlyQuotaTokensRemaining |
אסימונים למכסת משאבים שעתית נותרים. |