Method: properties.keyEvents.list
הפונקציה מחזירה רשימה של אירועים מרכזיים בנכס ההורה שצוין. הפונקציה מחזירה רשימה ריקה אם לא נמצאו אירועי מפתח.
בקשת HTTP
GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/keyEvents
כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.
פרמטרים של נתיב
פרמטרים |
parent |
string
חובה. שם המשאב של נכס ההורה. דוגמה: 'properties/123'
|
פרמטרים של שאילתה
פרמטרים |
pageSize |
integer
המספר המקסימלי של המשאבים להחזרה. אם לא צוין ערך, יוחזרו עד 50 משאבים. הערך המקסימלי הוא 200 (ערכים גבוהים יותר יומרו לערך המקסימלי)
|
pageToken |
string
אסימון דף, שהתקבל משיחה קודמת של keyEvents.list . יש לספק אותו כדי לאחזר את הדף הבא. כשמחלקים את הדפים, כל שאר הפרמטרים שסופקו ל-keyEvents.list חייבים להתאים לקריאה שסיפקה את אסימון הדף.
|
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
הודעת תגובה ל-RPC של keyEvents.list.
אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:
ייצוג ב-JSON |
{
"keyEvents": [
{
object (KeyEvent )
}
],
"nextPageToken": string
} |
שדות |
keyEvents[] |
object (KeyEvent )
האירועים המרכזיים המבוקשים
|
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)."],[[["Retrieves a list of Key Events, which are significant changes or occurrences within a Google Analytics property."],["Allows for filtering by parent property and pagination to manage large result sets."],["Requires specific authorization scopes for access, including read-only or edit permissions for Google Analytics data."],["Provides details about the HTTP request structure, including path and query parameters, for interacting with the API."],["The response includes a list of Key Events and a token for retrieving subsequent pages if available."]]],["This document details how to retrieve a list of Key Events associated with a specific property. A `GET` request to the provided URL, including the property's ID in the `parent` path parameter, is used. Optional `pageSize` and `pageToken` query parameters facilitate pagination. The request body must be empty. The response, formatted as JSON, contains an array of `keyEvents` and an optional `nextPageToken` for subsequent pages. It requires specific OAuth authorization scopes.\n"]]