Method: properties.list

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

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

בקשת HTTP

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

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

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

פרמטרים
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