Regen APIs, add mybusiness_v3

This commit is contained in:
Steve Bazyl committed 2016-05-25 09:16:15 -07:00
1 parent 253bc51e0b
commit 557057c754
67 files changed
+7410 -529

No files matched your search

+1 -1
View File
@@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/adsense/management/
module AdsenseV1_4
VERSION = 'V1_4'
REVISION = '20160507'
REVISION = '20160523'
# View and manage your AdSense data
AUTH_ADSENSE = 'https://www.googleapis.com/auth/adsense'
+1 -1
View File
@@ -26,7 +26,7 @@ module Google
# @see https://developers.google.com/adsense/host/
module AdsensehostV4_1
VERSION = 'V4_1'
REVISION = '20160507'
REVISION = '20160523'
# View and manage your AdSense host data and associated accounts
AUTH_ADSENSEHOST = 'https://www.googleapis.com/auth/adsensehost'
@@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/android/work/play/emm-api
module AndroidenterpriseV1
VERSION = 'V1'
REVISION = '20160511'
REVISION = '20160519'
# Manage corporate Android devices
AUTH_ANDROIDENTERPRISE = 'https://www.googleapis.com/auth/androidenterprise'
+1 -1
View File
@@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/android-publisher
module AndroidpublisherV2
VERSION = 'V2'
REVISION = '20160507'
REVISION = '20160516'
# View and manage your Google Play Developer account
AUTH_ANDROIDPUBLISHER = 'https://www.googleapis.com/auth/androidpublisher'
@@ -252,6 +252,56 @@ module Google
end
end
#
class Comment
include Google::Apis::Core::Hashable
# A comment from a developer.
# Corresponds to the JSON property `developerComment`
# @return [Google::Apis::AndroidpublisherV2::DeveloperComment]
attr_accessor :developer_comment
# A comment from a user.
# Corresponds to the JSON property `userComment`
# @return [Google::Apis::AndroidpublisherV2::UserComment]
attr_accessor :user_comment
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@developer_comment = args[:developer_comment] if args.key?(:developer_comment)
@user_comment = args[:user_comment] if args.key?(:user_comment)
end
end
#
class DeveloperComment
include Google::Apis::Core::Hashable
# The last time at which this comment was updated.
# Corresponds to the JSON property `lastModified`
# @return [Google::Apis::AndroidpublisherV2::Timestamp]
attr_accessor :last_modified
# The content of the comment, i.e. reply body.
# Corresponds to the JSON property `text`
# @return [String]
attr_accessor :text
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@last_modified = args[:last_modified] if args.key?(:last_modified)
@text = args[:text] if args.key?(:text)
end
end
# An Entitlement resource indicates a user's current entitlement to an inapp
# item or subscription.
class Entitlement
@@ -1159,6 +1209,132 @@ module Google
end
end
#
class Review
include Google::Apis::Core::Hashable
# The name of the user who wrote the review.
# Corresponds to the JSON property `authorName`
# @return [String]
attr_accessor :author_name
# A repeated field containing comments for the review.
# Corresponds to the JSON property `comments`
# @return [Array<Google::Apis::AndroidpublisherV2::Comment>]
attr_accessor :comments
# Unique identifier for this review.
# Corresponds to the JSON property `reviewId`
# @return [String]
attr_accessor :review_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@author_name = args[:author_name] if args.key?(:author_name)
@comments = args[:comments] if args.key?(:comments)
@review_id = args[:review_id] if args.key?(:review_id)
end
end
#
class ReviewReplyResult
include Google::Apis::Core::Hashable
# The time at which the reply took effect.
# Corresponds to the JSON property `lastEdited`
# @return [Google::Apis::AndroidpublisherV2::Timestamp]
attr_accessor :last_edited
# The reply text that was applied.
# Corresponds to the JSON property `replyText`
# @return [String]
attr_accessor :reply_text
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@last_edited = args[:last_edited] if args.key?(:last_edited)
@reply_text = args[:reply_text] if args.key?(:reply_text)
end
end
#
class ReviewsListResponse
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `pageInfo`
# @return [Google::Apis::AndroidpublisherV2::PageInfo]
attr_accessor :page_info
#
# Corresponds to the JSON property `reviews`
# @return [Array<Google::Apis::AndroidpublisherV2::Review>]
attr_accessor :reviews
#
# Corresponds to the JSON property `tokenPagination`
# @return [Google::Apis::AndroidpublisherV2::TokenPagination]
attr_accessor :token_pagination
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@page_info = args[:page_info] if args.key?(:page_info)
@reviews = args[:reviews] if args.key?(:reviews)
@token_pagination = args[:token_pagination] if args.key?(:token_pagination)
end
end
#
class ReviewsReplyRequest
include Google::Apis::Core::Hashable
# The text to set as the reply. Replies of more than approximately 350
# characters will be rejected. HTML tags will be stripped.
# Corresponds to the JSON property `replyText`
# @return [String]
attr_accessor :reply_text
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@reply_text = args[:reply_text] if args.key?(:reply_text)
end
end
#
class ReviewsReplyResponse
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `result`
# @return [Google::Apis::AndroidpublisherV2::ReviewReplyResult]
attr_accessor :result
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@result = args[:result] if args.key?(:result)
end
end
#
class Season
include Google::Apis::Core::Hashable
@@ -1372,6 +1548,31 @@ module Google
end
end
#
class Timestamp
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `nanos`
# @return [Fixnum]
attr_accessor :nanos
#
# Corresponds to the JSON property `seconds`
# @return [String]
attr_accessor :seconds
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@nanos = args[:nanos] if args.key?(:nanos)
@seconds = args[:seconds] if args.key?(:seconds)
end
end
#
class TokenPagination
include Google::Apis::Core::Hashable
@@ -1453,6 +1654,73 @@ module Google
@tracks = args[:tracks] if args.key?(:tracks)
end
end
#
class UserComment
include Google::Apis::Core::Hashable
# Integer Android SDK version of the user's device at the time the review was
# written, e.g. 23 is Marshmallow. May be absent.
# Corresponds to the JSON property `androidOsVersion`
# @return [Fixnum]
attr_accessor :android_os_version
# Integer version code of the app as installed at the time the review was
# written. May be absent.
# Corresponds to the JSON property `appVersionCode`
# @return [Fixnum]
attr_accessor :app_version_code
# String version name of the app as installed at the time the review was written.
# May be absent.
# Corresponds to the JSON property `appVersionName`
# @return [String]
attr_accessor :app_version_name
# Codename for the reviewer's device, e.g. klte, flounder. May be absent.
# Corresponds to the JSON property `device`
# @return [String]
attr_accessor :device
# The last time at which this comment was updated.
# Corresponds to the JSON property `lastModified`
# @return [Google::Apis::AndroidpublisherV2::Timestamp]
attr_accessor :last_modified
# Language code for the reviewer. This is taken from the device settings so is
# not guaranteed to match the language the review is written in. May be absent.
# Corresponds to the JSON property `reviewerLanguage`
# @return [String]
attr_accessor :reviewer_language
# The star rating associated with the review, from 1 to 5.
# Corresponds to the JSON property `starRating`
# @return [Fixnum]
attr_accessor :star_rating
# The content of the comment, i.e. review body. In some cases users have been
# able to write a review with separate title and body; in those cases the title
# and body are concatenated and separated by a tab character.
# Corresponds to the JSON property `text`
# @return [String]
attr_accessor :text
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@android_os_version = args[:android_os_version] if args.key?(:android_os_version)
@app_version_code = args[:app_version_code] if args.key?(:app_version_code)
@app_version_name = args[:app_version_name] if args.key?(:app_version_name)
@device = args[:device] if args.key?(:device)
@last_modified = args[:last_modified] if args.key?(:last_modified)
@reviewer_language = args[:reviewer_language] if args.key?(:reviewer_language)
@star_rating = args[:star_rating] if args.key?(:star_rating)
@text = args[:text] if args.key?(:text)
end
end
end
end
end
@@ -76,6 +76,18 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class Comment
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class DeveloperComment
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Entitlement
class Representation < Google::Apis::Core::JsonRepresentation; end
@@ -244,6 +256,36 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class Review
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ReviewReplyResult
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ReviewsListResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ReviewsReplyRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ReviewsReplyResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Season
class Representation < Google::Apis::Core::JsonRepresentation; end
@@ -280,6 +322,12 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class Timestamp
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class TokenPagination
class Representation < Google::Apis::Core::JsonRepresentation; end
@@ -298,6 +346,12 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class UserComment
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Apk
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@@ -374,6 +428,25 @@ module Google
end
end
class Comment
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :developer_comment, as: 'developerComment', class: Google::Apis::AndroidpublisherV2::DeveloperComment, decorator: Google::Apis::AndroidpublisherV2::DeveloperComment::Representation
property :user_comment, as: 'userComment', class: Google::Apis::AndroidpublisherV2::UserComment, decorator: Google::Apis::AndroidpublisherV2::UserComment::Representation
end
end
class DeveloperComment
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :last_modified, as: 'lastModified', class: Google::Apis::AndroidpublisherV2::Timestamp, decorator: Google::Apis::AndroidpublisherV2::Timestamp::Representation
property :text, as: 'text'
end
end
class Entitlement
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@@ -655,6 +728,52 @@ module Google
end
end
class Review
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :author_name, as: 'authorName'
collection :comments, as: 'comments', class: Google::Apis::AndroidpublisherV2::Comment, decorator: Google::Apis::AndroidpublisherV2::Comment::Representation
property :review_id, as: 'reviewId'
end
end
class ReviewReplyResult
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :last_edited, as: 'lastEdited', class: Google::Apis::AndroidpublisherV2::Timestamp, decorator: Google::Apis::AndroidpublisherV2::Timestamp::Representation
property :reply_text, as: 'replyText'
end
end
class ReviewsListResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :page_info, as: 'pageInfo', class: Google::Apis::AndroidpublisherV2::PageInfo, decorator: Google::Apis::AndroidpublisherV2::PageInfo::Representation
collection :reviews, as: 'reviews', class: Google::Apis::AndroidpublisherV2::Review, decorator: Google::Apis::AndroidpublisherV2::Review::Representation
property :token_pagination, as: 'tokenPagination', class: Google::Apis::AndroidpublisherV2::TokenPagination, decorator: Google::Apis::AndroidpublisherV2::TokenPagination::Representation
end
end
class ReviewsReplyRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :reply_text, as: 'replyText'
end
end
class ReviewsReplyResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :result, as: 'result', class: Google::Apis::AndroidpublisherV2::ReviewReplyResult, decorator: Google::Apis::AndroidpublisherV2::ReviewReplyResult::Representation
end
end
class Season
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@@ -714,6 +833,14 @@ module Google
end
end
class Timestamp
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :nanos, as: 'nanos'
property :seconds, as: 'seconds'
end
end
class TokenPagination
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@@ -739,6 +866,21 @@ module Google
end
end
class UserComment
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :android_os_version, as: 'androidOsVersion'
property :app_version_code, as: 'appVersionCode'
property :app_version_name, as: 'appVersionName'
property :device, as: 'device'
property :last_modified, as: 'lastModified', class: Google::Apis::AndroidpublisherV2::Timestamp, decorator: Google::Apis::AndroidpublisherV2::Timestamp::Representation
property :reviewer_language, as: 'reviewerLanguage'
property :star_rating, as: 'starRating'
property :text, as: 'text'
end
end
end
end
end
@@ -2324,6 +2324,127 @@ module Google
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Returns a single review.
# @param [String] package_name
# Unique identifier for the Android app for which we want reviews; for example, "
# com.spiffygame".
# @param [String] review_id
# @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.
# Overrides userIp if both are provided.
# @param [String] user_ip
# IP address of the site where the request originates. Use this if you want to
# enforce per-user limits.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AndroidpublisherV2::Review] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AndroidpublisherV2::Review]
#
# @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
def get_review(package_name, review_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, '{packageName}/reviews/{reviewId}', options)
command.response_representation = Google::Apis::AndroidpublisherV2::Review::Representation
command.response_class = Google::Apis::AndroidpublisherV2::Review
command.params['packageName'] = package_name unless package_name.nil?
command.params['reviewId'] = review_id unless review_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
# Returns a list of reviews.
# @param [String] package_name
# Unique identifier for the Android app for which we want reviews; for example, "
# com.spiffygame".
# @param [Fixnum] max_results
# @param [Fixnum] start_index
# @param [String] token
# @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.
# Overrides userIp if both are provided.
# @param [String] user_ip
# IP address of the site where the request originates. Use this if you want to
# enforce per-user limits.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AndroidpublisherV2::ReviewsListResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AndroidpublisherV2::ReviewsListResponse]
#
# @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
def list_reviews(package_name, max_results: nil, start_index: nil, token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, '{packageName}/reviews', options)
command.response_representation = Google::Apis::AndroidpublisherV2::ReviewsListResponse::Representation
command.response_class = Google::Apis::AndroidpublisherV2::ReviewsListResponse
command.params['packageName'] = package_name unless package_name.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['startIndex'] = start_index unless start_index.nil?
command.query['token'] = token unless 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
# Reply to a single review, or update an existing reply.
# @param [String] package_name
# Unique identifier for the Android app for which we want reviews; for example, "
# com.spiffygame".
# @param [String] review_id
# @param [Google::Apis::AndroidpublisherV2::ReviewsReplyRequest] reviews_reply_request_object
# @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.
# Overrides userIp if both are provided.
# @param [String] user_ip
# IP address of the site where the request originates. Use this if you want to
# enforce per-user limits.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AndroidpublisherV2::ReviewsReplyResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AndroidpublisherV2::ReviewsReplyResponse]
#
# @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
def reply_review(package_name, review_id, reviews_reply_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:post, '{packageName}/reviews/{reviewId}:reply', options)
command.request_representation = Google::Apis::AndroidpublisherV2::ReviewsReplyRequest::Representation
command.request_object = reviews_reply_request_object
command.response_representation = Google::Apis::AndroidpublisherV2::ReviewsReplyResponse::Representation
command.response_class = Google::Apis::AndroidpublisherV2::ReviewsReplyResponse
command.params['packageName'] = package_name unless package_name.nil?
command.params['reviewId'] = review_id unless review_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
protected
+1 -1
View File
@@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/games/services/web/api/states
module AppstateV1
VERSION = 'V1'
REVISION = '20160509'
REVISION = '20160519'
# View and manage your data for this application
AUTH_APPSTATE = 'https://www.googleapis.com/auth/appstate'
+1 -1
View File
@@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/google-apps/calendar/firstapp
module CalendarV3
VERSION = 'V3'
REVISION = '20160510'
REVISION = '20160517'
# Manage your calendars
AUTH_CALENDAR = 'https://www.googleapis.com/auth/calendar'
+22 -1
View File
@@ -25,7 +25,10 @@ module Google
# @see https://developers.google.com/classroom/
module ClassroomV1
VERSION = 'V1'
REVISION = '20160428'
REVISION = '20160517'
# View instructions for teacher-assigned work in your Google Classroom classes
AUTH_CLASSROOM_COURSE_WORK_READONLY = 'https://www.googleapis.com/auth/classroom.course-work.readonly'
# Manage your Google Classroom classes
AUTH_CLASSROOM_COURSES = 'https://www.googleapis.com/auth/classroom.courses'
@@ -33,6 +36,18 @@ module Google
# View your Google Classroom classes
AUTH_CLASSROOM_COURSES_READONLY = 'https://www.googleapis.com/auth/classroom.courses.readonly'
# Manage your course work and view your grades in Google Classroom
AUTH_CLASSROOM_COURSEWORK_ME = 'https://www.googleapis.com/auth/classroom.coursework.me'
# View your course work and grades in Google Classroom
AUTH_CLASSROOM_COURSEWORK_ME_READONLY = 'https://www.googleapis.com/auth/classroom.coursework.me.readonly'
# Manage course work and grades for students in the Google Classroom classes you teach and view the course work and grades for classes you administer
AUTH_CLASSROOM_COURSEWORK_STUDENTS = 'https://www.googleapis.com/auth/classroom.coursework.students'
# View course work and grades for students in the Google Classroom classes you teach or administer
AUTH_CLASSROOM_COURSEWORK_STUDENTS_READONLY = 'https://www.googleapis.com/auth/classroom.coursework.students.readonly'
# View the email addresses of people in your classes
AUTH_CLASSROOM_PROFILE_EMAILS = 'https://www.googleapis.com/auth/classroom.profile.emails'
@@ -44,6 +59,12 @@ module Google
# View your Google Classroom class rosters
AUTH_CLASSROOM_ROSTERS_READONLY = 'https://www.googleapis.com/auth/classroom.rosters.readonly'
# View your course work and grades in Google Classroom
AUTH_CLASSROOM_STUDENT_SUBMISSIONS_ME_READONLY = 'https://www.googleapis.com/auth/classroom.student-submissions.me.readonly'
# View course work and grades for students in the Google Classroom classes you teach or administer
AUTH_CLASSROOM_STUDENT_SUBMISSIONS_STUDENTS_READONLY = 'https://www.googleapis.com/auth/classroom.student-submissions.students.readonly'
end
end
end
+920 -6
View File
@@ -30,7 +30,7 @@ module Google
# may optionally set this identifier to an alias string in the request to create
# a corresponding alias. The `id` is still assigned by Classroom and cannot be
# updated after the course is created. Specifying this field in a course update
# mask will result in an error.
# mask results in an error.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
@@ -72,26 +72,26 @@ module Google
# create course request, this field is required. The identifier can be one of
# the following: * the numeric identifier for the user * the email address of
# the user * the string literal `"me"`, indicating the requesting user This must
# be set in a create request. Specifying this field in a course update mask will
# result in an `INVALID_ARGUMENT` error.
# be set in a create request. Specifying this field in a course update mask
# results in an `INVALID_ARGUMENT` error.
# Corresponds to the JSON property `ownerId`
# @return [String]
attr_accessor :owner_id
# Creation time of the course. Specifying this field in a course update mask
# will result in an error. Read-only.
# results in an error. Read-only.
# Corresponds to the JSON property `creationTime`
# @return [String]
attr_accessor :creation_time
# Time of the most recent update to this course. Specifying this field in a
# course update mask will result in an error. Read-only.
# course update mask results in an error. Read-only.
# Corresponds to the JSON property `updateTime`
# @return [String]
attr_accessor :update_time
# Enrollment code to use when joining this course. Specifying this field in a
# course update mask will result in an error. Read-only.
# course update mask results in an error. Read-only.
# Corresponds to the JSON property `enrollmentCode`
# @return [String]
attr_accessor :enrollment_code
@@ -106,6 +106,29 @@ module Google
# @return [String]
attr_accessor :alternate_link
# The email address of a Google group containing all teachers of the course.
# This group does not accept email and can only be used for permissions. Read-
# only.
# Corresponds to the JSON property `teacherGroupEmail`
# @return [String]
attr_accessor :teacher_group_email
# The email address of a Google group containing all members of the course. This
# group does not accept email and can only be used for permissions. Read-only.
# Corresponds to the JSON property `courseGroupEmail`
# @return [String]
attr_accessor :course_group_email
# Representation of a Google Drive folder.
# Corresponds to the JSON property `teacherFolder`
# @return [Google::Apis::ClassroomV1::DriveFolder]
attr_accessor :teacher_folder
# Sets of materials that appear on the "about" page of this course. Read-only.
# Corresponds to the JSON property `courseMaterialSets`
# @return [Array<Google::Apis::ClassroomV1::CourseMaterialSet>]
attr_accessor :course_material_sets
def initialize(**args)
update!(**args)
end
@@ -124,6 +147,249 @@ module Google
@enrollment_code = args[:enrollment_code] if args.key?(:enrollment_code)
@course_state = args[:course_state] if args.key?(:course_state)
@alternate_link = args[:alternate_link] if args.key?(:alternate_link)
@teacher_group_email = args[:teacher_group_email] if args.key?(:teacher_group_email)
@course_group_email = args[:course_group_email] if args.key?(:course_group_email)
@teacher_folder = args[:teacher_folder] if args.key?(:teacher_folder)
@course_material_sets = args[:course_material_sets] if args.key?(:course_material_sets)
end
end
# Representation of a Google Drive folder.
class DriveFolder
include Google::Apis::Core::Hashable
# Drive API resource ID.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# Title of the Drive folder. Read-only.
# Corresponds to the JSON property `title`
# @return [String]
attr_accessor :title
# URL that can be used to access the Drive folder. Read-only.
# Corresponds to the JSON property `alternateLink`
# @return [String]
attr_accessor :alternate_link
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@title = args[:title] if args.key?(:title)
@alternate_link = args[:alternate_link] if args.key?(:alternate_link)
end
end
# A set of materials that appears on the "About" page of the course. These
# materials might include a syllabus, schedule, or other background information
# relating to the course as a whole.
class CourseMaterialSet
include Google::Apis::Core::Hashable
# Title for this set.
# Corresponds to the JSON property `title`
# @return [String]
attr_accessor :title
# Materials attached to this set.
# Corresponds to the JSON property `materials`
# @return [Array<Google::Apis::ClassroomV1::CourseMaterial>]
attr_accessor :materials
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@title = args[:title] if args.key?(:title)
@materials = args[:materials] if args.key?(:materials)
end
end
# A material attached to a course as part of a material set.
class CourseMaterial
include Google::Apis::Core::Hashable
# Representation of a Google Drive file.
# Corresponds to the JSON property `driveFile`
# @return [Google::Apis::ClassroomV1::DriveFile]
attr_accessor :drive_file
# YouTube video item.
# Corresponds to the JSON property `youTubeVideo`
# @return [Google::Apis::ClassroomV1::YouTubeVideo]
attr_accessor :you_tube_video
# URL item.
# Corresponds to the JSON property `link`
# @return [Google::Apis::ClassroomV1::Link]
attr_accessor :link
# Google Forms item.
# Corresponds to the JSON property `form`
# @return [Google::Apis::ClassroomV1::Form]
attr_accessor :form
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@drive_file = args[:drive_file] if args.key?(:drive_file)
@you_tube_video = args[:you_tube_video] if args.key?(:you_tube_video)
@link = args[:link] if args.key?(:link)
@form = args[:form] if args.key?(:form)
end
end
# Representation of a Google Drive file.
class DriveFile
include Google::Apis::Core::Hashable
# Drive API resource ID.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# Title of the Drive item. Read-only.
# Corresponds to the JSON property `title`
# @return [String]
attr_accessor :title
# URL that can be used to access the Drive item. Read-only.
# Corresponds to the JSON property `alternateLink`
# @return [String]
attr_accessor :alternate_link
# URL of a thumbnail image of the Drive item. Read-only.
# Corresponds to the JSON property `thumbnailUrl`
# @return [String]
attr_accessor :thumbnail_url
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@title = args[:title] if args.key?(:title)
@alternate_link = args[:alternate_link] if args.key?(:alternate_link)
@thumbnail_url = args[:thumbnail_url] if args.key?(:thumbnail_url)
end
end
# YouTube video item.
class YouTubeVideo
include Google::Apis::Core::Hashable
# YouTube API resource ID.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# Title of the YouTube video. Read-only.
# Corresponds to the JSON property `title`
# @return [String]
attr_accessor :title
# URL that can be used to view the YouTube video. Read-only.
# Corresponds to the JSON property `alternateLink`
# @return [String]
attr_accessor :alternate_link
# URL of a thumbnail image of the YouTube video. Read-only.
# Corresponds to the JSON property `thumbnailUrl`
# @return [String]
attr_accessor :thumbnail_url
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@title = args[:title] if args.key?(:title)
@alternate_link = args[:alternate_link] if args.key?(:alternate_link)
@thumbnail_url = args[:thumbnail_url] if args.key?(:thumbnail_url)
end
end
# URL item.
class Link
include Google::Apis::Core::Hashable
# URL to link to. This must be a valid UTF-8 string containing between 1 and
# 2024 characters.
# Corresponds to the JSON property `url`
# @return [String]
attr_accessor :url
# Title of the target of the URL. Read-only.
# Corresponds to the JSON property `title`
# @return [String]
attr_accessor :title
# URL of a thumbnail image of the target URL. Read-only.
# Corresponds to the JSON property `thumbnailUrl`
# @return [String]
attr_accessor :thumbnail_url
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@url = args[:url] if args.key?(:url)
@title = args[:title] if args.key?(:title)
@thumbnail_url = args[:thumbnail_url] if args.key?(:thumbnail_url)
end
end
# Google Forms item.
class Form
include Google::Apis::Core::Hashable
# URL of the form.
# Corresponds to the JSON property `formUrl`
# @return [String]
attr_accessor :form_url
# URL of the form responses document. Only set if respsonses have been recorded
# and only when the requesting user is an editor of the form. Read-only.
# Corresponds to the JSON property `responseUrl`
# @return [String]
attr_accessor :response_url
# Title of the Form. Read-only.
# Corresponds to the JSON property `title`
# @return [String]
attr_accessor :title
# URL of a thumbnail image of the Form. Read-only.
# Corresponds to the JSON property `thumbnailUrl`
# @return [String]
attr_accessor :thumbnail_url
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@form_url = args[:form_url] if args.key?(:form_url)
@response_url = args[:response_url] if args.key?(:response_url)
@title = args[:title] if args.key?(:title)
@thumbnail_url = args[:thumbnail_url] if args.key?(:thumbnail_url)
end
end
@@ -470,6 +736,11 @@ module Google
# @return [Google::Apis::ClassroomV1::UserProfile]
attr_accessor :profile
# Representation of a Google Drive folder.
# Corresponds to the JSON property `studentWorkFolder`
# @return [Google::Apis::ClassroomV1::DriveFolder]
attr_accessor :student_work_folder
def initialize(**args)
update!(**args)
end
@@ -479,6 +750,7 @@ module Google
@course_id = args[:course_id] if args.key?(:course_id)
@user_id = args[:user_id] if args.key?(:user_id)
@profile = args[:profile] if args.key?(:profile)
@student_work_folder = args[:student_work_folder] if args.key?(:student_work_folder)
end
end
@@ -507,6 +779,648 @@ module Google
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
# Course work created by a teacher for students of the course.
class CourseWork
include Google::Apis::Core::Hashable
# Identifier of the course. Read-only.
# Corresponds to the JSON property `courseId`
# @return [String]
attr_accessor :course_id
# Classroom-assigned identifier of this course work, unique per course. Read-
# only.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# Title of this course work. The title must be a valid UTF-8 string containing
# between 1 and 3000 characters.
# Corresponds to the JSON property `title`
# @return [String]
attr_accessor :title
# Optional description of this course work. If set, the description must be a
# valid UTF-8 string containing no more than 30,000 characters.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Additional materials.
# Corresponds to the JSON property `materials`
# @return [Array<Google::Apis::ClassroomV1::Material>]
attr_accessor :materials
# Status of this course work.. If unspecified, the default state is `DRAFT`.
# Corresponds to the JSON property `state`
# @return [String]
attr_accessor :state
# Absolute link to this course work in the Classroom web UI. This is only
# populated if `state` is `PUBLISHED`. Read-only.
# Corresponds to the JSON property `alternateLink`
# @return [String]
attr_accessor :alternate_link
# Timestamp when this course work was created. Read-only.
# Corresponds to the JSON property `creationTime`
# @return [String]
attr_accessor :creation_time
# Timestamp of the most recent change to this course work. Read-only.
# Corresponds to the JSON property `updateTime`
# @return [String]
attr_accessor :update_time
# Represents a whole calendar date, e.g. date of birth. The time of day and time
# zone are either specified elsewhere or are not significant. The date is
# relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a
# year and month where the day is not significant, e.g. credit card expiration
# date. The year may be 0 to represent a month and day independent of year, e.g.
# anniversary date. Related types are google.type.TimeOfDay and `google.protobuf.
# Timestamp`.
# Corresponds to the JSON property `dueDate`
# @return [Google::Apis::ClassroomV1::Date]
attr_accessor :due_date
# Represents a time of day. The date and time zone are either not significant or
# are specified elsewhere. An API may chose to allow leap seconds. Related types
# are google.type.Date and `google.protobuf.Timestamp`.
# Corresponds to the JSON property `dueTime`
# @return [Google::Apis::ClassroomV1::TimeOfDay]
attr_accessor :due_time
# Maximum grade for this course work. If zero or unspecified, this assignment is
# considered ungraded. This must be an integer value.
# Corresponds to the JSON property `maxPoints`
# @return [Float]
attr_accessor :max_points
# Type of this course work. The type is set when the course work is created and
# cannot be changed. When creating course work, this must be `ASSIGNMENT`.
# Corresponds to the JSON property `workType`
# @return [String]
attr_accessor :work_type
# Whether this course work item is associated with the Developer Console project
# making the request. See google.classroom.Work.CreateCourseWork for more
# details. Read-only.
# Corresponds to the JSON property `associatedWithDeveloper`
# @return [Boolean]
attr_accessor :associated_with_developer
alias_method :associated_with_developer?, :associated_with_developer
# Setting to determine when students are allowed to modify submissions. If
# unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.
# Corresponds to the JSON property `submissionModificationMode`
# @return [String]
attr_accessor :submission_modification_mode
# Additional details for assignments.
# Corresponds to the JSON property `assignment`
# @return [Google::Apis::ClassroomV1::Assignment]
attr_accessor :assignment
# Additional details for multiple-choice questions.
# Corresponds to the JSON property `multipleChoiceQuestion`
# @return [Google::Apis::ClassroomV1::MultipleChoiceQuestion]
attr_accessor :multiple_choice_question
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@course_id = args[:course_id] if args.key?(:course_id)
@id = args[:id] if args.key?(:id)
@title = args[:title] if args.key?(:title)
@description = args[:description] if args.key?(:description)
@materials = args[:materials] if args.key?(:materials)
@state = args[:state] if args.key?(:state)
@alternate_link = args[:alternate_link] if args.key?(:alternate_link)
@creation_time = args[:creation_time] if args.key?(:creation_time)
@update_time = args[:update_time] if args.key?(:update_time)
@due_date = args[:due_date] if args.key?(:due_date)
@due_time = args[:due_time] if args.key?(:due_time)
@max_points = args[:max_points] if args.key?(:max_points)
@work_type = args[:work_type] if args.key?(:work_type)
@associated_with_developer = args[:associated_with_developer] if args.key?(:associated_with_developer)
@submission_modification_mode = args[:submission_modification_mode] if args.key?(:submission_modification_mode)
@assignment = args[:assignment] if args.key?(:assignment)
@multiple_choice_question = args[:multiple_choice_question] if args.key?(:multiple_choice_question)
end
end
# Material attached to course work. When creating attachments, only the Link
# field may be specified.
class Material
include Google::Apis::Core::Hashable
# Drive file that is used as material for course work.
# Corresponds to the JSON property `driveFile`
# @return [Google::Apis::ClassroomV1::SharedDriveFile]
attr_accessor :drive_file
# YouTube video item.
# Corresponds to the JSON property `youtubeVideo`
# @return [Google::Apis::ClassroomV1::YouTubeVideo]
attr_accessor :youtube_video
# URL item.
# Corresponds to the JSON property `link`
# @return [Google::Apis::ClassroomV1::Link]
attr_accessor :link
# Google Forms item.
# Corresponds to the JSON property `form`
# @return [Google::Apis::ClassroomV1::Form]
attr_accessor :form
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@drive_file = args[:drive_file] if args.key?(:drive_file)
@youtube_video = args[:youtube_video] if args.key?(:youtube_video)
@link = args[:link] if args.key?(:link)
@form = args[:form] if args.key?(:form)
end
end
# Drive file that is used as material for course work.
class SharedDriveFile
include Google::Apis::Core::Hashable
# Representation of a Google Drive file.
# Corresponds to the JSON property `driveFile`
# @return [Google::Apis::ClassroomV1::DriveFile]
attr_accessor :drive_file
# Mechanism by which students access the Drive item.
# Corresponds to the JSON property `shareMode`
# @return [String]
attr_accessor :share_mode
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@drive_file = args[:drive_file] if args.key?(:drive_file)
@share_mode = args[:share_mode] if args.key?(:share_mode)
end
end
# Represents a whole calendar date, e.g. date of birth. The time of day and time
# zone are either specified elsewhere or are not significant. The date is
# relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a
# year and month where the day is not significant, e.g. credit card expiration
# date. The year may be 0 to represent a month and day independent of year, e.g.
# anniversary date. Related types are google.type.TimeOfDay and `google.protobuf.
# Timestamp`.
class Date
include Google::Apis::Core::Hashable
# Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
# Corresponds to the JSON property `year`
# @return [Fixnum]
attr_accessor :year
# Month of year. Must be from 1 to 12.
# Corresponds to the JSON property `month`
# @return [Fixnum]
attr_accessor :month
# Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if
# specifying a year/month where the day is not significant.
# Corresponds to the JSON property `day`
# @return [Fixnum]
attr_accessor :day
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@year = args[:year] if args.key?(:year)
@month = args[:month] if args.key?(:month)
@day = args[:day] if args.key?(:day)
end
end
# Represents a time of day. The date and time zone are either not significant or
# are specified elsewhere. An API may chose to allow leap seconds. Related types
# are google.type.Date and `google.protobuf.Timestamp`.
class TimeOfDay
include Google::Apis::Core::Hashable
# Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to
# allow the value "24:00:00" for scenarios like business closing time.
# Corresponds to the JSON property `hours`
# @return [Fixnum]
attr_accessor :hours
# Minutes of hour of day. Must be from 0 to 59.
# Corresponds to the JSON property `minutes`
# @return [Fixnum]
attr_accessor :minutes
# Seconds of minutes of the time. Must normally be from 0 to 59. An API may
# allow the value 60 if it allows leap-seconds.
# Corresponds to the JSON property `seconds`
# @return [Fixnum]
attr_accessor :seconds
# Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
# Corresponds to the JSON property `nanos`
# @return [Fixnum]
attr_accessor :nanos
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@hours = args[:hours] if args.key?(:hours)
@minutes = args[:minutes] if args.key?(:minutes)
@seconds = args[:seconds] if args.key?(:seconds)
@nanos = args[:nanos] if args.key?(:nanos)
end
end
# Additional details for assignments.
class Assignment
include Google::Apis::Core::Hashable
# Representation of a Google Drive folder.
# Corresponds to the JSON property `studentWorkFolder`
# @return [Google::Apis::ClassroomV1::DriveFolder]
attr_accessor :student_work_folder
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@student_work_folder = args[:student_work_folder] if args.key?(:student_work_folder)
end
end
# Additional details for multiple-choice questions.
class MultipleChoiceQuestion
include Google::Apis::Core::Hashable
# Possible choices.
# Corresponds to the JSON property `choices`
# @return [Array<String>]
attr_accessor :choices
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@choices = args[:choices] if args.key?(:choices)
end
end
# Response when listing course work.
class ListCourseWorkResponse
include Google::Apis::Core::Hashable
# Course work items that match the request.
# Corresponds to the JSON property `courseWork`
# @return [Array<Google::Apis::ClassroomV1::CourseWork>]
attr_accessor :course_work
# Token identifying the next page of results to return. If empty, no further
# results are available.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@course_work = args[:course_work] if args.key?(:course_work)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
# Student submission for course work. StudentSubmission items are generated when
# a CourseWork item is created. StudentSubmissions that have never been accessed
# (i.e. with `state` = NEW) may not have a creation time or update time.
class StudentSubmission
include Google::Apis::Core::Hashable
# Identifier of the course. Read-only.
# Corresponds to the JSON property `courseId`
# @return [String]
attr_accessor :course_id
# Identifier for the course work this corresponds to. Read-only.
# Corresponds to the JSON property `courseWorkId`
# @return [String]
attr_accessor :course_work_id
# Classroom-assigned Identifier for the student submission. This is unique among
# submissions for the relevant course work. Read-only.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# Identifier for the student that owns this submission. Read-only.
# Corresponds to the JSON property `userId`
# @return [String]
attr_accessor :user_id
# Creation time of this submission.. This may be unset if the student has not
# accessed this item. Read-only.
# Corresponds to the JSON property `creationTime`
# @return [String]
attr_accessor :creation_time
# Last update time of this submission. This may be unset if the student has not
# accessed this item. Read-only.
# Corresponds to the JSON property `updateTime`
# @return [String]
attr_accessor :update_time
# State of this submission. Read-only.
# Corresponds to the JSON property `state`
# @return [String]
attr_accessor :state
# Whether this submission is late. Read-only.
# Corresponds to the JSON property `late`
# @return [Boolean]
attr_accessor :late
alias_method :late?, :late
# Optional pending grade. If unset, no grade was set. This must be an integer
# value. This is only visible to and modifiable by course teachers.
# Corresponds to the JSON property `draftGrade`
# @return [Float]
attr_accessor :draft_grade
# Optional grade. If unset, no grade was set. This must be an integer value.
# This may be modified only by course teachers.
# Corresponds to the JSON property `assignedGrade`
# @return [Float]
attr_accessor :assigned_grade
# Absolute link to the submission in the Classroom web UI. Read-only.
# Corresponds to the JSON property `alternateLink`
# @return [String]
attr_accessor :alternate_link
# Type of course work this submission is for. Read-only.
# Corresponds to the JSON property `courseWorkType`
# @return [String]
attr_accessor :course_work_type
# Whether this student submission is associated with the Developer Console
# project making the request. See google.classroom.Work.CreateCourseWork for
# more details. Read-only.
# Corresponds to the JSON property `associatedWithDeveloper`
# @return [Boolean]
attr_accessor :associated_with_developer
alias_method :associated_with_developer?, :associated_with_developer
# Student work for an assignment.
# Corresponds to the JSON property `assignmentSubmission`
# @return [Google::Apis::ClassroomV1::AssignmentSubmission]
attr_accessor :assignment_submission
# Student work for a short answer question.
# Corresponds to the JSON property `shortAnswerSubmission`
# @return [Google::Apis::ClassroomV1::ShortAnswerSubmission]
attr_accessor :short_answer_submission
# Student work for a multiple-choice question.
# Corresponds to the JSON property `multipleChoiceSubmission`
# @return [Google::Apis::ClassroomV1::MultipleChoiceSubmission]
attr_accessor :multiple_choice_submission
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@course_id = args[:course_id] if args.key?(:course_id)
@course_work_id = args[:course_work_id] if args.key?(:course_work_id)
@id = args[:id] if args.key?(:id)
@user_id = args[:user_id] if args.key?(:user_id)
@creation_time = args[:creation_time] if args.key?(:creation_time)
@update_time = args[:update_time] if args.key?(:update_time)
@state = args[:state] if args.key?(:state)
@late = args[:late] if args.key?(:late)
@draft_grade = args[:draft_grade] if args.key?(:draft_grade)
@assigned_grade = args[:assigned_grade] if args.key?(:assigned_grade)
@alternate_link = args[:alternate_link] if args.key?(:alternate_link)
@course_work_type = args[:course_work_type] if args.key?(:course_work_type)
@associated_with_developer = args[:associated_with_developer] if args.key?(:associated_with_developer)
@assignment_submission = args[:assignment_submission] if args.key?(:assignment_submission)
@short_answer_submission = args[:short_answer_submission] if args.key?(:short_answer_submission)
@multiple_choice_submission = args[:multiple_choice_submission] if args.key?(:multiple_choice_submission)
end
end
# Student work for an assignment.
class AssignmentSubmission
include Google::Apis::Core::Hashable
# Attachments added by the student. Drive files that correspond to materials
# with a share mode of SUBMISSION_COPY may not exist yet if the student has not
# accessed the assignment in Classroom. Some attachment metadata is only
# populated if the requesting user has permission to access it. Identifier and
# alternate_link fields are available, but others (e.g. title) may not be.
# Corresponds to the JSON property `attachments`
# @return [Array<Google::Apis::ClassroomV1::Attachment>]
attr_accessor :attachments
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@attachments = args[:attachments] if args.key?(:attachments)
end
end
# Attachment added to student assignment work. When creating attachments, only
# the Link field may be specified.
class Attachment
include Google::Apis::Core::Hashable
# Representation of a Google Drive file.
# Corresponds to the JSON property `driveFile`
# @return [Google::Apis::ClassroomV1::DriveFile]
attr_accessor :drive_file
# YouTube video item.
# Corresponds to the JSON property `youTubeVideo`
# @return [Google::Apis::ClassroomV1::YouTubeVideo]
attr_accessor :you_tube_video
# URL item.
# Corresponds to the JSON property `link`
# @return [Google::Apis::ClassroomV1::Link]
attr_accessor :link
# Google Forms item.
# Corresponds to the JSON property `form`
# @return [Google::Apis::ClassroomV1::Form]
attr_accessor :form
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@drive_file = args[:drive_file] if args.key?(:drive_file)
@you_tube_video = args[:you_tube_video] if args.key?(:you_tube_video)
@link = args[:link] if args.key?(:link)
@form = args[:form] if args.key?(:form)
end
end
# Student work for a short answer question.
class ShortAnswerSubmission
include Google::Apis::Core::Hashable
# Student response to a short-answer question.
# Corresponds to the JSON property `answer`
# @return [String]
attr_accessor :answer
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@answer = args[:answer] if args.key?(:answer)
end
end
# Student work for a multiple-choice question.
class MultipleChoiceSubmission
include Google::Apis::Core::Hashable
# Student's select choice.
# Corresponds to the JSON property `answer`
# @return [String]
attr_accessor :answer
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@answer = args[:answer] if args.key?(:answer)
end
end
# Response when listing student submissions.
class ListStudentSubmissionsResponse
include Google::Apis::Core::Hashable
# Student work that matches the request.
# Corresponds to the JSON property `studentSubmissions`
# @return [Array<Google::Apis::ClassroomV1::StudentSubmission>]
attr_accessor :student_submissions
# Token identifying the next page of results to return. If empty, no further
# results are available.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@student_submissions = args[:student_submissions] if args.key?(:student_submissions)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
# Request to turn in a student submission.
class TurnInStudentSubmissionRequest
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
# Request to reclaim a student submission.
class ReclaimStudentSubmissionRequest
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
# Request to return a student submission.
class ReturnStudentSubmissionRequest
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
# Request to modify the attachments of a student submission.
class ModifyAttachmentsRequest
include Google::Apis::Core::Hashable
# Attachments to add. This may only contain link attachments.
# Corresponds to the JSON property `addAttachments`
# @return [Array<Google::Apis::ClassroomV1::Attachment>]
attr_accessor :add_attachments
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@add_attachments = args[:add_attachments] if args.key?(:add_attachments)
end
end
end
end
end
@@ -28,6 +28,48 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class DriveFolder
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class CourseMaterialSet
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class CourseMaterial
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class DriveFile
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class YouTubeVideo
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Link
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Form
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Empty
class Representation < Google::Apis::Core::JsonRepresentation; end
@@ -106,6 +148,114 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class CourseWork
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Material
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class SharedDriveFile
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Date
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class TimeOfDay
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Assignment
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class MultipleChoiceQuestion
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListCourseWorkResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class StudentSubmission
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AssignmentSubmission
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Attachment
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ShortAnswerSubmission
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class MultipleChoiceSubmission
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListStudentSubmissionsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class TurnInStudentSubmissionRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ReclaimStudentSubmissionRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ReturnStudentSubmissionRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ModifyAttachmentsRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Course
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@@ -121,6 +271,83 @@ module Google
property :enrollment_code, as: 'enrollmentCode'
property :course_state, as: 'courseState'
property :alternate_link, as: 'alternateLink'
property :teacher_group_email, as: 'teacherGroupEmail'
property :course_group_email, as: 'courseGroupEmail'
property :teacher_folder, as: 'teacherFolder', class: Google::Apis::ClassroomV1::DriveFolder, decorator: Google::Apis::ClassroomV1::DriveFolder::Representation
collection :course_material_sets, as: 'courseMaterialSets', class: Google::Apis::ClassroomV1::CourseMaterialSet, decorator: Google::Apis::ClassroomV1::CourseMaterialSet::Representation
end
end
class DriveFolder
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :id, as: 'id'
property :title, as: 'title'
property :alternate_link, as: 'alternateLink'
end
end
class CourseMaterialSet
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :title, as: 'title'
collection :materials, as: 'materials', class: Google::Apis::ClassroomV1::CourseMaterial, decorator: Google::Apis::ClassroomV1::CourseMaterial::Representation
end
end
class CourseMaterial
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :drive_file, as: 'driveFile', class: Google::Apis::ClassroomV1::DriveFile, decorator: Google::Apis::ClassroomV1::DriveFile::Representation
property :you_tube_video, as: 'youTubeVideo', class: Google::Apis::ClassroomV1::YouTubeVideo, decorator: Google::Apis::ClassroomV1::YouTubeVideo::Representation
property :link, as: 'link', class: Google::Apis::ClassroomV1::Link, decorator: Google::Apis::ClassroomV1::Link::Representation
property :form, as: 'form', class: Google::Apis::ClassroomV1::Form, decorator: Google::Apis::ClassroomV1::Form::Representation
end
end
class DriveFile
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :id, as: 'id'
property :title, as: 'title'
property :alternate_link, as: 'alternateLink'
property :thumbnail_url, as: 'thumbnailUrl'
end
end
class YouTubeVideo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :id, as: 'id'
property :title, as: 'title'
property :alternate_link, as: 'alternateLink'
property :thumbnail_url, as: 'thumbnailUrl'
end
end
class Link
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :url, as: 'url'
property :title, as: 'title'
property :thumbnail_url, as: 'thumbnailUrl'
end
end
class Form
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :form_url, as: 'formUrl'
property :response_url, as: 'responseUrl'
property :title, as: 'title'
property :thumbnail_url, as: 'thumbnailUrl'
end
end
@@ -229,6 +456,8 @@ module Google
property :user_id, as: 'userId'
property :profile, as: 'profile', class: Google::Apis::ClassroomV1::UserProfile, decorator: Google::Apis::ClassroomV1::UserProfile::Representation
property :student_work_folder, as: 'studentWorkFolder', class: Google::Apis::ClassroomV1::DriveFolder, decorator: Google::Apis::ClassroomV1::DriveFolder::Representation
end
end
@@ -240,6 +469,196 @@ module Google
property :next_page_token, as: 'nextPageToken'
end
end
class CourseWork
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :course_id, as: 'courseId'
property :id, as: 'id'
property :title, as: 'title'
property :description, as: 'description'
collection :materials, as: 'materials', class: Google::Apis::ClassroomV1::Material, decorator: Google::Apis::ClassroomV1::Material::Representation
property :state, as: 'state'
property :alternate_link, as: 'alternateLink'
property :creation_time, as: 'creationTime'
property :update_time, as: 'updateTime'
property :due_date, as: 'dueDate', class: Google::Apis::ClassroomV1::Date, decorator: Google::Apis::ClassroomV1::Date::Representation
property :due_time, as: 'dueTime', class: Google::Apis::ClassroomV1::TimeOfDay, decorator: Google::Apis::ClassroomV1::TimeOfDay::Representation
property :max_points, as: 'maxPoints'
property :work_type, as: 'workType'
property :associated_with_developer, as: 'associatedWithDeveloper'
property :submission_modification_mode, as: 'submissionModificationMode'
property :assignment, as: 'assignment', class: Google::Apis::ClassroomV1::Assignment, decorator: Google::Apis::ClassroomV1::Assignment::Representation
property :multiple_choice_question, as: 'multipleChoiceQuestion', class: Google::Apis::ClassroomV1::MultipleChoiceQuestion, decorator: Google::Apis::ClassroomV1::MultipleChoiceQuestion::Representation
end
end
class Material
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :drive_file, as: 'driveFile', class: Google::Apis::ClassroomV1::SharedDriveFile, decorator: Google::Apis::ClassroomV1::SharedDriveFile::Representation
property :youtube_video, as: 'youtubeVideo', class: Google::Apis::ClassroomV1::YouTubeVideo, decorator: Google::Apis::ClassroomV1::YouTubeVideo::Representation
property :link, as: 'link', class: Google::Apis::ClassroomV1::Link, decorator: Google::Apis::ClassroomV1::Link::Representation
property :form, as: 'form', class: Google::Apis::ClassroomV1::Form, decorator: Google::Apis::ClassroomV1::Form::Representation
end
end
class SharedDriveFile
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :drive_file, as: 'driveFile', class: Google::Apis::ClassroomV1::DriveFile, decorator: Google::Apis::ClassroomV1::DriveFile::Representation
property :share_mode, as: 'shareMode'
end
end
class Date
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :year, as: 'year'
property :month, as: 'month'
property :day, as: 'day'
end
end
class TimeOfDay
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :hours, as: 'hours'
property :minutes, as: 'minutes'
property :seconds, as: 'seconds'
property :nanos, as: 'nanos'
end
end
class Assignment
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :student_work_folder, as: 'studentWorkFolder', class: Google::Apis::ClassroomV1::DriveFolder, decorator: Google::Apis::ClassroomV1::DriveFolder::Representation
end
end
class MultipleChoiceQuestion
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :choices, as: 'choices'
end
end
class ListCourseWorkResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :course_work, as: 'courseWork', class: Google::Apis::ClassroomV1::CourseWork, decorator: Google::Apis::ClassroomV1::CourseWork::Representation
property :next_page_token, as: 'nextPageToken'
end
end
class StudentSubmission
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :course_id, as: 'courseId'
property :course_work_id, as: 'courseWorkId'
property :id, as: 'id'
property :user_id, as: 'userId'
property :creation_time, as: 'creationTime'
property :update_time, as: 'updateTime'
property :state, as: 'state'
property :late, as: 'late'
property :draft_grade, as: 'draftGrade'
property :assigned_grade, as: 'assignedGrade'
property :alternate_link, as: 'alternateLink'
property :course_work_type, as: 'courseWorkType'
property :associated_with_developer, as: 'associatedWithDeveloper'
property :assignment_submission, as: 'assignmentSubmission', class: Google::Apis::ClassroomV1::AssignmentSubmission, decorator: Google::Apis::ClassroomV1::AssignmentSubmission::Representation
property :short_answer_submission, as: 'shortAnswerSubmission', class: Google::Apis::ClassroomV1::ShortAnswerSubmission, decorator: Google::Apis::ClassroomV1::ShortAnswerSubmission::Representation
property :multiple_choice_submission, as: 'multipleChoiceSubmission', class: Google::Apis::ClassroomV1::MultipleChoiceSubmission, decorator: Google::Apis::ClassroomV1::MultipleChoiceSubmission::Representation
end
end
class AssignmentSubmission
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :attachments, as: 'attachments', class: Google::Apis::ClassroomV1::Attachment, decorator: Google::Apis::ClassroomV1::Attachment::Representation
end
end
class Attachment
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :drive_file, as: 'driveFile', class: Google::Apis::ClassroomV1::DriveFile, decorator: Google::Apis::ClassroomV1::DriveFile::Representation
property :you_tube_video, as: 'youTubeVideo', class: Google::Apis::ClassroomV1::YouTubeVideo, decorator: Google::Apis::ClassroomV1::YouTubeVideo::Representation
property :link, as: 'link', class: Google::Apis::ClassroomV1::Link, decorator: Google::Apis::ClassroomV1::Link::Representation
property :form, as: 'form', class: Google::Apis::ClassroomV1::Form, decorator: Google::Apis::ClassroomV1::Form::Representation
end
end
class ShortAnswerSubmission
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :answer, as: 'answer'
end
end
class MultipleChoiceSubmission
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :answer, as: 'answer'
end
end
class ListStudentSubmissionsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :student_submissions, as: 'studentSubmissions', class: Google::Apis::ClassroomV1::StudentSubmission, decorator: Google::Apis::ClassroomV1::StudentSubmission::Representation
property :next_page_token, as: 'nextPageToken'
end
end
class TurnInStudentSubmissionRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class ReclaimStudentSubmissionRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class ReturnStudentSubmissionRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class ModifyAttachmentsRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :add_attachments, as: 'addAttachments', class: Google::Apis::ClassroomV1::Attachment, decorator: Google::Apis::ClassroomV1::Attachment::Representation
end
end
end
end
end
@@ -733,6 +733,512 @@ module Google
execute_or_queue_command(command, &block)
end
# Creates course work. The resulting course work (and corresponding student
# submissions) are associated with the Developer Console project of the [OAuth
# client ID](https://support.google.com/cloud/answer/6158849) used to make the
# request. Classroom API requests to modify course work and student submissions
# must be made with an OAuth client ID from the associated Developer Console
# project. This method returns the following error codes: * `PERMISSION_DENIED`
# if the requesting user is not permitted to access the requested course, create
# course work in the requested course, or for access errors. * `INVALID_ARGUMENT`
# if the request is malformed. * `NOT_FOUND` if the requested course does not
# exist.
# @param [String] course_id
# Identifier of the course. This identifier can be either the Classroom-assigned
# identifier or an alias.
# @param [Google::Apis::ClassroomV1::CourseWork] course_work_object
# @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::ClassroomV1::CourseWork] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ClassroomV1::CourseWork]
#
# @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
def create_course_work(course_id, course_work_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/courses/{courseId}/courseWork', options)
command.request_representation = Google::Apis::ClassroomV1::CourseWork::Representation
command.request_object = course_work_object
command.response_representation = Google::Apis::ClassroomV1::CourseWork::Representation
command.response_class = Google::Apis::ClassroomV1::CourseWork
command.params['courseId'] = course_id unless course_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns course work. This method returns the following error codes: * `
# PERMISSION_DENIED` if the requesting user is not permitted to access the
# requested course or course work, or for access errors. * `INVALID_ARGUMENT` if
# the request is malformed. * `NOT_FOUND` if the requested course or course work
# does not exist.
# @param [String] course_id
# Identifier of the course. This identifier can be either the Classroom-assigned
# identifier or an alias.
# @param [String] id
# Identifier of the course work.
# @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::ClassroomV1::CourseWork] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ClassroomV1::CourseWork]
#
# @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
def get_course_work(course_id, id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/courses/{courseId}/courseWork/{id}', options)
command.response_representation = Google::Apis::ClassroomV1::CourseWork::Representation
command.response_class = Google::Apis::ClassroomV1::CourseWork
command.params['courseId'] = course_id unless course_id.nil?
command.params['id'] = id unless id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns a list of course work that the requester is permitted to view. Course
# students may only view `PUBLISHED` course work. Course teachers and domain
# administrators may view all course work. This method returns the following
# error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to
# access the requested course or for access errors. * `INVALID_ARGUMENT` if the
# request is malformed. * `NOT_FOUND` if the requested course does not exist.
# @param [String] course_id
# Identifier of the course. This identifier can be either the Classroom-assigned
# identifier or an alias.
# @param [Array<String>, String] course_work_states
# Restriction on the work status to return. Only courseWork that matches is
# returned. If unspecified, items with a work status of `PUBLISHED` is returned.
# @param [String] order_by
# Optional sort ordering for results. A comma-separated list of fields with an
# optional sort direction keyword. Supported fields are `updateTime` and `
# dueDate`. Supported direction keywords are `asc` and `desc`. If not specified,
# `updateTime desc` is the default behavior. Examples: `dueDate asc,updateTime
# desc`, `updateTime,dueDate desc`
# @param [Fixnum] page_size
# Maximum number of items to return. Zero or unspecified indicates that the
# server may assign a maximum. The server may return fewer than the specified
# number of results.
# @param [String] page_token
# nextPageToken value returned from a previous list call, indicating that the
# subsequent page of results should be returned. The list request must be
# otherwise identical to the one that resulted in this token.
# @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::ClassroomV1::ListCourseWorkResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ClassroomV1::ListCourseWorkResponse]
#
# @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
def list_course_works(course_id, course_work_states: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/courses/{courseId}/courseWork', options)
command.response_representation = Google::Apis::ClassroomV1::ListCourseWorkResponse::Representation
command.response_class = Google::Apis::ClassroomV1::ListCourseWorkResponse
command.params['courseId'] = course_id unless course_id.nil?
command.query['courseWorkStates'] = course_work_states unless course_work_states.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
# Returns a student submission. * `PERMISSION_DENIED` if the requesting user is
# not permitted to access the requested course, course work, or student
# submission or for access errors. * `INVALID_ARGUMENT` if the request is
# malformed. * `NOT_FOUND` if the requested course, course work, or student
# submission does not exist.
# @param [String] course_id
# Identifier of the course. This identifier can be either the Classroom-assigned
# identifier or an alias.
# @param [String] course_work_id
# Identifier of the course work.
# @param [String] id
# Identifier of the student submission.
# @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::ClassroomV1::StudentSubmission] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ClassroomV1::StudentSubmission]
#
# @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
def get_student_submission(course_id, course_work_id, id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}', options)
command.response_representation = Google::Apis::ClassroomV1::StudentSubmission::Representation
command.response_class = Google::Apis::ClassroomV1::StudentSubmission
command.params['courseId'] = course_id unless course_id.nil?
command.params['courseWorkId'] = course_work_id unless course_work_id.nil?
command.params['id'] = id unless id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates one or more fields of a student submission. See google.classroom.v1.
# StudentSubmission for details of which fields may be updated and who may
# change them. This request must be made by the Developer Console project of the
# [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to
# create the corresponding course work item. This method returns the following
# error codes: * `PERMISSION_DENIED` if the requesting developer project did not
# create the corresponding course work, if the user is not permitted to make the
# requested modification to the student submission, or for access errors. * `
# INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested
# course, course work, or student submission does not exist.
# @param [String] course_id
# Identifier of the course. This identifier can be either the Classroom-assigned
# identifier or an alias.
# @param [String] course_work_id
# Identifier of the course work.
# @param [String] id
# Identifier of the student submission.
# @param [Google::Apis::ClassroomV1::StudentSubmission] student_submission_object
# @param [String] update_mask
# Mask that identifies which fields on the student submission to update. This
# field is required to do an update. The update fails if invalid fields are
# specified. The following fields may be specified by teachers: * `draft_grade` *
# `assigned_grade`
# @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::ClassroomV1::StudentSubmission] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ClassroomV1::StudentSubmission]
#
# @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
def patch_student_submission(course_id, course_work_id, id, student_submission_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}', options)
command.request_representation = Google::Apis::ClassroomV1::StudentSubmission::Representation
command.request_object = student_submission_object
command.response_representation = Google::Apis::ClassroomV1::StudentSubmission::Representation
command.response_class = Google::Apis::ClassroomV1::StudentSubmission
command.params['courseId'] = course_id unless course_id.nil?
command.params['courseWorkId'] = course_work_id unless course_work_id.nil?
command.params['id'] = id unless id.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
# Returns a list of student submissions that the requester is permitted to view,
# factoring in the OAuth scopes of the request. `-` may be specified as the `
# course_work_id` to include student submissions for multiple course work items.
# Course students may only view their own work. Course teachers and domain
# administrators may view all student submissions. This method returns the
# following error codes: * `PERMISSION_DENIED` if the requesting user is not
# permitted to access the requested course or course work, or for access errors.
# * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the
# requested course does not exist.
# @param [String] course_id
# Identifier of the course. This identifier can be either the Classroom-assigned
# identifier or an alias.
# @param [String] course_work_id
# Identifer of the student work to request. If `user_id` is specified, this may
# be set to the string literal `"-"` to request student work for all course work
# in the specified course.
# @param [String] user_id
# Optional argument to restrict returned student work to those owned by the
# student with the specified identifier. The identifier can be one of the
# following: * the numeric identifier for the user * the email address of the
# user * the string literal `"me"`, indicating the requesting user
# @param [Array<String>, String] states
# Requested submission states. If specified, returned student submissions match
# one of the specified submission states.
# @param [String] late
# Requested lateness value. If specified, returned student submissions are
# restricted by the requested value. If unspecified, submissions are returned
# regardless of `late` value.
# @param [Fixnum] page_size
# Maximum number of items to return. Zero or unspecified indicates that the
# server may assign a maximum. The server may return fewer than the specified
# number of results.
# @param [String] page_token
# nextPageToken value returned from a previous list call, indicating that the
# subsequent page of results should be returned. The list request must be
# otherwise identical to the one that resulted in this token.
# @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::ClassroomV1::ListStudentSubmissionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ClassroomV1::ListStudentSubmissionsResponse]
#
# @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
def list_student_submissions(course_id, course_work_id, user_id: nil, states: nil, late: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions', options)
command.response_representation = Google::Apis::ClassroomV1::ListStudentSubmissionsResponse::Representation
command.response_class = Google::Apis::ClassroomV1::ListStudentSubmissionsResponse
command.params['courseId'] = course_id unless course_id.nil?
command.params['courseWorkId'] = course_work_id unless course_work_id.nil?
command.query['userId'] = user_id unless user_id.nil?
command.query['states'] = states unless states.nil?
command.query['late'] = late unless late.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
# Turns in a student submission. Turning in a student submission transfers
# ownership of attached Drive files to the teacher and may also update the
# submission state. This may only be called by the student that owns the
# specified student submission. This request must be made by the Developer
# Console project of the [OAuth client ID](https://support.google.com/cloud/
# answer/6158849) used to create the corresponding course work item. This method
# returns the following error codes: * `PERMISSION_DENIED` if the requesting
# user is not permitted to access the requested course or course work, turn in
# the requested student submission, or for access errors. * `INVALID_ARGUMENT`
# if the request is malformed. * `NOT_FOUND` if the requested course, course
# work, or student submission does not exist.
# @param [String] course_id
# Identifier of the course. This identifier can be either the Classroom-assigned
# identifier or an alias.
# @param [String] course_work_id
# Identifier of the course work.
# @param [String] id
# Identifier of the student submission.
# @param [Google::Apis::ClassroomV1::TurnInStudentSubmissionRequest] turn_in_student_submission_request_object
# @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::ClassroomV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ClassroomV1::Empty]
#
# @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
def turn_in_student_submission(course_id, course_work_id, id, turn_in_student_submission_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn', options)
command.request_representation = Google::Apis::ClassroomV1::TurnInStudentSubmissionRequest::Representation
command.request_object = turn_in_student_submission_request_object
command.response_representation = Google::Apis::ClassroomV1::Empty::Representation
command.response_class = Google::Apis::ClassroomV1::Empty
command.params['courseId'] = course_id unless course_id.nil?
command.params['courseWorkId'] = course_work_id unless course_work_id.nil?
command.params['id'] = id unless id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Reclaims a student submission on behalf of the student that owns it.
# Reclaiming a student submission transfers ownership of attached Drive files to
# the student and update the submission state. Only the student that ownes the
# requested student submission may call this method, and only for a student
# submission that has been turned in. This request must be made by the Developer
# Console project of the [OAuth client ID](https://support.google.com/cloud/
# answer/6158849) used to create the corresponding course work item. This method
# returns the following error codes: * `PERMISSION_DENIED` if the requesting
# user is not permitted to access the requested course or course work, unsubmit
# the requested student submission, or for access errors. * `FAILED_PRECONDITION`
# if the student submission has not been turned in. * `INVALID_ARGUMENT` if the
# request is malformed. * `NOT_FOUND` if the requested course, course work, or
# student submission does not exist.
# @param [String] course_id
# Identifier of the course. This identifier can be either the Classroom-assigned
# identifier or an alias.
# @param [String] course_work_id
# Identifier of the course work.
# @param [String] id
# Identifier of the student submission.
# @param [Google::Apis::ClassroomV1::ReclaimStudentSubmissionRequest] reclaim_student_submission_request_object
# @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::ClassroomV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ClassroomV1::Empty]
#
# @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
def reclaim_student_submission(course_id, course_work_id, id, reclaim_student_submission_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim', options)
command.request_representation = Google::Apis::ClassroomV1::ReclaimStudentSubmissionRequest::Representation
command.request_object = reclaim_student_submission_request_object
command.response_representation = Google::Apis::ClassroomV1::Empty::Representation
command.response_class = Google::Apis::ClassroomV1::Empty
command.params['courseId'] = course_id unless course_id.nil?
command.params['courseWorkId'] = course_work_id unless course_work_id.nil?
command.params['id'] = id unless id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns a student submission. Returning a student submission transfers
# ownership of attached Drive files to the student and may also update the
# submission state. Unlike the Classroom application, returning a student
# submission does not set assignedGrade to the draftGrade value. Only a teacher
# of the course that contains the requested student submission may call this
# method. This request must be made by the Developer Console project of the [
# OAuth client ID](https://support.google.com/cloud/answer/6158849) used to
# create the corresponding course work item. This method returns the following
# error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to
# access the requested course or course work, return the requested student
# submission, or for access errors. * `INVALID_ARGUMENT` if the request is
# malformed. * `NOT_FOUND` if the requested course, course work, or student
# submission does not exist.
# @param [String] course_id
# Identifier of the course. This identifier can be either the Classroom-assigned
# identifier or an alias.
# @param [String] course_work_id
# Identifier of the course work.
# @param [String] id
# Identifier of the student submission.
# @param [Google::Apis::ClassroomV1::ReturnStudentSubmissionRequest] return_student_submission_request_object
# @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::ClassroomV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ClassroomV1::Empty]
#
# @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
def return_student_submission(course_id, course_work_id, id, return_student_submission_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return', options)
command.request_representation = Google::Apis::ClassroomV1::ReturnStudentSubmissionRequest::Representation
command.request_object = return_student_submission_request_object
command.response_representation = Google::Apis::ClassroomV1::Empty::Representation
command.response_class = Google::Apis::ClassroomV1::Empty
command.params['courseId'] = course_id unless course_id.nil?
command.params['courseWorkId'] = course_work_id unless course_work_id.nil?
command.params['id'] = id unless id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Modifies attachments of student submission. Attachments may only be added to
# student submissions whose type is `ASSIGNMENT`. This request must be made by
# the Developer Console project of the [OAuth client ID](https://support.google.
# com/cloud/answer/6158849) used to create the corresponding course work item.
# This method returns the following error codes: * `PERMISSION_DENIED` if the
# requesting user is not permitted to access the requested course or course work,
# if the user is not permitted to modify attachments on the requested student
# submission, or for access errors. * `INVALID_ARGUMENT` if the request is
# malformed. * `NOT_FOUND` if the requested course, course work, or student
# submission does not exist.
# @param [String] course_id
# Identifier of the course. This identifier can be either the Classroom-assigned
# identifier or an alias.
# @param [String] course_work_id
# Identifier of the course work.
# @param [String] id
# Identifier of the student submission.
# @param [Google::Apis::ClassroomV1::ModifyAttachmentsRequest] modify_attachments_request_object
# @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::ClassroomV1::StudentSubmission] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ClassroomV1::StudentSubmission]
#
# @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
def modify_student_submission_attachments(course_id, course_work_id, id, modify_attachments_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments', options)
command.request_representation = Google::Apis::ClassroomV1::ModifyAttachmentsRequest::Representation
command.request_object = modify_attachments_request_object
command.response_representation = Google::Apis::ClassroomV1::StudentSubmission::Representation
command.response_class = Google::Apis::ClassroomV1::StudentSubmission
command.params['courseId'] = course_id unless course_id.nil?
command.params['courseWorkId'] = course_work_id unless course_work_id.nil?
command.params['id'] = id unless id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates an invitation. Only one invitation for a user and course may exist at
# a time. Delete and re-create an invitation to make changes. This method
# returns the following error codes: * `PERMISSION_DENIED` if the requesting
+1 -1
View File
@@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/container-builder/docs/
module CloudbuildV1
VERSION = 'V1'
REVISION = '20160512'
REVISION = '20160525'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
@@ -341,7 +341,7 @@ module Google
# @return [String]
attr_accessor :status
# Time at whihc execution of the build was finished.
# Time at which execution of the build was finished.
# @OutputOnly
# Corresponds to the JSON property `finishTime`
# @return [String]
@@ -26,7 +26,7 @@ module Google
# @see https://cloud.google.com/resource-manager
module CloudresourcemanagerV1
VERSION = 'V1'
REVISION = '20160316'
REVISION = '20160518'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
@@ -26,7 +26,7 @@ module Google
# @see https://cloud.google.com/resource-manager
module CloudresourcemanagerV1beta1
VERSION = 'V1beta1'
REVISION = '20160316'
REVISION = '20160518'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
@@ -184,6 +184,61 @@ module Google
end
end
# The request sent to the GetAncestry method.
class GetAncestryRequest
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
# Response from the GetAncestry method.
class GetAncestryResponse
include Google::Apis::Core::Hashable
# Ancestors are ordered from bottom to top of the resource hierarchy. The first
# ancestor is the project itself, followed by the project's parent, etc.
# Corresponds to the JSON property `ancestor`
# @return [Array<Google::Apis::CloudresourcemanagerV1beta1::Ancestor>]
attr_accessor :ancestor
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@ancestor = args[:ancestor] if args.key?(:ancestor)
end
end
# Identifying information for a single ancestor of a project.
class Ancestor
include Google::Apis::Core::Hashable
# A container to reference an id for any resource type. A `resource` in Google
# Cloud Platform is a generic term for something you (a developer) may want to
# interact with through one of our API's. Some examples are an AppEngine app, a
# Compute Engine instance, a Cloud SQL database, and so on.
# Corresponds to the JSON property `resourceId`
# @return [Google::Apis::CloudresourcemanagerV1beta1::ResourceId]
attr_accessor :resource_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@resource_id = args[:resource_id] if args.key?(:resource_id)
end
end
# Request message for `GetIamPolicy` method.
class GetIamPolicyRequest
include Google::Apis::Core::Hashable
@@ -52,6 +52,24 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class GetAncestryRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GetAncestryResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Ancestor
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GetIamPolicyRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
@@ -149,6 +167,28 @@ module Google
end
end
class GetAncestryRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class GetAncestryResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :ancestor, as: 'ancestor', class: Google::Apis::CloudresourcemanagerV1beta1::Ancestor, decorator: Google::Apis::CloudresourcemanagerV1beta1::Ancestor::Representation
end
end
class Ancestor
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :resource_id, as: 'resourceId', class: Google::Apis::CloudresourcemanagerV1beta1::ResourceId, decorator: Google::Apis::CloudresourcemanagerV1beta1::ResourceId::Representation
end
end
class GetIamPolicyRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@@ -273,6 +273,41 @@ module Google
execute_or_queue_command(command, &block)
end
# Gets a list of ancestors in the resource hierarchy for the Project identified
# by the specified `project_id` (for example, `my-project-123`). The caller must
# have read permissions for this Project.
# @param [String] project_id
# The Project ID (for example, `my-project-123`). Required.
# @param [Google::Apis::CloudresourcemanagerV1beta1::GetAncestryRequest] get_ancestry_request_object
# @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::CloudresourcemanagerV1beta1::GetAncestryResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1beta1::GetAncestryResponse]
#
# @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
def get_project_ancestry(project_id, get_ancestry_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/projects/{projectId}:getAncestry', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::GetAncestryRequest::Representation
command.request_object = get_ancestry_request_object
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::GetAncestryResponse::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::GetAncestryResponse
command.params['projectId'] = project_id unless project_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns the IAM access control policy for the specified Project. Permission is
# denied if the policy or the resource does not exist.
# @param [String] resource
+11 -3
View File
@@ -20,16 +20,24 @@ module Google
module Apis
# Google Cloud Trace API
#
# The Cloud Trace API allows you to send traces to and retrieve traces from
# Google Cloud Trace.
# Send and retrieve trace data from Google Cloud Trace. Data is generated and
# available by default for all App Engine applications. Data from other
# applications can be written to Cloud Trace for display, reporting, and
# analysis.
#
# @see https://cloud.google.com/tools/cloud-trace
module CloudtraceV1
VERSION = 'V1'
REVISION = '20151207'
REVISION = '20160518'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
# Write Trace data for a project or application
AUTH_TRACE_APPEND = 'https://www.googleapis.com/auth/trace.append'
# Read Trace data for a project or application
AUTH_TRACE_READONLY = 'https://www.googleapis.com/auth/trace.readonly'
end
end
end
@@ -103,11 +103,11 @@ module Google
# @return [String]
attr_accessor :kind
# Name of the trace. The trace name is sanitized and displayed in the Cloud
# Trace tool in the Google Developers Console. The name may be a method name or
# some other per-call site name. For the same executable and the same call point,
# a best practice is to use a consistent name, which makes it easier to
# correlate cross-trace spans.
# Name of the trace. The trace name is sanitized and displayed in the
# Stackdriver Trace tool in the `% dynamic print site_values.console_name %`.
# The name may be a method name or some other per-call site name. For the same
# executable and the same call point, a best practice is to use a consistent
# name, which makes it easier to correlate cross-trace spans.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
@@ -22,17 +22,19 @@ module Google
module CloudtraceV1
# Google Cloud Trace API
#
# The Cloud Trace API allows you to send traces to and retrieve traces from
# Google Cloud Trace.
# Send and retrieve trace data from Google Cloud Trace. Data is generated and
# available by default for all App Engine applications. Data from other
# applications can be written to Cloud Trace for display, reporting, and
# analysis.
#
# @example
# require 'google/apis/cloudtrace_v1'
#
# Cloudtrace = Google::Apis::CloudtraceV1 # Alias the module
# service = Cloudtrace::CloudtraceService.new
# service = Cloudtrace::CloudTraceService.new
#
# @see https://cloud.google.com/tools/cloud-trace
class CloudtraceService < Google::Apis::Core::BaseService
class CloudTraceService < Google::Apis::Core::BaseService
# @return [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.
@@ -47,8 +49,8 @@ module Google
super('https://cloudtrace.googleapis.com/', '')
end
# Sends new traces to Cloud Trace or updates existing traces. If the ID of a
# trace that you send matches that of an existing trace, any fields in the
# Sends new traces to Stackdriver Trace or updates existing traces. If the ID of
# a trace that you send matches that of an existing trace, any fields in the
# existing trace and its spans are overwritten by the provided values, and any
# new fields provided are merged with the existing trace data. If the ID does
# not match, a new trace is created.
+1 -1
View File
@@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/compute/docs/reference/latest/
module ComputeBeta
VERSION = 'Beta'
REVISION = '20160426'
REVISION = '20160519'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
@@ -2139,6 +2139,10 @@ module Google
# If both properties are set, an inbound connection is allowed if the range
# matches the sourceRanges OR the tag of the source matches the sourceTags
# property. The connection does not need to match both properties.
# Source tags cannot be used to allow access to an instance's external IP
# address. Because tags are associated with an instance, not an IP address,
# source tags can only be used to control traffic traveling from an instance
# inside the same network as the firewall.
# Corresponds to the JSON property `sourceTags`
# @return [Array<String>]
attr_accessor :source_tags
@@ -5043,7 +5047,8 @@ module Google
# @return [String]
attr_accessor :id
# [Output Only] Whether this machine type has a shared CPU.
# [Output Only] Whether this machine type has a shared CPU. See Shared-core
# machine types for more information.
# Corresponds to the JSON property `isSharedCpu`
# @return [Boolean]
attr_accessor :is_shared_cpu
@@ -5648,9 +5653,9 @@ module Google
# @return [String]
attr_accessor :network
# An IPV4 internal network address to assign to the instance for this network
# interface. If not specified by user an unused internal IP is assigned by
# system.
# An IPv4 internal network address to assign to the instance for this network
# interface. If not specified by the user, an unused internal IP is assigned by
# the system.
# Corresponds to the JSON property `networkIP`
# @return [String]
attr_accessor :network_ip
+1 -1
View File
@@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/compute/docs/reference/latest/
module ComputeV1
VERSION = 'V1'
REVISION = '20160426'
REVISION = '20160519'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
+7 -3
View File
@@ -1986,6 +1986,10 @@ module Google
# If both properties are set, an inbound connection is allowed if the range
# matches the sourceRanges OR the tag of the source matches the sourceTags
# property. The connection does not need to match both properties.
# Source tags cannot be used to allow access to an instance's external IP
# address. Because tags are associated with an instance, not an IP address,
# source tags can only be used to control traffic traveling from an instance
# inside the same network as the firewall.
# Corresponds to the JSON property `sourceTags`
# @return [Array<String>]
attr_accessor :source_tags
@@ -5273,9 +5277,9 @@ module Google
# @return [String]
attr_accessor :network
# An IPV4 internal network address to assign to the instance for this network
# interface. If not specified by user an unused internal IP is assigned by
# system.
# An IPv4 internal network address to assign to the instance for this network
# interface. If not specified by the user, an unused internal IP is assigned by
# the system.
# Corresponds to the JSON property `networkIP`
# @return [String]
attr_accessor :network_ip
+1 -1
View File
@@ -26,7 +26,7 @@ module Google
# @see https://developers.google.com/shopping-content
module ContentV2
VERSION = 'V2'
REVISION = '20160419'
REVISION = '20160520'
# Manage your product listings and accounts for Google Shopping
AUTH_CONTENT = 'https://www.googleapis.com/auth/content'
@@ -4554,6 +4554,12 @@ module Google
# @return [Array<String>]
attr_accessor :additional_image_links
# Additional categories of the item (formatted as in products feed specification)
# .
# Corresponds to the JSON property `additionalProductTypes`
# @return [Array<String>]
attr_accessor :additional_product_types
# Set to true if the item is targeted towards adults.
# Corresponds to the JSON property `adult`
# @return [Boolean]
@@ -4931,6 +4937,7 @@ module Google
# Update properties of this object
def update!(**args)
@additional_image_links = args[:additional_image_links] if args.key?(:additional_image_links)
@additional_product_types = args[:additional_product_types] if args.key?(:additional_product_types)
@adult = args[:adult] if args.key?(:adult)
@adwords_grouping = args[:adwords_grouping] if args.key?(:adwords_grouping)
@adwords_labels = args[:adwords_labels] if args.key?(:adwords_labels)
@@ -2212,6 +2212,7 @@ module Google
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :additional_image_links, as: 'additionalImageLinks'
collection :additional_product_types, as: 'additionalProductTypes'
property :adult, as: 'adult'
property :adwords_grouping, as: 'adwordsGrouping'
collection :adwords_labels, as: 'adwordsLabels'
+1 -1
View File
@@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/cloud-dns
module DnsV1
VERSION = 'V1'
REVISION = '20160509'
REVISION = '20160513'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
@@ -26,7 +26,7 @@ module Google
# @see https://developers.google.com/doubleclick-search/
module DoubleclicksearchV2
VERSION = 'V2'
REVISION = '20160506'
REVISION = '20160519'
# View and manage your advertising data in DoubleClick Search
AUTH_DOUBLECLICKSEARCH = 'https://www.googleapis.com/auth/doubleclicksearch'
+1 -1
View File
@@ -26,7 +26,7 @@ module Google
# @see https://developers.google.com/drive/
module DriveV2
VERSION = 'V2'
REVISION = '20160506'
REVISION = '20160520'
# View and manage the files in your Google Drive
AUTH_DRIVE = 'https://www.googleapis.com/auth/drive'
+1 -1
View File
@@ -26,7 +26,7 @@ module Google
# @see https://developers.google.com/drive/
module DriveV3
VERSION = 'V3'
REVISION = '20160506'
REVISION = '20160520'
# View and manage the files in your Google Drive
AUTH_DRIVE = 'https://www.googleapis.com/auth/drive'
@@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/games/services
module GamesConfigurationV1configuration
VERSION = 'V1configuration'
REVISION = '20160509'
REVISION = '20160519'
# View and manage your Google Play Developer account
AUTH_ANDROIDPUBLISHER = 'https://www.googleapis.com/auth/androidpublisher'
@@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/games/services
module GamesManagementV1management
VERSION = 'V1management'
REVISION = '20160509'
REVISION = '20160519'
# Share your Google+ profile information and view and manage your game activity
AUTH_GAMES = 'https://www.googleapis.com/auth/games'
+1 -1
View File
@@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/games/services/
module GamesV1
VERSION = 'V1'
REVISION = '20160509'
REVISION = '20160519'
# View and manage its own configuration data in your Google Drive
AUTH_DRIVE_APPDATA = 'https://www.googleapis.com/auth/drive.appdata'
File diff suppressed because it is too large. Load diff
+1 -1
View File
@@ -27,7 +27,7 @@ module Google
# @see https://cloud.google.com/genomics/
module GenomicsV1
VERSION = 'V1'
REVISION = '20160512'
REVISION = '20160524'
# View and manage your data in Google BigQuery
AUTH_BIGQUERY = 'https://www.googleapis.com/auth/bigquery'
+1 -1
View File
@@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/gmail/api/
module GmailV1
VERSION = 'V1'
REVISION = '20160316'
REVISION = '20160522'
# View and manage your mail
AUTH_SCOPE = 'https://mail.google.com/'
+1 -1
View File
@@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/identity-toolkit/v3/
module IdentitytoolkitV3
VERSION = 'V3'
REVISION = '20160420'
REVISION = '20160510'
end
end
end
@@ -1037,6 +1037,12 @@ module Google
class VerifyCustomTokenRequest
include Google::Apis::Core::Hashable
# GCP project number of the requesting delegated app. Currently only intended
# for Firebase V1 migration.
# Corresponds to the JSON property `delegatedProjectNumber`
# @return [String]
attr_accessor :delegated_project_number
# Instance id token of the app.
# Corresponds to the JSON property `instanceId`
# @return [String]
@@ -1059,6 +1065,7 @@ module Google
# Update properties of this object
def update!(**args)
@delegated_project_number = args[:delegated_project_number] if args.key?(:delegated_project_number)
@instance_id = args[:instance_id] if args.key?(:instance_id)
@return_secure_token = args[:return_secure_token] if args.key?(:return_secure_token)
@token = args[:token] if args.key?(:token)
@@ -498,6 +498,7 @@ module Google
class VerifyCustomTokenRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :delegated_project_number, as: 'delegatedProjectNumber'
property :instance_id, as: 'instanceId'
property :return_secure_token, as: 'returnSecureToken'
property :token, as: 'token'
+32
View File
@@ -0,0 +1,32 @@
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/mybusiness_v3/service.rb'
require 'google/apis/mybusiness_v3/classes.rb'
require 'google/apis/mybusiness_v3/representations.rb'
module Google
module Apis
# Google My Business API
#
# The Google My Business API provides an interface for managing business
# location information on Google.
#
# @see https://developers.google.com/my-business/
module MybusinessV3
VERSION = 'V3'
REVISION = '0'
end
end
end
File diff suppressed because it is too large. Load diff
@@ -0,0 +1,741 @@
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'date'
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module MybusinessV3
class ListAccountsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Account
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AccountState
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListAccountAdminsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Admin
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Empty
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListLocationsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Location
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Address
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Category
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class BusinessHours
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class TimePeriod
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class SpecialHours
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class SpecialHourPeriod
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Date
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ServiceAreaBusiness
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class PointRadius
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class LatLng
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Places
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class PlaceInfo
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class LocationKey
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AdWordsLocationExtensions
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Photos
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class OpenInfo
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class LocationState
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Attribute
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Metadata
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Duplicate
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class BatchGetLocationsRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class BatchGetLocationsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleUpdatedLocation
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListLocationAdminsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class FindMatchingLocationsRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class FindMatchingLocationsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class MatchedLocation
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AssociateLocationRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ClearLocationAssociationRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class TransferLocationRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListReviewsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Review
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Reviewer
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ReviewReply
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListLocationAttributeMetadataResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AttributeMetadata
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AttributeValueMetadata
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListAccountsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :accounts, as: 'accounts', class: Google::Apis::MybusinessV3::Account, decorator: Google::Apis::MybusinessV3::Account::Representation
property :next_page_token, as: 'nextPageToken'
end
end
class Account
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :name, as: 'name'
property :account_name, as: 'accountName'
property :type, as: 'type'
property :role, as: 'role'
property :state, as: 'state', class: Google::Apis::MybusinessV3::AccountState, decorator: Google::Apis::MybusinessV3::AccountState::Representation
end
end
class AccountState
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :status, as: 'status'
end
end
class ListAccountAdminsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :admins, as: 'admins', class: Google::Apis::MybusinessV3::Admin, decorator: Google::Apis::MybusinessV3::Admin::Representation
end
end
class Admin
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :name, as: 'name'
property :admin_name, as: 'adminName'
property :role, as: 'role'
property :pending_invitation, as: 'pendingInvitation'
end
end
class Empty
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class ListLocationsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :locations, as: 'locations', class: Google::Apis::MybusinessV3::Location, decorator: Google::Apis::MybusinessV3::Location::Representation
property :next_page_token, as: 'nextPageToken'
end
end
class Location
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :name, as: 'name'
property :store_code, as: 'storeCode'
property :location_name, as: 'locationName'
property :primary_phone, as: 'primaryPhone'
collection :additional_phones, as: 'additionalPhones'
property :address, as: 'address', class: Google::Apis::MybusinessV3::Address, decorator: Google::Apis::MybusinessV3::Address::Representation
property :primary_category, as: 'primaryCategory', class: Google::Apis::MybusinessV3::Category, decorator: Google::Apis::MybusinessV3::Category::Representation
collection :additional_categories, as: 'additionalCategories', class: Google::Apis::MybusinessV3::Category, decorator: Google::Apis::MybusinessV3::Category::Representation
property :website_url, as: 'websiteUrl'
property :regular_hours, as: 'regularHours', class: Google::Apis::MybusinessV3::BusinessHours, decorator: Google::Apis::MybusinessV3::BusinessHours::Representation
property :special_hours, as: 'specialHours', class: Google::Apis::MybusinessV3::SpecialHours, decorator: Google::Apis::MybusinessV3::SpecialHours::Representation
property :service_area, as: 'serviceArea', class: Google::Apis::MybusinessV3::ServiceAreaBusiness, decorator: Google::Apis::MybusinessV3::ServiceAreaBusiness::Representation
property :location_key, as: 'locationKey', class: Google::Apis::MybusinessV3::LocationKey, decorator: Google::Apis::MybusinessV3::LocationKey::Representation
collection :labels, as: 'labels'
property :ad_words_location_extensions, as: 'adWordsLocationExtensions', class: Google::Apis::MybusinessV3::AdWordsLocationExtensions, decorator: Google::Apis::MybusinessV3::AdWordsLocationExtensions::Representation
property :photos, as: 'photos', class: Google::Apis::MybusinessV3::Photos, decorator: Google::Apis::MybusinessV3::Photos::Representation
property :latlng, as: 'latlng', class: Google::Apis::MybusinessV3::LatLng, decorator: Google::Apis::MybusinessV3::LatLng::Representation
property :open_info, as: 'openInfo', class: Google::Apis::MybusinessV3::OpenInfo, decorator: Google::Apis::MybusinessV3::OpenInfo::Representation
property :location_state, as: 'locationState', class: Google::Apis::MybusinessV3::LocationState, decorator: Google::Apis::MybusinessV3::LocationState::Representation
collection :attributes, as: 'attributes', class: Google::Apis::MybusinessV3::Attribute, decorator: Google::Apis::MybusinessV3::Attribute::Representation
property :metadata, as: 'metadata', class: Google::Apis::MybusinessV3::Metadata, decorator: Google::Apis::MybusinessV3::Metadata::Representation
end
end
class Address
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :address_lines, as: 'addressLines'
property :sub_locality, as: 'subLocality'
property :locality, as: 'locality'
property :administrative_area, as: 'administrativeArea'
property :country, as: 'country'
property :postal_code, as: 'postalCode'
end
end
class Category
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :name, as: 'name'
property :category_id, as: 'categoryId'
end
end
class BusinessHours
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :periods, as: 'periods', class: Google::Apis::MybusinessV3::TimePeriod, decorator: Google::Apis::MybusinessV3::TimePeriod::Representation
end
end
class TimePeriod
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :open_day, as: 'openDay'
property :open_time, as: 'openTime'
property :close_day, as: 'closeDay'
property :close_time, as: 'closeTime'
end
end
class SpecialHours
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :special_hour_periods, as: 'specialHourPeriods', class: Google::Apis::MybusinessV3::SpecialHourPeriod, decorator: Google::Apis::MybusinessV3::SpecialHourPeriod::Representation
end
end
class SpecialHourPeriod
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :start_date, as: 'startDate', class: Google::Apis::MybusinessV3::Date, decorator: Google::Apis::MybusinessV3::Date::Representation
property :open_time, as: 'openTime'
property :end_date, as: 'endDate', class: Google::Apis::MybusinessV3::Date, decorator: Google::Apis::MybusinessV3::Date::Representation
property :close_time, as: 'closeTime'
property :is_closed, as: 'isClosed'
end
end
class Date
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :year, as: 'year'
property :month, as: 'month'
property :day, as: 'day'
end
end
class ServiceAreaBusiness
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :business_type, as: 'businessType'
property :radius, as: 'radius', class: Google::Apis::MybusinessV3::PointRadius, decorator: Google::Apis::MybusinessV3::PointRadius::Representation
property :places, as: 'places', class: Google::Apis::MybusinessV3::Places, decorator: Google::Apis::MybusinessV3::Places::Representation
end
end
class PointRadius
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :latlng, as: 'latlng', class: Google::Apis::MybusinessV3::LatLng, decorator: Google::Apis::MybusinessV3::LatLng::Representation
property :radius_km, as: 'radiusKm'
end
end
class LatLng
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :latitude, as: 'latitude'
property :longitude, as: 'longitude'
end
end
class Places
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :place_infos, as: 'placeInfos', class: Google::Apis::MybusinessV3::PlaceInfo, decorator: Google::Apis::MybusinessV3::PlaceInfo::Representation
end
end
class PlaceInfo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :name, as: 'name'
property :place_id, as: 'placeId'
end
end
class LocationKey
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :plus_page_id, as: 'plusPageId'
property :place_id, as: 'placeId'
property :explicit_no_place_id, as: 'explicitNoPlaceId'
end
end
class AdWordsLocationExtensions
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :ad_phone, as: 'adPhone'
end
end
class Photos
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :profile_photo_url, as: 'profilePhotoUrl'
property :cover_photo_url, as: 'coverPhotoUrl'
property :logo_photo_url, as: 'logoPhotoUrl'
collection :exterior_photo_urls, as: 'exteriorPhotoUrls'
collection :interior_photo_urls, as: 'interiorPhotoUrls'
collection :product_photo_urls, as: 'productPhotoUrls'
collection :photos_at_work_urls, as: 'photosAtWorkUrls'
collection :food_and_drink_photo_urls, as: 'foodAndDrinkPhotoUrls'
collection :menu_photo_urls, as: 'menuPhotoUrls'
collection :common_areas_photo_urls, as: 'commonAreasPhotoUrls'
collection :rooms_photo_urls, as: 'roomsPhotoUrls'
collection :team_photo_urls, as: 'teamPhotoUrls'
collection :additional_photo_urls, as: 'additionalPhotoUrls'
property :preferred_photo, as: 'preferredPhoto'
end
end
class OpenInfo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :status, as: 'status'
end
end
class LocationState
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :is_google_updated, as: 'isGoogleUpdated'
property :is_duplicate, as: 'isDuplicate'
property :is_suspended, as: 'isSuspended'
property :can_update, as: 'canUpdate'
property :can_delete, as: 'canDelete'
property :is_verified, as: 'isVerified'
property :needs_reverification, as: 'needsReverification'
end
end
class Attribute
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :attribute_id, as: 'attributeId'
property :value_type, as: 'valueType'
collection :values, as: 'values'
end
end
class Metadata
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :duplicate, as: 'duplicate', class: Google::Apis::MybusinessV3::Duplicate, decorator: Google::Apis::MybusinessV3::Duplicate::Representation
end
end
class Duplicate
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :location_name, as: 'locationName'
property :ownership, as: 'ownership'
end
end
class BatchGetLocationsRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :location_names, as: 'locationNames'
end
end
class BatchGetLocationsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :locations, as: 'locations', class: Google::Apis::MybusinessV3::Location, decorator: Google::Apis::MybusinessV3::Location::Representation
end
end
class GoogleUpdatedLocation
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :location, as: 'location', class: Google::Apis::MybusinessV3::Location, decorator: Google::Apis::MybusinessV3::Location::Representation
property :diff_mask, as: 'diffMask'
end
end
class ListLocationAdminsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :admins, as: 'admins', class: Google::Apis::MybusinessV3::Admin, decorator: Google::Apis::MybusinessV3::Admin::Representation
end
end
class FindMatchingLocationsRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :language_code, as: 'languageCode'
property :num_results, as: 'numResults'
property :max_cache_duration, as: 'maxCacheDuration'
end
end
class FindMatchingLocationsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :matched_locations, as: 'matchedLocations', class: Google::Apis::MybusinessV3::MatchedLocation, decorator: Google::Apis::MybusinessV3::MatchedLocation::Representation
property :match_time, as: 'matchTime'
end
end
class MatchedLocation
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :location, as: 'location', class: Google::Apis::MybusinessV3::Location, decorator: Google::Apis::MybusinessV3::Location::Representation
property :is_exact_match, as: 'isExactMatch'
end
end
class AssociateLocationRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :place_id, as: 'placeId'
end
end
class ClearLocationAssociationRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class TransferLocationRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :to_account, as: 'toAccount'
end
end
class ListReviewsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :reviews, as: 'reviews', class: Google::Apis::MybusinessV3::Review, decorator: Google::Apis::MybusinessV3::Review::Representation
property :average_rating, as: 'averageRating'
property :total_review_count, as: 'totalReviewCount'
property :next_page_token, as: 'nextPageToken'
end
end
class Review
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :review_id, as: 'reviewId'
property :reviewer, as: 'reviewer', class: Google::Apis::MybusinessV3::Reviewer, decorator: Google::Apis::MybusinessV3::Reviewer::Representation
property :star_rating, as: 'starRating'
property :comment, as: 'comment'
property :create_time, as: 'createTime'
property :update_time, as: 'updateTime'
property :review_reply, as: 'reviewReply', class: Google::Apis::MybusinessV3::ReviewReply, decorator: Google::Apis::MybusinessV3::ReviewReply::Representation
end
end
class Reviewer
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :display_name, as: 'displayName'
property :is_anonymous, as: 'isAnonymous'
end
end
class ReviewReply
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :comment, as: 'comment'
property :update_time, as: 'updateTime'
end
end
class ListLocationAttributeMetadataResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :attributes, as: 'attributes', class: Google::Apis::MybusinessV3::AttributeMetadata, decorator: Google::Apis::MybusinessV3::AttributeMetadata::Representation
end
end
class AttributeMetadata
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :attribute_id, as: 'attributeId'
property :value_type, as: 'valueType'
property :display_name, as: 'displayName'
property :group_display_name, as: 'groupDisplayName'
property :is_repeatable, as: 'isRepeatable'
collection :value_metadata, as: 'valueMetadata', class: Google::Apis::MybusinessV3::AttributeValueMetadata, decorator: Google::Apis::MybusinessV3::AttributeValueMetadata::Representation
end
end
class AttributeValueMetadata
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :value, as: 'value'
property :display_name, as: 'displayName'
end
end
end
end
end
@@ -0,0 +1,960 @@
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module MybusinessV3
# Google My Business API
#
# The Google My Business API provides an interface for managing business
# location information on Google.
#
# @example
# require 'google/apis/mybusiness_v3'
#
# Mybusiness = Google::Apis::MybusinessV3 # Alias the module
# service = Mybusiness::MybusinessService.new
#
# @see https://developers.google.com/my-business/
class MybusinessService < Google::Apis::Core::BaseService
# @return [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.
attr_accessor :key
# @return [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.
attr_accessor :quota_user
def initialize
super('https://mybusiness.googleapis.com/', '')
end
# Lists all of the accounts for the authenticated user. This includes all
# accounts that the user owns, as well as any accounts for which the user
# has management rights.
# @param [Fixnum] page_size
# How many accounts to fetch per page. Default is 50,
# minimum is 1, and maximum page size is 50.
# @param [String] page_token
# If specified, the next page of accounts is retrieved. The `pageToken` is
# returned when a call to `accounts.list` returns more results than can fit
# into the requested page size.
# @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::MybusinessV3::ListAccountsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MybusinessV3::ListAccountsResponse]
#
# @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
def list_accounts(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v3/accounts', options)
command.response_representation = Google::Apis::MybusinessV3::ListAccountsResponse::Representation
command.response_class = Google::Apis::MybusinessV3::ListAccountsResponse
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
# Gets the specified account. Returns `NOT_FOUND` if the
# account does not exist or if the caller does not have access rights to it.
# @param [String] name
# The name of the account to fetch.
# @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::MybusinessV3::Account] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MybusinessV3::Account]
#
# @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
def get_account(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v3/{+name}', options)
command.response_representation = Google::Apis::MybusinessV3::Account::Representation
command.response_class = Google::Apis::MybusinessV3::Account
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates the specified business account. Personal accounts cannot be
# updated using this method.
# Note: At this time the only editable field for an account is
# `account_name`.
# Any other fields passed in (such as `type`, `role`, and `verified`) is
# ignored.
# @param [String] name
# The name of the account to update.
# @param [Google::Apis::MybusinessV3::Account] account_object
# @param [String] language_code
# The language of the account update.
# @param [Boolean] validate_only
# If true, the request is validated without actually updating the account.
# @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::MybusinessV3::Account] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MybusinessV3::Account]
#
# @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
def update_account(name, account_object = nil, language_code: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'v3/{+name}', options)
command.request_representation = Google::Apis::MybusinessV3::Account::Representation
command.request_object = account_object
command.response_representation = Google::Apis::MybusinessV3::Account::Representation
command.response_class = Google::Apis::MybusinessV3::Account
command.params['name'] = name unless name.nil?
command.query['languageCode'] = language_code unless language_code.nil?
command.query['validateOnly'] = validate_only unless validate_only.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists the admins for the specified account.
# @param [String] name
# The name of the account from which to retrieve a list of admins.
# @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::MybusinessV3::ListAccountAdminsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MybusinessV3::ListAccountAdminsResponse]
#
# @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
def list_account_admins(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v3/{+name}/admins', options)
command.response_representation = Google::Apis::MybusinessV3::ListAccountAdminsResponse::Representation
command.response_class = Google::Apis::MybusinessV3::ListAccountAdminsResponse
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Invites the specified user to become an administrator on the specified
# account. The invitee must accept the invitation in order to be granted
# access to the account.
# @param [String] name
# The resource name. For account admins, this is in the form:
# `accounts/`account_id`/admins/`admin_id``
# For location admins, this is in the form:
# `accounts/`account_id`/locations/`location_id`/admins/`admin_id``
# @param [Google::Apis::MybusinessV3::Admin] admin_object
# @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::MybusinessV3::Admin] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MybusinessV3::Admin]
#
# @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
def create_account_admin(name, admin_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v3/{+name}/admins', options)
command.request_representation = Google::Apis::MybusinessV3::Admin::Representation
command.request_object = admin_object
command.response_representation = Google::Apis::MybusinessV3::Admin::Representation
command.response_class = Google::Apis::MybusinessV3::Admin
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Removes the specified admin from the specified account.
# @param [String] name
# The resource name of the admin to remove from the account.
# @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::MybusinessV3::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MybusinessV3::Empty]
#
# @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
def delete_account_admin(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v3/{+name}', options)
command.response_representation = Google::Apis::MybusinessV3::Empty::Representation
command.response_class = Google::Apis::MybusinessV3::Empty
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists the locations for the specified account.
# @param [String] name
# The name of the account to fetch locations from.
# @param [Fixnum] page_size
# How many locations to fetch per page. Default is 100,
# minimum is 1, and maximum page size is 100.
# @param [String] page_token
# If specified, it fetches the next `page` of locations. The page token
# is returned by previous calls to ListLocations when there were more
# locations than could fit in the requested page size.
# @param [String] filter
# A filter constraining the locations to return. The response includes
# only entries that match the filter. If `filter` is empty, then
# constraints are applied and all locations (paginated) are retrieved for
# the requested account.
# Further information on valid filter fields and example usage is available
# [here](https://developers.google.com/my-business/content/location-data#
# filter_results_when_listing_locations)
# .
# @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::MybusinessV3::ListLocationsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MybusinessV3::ListLocationsResponse]
#
# @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
def list_account_locations(name, page_size: nil, page_token: nil, filter: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v3/{+name}/locations', options)
command.response_representation = Google::Apis::MybusinessV3::ListLocationsResponse::Representation
command.response_class = Google::Apis::MybusinessV3::ListLocationsResponse
command.params['name'] = name unless name.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['filter'] = filter unless filter.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the specified location. Returns `NOT_FOUND` if the
# location does not exist.
# @param [String] name
# The name of the location to fetch.
# @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::MybusinessV3::Location] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MybusinessV3::Location]
#
# @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
def get_account_location(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v3/{+name}', options)
command.response_representation = Google::Apis::MybusinessV3::Location::Representation
command.response_class = Google::Apis::MybusinessV3::Location
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets all of the specified locations in the given account.
# @param [String] name
# The name of the account from which to fetch locations.
# @param [Google::Apis::MybusinessV3::BatchGetLocationsRequest] batch_get_locations_request_object
# @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::MybusinessV3::BatchGetLocationsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MybusinessV3::BatchGetLocationsResponse]
#
# @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
def batch_get_locations(name, batch_get_locations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v3/{+name}/locations:batchGet', options)
command.request_representation = Google::Apis::MybusinessV3::BatchGetLocationsRequest::Representation
command.request_object = batch_get_locations_request_object
command.response_representation = Google::Apis::MybusinessV3::BatchGetLocationsResponse::Representation
command.response_class = Google::Apis::MybusinessV3::BatchGetLocationsResponse
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the Google updated version of the specified location.
# Returns `NOT_FOUND` if the location does not exist.
# @param [String] name
# The name of the location to fetch.
# @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::MybusinessV3::GoogleUpdatedLocation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MybusinessV3::GoogleUpdatedLocation]
#
# @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
def get_google_updated_account_location(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v3/{+name}:googleUpdated', options)
command.response_representation = Google::Apis::MybusinessV3::GoogleUpdatedLocation::Representation
command.response_class = Google::Apis::MybusinessV3::GoogleUpdatedLocation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a new location owned by the
# specified account, and returns it.
# @param [String] name
# The name of the account in which to create this location.
# @param [Google::Apis::MybusinessV3::Location] location_object
# @param [String] language_code
# The language of the location update. Currently this is used to disambiguate
# what localized categories are valid for this create request.
# @param [Boolean] validate_only
# If true, the request is validated without actually creating the location.
# @param [String] request_id
# A unique request ID for the server to detect duplicated requests. UUIDs are
# recommended. Max length is 50 characters.
# @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::MybusinessV3::Location] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MybusinessV3::Location]
#
# @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
def create_account_location(name, location_object = nil, language_code: nil, validate_only: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v3/{+name}/locations', options)
command.request_representation = Google::Apis::MybusinessV3::Location::Representation
command.request_object = location_object
command.response_representation = Google::Apis::MybusinessV3::Location::Representation
command.response_class = Google::Apis::MybusinessV3::Location
command.params['name'] = name unless name.nil?
command.query['languageCode'] = language_code unless language_code.nil?
command.query['validateOnly'] = validate_only unless validate_only.nil?
command.query['requestId'] = request_id unless request_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates the specified location.
# Photos are only allowed on a location that has a Google+ page.
# Returns `NOT_FOUND` if the location does not exist.
# @param [String] name
# The name of the location to update.
# @param [Google::Apis::MybusinessV3::Location] location_object
# @param [String] language_code
# The language of the location update. Currently this is used to disambiguate
# what localized categories are valid for this update request.
# @param [String] field_mask
# The specific fields to update. If no mask is specified, then this is
# treated as a full update and all fields are set to the values passed
# in, which may include unsetting empty fields in the request.
# @param [Boolean] validate_only
# If true, the request is validated without actually updating the location.
# @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::MybusinessV3::Location] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MybusinessV3::Location]
#
# @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
def patch_account_location(name, location_object = nil, language_code: nil, field_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v3/{+name}', options)
command.request_representation = Google::Apis::MybusinessV3::Location::Representation
command.request_object = location_object
command.response_representation = Google::Apis::MybusinessV3::Location::Representation
command.response_class = Google::Apis::MybusinessV3::Location
command.params['name'] = name unless name.nil?
command.query['languageCode'] = language_code unless language_code.nil?
command.query['fieldMask'] = field_mask unless field_mask.nil?
command.query['validateOnly'] = validate_only unless validate_only.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a location. Note: If this location has an associated Google+ page, as
# indicated by a `plus_page_id` in the LocationKey, it cannot be deleted using
# the API, it
# must be done using the [Google My Business]
# (https://www.google.com/local/manage/) website.
# Returns `NOT_FOUND` if the location does not exist.
# @param [String] name
# The name of the location to delete.
# @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::MybusinessV3::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MybusinessV3::Empty]
#
# @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
def delete_account_location(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v3/{+name}', options)
command.response_representation = Google::Apis::MybusinessV3::Empty::Representation
command.response_class = Google::Apis::MybusinessV3::Empty
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Finds all of the possible locations that are a match to the specified
# location. This operation is only valid if the location is unverified.
# @param [String] name
# The resource name of the location to find matches for.
# @param [Google::Apis::MybusinessV3::FindMatchingLocationsRequest] find_matching_locations_request_object
# @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::MybusinessV3::FindMatchingLocationsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MybusinessV3::FindMatchingLocationsResponse]
#
# @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
def find_account_location_matches(name, find_matching_locations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v3/{+name}:findMatches', options)
command.request_representation = Google::Apis::MybusinessV3::FindMatchingLocationsRequest::Representation
command.request_object = find_matching_locations_request_object
command.response_representation = Google::Apis::MybusinessV3::FindMatchingLocationsResponse::Representation
command.response_class = Google::Apis::MybusinessV3::FindMatchingLocationsResponse
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Associates a location to a place ID. Any previous association is
# overwritten. This operation is only valid if the location is unverified.
# The association must be valid, i.e. appear in the list of
# FindMatchingLocations.
# @param [String] name
# The resource name of the location to associate.
# @param [Google::Apis::MybusinessV3::AssociateLocationRequest] associate_location_request_object
# @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::MybusinessV3::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MybusinessV3::Empty]
#
# @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
def associate_location(name, associate_location_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v3/{+name}:associate', options)
command.request_representation = Google::Apis::MybusinessV3::AssociateLocationRequest::Representation
command.request_object = associate_location_request_object
command.response_representation = Google::Apis::MybusinessV3::Empty::Representation
command.response_class = Google::Apis::MybusinessV3::Empty
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Clears an assocation between a location and its place ID. This
# operation is only valid if the location is unverified.
# @param [String] name
# The resource name of the location to disassociate.
# @param [Google::Apis::MybusinessV3::ClearLocationAssociationRequest] clear_location_association_request_object
# @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::MybusinessV3::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MybusinessV3::Empty]
#
# @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
def clear_account_location_association(name, clear_location_association_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v3/{+name}:clearAssociation', options)
command.request_representation = Google::Apis::MybusinessV3::ClearLocationAssociationRequest::Representation
command.request_object = clear_location_association_request_object
command.response_representation = Google::Apis::MybusinessV3::Empty::Representation
command.response_class = Google::Apis::MybusinessV3::Empty
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Transfer a location from one account to another. The current account that
# the location is associated with and the destination account must have the
# same ultimate owner. Returns the Location with its new resource name.
# @param [String] name
# The name of the location to transfer.
# @param [Google::Apis::MybusinessV3::TransferLocationRequest] transfer_location_request_object
# @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::MybusinessV3::Location] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MybusinessV3::Location]
#
# @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
def transfer_location(name, transfer_location_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v3/{+name}:transfer', options)
command.request_representation = Google::Apis::MybusinessV3::TransferLocationRequest::Representation
command.request_object = transfer_location_request_object
command.response_representation = Google::Apis::MybusinessV3::Location::Representation
command.response_class = Google::Apis::MybusinessV3::Location
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists all of the admins for the specified location.
# @param [String] name
# The name of the location to list admins of.
# @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::MybusinessV3::ListLocationAdminsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MybusinessV3::ListLocationAdminsResponse]
#
# @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
def list_account_location_admins(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v3/{+name}/admins', options)
command.response_representation = Google::Apis::MybusinessV3::ListLocationAdminsResponse::Representation
command.response_class = Google::Apis::MybusinessV3::ListLocationAdminsResponse
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Invites the specified user to become an administrator on the specified
# location. The invitee must accept the invitation in order to be granted
# access to the location.
# @param [String] name
# The resource name. For account admins, this is in the form:
# `accounts/`account_id`/admins/`admin_id``
# For location admins, this is in the form:
# `accounts/`account_id`/locations/`location_id`/admins/`admin_id``
# @param [Google::Apis::MybusinessV3::Admin] admin_object
# @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::MybusinessV3::Admin] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MybusinessV3::Admin]
#
# @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
def create_account_location_admin(name, admin_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v3/{+name}/admins', options)
command.request_representation = Google::Apis::MybusinessV3::Admin::Representation
command.request_object = admin_object
command.response_representation = Google::Apis::MybusinessV3::Admin::Representation
command.response_class = Google::Apis::MybusinessV3::Admin
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Removes the specified admin as a manager of the specified location.
# @param [String] name
# The resource name of the admin to remove from the location.
# @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::MybusinessV3::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MybusinessV3::Empty]
#
# @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
def delete_account_location_admin(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v3/{+name}', options)
command.response_representation = Google::Apis::MybusinessV3::Empty::Representation
command.response_class = Google::Apis::MybusinessV3::Empty
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns the paginated list of reviews for the specified location.
# This operation is only valid if the specified location is verified.
# @param [String] name
# The name of the location to fetch reviews for.
# @param [Fixnum] page_size
# How many reviews to fetch per page. The maximum page_size is 200.
# @param [String] page_token
# If specified, it fetches the next ‘page’ of reviews.
# @param [String] order_by
# Specifies the field to sort reviews by.
# If unspecified, the order of reviews returned will
# default to "update_timedesc".
# Valid orders to sort by are `rating` and `ratingdesc` and `update_timedesc`.
# @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::MybusinessV3::ListReviewsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MybusinessV3::ListReviewsResponse]
#
# @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
def list_reviews(name, page_size: nil, page_token: nil, order_by: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v3/{+name}/reviews', options)
command.response_representation = Google::Apis::MybusinessV3::ListReviewsResponse::Representation
command.response_class = Google::Apis::MybusinessV3::ListReviewsResponse
command.params['name'] = name unless name.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['orderBy'] = order_by unless order_by.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns the specified review.
# This operation is only valid if the specified location is verified.
# Returns `NOT_FOUND` if the review does not exist, or has been deleted.
# @param [String] name
# The name of the review to fetch.
# @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::MybusinessV3::Review] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MybusinessV3::Review]
#
# @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
def get_review(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v3/{+name}', options)
command.response_representation = Google::Apis::MybusinessV3::Review::Representation
command.response_class = Google::Apis::MybusinessV3::Review
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates the reply to the specified review.
# A reply is created if one does not exist.
# This operation is only valid if the specified location is verified.
# @param [String] name
# The name of the review to respond to.
# @param [Google::Apis::MybusinessV3::ReviewReply] review_reply_object
# @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::MybusinessV3::ReviewReply] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MybusinessV3::ReviewReply]
#
# @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
def reply_to_review(name, review_reply_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v3/{+name}/reply', options)
command.request_representation = Google::Apis::MybusinessV3::ReviewReply::Representation
command.request_object = review_reply_object
command.response_representation = Google::Apis::MybusinessV3::ReviewReply::Representation
command.response_class = Google::Apis::MybusinessV3::ReviewReply
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes the response to the specified review.
# This operation is only valid if the specified location is verified.
# @param [String] name
# The name of the review reply to delete.
# @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::MybusinessV3::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MybusinessV3::Empty]
#
# @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
def delete_reply(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v3/{+name}/reply', options)
command.response_representation = Google::Apis::MybusinessV3::Empty::Representation
command.response_class = Google::Apis::MybusinessV3::Empty
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns the list of available attributes that would be available for a
# location with the given primary category and country.
# @param [String] name
# Resource name of the location to lookup available attributes.
# @param [String] category_id
# The primary category stable id to find available attributes.
# @param [String] country
# The ISO 3166-1 alpha-2 country code to find available attributes.
# @param [String] language_code
# The BCP 47 code of language to get attribute display names in. If this
# language is not available, they will be provided in English.
# @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::MybusinessV3::ListLocationAttributeMetadataResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MybusinessV3::ListLocationAttributeMetadataResponse]
#
# @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
def list_attributes(name: nil, category_id: nil, country: nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v3/attributes', options)
command.response_representation = Google::Apis::MybusinessV3::ListLocationAttributeMetadataResponse::Representation
command.response_class = Google::Apis::MybusinessV3::ListLocationAttributeMetadataResponse
command.query['name'] = name unless name.nil?
command.query['categoryId'] = category_id unless category_id.nil?
command.query['country'] = country unless country.nil?
command.query['languageCode'] = language_code unless language_code.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
protected
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
end
end
end
end
end
+1 -1
View File
@@ -26,7 +26,7 @@ module Google
# @see https://developers.google.com/speed/docs/insights/v2/getting-started
module PagespeedonlineV2
VERSION = 'V2'
REVISION = '20160413'
REVISION = '20160516'
end
end
end
+1 -1
View File
@@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/+/domains/
module PlusDomainsV1
VERSION = 'V1'
REVISION = '20160511'
REVISION = '20160523'
# View your circles and the people and pages in them
AUTH_PLUS_CIRCLES_READ = 'https://www.googleapis.com/auth/plus.circles.read'
+1 -1
View File
@@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/+/api/
module PlusV1
VERSION = 'V1'
REVISION = '20160511'
REVISION = '20160523'
# Know the list of people in your circles, your age range, and language
AUTH_PLUS_LOGIN = 'https://www.googleapis.com/auth/plus.login'
+4 -1
View File
@@ -26,7 +26,10 @@ module Google
# @see https://developers.google.com/prediction/docs/developer-guide
module PredictionV1_6
VERSION = 'V1_6'
REVISION = '20160304'
REVISION = '20160511'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
# Manage your data and permissions in Google Cloud Storage
AUTH_DEVSTORAGE_FULL_CONTROL = 'https://www.googleapis.com/auth/devstorage.full_control'
@@ -26,7 +26,7 @@ module Google
# @see https://developers.google.com/compute/
module ResourceviewsV1beta2
VERSION = 'V1beta2'
REVISION = '20150708'
REVISION = '20160512'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
+2 -2
View File
@@ -20,12 +20,12 @@ module Google
module Apis
# Google Sheets API
#
# An API for reading and modifying Google Sheets.
# Reads and writes Google Sheets.
#
# @see https://developers.google.com/sheets/
module SheetsV4
VERSION = 'V4'
REVISION = '20160511'
REVISION = '20160519'
# View the files in your Google Drive
AUTH_DRIVE_READONLY = 'https://www.googleapis.com/auth/drive.readonly'
File diff suppressed because it is too large. Load diff
+19 -20
View File
@@ -22,7 +22,7 @@ module Google
module SheetsV4
# Google Sheets API
#
# An API for reading and modifying Google Sheets.
# Reads and writes Google Sheets.
#
# @example
# require 'google/apis/sheets_v4'
@@ -76,16 +76,15 @@ module Google
execute_or_queue_command(command, &block)
end
# Returns the spreadsheet at the given id.
# Returns the spreadsheet at the given ID.
# The caller must specify the spreadsheet ID.
# By default, data within grids will not be returned.
# You can include grid data one of two ways: specify a field mask listing
# your desired fields (using the `fields` URL parameter in HTTP,
# or `FieldMaskContext.response_mask` in the request extensions in an RPC),
# or by setting the
# includeGridData URL parameter
# to true. If a field mask is set, the `includeGridData` parameter is
# ignored.
# You can include grid data one of two ways:
# * Specify a field mask listing your desired fields using the `fields` URL
# parameter in HTTP
# * Set the includeGridData
# URL parameter to true. If a field mask is set, the `includeGridData`
# parameter is ignored
# For large spreadsheets, it is recommended to retrieve only the specific
# fields of the spreadsheet that you want.
# To retrieve only subsets of the spreadsheet, use the
@@ -135,14 +134,14 @@ module Google
# fail and nothing will be applied.
# Some requests have replies to
# give you some information about how
# they applied. The replies will mirror the requests. For example,
# they are applied. The replies will mirror the requests. For example,
# if you applied 4 updates and the 3rd one had a reply, then the
# response will have 2 empty replies, the actual reply, and another empty
# reply, in that order.
# Due to the collaborative nature of spreadsheets, it is not guaranteed that
# the spreadsheet will reflect exactly your changes after this completes,
# however it is guaranteed that all the updates in the request will be
# applied atomically. Your changes may be altered with respect to
# however it is guaranteed that the updates in the request will be
# applied together atomically. Your changes may be altered with respect to
# collaborator changes. If there are no collaborators, the spreadsheet
# should reflect your changes.
# @param [String] spreadsheet_id
@@ -181,7 +180,7 @@ module Google
# The caller must specify the spreadsheet ID, range, and
# a valueInputOption.
# @param [String] spreadsheet_id
# The id of the spreadsheet to update.
# The ID of the spreadsheet to update.
# @param [String] range
# The A1 notation of the values to update.
# @param [Google::Apis::SheetsV4::ValueRange] value_range_object
@@ -221,14 +220,14 @@ module Google
# Returns a range of values from a spreadsheet.
# The caller must specify the spreadsheet ID and a range.
# @param [String] spreadsheet_id
# The id of the spreadsheet to retrieve data from.
# The ID of the spreadsheet to retrieve data from.
# @param [String] range
# The A1 notation of the values to retrieve.
# @param [String] value_render_option
# How values should be represented in the output.
# @param [String] date_time_render_option
# How dates, times, and durations should be represented in the output.
# This is ignored if the ValueRenderOption option is
# This is ignored if value_render_option is
# FORMATTED_VALUE.
# @param [String] major_dimension
# The major dimension that results should use.
@@ -271,14 +270,14 @@ module Google
# Returns one or more ranges of values from a spreadsheet.
# The caller must specify the spreadsheet ID and one or more ranges.
# @param [String] spreadsheet_id
# The id of the spreadsheet to retrieve data from.
# The ID of the spreadsheet to retrieve data from.
# @param [Array<String>, String] ranges
# The A1 notation of the values to retrieve.
# @param [String] value_render_option
# How values should be represented in the output.
# @param [String] date_time_render_option
# How dates, times, and durations should be represented in the output.
# This is ignored if ValueRenderOption option is
# This is ignored if value_render_option is
# FORMATTED_VALUE.
# @param [String] major_dimension
# The major dimension that results should use.
@@ -318,12 +317,12 @@ module Google
execute_or_queue_command(command, &block)
end
# Sets values in a range of a spreadsheet.
# Sets values in one or more ranges of a spreadsheet.
# The caller must specify the spreadsheet ID,
# a valueInputOption, and one or more
# ValueRanges.
# @param [String] spreadsheet_id
# The id of the spreadsheet to update.
# The ID of the spreadsheet to update.
# @param [Google::Apis::SheetsV4::BatchUpdateValuesRequest] batch_update_values_request_object
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
@@ -357,7 +356,7 @@ module Google
# Copies a single sheet from a spreadsheet to another spreadsheet.
# Returns the properties of the newly created sheet.
# @param [String] spreadsheet_id
# The id of the spreadsheet containing the sheet to copy.
# The ID of the spreadsheet containing the sheet to copy.
# @param [Fixnum] sheet_id
# The ID of the sheet to copy.
# @param [Google::Apis::SheetsV4::CopySheetToAnotherSpreadsheetRequest] copy_sheet_to_another_spreadsheet_request_object
+1 -1
View File
@@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/storage/docs/json_api/
module StorageV1
VERSION = 'V1'
REVISION = '20160427'
REVISION = '20160504'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
+2 -1
View File
@@ -781,7 +781,8 @@ module Google
# @return [String]
attr_accessor :content_language
# Content-Type of the object data.
# Content-Type of the object data. If contentType is not specified, object
# downloads will be served as application/octet-stream.
# Corresponds to the JSON property `contentType`
# @return [String]
attr_accessor :content_type
+1 -1
View File
@@ -27,7 +27,7 @@ module Google
# @see https://cloud.google.com/vision/
module VisionV1
VERSION = 'V1'
REVISION = '20160420'
REVISION = '20160519'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
+67 -67
View File
@@ -195,7 +195,7 @@ module Google
# return r
# def NormalizeLatLng(latitude, longitude):
# """Wraps decimal degrees latitude and longitude to
# [-180.0, 180.0] and [-90.0, 90.0], respectively."""
# [-90.0, 90.0] and [-180.0, 180.0], respectively."""
# r = latitude % 360.0
# if r <= 90.0:
# return r, NormalizeLongitude(longitude)
@@ -234,7 +234,7 @@ module Google
# return r
# def NormalizeLatLng(latitude, longitude):
# """Wraps decimal degrees latitude and longitude to
# [-180.0, 180.0] and [-90.0, 90.0], respectively."""
# [-90.0, 90.0] and [-180.0, 180.0], respectively."""
# r = latitude % 360.0
# if r <= 90.0:
# return r, NormalizeLongitude(longitude)
@@ -393,11 +393,6 @@ module Google
# @return [String]
attr_accessor :headwear_likelihood
# A bounding polygon for the detected image annotation.
# Corresponds to the JSON property `boundingPoly`
# @return [Google::Apis::VisionV1::BoundingPoly]
attr_accessor :bounding_poly
# Yaw angle. Indicates the leftward/rightward angle that the face is
# pointing, relative to the vertical plane perpendicular to the image. Range
# [-180,180].
@@ -405,6 +400,11 @@ module Google
# @return [Float]
attr_accessor :pan_angle
# A bounding polygon for the detected image annotation.
# Corresponds to the JSON property `boundingPoly`
# @return [Google::Apis::VisionV1::BoundingPoly]
attr_accessor :bounding_poly
# Detected face landmarks.
# Corresponds to the JSON property `landmarks`
# @return [Array<Google::Apis::VisionV1::Landmark>]
@@ -443,8 +443,8 @@ module Google
@surprise_likelihood = args[:surprise_likelihood] if args.key?(:surprise_likelihood)
@anger_likelihood = args[:anger_likelihood] if args.key?(:anger_likelihood)
@headwear_likelihood = args[:headwear_likelihood] if args.key?(:headwear_likelihood)
@bounding_poly = args[:bounding_poly] if args.key?(:bounding_poly)
@pan_angle = args[:pan_angle] if args.key?(:pan_angle)
@bounding_poly = args[:bounding_poly] if args.key?(:bounding_poly)
@landmarks = args[:landmarks] if args.key?(:landmarks)
@blurred_likelihood = args[:blurred_likelihood] if args.key?(:blurred_likelihood)
@roll_angle = args[:roll_angle] if args.key?(:roll_angle)
@@ -662,6 +662,11 @@ module Google
class ImageContext
include Google::Apis::Core::Hashable
# Rectangle determined by min and max LatLng pairs.
# Corresponds to the JSON property `latLongRect`
# @return [Google::Apis::VisionV1::LatLongRect]
attr_accessor :lat_long_rect
# List of languages to use for TEXT_DETECTION. In most cases, an empty value
# will yield the best results as it will allow text detection to
# automatically detect the text language. For languages based on the latin
@@ -676,19 +681,14 @@ module Google
# @return [Array<String>]
attr_accessor :language_hints
# Rectangle determined by min and max LatLng pairs.
# Corresponds to the JSON property `latLongRect`
# @return [Google::Apis::VisionV1::LatLongRect]
attr_accessor :lat_long_rect
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@language_hints = args[:language_hints] if args.key?(:language_hints)
@lat_long_rect = args[:lat_long_rect] if args.key?(:lat_long_rect)
@language_hints = args[:language_hints] if args.key?(:language_hints)
end
end
@@ -978,7 +978,7 @@ module Google
# return r
# def NormalizeLatLng(latitude, longitude):
# """Wraps decimal degrees latitude and longitude to
# [-180.0, 180.0] and [-90.0, 90.0], respectively."""
# [-90.0, 90.0] and [-180.0, 180.0], respectively."""
# r = latitude % 360.0
# if r <= 90.0:
# return r, NormalizeLongitude(longitude)
@@ -1024,11 +1024,6 @@ module Google
# @return [String]
attr_accessor :medical
# Violence likelihood.
# Corresponds to the JSON property `violence`
# @return [String]
attr_accessor :violence
# Spoof likelihood. The likelihood that an obvious modification
# was made to the image's canonical version to make it appear
# funny or offensive.
@@ -1036,6 +1031,11 @@ module Google
# @return [String]
attr_accessor :spoof
# Violence likelihood.
# Corresponds to the JSON property `violence`
# @return [String]
attr_accessor :violence
# Represents the adult contents likelihood for the image.
# Corresponds to the JSON property `adult`
# @return [String]
@@ -1048,8 +1048,8 @@ module Google
# Update properties of this object
def update!(**args)
@medical = args[:medical] if args.key?(:medical)
@violence = args[:violence] if args.key?(:violence)
@spoof = args[:spoof] if args.key?(:spoof)
@violence = args[:violence] if args.key?(:violence)
@adult = args[:adult] if args.key?(:adult)
end
end
@@ -1105,24 +1105,24 @@ module Google
class Feature
include Google::Apis::Core::Hashable
# Maximum number of results of this type.
# Corresponds to the JSON property `maxResults`
# @return [Fixnum]
attr_accessor :max_results
# The feature type.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
# Maximum number of results of this type.
# Corresponds to the JSON property `maxResults`
# @return [Fixnum]
attr_accessor :max_results
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@max_results = args[:max_results] if args.key?(:max_results)
@type = args[:type] if args.key?(:type)
@max_results = args[:max_results] if args.key?(:max_results)
end
end
@@ -1164,39 +1164,6 @@ module Google
end
end
# A 3D position in the image, used primarily for Face detection landmarks.
# A valid Position must have both x and y coordinates.
# The position coordinates are in the same scale as the original image.
class Position
include Google::Apis::Core::Hashable
# Y coordinate.
# Corresponds to the JSON property `y`
# @return [Float]
attr_accessor :y
# Z coordinate (or depth).
# Corresponds to the JSON property `z`
# @return [Float]
attr_accessor :z
# X coordinate.
# Corresponds to the JSON property `x`
# @return [Float]
attr_accessor :x
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@y = args[:y] if args.key?(:y)
@z = args[:z] if args.key?(:z)
@x = args[:x] if args.key?(:x)
end
end
# An object representing a latitude/longitude pair. This is expressed as a pair
# of doubles representing degrees latitude and degrees longitude. Unless
# specified otherwise, this must conform to the
@@ -1211,7 +1178,7 @@ module Google
# return r
# def NormalizeLatLng(latitude, longitude):
# """Wraps decimal degrees latitude and longitude to
# [-180.0, 180.0] and [-90.0, 90.0], respectively."""
# [-90.0, 90.0] and [-180.0, 180.0], respectively."""
# r = latitude % 360.0
# if r <= 90.0:
# return r, NormalizeLongitude(longitude)
@@ -1235,24 +1202,57 @@ module Google
class LatLng
include Google::Apis::Core::Hashable
# The longitude in degrees. It must be in the range [-180.0, +180.0].
# Corresponds to the JSON property `longitude`
# @return [Float]
attr_accessor :longitude
# The latitude in degrees. It must be in the range [-90.0, +90.0].
# Corresponds to the JSON property `latitude`
# @return [Float]
attr_accessor :latitude
# The longitude in degrees. It must be in the range [-180.0, +180.0].
# Corresponds to the JSON property `longitude`
# @return [Float]
attr_accessor :longitude
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@longitude = args[:longitude] if args.key?(:longitude)
@latitude = args[:latitude] if args.key?(:latitude)
@longitude = args[:longitude] if args.key?(:longitude)
end
end
# A 3D position in the image, used primarily for Face detection landmarks.
# A valid Position must have both x and y coordinates.
# The position coordinates are in the same scale as the original image.
class Position
include Google::Apis::Core::Hashable
# Y coordinate.
# Corresponds to the JSON property `y`
# @return [Float]
attr_accessor :y
# X coordinate.
# Corresponds to the JSON property `x`
# @return [Float]
attr_accessor :x
# Z coordinate (or depth).
# Corresponds to the JSON property `z`
# @return [Float]
attr_accessor :z
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@y = args[:y] if args.key?(:y)
@x = args[:x] if args.key?(:x)
@z = args[:z] if args.key?(:z)
end
end
end
@@ -154,13 +154,13 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class Position
class LatLng
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class LatLng
class Position
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
@@ -239,9 +239,9 @@ module Google
property :surprise_likelihood, as: 'surpriseLikelihood'
property :anger_likelihood, as: 'angerLikelihood'
property :headwear_likelihood, as: 'headwearLikelihood'
property :pan_angle, as: 'panAngle'
property :bounding_poly, as: 'boundingPoly', class: Google::Apis::VisionV1::BoundingPoly, decorator: Google::Apis::VisionV1::BoundingPoly::Representation
property :pan_angle, as: 'panAngle'
collection :landmarks, as: 'landmarks', class: Google::Apis::VisionV1::Landmark, decorator: Google::Apis::VisionV1::Landmark::Representation
property :blurred_likelihood, as: 'blurredLikelihood'
@@ -288,9 +288,9 @@ module Google
class ImageContext
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :language_hints, as: 'languageHints'
property :lat_long_rect, as: 'latLongRect', class: Google::Apis::VisionV1::LatLongRect, decorator: Google::Apis::VisionV1::LatLongRect::Representation
collection :language_hints, as: 'languageHints'
end
end
@@ -350,8 +350,8 @@ module Google
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :medical, as: 'medical'
property :violence, as: 'violence'
property :spoof, as: 'spoof'
property :violence, as: 'violence'
property :adult, as: 'adult'
end
end
@@ -376,8 +376,8 @@ module Google
class Feature
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :max_results, as: 'maxResults'
property :type, as: 'type'
property :max_results, as: 'maxResults'
end
end
@@ -397,20 +397,20 @@ module Google
end
end
class LatLng
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :latitude, as: 'latitude'
property :longitude, as: 'longitude'
end
end
class Position
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :y, as: 'y'
property :z, as: 'z'
property :x, as: 'x'
end
end
class LatLng
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :longitude, as: 'longitude'
property :latitude, as: 'latitude'
property :z, as: 'z'
end
end
end
+3 -3
View File
@@ -20,13 +20,13 @@ module Google
module Apis
# YouTube Reporting API
#
# Schedules reporting jobs and downloads the resulting bulk data reports about
# YouTube channels, videos, etc. in the form of CSV files.
# Schedules reporting jobs containing your YouTube Analytics data and downloads
# the resulting bulk data reports in the form of CSV files.
#
# @see https://developers.google.com/youtube/reporting/v1/reports/
module YoutubereportingV1
VERSION = 'V1'
REVISION = '20160419'
REVISION = '20160517'
# View monetary and non-monetary YouTube Analytics reports for your YouTube content
AUTH_YT_ANALYTICS_MONETARY_READONLY = 'https://www.googleapis.com/auth/yt-analytics-monetary.readonly'
@@ -82,6 +82,11 @@ module Google
# @return [String]
attr_accessor :name
# The date/time when this report type was/will be deprecated.
# Corresponds to the JSON property `deprecateTime`
# @return [String]
attr_accessor :deprecate_time
# True if this a system-managed report type; otherwise false. Reporting jobs for
# system-managed report types are created automatically and can thus not be used
# in the `CreateJob` method.
@@ -98,6 +103,7 @@ module Google
def update!(**args)
@id = args[:id] if args.key?(:id)
@name = args[:name] if args.key?(:name)
@deprecate_time = args[:deprecate_time] if args.key?(:deprecate_time)
@system_managed = args[:system_managed] if args.key?(:system_managed)
end
end
@@ -126,6 +132,12 @@ module Google
# @return [String]
attr_accessor :create_time
# The date/time when this job will expire/expired. After a job expired, no new
# reports are generated.
# Corresponds to the JSON property `expireTime`
# @return [String]
attr_accessor :expire_time
# True if this a system-managed job that cannot be modified by the user;
# otherwise false.
# Corresponds to the JSON property `systemManaged`
@@ -143,6 +155,7 @@ module Google
@report_type_id = args[:report_type_id] if args.key?(:report_type_id)
@name = args[:name] if args.key?(:name)
@create_time = args[:create_time] if args.key?(:create_time)
@expire_time = args[:expire_time] if args.key?(:expire_time)
@system_managed = args[:system_managed] if args.key?(:system_managed)
end
end
@@ -233,6 +246,11 @@ module Google
# @return [String]
attr_accessor :job_id
# The date/time when the job this report belongs to will expire/expired.
# Corresponds to the JSON property `jobExpireTime`
# @return [String]
attr_accessor :job_expire_time
# The start of the time period that the report instance covers. The value is
# inclusive.
# Corresponds to the JSON property `startTime`
@@ -263,6 +281,7 @@ module Google
def update!(**args)
@id = args[:id] if args.key?(:id)
@job_id = args[:job_id] if args.key?(:job_id)
@job_expire_time = args[:job_expire_time] if args.key?(:job_expire_time)
@start_time = args[:start_time] if args.key?(:start_time)
@end_time = args[:end_time] if args.key?(:end_time)
@create_time = args[:create_time] if args.key?(:create_time)
@@ -91,6 +91,7 @@ module Google
class Representation < Google::Apis::Core::JsonRepresentation
property :id, as: 'id'
property :name, as: 'name'
property :deprecate_time, as: 'deprecateTime'
property :system_managed, as: 'systemManaged'
end
end
@@ -102,6 +103,7 @@ module Google
property :report_type_id, as: 'reportTypeId'
property :name, as: 'name'
property :create_time, as: 'createTime'
property :expire_time, as: 'expireTime'
property :system_managed, as: 'systemManaged'
end
end
@@ -135,6 +137,7 @@ module Google
class Representation < Google::Apis::Core::JsonRepresentation
property :id, as: 'id'
property :job_id, as: 'jobId'
property :job_expire_time, as: 'jobExpireTime'
property :start_time, as: 'startTime'
property :end_time, as: 'endTime'
property :create_time, as: 'createTime'
@@ -22,8 +22,8 @@ module Google
module YoutubereportingV1
# YouTube Reporting API
#
# Schedules reporting jobs and downloads the resulting bulk data reports about
# YouTube channels, videos, etc. in the form of CSV files.
# Schedules reporting jobs containing your YouTube Analytics data and downloads
# the resulting bulk data reports in the form of CSV files.
#
# @example
# require 'google/apis/youtubereporting_v1'
@@ -50,8 +50,7 @@ module Google
# Method for media download. Download is supported on the URI `/v1/media/`+name`?
# alt=media`.
# @param [String] resource_name
# Name of the media that is being downloaded. See ByteStream.ReadRequest.
# resource_name.
# Name of the media that is being downloaded. See ReadRequest.resource_name.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user