Class: Google::Analytics::Admin::V1alpha::ListPropertiesRequest

Inherits:

Object

• Object
• Google::Analytics::Admin::V1alpha::ListPropertiesRequest

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb

Overview

Request message for ListProperties RPC.

Instance Attribute Summary

• #filter ⇒ ::String

  Required.

• #page_size ⇒ ::Integer

  The maximum number of resources to return.

• #page_token ⇒ ::String

  A page token, received from a previous ListProperties call.

• #show_deleted ⇒ ::Boolean

  Whether to include soft-deleted (ie: "trashed") Properties in the results.

Instance Attribute Details

#filter ⇒ ::String

Returns 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.    |
```.

Returns:

• (::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.    |
  

# File 'proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb', line 296

class ListPropertiesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

Returns 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).

Returns:

• (::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)

# File 'proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb', line 296

class ListPropertiesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

Returns 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.

Returns:

• (::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.

# File 'proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb', line 296

class ListPropertiesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#show_deleted ⇒ ::Boolean

Returns Whether to include soft-deleted (ie: "trashed") Properties in the results. Properties can be inspected to determine whether they are deleted or not.

Returns:

• (::Boolean) —

  Whether to include soft-deleted (ie: "trashed") Properties in the results. Properties can be inspected to determine whether they are deleted or not.

# File 'proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb', line 296

class ListPropertiesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end