Class: Google::Apis::PlusDomainsV1::PlusDomainsService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::PlusDomainsV1::PlusDomainsService
- 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.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
An opaque string that represents a user for quota purposes.
-
#user_ip ⇒ String
Deprecated.
Attributes inherited from Core::BaseService
#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path
Instance Method Summary collapse
-
#get_activity(activity_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlusDomainsV1::Activity
Get an activity.
-
#get_comment(comment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlusDomainsV1::Comment
Get a comment.
-
#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.
-
#initialize ⇒ PlusDomainsService
constructor
A new instance of PlusDomainsService.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
Methods inherited from Core::BaseService
#batch, #batch_upload, #fetch_all, #http
Methods included from Core::Logging
Constructor Details
#initialize ⇒ PlusDomainsService
Returns a new instance of PlusDomainsService
49 50 51 52 |
# File 'generated/google/apis/plus_domains_v1/service.rb', line 49 def initialize super('https://www.googleapis.com/', 'plusDomains/v1/') @batch_path = 'batch/plusDomains/v1' 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.
38 39 40 |
# File 'generated/google/apis/plus_domains_v1/service.rb', line 38 def key @key end |
#quota_user ⇒ String
Returns An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
43 44 45 |
# File 'generated/google/apis/plus_domains_v1/service.rb', line 43 def quota_user @quota_user end |
#user_ip ⇒ String
Returns Deprecated. Please use quotaUser instead.
47 48 49 |
# File 'generated/google/apis/plus_domains_v1/service.rb', line 47 def user_ip @user_ip end |
Instance Method Details
#get_activity(activity_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlusDomainsV1::Activity
Get an activity.
76 77 78 79 80 81 82 83 84 85 |
# File 'generated/google/apis/plus_domains_v1/service.rb', line 76 def get_activity(activity_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'activities/{activityId}', ) 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_comment(comment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlusDomainsV1::Comment
Get a comment.
244 245 246 247 248 249 250 251 252 253 |
# File 'generated/google/apis/plus_domains_v1/service.rb', line 244 def get_comment(comment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'comments/{commentId}', ) 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.
411 412 413 414 415 416 417 418 419 420 |
# File 'generated/google/apis/plus_domains_v1/service.rb', line 411 def get_person(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'people/{userId}', ) 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_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.
278 279 280 281 282 283 284 285 286 287 288 289 |
# File 'generated/google/apis/plus_domains_v1/service.rb', line 278 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', ) 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.
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 |
# File 'generated/google/apis/plus_domains_v1/service.rb', line 368 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}', ) else command = make_upload_command(:post, 'people/{userId}/media/{collection}', ) 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.
120 121 122 123 124 125 126 127 128 129 130 131 132 |
# File 'generated/google/apis/plus_domains_v1/service.rb', line 120 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}', ) 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.
165 166 167 168 169 170 171 172 173 174 175 176 |
# File 'generated/google/apis/plus_domains_v1/service.rb', line 165 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', ) 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.
209 210 211 212 213 214 215 216 217 218 219 220 |
# File 'generated/google/apis/plus_domains_v1/service.rb', line 209 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', ) 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.
323 324 325 326 327 328 329 330 331 332 333 334 335 |
# File 'generated/google/apis/plus_domains_v1/service.rb', line 323 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', ) 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.
457 458 459 460 461 462 463 464 465 466 467 468 469 470 |
# File 'generated/google/apis/plus_domains_v1/service.rb', line 457 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}', ) 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.
504 505 506 507 508 509 510 511 512 513 514 515 516 |
# File 'generated/google/apis/plus_domains_v1/service.rb', line 504 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}', ) 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.
548 549 550 551 552 553 554 555 556 557 558 559 |
# File 'generated/google/apis/plus_domains_v1/service.rb', line 548 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', ) 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 |