Reference documentation and code samples for the Google Analytics Admin V1alpha Client class ListPropertiesRequest.
Request message for ListProperties RPC.
Generated from protobuf message google.analytics.admin.v1alpha.ListPropertiesRequest
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ filter
string
Required. An expression for filtering the results of the request. Fields eligible for filtering are: parent:
(The resource name of the parent account/property) or ancestor:
(The resource name of the parent account) or firebase_project:
(The id or number of the linked firebase project). Some examples of filters: | 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. |
↳ page_size
int
The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
↳ page_token
string
A page token, received from a previous ListProperties
call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListProperties
must match the call that provided the page token.
↳ show_deleted
bool
Whether to include soft-deleted (ie: "trashed") Properties in the results. Properties can be inspected to determine whether they are deleted or not.
getFilter
Required. An expression for filtering the results of the request.
Fields eligible for filtering are: parent:
(The resource name of the parent account/property) or ancestor:
(The resource name of the parent account) or firebase_project:
(The id or number of the linked firebase project).
Some examples of filters:
| 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. |
string
setFilter
Required. An expression for filtering the results of the request.
Fields eligible for filtering are: parent:
(The resource name of the parent account/property) or ancestor:
(The resource name of the parent account) or firebase_project:
(The id or number of the linked firebase project).
Some examples of filters:
| 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. |
var
string
$this
getPageSize
The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages.
If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
int
setPageSize
The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages.
If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
var
int
$this
getPageToken
A page token, received from a previous ListProperties
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListProperties
must
match the call that provided the page token.
string
setPageToken
A page token, received from a previous ListProperties
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListProperties
must
match the call that provided the page token.
var
string
$this
getShowDeleted
Whether to include soft-deleted (ie: "trashed") Properties in the results. Properties can be inspected to determine whether they are deleted or not.
bool
setShowDeleted
Whether to include soft-deleted (ie: "trashed") Properties in the results. Properties can be inspected to determine whether they are deleted or not.
var
bool
$this
