Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
Method: properties.dataStreams.eventEditRules.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists EventEditRules on a web data stream.
HTTP request
GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*/dataStreams/*}/eventEditRules
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
parent |
string
Required. Example format: properties/123/dataStreams/456
|
Query parameters
Parameters |
pageSize |
integer
Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
|
pageToken |
string
Optional. A page token, received from a previous eventEditRules.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to eventEditRules.list must match the call that provided the page token.
|
Request body
The request body must be empty.
Response body
Response message for eventEditRules.list RPC.
If successful, the response body contains data with the following structure:
JSON representation |
{
"eventEditRules": [
{
object (EventEditRule )
}
],
"nextPageToken": string
} |
Fields |
eventEditRules[] |
object (EventEditRule )
List of EventEditRules. These will be ordered stably, but in an arbitrary order.
|
nextPageToken |
string
A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics.edit
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-02 UTC.
[null,null,["Last updated 2025-04-02 UTC."],[[["\u003cp\u003eLists Event Edit Rules configured for a specified web data stream within a Google Analytics 4 property.\u003c/p\u003e\n"],["\u003cp\u003eAllows for pagination to retrieve large lists of Event Edit Rules, specifying the maximum number of results per page.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with specific Google Analytics scopes for read or edit access.\u003c/p\u003e\n"],["\u003cp\u003eProvides a response containing an array of Event Edit Rules and a token for retrieving subsequent pages, if available.\u003c/p\u003e\n"],["\u003cp\u003eEmploys gRPC Transcoding for its HTTP request structure and utilizes path and query parameters for resource identification and filtering.\u003c/p\u003e\n"]]],["This document outlines how to list EventEditRules for a web data stream using an HTTP GET request. The request is sent to a specific URL, defined by the `parent` path parameter (e.g., `properties/123/dataStreams/456`). Optional query parameters `pageSize` (max 200) and `pageToken` support pagination. The request body must be empty, and the response, in JSON format, contains a list of `eventEditRules` and a `nextPageToken` for retrieving subsequent pages if any. The requests requires authorization scopes `https://www.googleapis.com/auth/analytics.readonly` or `https://www.googleapis.com/auth/analytics.edit`\n"],null,["# Method: properties.dataStreams.eventEditRules.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListEventEditRulesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists EventEditRules on a web data stream.\n\n### HTTP request\n\n`GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*/dataStreams/*}/eventEditRules`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-------------------------------------------------------------------|\n| `parent` | `string` Required. Example format: properties/123/dataStreams/456 |\n\n### Query parameters\n\n| Parameters ||\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). |\n| `pageToken` | `string` Optional. A page token, received from a previous `eventEditRules.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `eventEditRules.list` must match the call that provided the page token. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for eventEditRules.list RPC.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"eventEditRules\": [ { object (/analytics/devguides/config/admin/v1/rest/v1alpha/properties.dataStreams.eventEditRules#EventEditRule) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `eventEditRules[]` | `object (`[EventEditRule](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.dataStreams.eventEditRules#EventEditRule)`)` List of EventEditRules. These will be ordered stably, but in an arbitrary order. |\n| `nextPageToken` | `string` A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/analytics.readonly`\n- `https://www.googleapis.com/auth/analytics.edit`"]]