- בקשת HTTP
- פרמטרים של נתיב
- גוף הבקשה
- גוף התשובה
- היקפי ההרשאות
- ResponseMetaData
- SchemaRestrictionResponse
- ActiveMetricRestriction
- RestrictedMetricType
- רוצים לנסות?
אחזור התוכן של משימת דיווח. לאחר שליחת הבקשה אל reportTasks.create
, תהיה לך אפשרות לאחזר את תוכן הדוח ברגע שהדוח יהיה פעיל. השיטה הזו תחזיר שגיאה אם המצב של משימת הדיווח הוא לא ACTIVE
. תשובת שאילתה תחזיר את השורה בטבלה בעמודות של הדוח.
בקשת HTTP
POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/reportTasks/*}:query
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
name |
חובה. השם של מקור הדוח. פורמט: |
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{ "offset": string, "limit": string } |
שדות | |
---|---|
offset |
זה שינוי אופציונלי. מספר השורות בשורת ההתחלה בדוח. השורה הראשונה נספרת כשורה 0. במהלך החלוקה לדפים, הבקשה הראשונה לא מציינת קיזוז. או באופן שווה, מגדיר את ההיסט ל-0; הבקשה הראשונה מחזירה את מידע נוסף על פרמטר העימוד הזה זמין במאמר עימוד. |
limit |
זה שינוי אופציונלי. מספר השורות שצריך להחזיר מהדוח. אם לא מציינים שום אפשרות, יוחזרו 10,000 שורות. ה-API מחזיר עד 250,000 שורות לכל בקשה, לא משנה כמה מבקשים. הערך ה-API יכול גם להחזיר פחות שורות מהשדה מידע נוסף על פרמטר העימוד הזה זמין במאמר עימוד. |
גוף התשובה
תוכן הדיווח שתואם למשימת הדיווח.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{ "dimensionHeaders": [ { object ( |
שדות | |
---|---|
dimensionHeaders[] |
מתאר עמודות של מאפיינים. מספר 'כותרות המאפיינים' והסדר של 'כותרות מאפיינים' תואמים למאפיינים שמופיעים בשורות. |
metricHeaders[] |
תיאור עמודות של מדדים. מספר MetricHeaders והסדר של MetricHeaders תואמים למדדים שמופיעים בשורות. |
rows[] |
שורות של שילובים של ערכי מאפיינים וערכי מדדים בדוח. |
totals[] |
אם מתבקשים, ערכי המדדים הכוללים. |
maximums[] |
הערכים המקסימליים של המדדים, אם צריך. |
minimums[] |
הערכים המינימליים של המדדים, אם צריך. |
rowCount |
המספר הכולל של השורות בתוצאת השאילתה. |
metadata |
מטא-נתונים של הדוח. |
היקפי ההרשאות
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
ResponseMetaData
המטא-נתונים של התשובה שכוללים מידע נוסף על תוכן הדוח.
ייצוג JSON |
---|
{
"dataLossFromOtherRow": boolean,
"schemaRestrictionResponse": {
object ( |
שדות | |
---|---|
dataLossFromOtherRow |
אם הערך הוא True, קטגוריות מסוימות של שילובי מאפיינים מועברות ל-'(other)'. השורה הראשונה. מצב כזה יכול לקרות בדוחות בעלי עוצמה גבוהה. פרמטר המטא-נתונים dataLossFromOtherRow מאוכלס על סמך טבלת הנתונים הנצברים שנעשה בה שימוש בדוח. הפרמטר יאוכלס באופן מדויק ללא קשר למסננים ולמגבלות שבדוח. לדוגמה, ייתכן שהשורה (other) תוסר מהדוח כי הבקשה מכילה מסנן ברמת sessionSource = google. הפרמטר הזה עדיין יאוכלס אם היה אובדן נתונים משורה אחרת בנתוני הקלט הנצברים ששימשו ליצירת הדוח הזה. מידע נוסף זמין במאמר מידע על השורה (אחר) ועל דגימת נתונים. |
schemaRestrictionResponse |
תיאור של הגבלות הסכימה שנאכפות באופן פעיל ביצירת הדוח הזה. מידע נוסף זמין במאמר ניהול גישה והגבלת נתונים. |
currencyCode |
קוד המטבע שמוצג בדוח הזה. מיועד לשימוש בפורמט מדדי מטבע כמו קודי מטבע הם קידוד מחרוזות של סוגי מטבעות לפי תקן ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217); לדוגמה, "USD", "EUR", "JPY". מידע נוסף זמין בכתובת https://support.google.com/analytics/answer/9796179. |
timeZone |
אזור הזמן הנוכחי של הנכס. מיועדת לשמש לפירוש מאפיינים מבוססי-זמן כמו |
emptyReason |
אם ציינתם סיבה ריקה, הדוח יהיה ריק מהסיבה הזו. |
subjectToThresholding |
אם הערך של |
SchemaRestrictionResponse
הגבלות הסכימה שנאכפות באופן פעיל ביצירת הדוח הזה. מידע נוסף זמין במאמר ניהול גישה והגבלת נתונים.
ייצוג JSON |
---|
{
"activeMetricRestrictions": [
{
object ( |
שדות | |
---|---|
activeMetricRestrictions[] |
כל ההגבלות נאכפות באופן פעיל ביצירת הדוח. לדוגמה, |
ActiveMetricRestriction
מדד שחלה עליו הגבלה פעילה ליצירת הדוח.
ייצוג JSON |
---|
{
"restrictedMetricTypes": [
enum ( |
שדות | |
---|---|
restrictedMetricTypes[] |
הסיבה להגבלה של המדד הזה. |
metricName |
שם המדד המוגבל. |
RestrictedMetricType
קטגוריות של נתונים שיכול להיות שתוגבל בהן האפשרות לצפות בהם בנכסי GA4 מסוימים.
טיפוסים בני מנייה (enum) | |
---|---|
RESTRICTED_METRIC_TYPE_UNSPECIFIED |
הסוג לא צוין. |
COST_DATA |
מדדי עלות כמו adCost . |
REVENUE_DATA |
מדדי הכנסה כמו purchaseRevenue . |