GoogleApi.AnalyticsAdmin.V1alpha.Api.Properties.analyticsadmin_properties_list
You're seeing just the function
analyticsadmin_properties_list
, go back to GoogleApi.AnalyticsAdmin.V1alpha.Api.Properties module for more information.
Link to this function
analyticsadmin_properties_list(connection, optional_params \\ [], opts \\ [])
View SourceSpecs
analyticsadmin_properties_list(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaListPropertiesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns child Properties under the specified parent Account. Only "GA4" properties will be returned. 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.
Parameters
-
connection
(type:GoogleApi.AnalyticsAdmin.V1alpha.Connection.t
) - Connection to server -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - Required. An expression for filtering the results of the request. Fields eligible for filtering are:parent:
(The resource name of the parent account) orfirebase_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. | | firebase_project:project-id | The firebase project with id: project-id. | | firebase_project:123 | The firebase project with number: 123. |
-
:pageSize
(type:integer()
) - 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) -
:pageToken
(type:String.t
) - A page token, received from a previousListProperties
call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided toListProperties
must match the call that provided the page token. -
:showDeleted
(type:boolean()
) - Whether to include soft-deleted (ie: "trashed") Properties in the results. Properties can be inspected to determine whether they are deleted or not.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaListPropertiesResponse{}}
on success -
{:error, info}
on failure