Class PropertiesResource.ListRequest
Returns child Properties under the specified parent Account. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found.
Inheritance
Implements
Inherited Members
Namespace: Google.Apis.GoogleAnalyticsAdmin.v1beta
Assembly: Google.Apis.GoogleAnalyticsAdmin.v1beta.dll
Syntax
public class PropertiesResource.ListRequest : GoogleAnalyticsAdminBaseServiceRequest<GoogleAnalyticsAdminV1betaListPropertiesResponse>, IClientServiceRequest<GoogleAnalyticsAdminV1betaListPropertiesResponse>, IClientServiceRequest
Constructors
ListRequest(IClientService)
Constructs a new List request.
Declaration
public ListRequest(IClientService service)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service |
Properties
Filter
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. |
Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual string Filter { get; set; }
Property Value
Type | Description |
---|---|
string |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
PageSize
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)
Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type | Description |
---|---|
int? |
PageToken
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.
Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type | Description |
---|---|
string |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
ShowDeleted
Whether to include soft-deleted (ie: "trashed") Properties in the results. Properties can be inspected to determine whether they are deleted or not.
Declaration
[RequestParameter("showDeleted", RequestParameterType.Query)]
public virtual bool? ShowDeleted { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()