generated/google-apis-ideahub_v1alpha/lib/google/apis/ideahub_v1alpha/service.rb
# List ideas for a given Creator and filter and sort options.
# @param [String] creator_platform
#   Identifies the platform from which this user is accessing Idea Hub.
# @param [String] creator_platform_id
#   Identifies the platform account (blog/site/etc.) for which to fetch Ideas.
# @param [String] filter
#   Allows filtering. Supported syntax: * Filter expressions are made up of one or
#   more restrictions. * Restrictions are implicitly combined, as if the `AND`
#   operator was always used. The `OR` operator is currently unsupported. *
#   Supported functions: - `saved(bool)`: If set to true, fetches only saved ideas.
#   If set to false, fetches all except saved ideas. Can't be simultaneously used
#   with `dismissed(bool)`. - `dismissed(bool)`: If set to true, fetches only
#   dismissed ideas. Can't be simultaneously used with `saved(bool)`. The `false`
#   value is currently unsupported. Examples: * `saved(true)` * `saved(false)` * `
#   dismissed(true)` The length of this field should be no more than 500
#   characters.
# @param [String] order_by
#   Order semantics described below.
# @param [Fixnum] page_size
#   The maximum number of ideas per page. If unspecified, at most 10 ideas will be
#   returned. The maximum value is 2000; values above 2000 will be coerced to 2000.
# @param [String] page_token
#   Used to fetch next page.
# @param [String] parent
#   If defined, specifies the creator for which to filter by. Format: publishers/`
#   publisher`/properties/`property`
# @param [String] fields
#   Selector specifying which fields to include in a partial response.
# @param [String] quota_user
#   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.
# @param [Google::Apis::RequestOptions] options
#   Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::IdeahubV1alpha::GoogleSearchIdeahubV1alphaListIdeasResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::IdeahubV1alpha::GoogleSearchIdeahubV1alphaListIdeasResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
List ideas for a given Creator and filter and sort options.
List ideas for a given Creator and filter and sort options .
def list_ideas(creator_platform: nil, creator_platform_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, parent: nil, fields: nil, quota_user: nil, options: nil, &block)
          command = make_simple_command(:get, 'v1alpha/ideas', options)
          command.response_representation = Google::Apis::IdeahubV1alpha::GoogleSearchIdeahubV1alphaListIdeasResponse::Representation
          command.response_class = Google::Apis::IdeahubV1alpha::GoogleSearchIdeahubV1alphaListIdeasResponse
          command.query['creator.platform'] = creator_platform unless creator_platform.nil?
          command.query['creator.platformId'] = creator_platform_id unless creator_platform_id.nil?
          command.query['filter'] = filter unless filter.nil?
          command.query['orderBy'] = order_by unless order_by.nil?
          command.query['pageSize'] = page_size unless page_size.nil?
          command.query['pageToken'] = page_token unless page_token.nil?
          command.query['parent'] = parent unless parent.nil?
          command.query['fields'] = fields unless fields.nil?
          command.query['quotaUser'] = quota_user unless quota_user.nil?
          execute_or_queue_command(command, &block)
        end
def list_ideas ( creator_platform : nil , creator_platform_id : nil , filter : nil , order_by : nil , page_size : nil , page_token : nil , parent : nil , fields : nil , quota_user : nil , options : nil , & block ) command = make_simple_command ( :get , 'v1alpha/ideas' , options ) command . response_representation = Google :: Apis :: IdeahubV1alpha :: GoogleSearchIdeahubV1alphaListIdeasResponse :: Representation command . response_class = Google :: Apis :: IdeahubV1alpha :: GoogleSearchIdeahubV1alphaListIdeasResponse command . query [ 'creator.platform' ] = creator_platform unless creator_platform . nil? command . query [ 'creator.platformId' ] = creator_platform_id unless creator_platform_id . nil? command . query [ 'filter' ] = filter unless filter . nil? command . query [ 'orderBy' ] = order_by unless order_by . nil? command . query [ 'pageSize' ] = page_size unless page_size . nil? command . query [ 'pageToken' ] = page_token unless page_token . nil? command . query [ 'parent' ] = parent unless parent . nil? command . query [ 'fields' ] = fields unless fields . nil? command . query [ 'quotaUser' ] = quota_user unless quota_user . nil? execute_or_queue_command ( command , & block ) end
List ideas for a given Creator and filter and sort options.
List ideas for a given Creator and filter and sort options .
None
Google::Apis::IdeahubV1alpha::GoogleSearchIdeahubV1alphaListIdeasResponse
[Google::Apis::ServerError] An error occurred on the server and the request can be retried
[ Google :: Apis :: ServerError ] An error occurred on the server and the request can be retried
[Google::Apis::ClientError] The request is invalid and should not be retried without modification
[ Google :: Apis :: ClientError ] The request is invalid and should not be retried without modification
[Google::Apis::AuthorizationError] Authorization is required
[ Google :: Apis :: AuthorizationError ] Authorization is required
creator_platform
<not_specific>
creator_platform_id
<not_specific>
filter
<not_specific>
order_by
<not_specific>
page_size
<not_specific>
page_token
<not_specific>
parent
<not_specific>
fields
<not_specific>
quota_user
<not_specific>
options
<not_specific>
block
<not_specific>
<not_specific>
options Request-specific options
options Request - specific options
]
<not_specific>
Result & error if block supplied
Result & error if block supplied
result
<not_specific>
parsed result object
parsed result object
err
<not_specific>
error object if request failed
error object if request failed