Method: properties.list

הפונקציה מחזירה נכסי צאצא בחשבון ההורה שצוין.

רק 'GA4' הנכסים יוחזרו. המאפיינים יוחרגו אם אין לפונקציית קריאה חוזרת גישה. כברירת מחדל, נכסים שנמחקו עם מחיקה רכה (כלומר 'הועברו לאשפה') מוחרגים. מחזירה רשימה ריקה אם לא נמצאו מאפיינים רלוונטיים.

בקשת HTTP

GET https://analyticsadmin.googleapis.com/v1alpha/properties

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של שאילתה

פרמטרים
filter

string

חובה. ביטוי לסינון תוצאות הבקשה. השדות שאפשר לסנן הם: parent:(שם המשאב של החשבון או הנכס ההורה) או ancestor:(שם המשאב של חשבון ההורה) או firebase_project:(המזהה או המספר של פרויקט Firebase המקושר). דוגמאות למסננים:

| Filter                      | Description                               |
|-----------------------------|-------------------------------------------|
| parent:accounts/123         | The account with account id: 123.       |
| parent:properties/123       | The property with property id: 123.       |
| ancestor:accounts/123       | The account with account id: 123.         |
| firebase_project:project-id | The firebase project with id: project-id. |
| firebase_project:123        | The firebase project with number: 123.    |
pageSize

integer

המספר המקסימלי של משאבים שצריך להחזיר. השירות עשוי להחזיר פחות מהערך הזה, גם אם יש דפים נוספים. אם לא צויין ערך, יוחזרו 50 משאבים לכל היותר. הערך המקסימלי הוא 200; (ערכים גבוהים יותר ייקראו לערך המקסימלי)
pageToken

string

אסימון דף, שהתקבל מקריאה קודמת ב-properties.list. צריך לספק את הכתובת הזו כדי לאחזר את הדף הבא. במהלך החלוקה לדפים, כל שאר הפרמטרים שסופקו ל-properties.list חייבים להתאים לקריאה שסיפקה את אסימון הדף.
showDeleted

boolean

האם לכלול בתוצאות נכסים שנמחקו עם יכולת שחזור (למשל: "הועבר לאשפה"). אפשר לבדוק מאפיינים כדי לקבוע אם הם נמחקו או לא.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

הודעת תגובה ל-RPC ב-property.list.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "properties": [
    {
      object (Property)
    }
  ],
  "nextPageToken": string
}
שדות
properties[]

object (Property)

תוצאות שהתאימו לקריטריונים לסינון והיו נגישות למבצע הקריאה.
nextPageToken

string

אסימון, שניתן לשלוח בתור pageToken כדי לאחזר את הדף הבא. אם השדה הזה יושמט, אין דפים נוספים.

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit