Method: properties.keyEvents.list
فهرستی از رویدادهای کلیدی را در ویژگی والد مشخص شده برمی گرداند. در صورتی که هیچ رویداد کلیدی یافت نشد، یک لیست خالی برمی گرداند.
درخواست HTTP
GET https://analyticsadmin.googleapis.com/v1beta/{parent=properties/*}/keyEvents
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
پارامترها |
---|
parent | string مورد نیاز. نام منبع ویژگی والد. مثال: 'properties/123' |
پارامترهای پرس و جو
پارامترها |
---|
page Size | integer حداکثر تعداد منابع برای بازگشت. اگر نامشخص باشد، حداکثر 50 منبع برگردانده می شود. حداکثر مقدار 200 است. (مقادیر بالاتر تا حداکثر اجباری خواهد بود) |
page Token | string یک نشانه صفحه، دریافت شده از تماس قبلی keyEvents.list . این را برای بازیابی صفحه بعدی ارائه کنید. هنگام صفحه بندی، تمام پارامترهای دیگر ارائه شده به keyEvents.list باید با فراخوانی که توکن صفحه را ارائه می کند مطابقت داشته باشد. |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
پیام پاسخ برای keyEvents.list RPC.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{
"keyEvents": [
{
object (KeyEvent )
}
],
"nextPageToken": string
} |
فیلدها |
---|
key Events[] | object ( KeyEvent ) رویدادهای کلیدی درخواستی |
next Page Token | string یک نشانه، که می تواند به عنوان pageToken برای بازیابی صفحه بعدی ارسال شود. اگر این قسمت حذف شود، هیچ صفحه بعدی وجود ندارد. |
محدوده مجوز
به یکی از حوزه های OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/analytics.readonly
-
https://www.googleapis.com/auth/analytics.edit
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-01-14 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-01-14 بهوقت ساعت هماهنگ جهانی."],[[["Retrieves a list of Key Events, which are significant changes or actions within a Google Analytics property."],["Allows for filtering by parent property and pagination to manage large result sets."],["Requires specific authorization scopes for access to data."],["Provides a structured JSON response containing Key Events and pagination details."],["Includes links to relevant documentation and code samples for implementation."]]],["This document details how to list Key Events via an HTTP GET request to `https://analyticsadmin.googleapis.com/v1beta/{parent=properties/*}/keyEvents`. It requires a `parent` path parameter specifying the property, and optional `pageSize` and `pageToken` query parameters for pagination. The request body must be empty. A successful response returns a JSON structure containing an array of `keyEvents` and a `nextPageToken` for further pagination. Authorization requires specific OAuth scopes.\n"]]