Method: properties.list

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

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של 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 של properties.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