Class: Google::Apis::PlusDomainsV1::PlusDomainsService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/plus_domains_v1/service.rb

Overview

Google+ Domains API

Builds on top of the Google+ platform for Google Apps Domains.

Examples:

require 'google/apis/plus_domains_v1'

PlusDomains = Google::Apis::PlusDomainsV1 # Alias the module
service = PlusDomains::PlusDomainsService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializePlusDomainsService

Returns a new instance of PlusDomainsService



51
52
53
54
# File 'generated/google/apis/plus_domains_v1/service.rb', line 51

def initialize
  super('https://www.googleapis.com/', 'plusDomains/v1/')
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

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 'generated/google/apis/plus_domains_v1/service.rb', line 38

def key
  @key
end

#quota_userString

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. Overrides userIp if both are provided.

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. Overrides userIp if both are provided.



44
45
46
# File 'generated/google/apis/plus_domains_v1/service.rb', line 44

def quota_user
  @quota_user
end

#user_ipString

Returns IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Returns:

  • (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.



49
50
51
# File 'generated/google/apis/plus_domains_v1/service.rb', line 49

def user_ip
  @user_ip
end

Instance Method Details

#add_people(circle_id, email: nil, user_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlusDomainsV1::Circle

Add a person to a circle. Google+ limits certain circle operations, including the number of circle adds. Learn More.

Parameters:

  • circle_id (String)

    The ID of the circle to add the person to.

  • email (Array<String>, String)

    Email of the people to add to the circle. Optional, can be repeated.

  • user_id (Array<String>, String)

    IDs of the people to add to the circle. Optional, can be repeated.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



259
260
261
262
263
264
265
266
267
268
269
270
# File 'generated/google/apis/plus_domains_v1/service.rb', line 259

def add_people(circle_id, email: nil, user_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'circles/{circleId}/people', options)
  command.response_representation = Google::Apis::PlusDomainsV1::Circle::Representation
  command.response_class = Google::Apis::PlusDomainsV1::Circle
  command.params['circleId'] = circle_id unless circle_id.nil?
  command.query['email'] = email unless email.nil?
  command.query['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_activity(activity_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlusDomainsV1::Activity

Get an activity.

Parameters:

  • activity_id (String)

    The ID of the activity to get.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



80
81
82
83
84
85
86
87
88
89
# File 'generated/google/apis/plus_domains_v1/service.rb', line 80

def get_activity(activity_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'activities/{activityId}', options)
  command.response_representation = Google::Apis::PlusDomainsV1::Activity::Representation
  command.response_class = Google::Apis::PlusDomainsV1::Activity
  command.params['activityId'] = activity_id unless activity_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_circle(circle_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlusDomainsV1::Circle

Get a circle.

Parameters:

  • circle_id (String)

    The ID of the circle to get.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



296
297
298
299
300
301
302
303
304
305
# File 'generated/google/apis/plus_domains_v1/service.rb', line 296

def get_circle(circle_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'circles/{circleId}', options)
  command.response_representation = Google::Apis::PlusDomainsV1::Circle::Representation
  command.response_class = Google::Apis::PlusDomainsV1::Circle
  command.params['circleId'] = circle_id unless circle_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_comment(comment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlusDomainsV1::Comment

Get a comment.

Parameters:

  • comment_id (String)

    The ID of the comment to get.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



564
565
566
567
568
569
570
571
572
573
# File 'generated/google/apis/plus_domains_v1/service.rb', line 564

def get_comment(comment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'comments/{commentId}', options)
  command.response_representation = Google::Apis::PlusDomainsV1::Comment::Representation
  command.response_class = Google::Apis::PlusDomainsV1::Comment
  command.params['commentId'] = comment_id unless comment_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_person(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlusDomainsV1::Person

Get a person's profile.

Parameters:

  • user_id (String)

    The ID of the person to get the profile for. The special value "me" can be used to indicate the authenticated user.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



739
740
741
742
743
744
745
746
747
748
# File 'generated/google/apis/plus_domains_v1/service.rb', line 739

def get_person(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'people/{userId}', options)
  command.response_representation = Google::Apis::PlusDomainsV1::Person::Representation
  command.response_class = Google::Apis::PlusDomainsV1::Person
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_activity(user_id, activity_object = nil, preview: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlusDomainsV1::Activity

Create a new activity for the authenticated user.

Parameters:

  • user_id (String)

    The ID of the user to create the activity on behalf of. Its value should be " me", to indicate the authenticated user.

  • activity_object (Google::Apis::PlusDomainsV1::Activity) (defaults to: nil)
  • preview (Boolean)

    If "true", extract the potential media attachments for a URL. The response will include all possible attachments for a URL, including video, photos, and articles based on the content of the page.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



121
122
123
124
125
126
127
128
129
130
131
132
133
# File 'generated/google/apis/plus_domains_v1/service.rb', line 121

def insert_activity(user_id, activity_object = nil, preview: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'people/{userId}/activities', options)
  command.request_representation = Google::Apis::PlusDomainsV1::Activity::Representation
  command.request_object = activity_object
  command.response_representation = Google::Apis::PlusDomainsV1::Activity::Representation
  command.response_class = Google::Apis::PlusDomainsV1::Activity
  command.params['userId'] = user_id unless user_id.nil?
  command.query['preview'] = preview unless preview.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_circle(user_id, circle_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlusDomainsV1::Circle

Create a new circle for the authenticated user.

Parameters:

  • user_id (String)

    The ID of the user to create the circle on behalf of. The value "me" can be used to indicate the authenticated user.

  • circle_object (Google::Apis::PlusDomainsV1::Circle) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



333
334
335
336
337
338
339
340
341
342
343
344
# File 'generated/google/apis/plus_domains_v1/service.rb', line 333

def insert_circle(user_id, circle_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'people/{userId}/circles', options)
  command.request_representation = Google::Apis::PlusDomainsV1::Circle::Representation
  command.request_object = circle_object
  command.response_representation = Google::Apis::PlusDomainsV1::Circle::Representation
  command.response_class = Google::Apis::PlusDomainsV1::Circle
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_comment(activity_id, comment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlusDomainsV1::Comment

Create a new comment in reply to an activity.

Parameters:

  • activity_id (String)

    The ID of the activity to reply to.

  • comment_object (Google::Apis::PlusDomainsV1::Comment) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



600
601
602
603
604
605
606
607
608
609
610
611
# File 'generated/google/apis/plus_domains_v1/service.rb', line 600

def insert_comment(activity_id, comment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'activities/{activityId}/comments', options)
  command.request_representation = Google::Apis::PlusDomainsV1::Comment::Representation
  command.request_object = comment_object
  command.response_representation = Google::Apis::PlusDomainsV1::Comment::Representation
  command.response_class = Google::Apis::PlusDomainsV1::Comment
  command.params['activityId'] = activity_id unless activity_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_medium(user_id, collection, media_object = nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlusDomainsV1::Media

Add a new media item to an album. The current upload size limitations are 36MB for a photo and 1GB for a video. Uploads do not count against quota if photos are less than 2048 pixels on their longest side or videos are less than 15 minutes in length.

Parameters:

  • user_id (String)

    The ID of the user to create the activity on behalf of.

  • collection (String)
  • media_object (Google::Apis::PlusDomainsV1::Media) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • upload_source (IO, String)

    IO stream or filename containing content to upload

  • content_type (String)

    Content type of the uploaded content.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
# File 'generated/google/apis/plus_domains_v1/service.rb', line 694

def insert_medium(user_id, collection, media_object = nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command =  make_simple_command(:post, 'people/{userId}/media/{collection}', options)
  else
    command = make_upload_command(:post, 'people/{userId}/media/{collection}', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.request_representation = Google::Apis::PlusDomainsV1::Media::Representation
  command.request_object = media_object
  command.response_representation = Google::Apis::PlusDomainsV1::Media::Representation
  command.response_class = Google::Apis::PlusDomainsV1::Media
  command.params['userId'] = user_id unless user_id.nil?
  command.params['collection'] = collection unless collection.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_activities(user_id, collection, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlusDomainsV1::ActivityFeed

List all of the activities in the specified collection for a particular user.

Parameters:

  • user_id (String)

    The ID of the user to get activities for. The special value "me" can be used to indicate the authenticated user.

  • collection (String)

    The collection of activities to list.

  • max_results (Fixnum)

    The maximum number of activities to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.

  • page_token (String)

    The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of " nextPageToken" from the previous response.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



170
171
172
173
174
175
176
177
178
179
180
181
182
# File 'generated/google/apis/plus_domains_v1/service.rb', line 170

def list_activities(user_id, collection, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'people/{userId}/activities/{collection}', options)
  command.response_representation = Google::Apis::PlusDomainsV1::ActivityFeed::Representation
  command.response_class = Google::Apis::PlusDomainsV1::ActivityFeed
  command.params['userId'] = user_id unless user_id.nil?
  command.params['collection'] = collection unless collection.nil?
  command.query['maxResults'] = max_results unless max_results.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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_audiences(user_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlusDomainsV1::AudiencesFeed

List all of the audiences to which a user can share.

Parameters:

  • user_id (String)

    The ID of the user to get audiences for. The special value "me" can be used to indicate the authenticated user.

  • max_results (Fixnum)

    The maximum number of circles to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.

  • page_token (String)

    The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of " nextPageToken" from the previous response.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



217
218
219
220
221
222
223
224
225
226
227
228
# File 'generated/google/apis/plus_domains_v1/service.rb', line 217

def list_audiences(user_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'people/{userId}/audiences', options)
  command.response_representation = Google::Apis::PlusDomainsV1::AudiencesFeed::Representation
  command.response_class = Google::Apis::PlusDomainsV1::AudiencesFeed
  command.params['userId'] = user_id unless user_id.nil?
  command.query['maxResults'] = max_results unless max_results.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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_circles(user_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlusDomainsV1::CircleFeed

List all of the circles for a user.

Parameters:

  • user_id (String)

    The ID of the user to get circles for. The special value "me" can be used to indicate the authenticated user.

  • max_results (Fixnum)

    The maximum number of circles to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.

  • page_token (String)

    The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of " nextPageToken" from the previous response.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



379
380
381
382
383
384
385
386
387
388
389
390
# File 'generated/google/apis/plus_domains_v1/service.rb', line 379

def list_circles(user_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'people/{userId}/circles', options)
  command.response_representation = Google::Apis::PlusDomainsV1::CircleFeed::Representation
  command.response_class = Google::Apis::PlusDomainsV1::CircleFeed
  command.params['userId'] = user_id unless user_id.nil?
  command.query['maxResults'] = max_results unless max_results.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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_comments(activity_id, max_results: nil, page_token: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlusDomainsV1::CommentFeed

List all of the comments for an activity.

Parameters:

  • activity_id (String)

    The ID of the activity to get comments for.

  • max_results (Fixnum)

    The maximum number of comments to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.

  • page_token (String)

    The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of " nextPageToken" from the previous response.

  • sort_order (String)

    The order in which to sort the list of comments.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



647
648
649
650
651
652
653
654
655
656
657
658
659
# File 'generated/google/apis/plus_domains_v1/service.rb', line 647

def list_comments(activity_id, max_results: nil, page_token: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'activities/{activityId}/comments', options)
  command.response_representation = Google::Apis::PlusDomainsV1::CommentFeed::Representation
  command.response_class = Google::Apis::PlusDomainsV1::CommentFeed
  command.params['activityId'] = activity_id unless activity_id.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['sortOrder'] = sort_order unless sort_order.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_people(user_id, collection, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlusDomainsV1::PeopleFeed

List all of the people in the specified collection.

Parameters:

  • user_id (String)

    Get the collection of people for the person identified. Use "me" to indicate the authenticated user.

  • collection (String)

    The collection of people to list.

  • max_results (Fixnum)

    The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.

  • order_by (String)

    The order to return people in.

  • page_token (String)

    The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of " nextPageToken" from the previous response.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



787
788
789
790
791
792
793
794
795
796
797
798
799
800
# File 'generated/google/apis/plus_domains_v1/service.rb', line 787

def list_people(user_id, collection, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'people/{userId}/people/{collection}', options)
  command.response_representation = Google::Apis::PlusDomainsV1::PeopleFeed::Representation
  command.response_class = Google::Apis::PlusDomainsV1::PeopleFeed
  command.params['userId'] = user_id unless user_id.nil?
  command.params['collection'] = collection unless collection.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['orderBy'] = order_by unless order_by.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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_people_by_activity(activity_id, collection, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlusDomainsV1::PeopleFeed

List all of the people in the specified collection for a particular activity.

Parameters:

  • activity_id (String)

    The ID of the activity to get the list of people for.

  • collection (String)

    The collection of people to list.

  • max_results (Fixnum)

    The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.

  • page_token (String)

    The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of " nextPageToken" from the previous response.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



836
837
838
839
840
841
842
843
844
845
846
847
848
# File 'generated/google/apis/plus_domains_v1/service.rb', line 836

def list_people_by_activity(activity_id, collection, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'activities/{activityId}/people/{collection}', options)
  command.response_representation = Google::Apis::PlusDomainsV1::PeopleFeed::Representation
  command.response_class = Google::Apis::PlusDomainsV1::PeopleFeed
  command.params['activityId'] = activity_id unless activity_id.nil?
  command.params['collection'] = collection unless collection.nil?
  command.query['maxResults'] = max_results unless max_results.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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_people_by_circle(circle_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlusDomainsV1::PeopleFeed

List all of the people who are members of a circle.

Parameters:

  • circle_id (String)

    The ID of the circle to get the members of.

  • max_results (Fixnum)

    The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.

  • page_token (String)

    The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of " nextPageToken" from the previous response.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



882
883
884
885
886
887
888
889
890
891
892
893
# File 'generated/google/apis/plus_domains_v1/service.rb', line 882

def list_people_by_circle(circle_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'circles/{circleId}/people', options)
  command.response_representation = Google::Apis::PlusDomainsV1::PeopleFeed::Representation
  command.response_class = Google::Apis::PlusDomainsV1::PeopleFeed
  command.params['circleId'] = circle_id unless circle_id.nil?
  command.query['maxResults'] = max_results unless max_results.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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_circle(circle_id, circle_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlusDomainsV1::Circle

Update a circle's description. This method supports patch semantics.

Parameters:

  • circle_id (String)

    The ID of the circle to update.

  • circle_object (Google::Apis::PlusDomainsV1::Circle) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



417
418
419
420
421
422
423
424
425
426
427
428
# File 'generated/google/apis/plus_domains_v1/service.rb', line 417

def patch_circle(circle_id, circle_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'circles/{circleId}', options)
  command.request_representation = Google::Apis::PlusDomainsV1::Circle::Representation
  command.request_object = circle_object
  command.response_representation = Google::Apis::PlusDomainsV1::Circle::Representation
  command.response_class = Google::Apis::PlusDomainsV1::Circle
  command.params['circleId'] = circle_id unless circle_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#remove_circle(circle_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Delete a circle.

Parameters:

  • circle_id (String)

    The ID of the circle to delete.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:



454
455
456
457
458
459
460
461
# File 'generated/google/apis/plus_domains_v1/service.rb', line 454

def remove_circle(circle_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'circles/{circleId}', options)
  command.params['circleId'] = circle_id unless circle_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#remove_people(circle_id, email: nil, user_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Remove a person from a circle.

Parameters:

  • circle_id (String)

    The ID of the circle to remove the person from.

  • email (Array<String>, String)

    Email of the people to add to the circle. Optional, can be repeated.

  • user_id (Array<String>, String)

    IDs of the people to remove from the circle. Optional, can be repeated.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:



491
492
493
494
495
496
497
498
499
500
# File 'generated/google/apis/plus_domains_v1/service.rb', line 491

def remove_people(circle_id, email: nil, user_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'circles/{circleId}/people', options)
  command.params['circleId'] = circle_id unless circle_id.nil?
  command.query['email'] = email unless email.nil?
  command.query['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_circle(circle_id, circle_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlusDomainsV1::Circle

Update a circle's description.

Parameters:

  • circle_id (String)

    The ID of the circle to update.

  • circle_object (Google::Apis::PlusDomainsV1::Circle) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



527
528
529
530
531
532
533
534
535
536
537
538
# File 'generated/google/apis/plus_domains_v1/service.rb', line 527

def update_circle(circle_id, circle_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'circles/{circleId}', options)
  command.request_representation = Google::Apis::PlusDomainsV1::Circle::Representation
  command.request_object = circle_object
  command.response_representation = Google::Apis::PlusDomainsV1::Circle::Representation
  command.response_class = Google::Apis::PlusDomainsV1::Circle
  command.params['circleId'] = circle_id unless circle_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end