Method: properties.list
הפונקציה מחזירה נכסי צאצא בחשבון ההורה שצוין.
נכסים יוחרגו אם למבצע הקריאה החוזרת אין גישה אליהם. כברירת מחדל, נכסים שנמחקו באופן סופי (כלומר, הועברו לאשפה) לא נכללים. אם לא נמצאו נכסים רלוונטיים, הפונקציה מחזירה רשימה ריקה.
בקשת 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
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-01-14 (שעון UTC).
[null,null,["עדכון אחרון: 2025-01-14 (שעון UTC)."],[[["Returns a list of \"GA4\" properties under a specified parent Account, excluding those without user access and soft-deleted ones."],["Allows filtering results by parent, ancestor, or linked Firebase project using the `filter` query parameter."],["Supports pagination with `pageSize` and `pageToken` parameters to retrieve large result sets."],["Requires `analytics.readonly` or `analytics.edit` authorization scopes for access."],["Provides a JSON response containing an array of properties and a token for retrieving subsequent pages."]]],["This document details how to retrieve a list of child properties under a specified parent account using a `GET` request to the provided URL. Key actions involve using query parameters such as `filter`, `pageSize`, `pageToken`, and `showDeleted` to refine the search. The `filter` parameter allows specification of parent account/property, ancestor, or firebase project. The response body, in JSON format, returns a list of accessible properties and a `nextPageToken` for pagination. The process requires specific authorization scopes.\n"]]