Class: Google::Apis::IdeahubV1alpha::IdeahubService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/ideahub_v1alpha/service.rb

Overview

Idea Hub API

Examples:

require 'google/apis/ideahub_v1alpha'

Ideahub = Google::Apis::IdeahubV1alpha # Alias the module
service = Ideahub::IdeahubService.new

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ IdeahubService

Returns a new instance of IdeahubService.



45
46
47
48
49
50
 
# File 'lib/google/apis/ideahub_v1alpha/service.rb', line 45

def initialize
  super('https://ideahub.googleapis.com/', '',
        client_name: 'google-apis-ideahub_v1alpha',
        client_version: Google::Apis::IdeahubV1alpha::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

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

Returns:

  • (String) —

    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.



38
39
40
 
# File 'lib/google/apis/ideahub_v1alpha/service.rb', line 38

def key
  @key
end

#quota_user ⇒ String

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

Returns:

  • (String) —

    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.



43
44
45
 
# File 'lib/google/apis/ideahub_v1alpha/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#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) {|result, err| ... } ⇒ Google::Apis::IdeahubV1alpha::GoogleSearchIdeahubV1alphaListIdeasResponse

List ideas for a given Creator and filter and sort options.

Parameters:

  • creator_platform (String) (defaults to: nil) —

    Identifies the platform from which this user is accessing Idea Hub.

  • creator_platform_id (String) (defaults to: nil) —

    Identifies the platform account (blog/site/etc.) for which to fetch Ideas.

  • filter (String) (defaults to: nil) —

    Filter semantics described below.

  • order_by (String) (defaults to: nil) —

    Order semantics described below.

  • page_size (Fixnum) (defaults to: nil) —

    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.

  • page_token (String) (defaults to: nil) —

    Used to fetch next page.

  • parent (String) (defaults to: nil) —

    If defined, specifies the creator for which to filter by. Format: publishers/ publisher/properties/property

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

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

    Authorization is required



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/google/apis/ideahub_v1alpha/service.rb', line 86

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_platform_property_ideas(parent, creator_platform: nil, creator_platform_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdeahubV1alpha::GoogleSearchIdeahubV1alphaListIdeasResponse

List ideas for a given Creator and filter and sort options.

Parameters:

  • parent (String) —

    If defined, specifies the creator for which to filter by. Format: publishers/ publisher/properties/property

  • creator_platform (String) (defaults to: nil) —

    Identifies the platform from which this user is accessing Idea Hub.

  • creator_platform_id (String) (defaults to: nil) —

    Identifies the platform account (blog/site/etc.) for which to fetch Ideas.

  • filter (String) (defaults to: nil) —

    Filter semantics described below.

  • order_by (String) (defaults to: nil) —

    Order semantics described below.

  • page_size (Fixnum) (defaults to: nil) —

    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.

  • page_token (String) (defaults to: nil) —

    Used to fetch next page.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

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

    Authorization is required



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/google/apis/ideahub_v1alpha/service.rb', line 173

def list_platform_property_ideas(parent, creator_platform: nil, creator_platform_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+parent}/ideas', options)
  command.response_representation = Google::Apis::IdeahubV1alpha::GoogleSearchIdeahubV1alphaListIdeasResponse::Representation
  command.response_class = Google::Apis::IdeahubV1alpha::GoogleSearchIdeahubV1alphaListIdeasResponse
  command.params['parent'] = parent unless parent.nil?
  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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_platform_property_locales(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdeahubV1alpha::GoogleSearchIdeahubV1alphaListAvailableLocalesResponse

Returns which locales ideas are available in for a given Creator.

Parameters:

  • parent (String) —

    Required. The web property to check idea availability for Format: platforms/ platform/property/property

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of locales to return. The service may return fewer than this value. If unspecified, at most 100 locales will be returned. The maximum value is 100; values above 100 will be coerced to 100.

  • page_token (String) (defaults to: nil) —

    A page token, received from a previous ListAvailableLocales call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAvailableLocales must match the call that provided the page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

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

    Authorization is required



219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/google/apis/ideahub_v1alpha/service.rb', line 219

def list_platform_property_locales(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+parent}/locales', options)
  command.response_representation = Google::Apis::IdeahubV1alpha::GoogleSearchIdeahubV1alphaListAvailableLocalesResponse::Representation
  command.response_class = Google::Apis::IdeahubV1alpha::GoogleSearchIdeahubV1alphaListAvailableLocalesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_platform_property_idea_state(name, google_search_ideahub_v1alpha_idea_state_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IdeahubV1alpha::GoogleSearchIdeahubV1alphaIdeaState

Update an idea state resource.

Parameters:

  • name (String) —

    Unique identifier for the idea state. Format: platforms/platform/properties/ property/ideaStates/idea_state

  • google_search_ideahub_v1alpha_idea_state_object (Google::Apis::IdeahubV1alpha::GoogleSearchIdeahubV1alphaIdeaState) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    The list of fields to be updated.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

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

    Authorization is required



126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/google/apis/ideahub_v1alpha/service.rb', line 126

def patch_platform_property_idea_state(name, google_search_ideahub_v1alpha_idea_state_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1alpha/{+name}', options)
  command.request_representation = Google::Apis::IdeahubV1alpha::GoogleSearchIdeahubV1alphaIdeaState::Representation
  command.request_object = google_search_ideahub_v1alpha_idea_state_object
  command.response_representation = Google::Apis::IdeahubV1alpha::GoogleSearchIdeahubV1alphaIdeaState::Representation
  command.response_class = Google::Apis::IdeahubV1alpha::GoogleSearchIdeahubV1alphaIdeaState
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end