google-apis-youtube_v3 0.15.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e1618c4076d4ff460b4cb68eb67194b78de408fd5ee79b4e17042815f33864f
-  data.tar.gz: '04920e5e569b2830fc72721e2092754af7c54e2252c4fc23531e789d3e463217'
+  metadata.gz: 397db2830e03a8d4910f0b468cc9a72448024d3d191825753da6e4bc7cb2d1df
+  data.tar.gz: ebd51d15b2ea76432d7b74e325cba63ea33a1d6f6ecde98205b98171014d20ec
 SHA512:
-  metadata.gz: 5c0c840c241e0425304b8e1afc5a1b5bebe70f8d48e25adb055774419fcf4c6a97ffc734c3ad3266da4885d1d33bf1bb2f758949fc12700a17a2210394e2e1ca
-  data.tar.gz: 1f8d1450f4c4b929238699966bfbb052b5605b0cfd99c9c9fb6823e84245ddc9a06855370a9697313045f2b429cb90b6d5a921ef13f22afd85225be4d8b382fb
+  metadata.gz: b1428f639b2b040bff450d53181f8707a9261cf935634cce87955685165c1ebcb43ba3d86815a01b82506df800a222fe08a6cc19611181a6ecab0b63ef92d1b1
+  data.tar.gz: 77f95e51362d1ae81a1c0c18e3e85c5919e7da5b072c2d349a4a7831dc416af5ff32c1e2339108c56fa0d0e7f588aabe77308edecb6f4835d536e8bcccb614f1

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Release history for google-apis-youtube_v3
 
+### v0.18.0 (2022-06-10)
+
+* Regenerated from discovery document revision 20220608
+* Regenerated using generator version 0.5.0
+
+### v0.17.0 (2022-03-22)
+
+* Regenerated from discovery document revision 20220320
+
+### v0.16.0 (2022-03-15)
+
+* Regenerated from discovery document revision 20220312
+
 ### v0.15.0 (2022-03-01)
 
 * Regenerated from discovery document revision 20220227

data/lib/google/apis/youtube_v3/classes.rb

@@ -1911,6 +1911,11 @@ module Google
       class ChannelToStoreLinkDetails
         include Google::Apis::Core::Hashable
       
+        # Google Merchant Center id of the store.
+        # Corresponds to the JSON property `merchantId`
+        # @return [Fixnum]
+        attr_accessor :merchant_id
+      
         # Name of the store.
         # Corresponds to the JSON property `storeName`
         # @return [String]
@@ -1927,6 +1932,7 @@ module Google
       
         # Update properties of this object
         def update!(**args)
+          @merchant_id = args[:merchant_id] if args.key?(:merchant_id)
           @store_name = args[:store_name] if args.key?(:store_name)
           @store_url = args[:store_url] if args.key?(:store_url)
         end
@@ -2855,6 +2861,53 @@ module Google
         end
       end
       
+      # Note that there may be a 5-second end-point resolution issue. For instance, if
+      # a cuepoint comes in for 22:03:27, we may stuff the cuepoint into 22:03:25 or
+      # 22:03:30, depending. This is an artifact of HLS.
+      class Cuepoint
+        include Google::Apis::Core::Hashable
+      
+        # 
+        # Corresponds to the JSON property `cueType`
+        # @return [String]
+        attr_accessor :cue_type
+      
+        # The duration of this cuepoint.
+        # Corresponds to the JSON property `durationSecs`
+        # @return [Fixnum]
+        attr_accessor :duration_secs
+      
+        # The identifier for cuepoint resource.
+        # Corresponds to the JSON property `id`
+        # @return [String]
+        attr_accessor :id
+      
+        # The time when the cuepoint should be inserted by offset to the broadcast
+        # actual start time.
+        # Corresponds to the JSON property `insertionOffsetTimeMs`
+        # @return [Fixnum]
+        attr_accessor :insertion_offset_time_ms
+      
+        # The wall clock time at which the cuepoint should be inserted. Only one of
+        # insertion_offset_time_ms and walltime_ms may be set at a time.
+        # Corresponds to the JSON property `walltimeMs`
+        # @return [Fixnum]
+        attr_accessor :walltime_ms
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @cue_type = args[:cue_type] if args.key?(:cue_type)
+          @duration_secs = args[:duration_secs] if args.key?(:duration_secs)
+          @id = args[:id] if args.key?(:id)
+          @insertion_offset_time_ms = args[:insertion_offset_time_ms] if args.key?(:insertion_offset_time_ms)
+          @walltime_ms = args[:walltime_ms] if args.key?(:walltime_ms)
+        end
+      end
+      
       # 
       class Entity
         include Google::Apis::Core::Hashable
@@ -4058,6 +4111,43 @@ module Google
         end
       end
       
+      # 
+      class LiveChatGiftMembershipReceivedDetails
+        include Google::Apis::Core::Hashable
+      
+        # The ID of the membership gifting message that is related to this gift
+        # membership. This ID will always refer to a message whose type is '
+        # membershipGiftingEvent'.
+        # Corresponds to the JSON property `associatedMembershipGiftingMessageId`
+        # @return [String]
+        attr_accessor :associated_membership_gifting_message_id
+      
+        # The ID of the user that made the membership gifting purchase. This matches the
+        # `snippet.authorChannelId` of the associated membership gifting message.
+        # Corresponds to the JSON property `gifterChannelId`
+        # @return [String]
+        attr_accessor :gifter_channel_id
+      
+        # The name of the Level at which the viewer is a member. This matches the `
+        # snippet.membershipGiftingDetails.giftMembershipsLevelName` of the associated
+        # membership gifting message. The Level names are defined by the YouTube channel
+        # offering the Membership. In some situations this field isn't filled.
+        # Corresponds to the JSON property `memberLevelName`
+        # @return [String]
+        attr_accessor :member_level_name
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @associated_membership_gifting_message_id = args[:associated_membership_gifting_message_id] if args.key?(:associated_membership_gifting_message_id)
+          @gifter_channel_id = args[:gifter_channel_id] if args.key?(:gifter_channel_id)
+          @member_level_name = args[:member_level_name] if args.key?(:member_level_name)
+        end
+      end
+      
       # 
       class LiveChatMemberMilestoneChatDetails
         include Google::Apis::Core::Hashable
@@ -4094,6 +4184,33 @@ module Google
         end
       end
       
+      # 
+      class LiveChatMembershipGiftingDetails
+        include Google::Apis::Core::Hashable
+      
+        # The number of gift memberships purchased by the user.
+        # Corresponds to the JSON property `giftMembershipsCount`
+        # @return [Fixnum]
+        attr_accessor :gift_memberships_count
+      
+        # The name of the level of the gift memberships purchased by the user. The Level
+        # names are defined by the YouTube channel offering the Membership. In some
+        # situations this field isn't filled.
+        # Corresponds to the JSON property `giftMembershipsLevelName`
+        # @return [String]
+        attr_accessor :gift_memberships_level_name
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @gift_memberships_count = args[:gift_memberships_count] if args.key?(:gift_memberships_count)
+          @gift_memberships_level_name = args[:gift_memberships_level_name] if args.key?(:gift_memberships_level_name)
+        end
+      end
+      
       # A *liveChatMessage* resource represents a chat message in a YouTube Live Chat.
       class LiveChatMessage
         include Google::Apis::Core::Hashable
@@ -4120,7 +4237,7 @@ module Google
         # @return [String]
         attr_accessor :kind
       
-        # Next ID: 31
+        # Next ID: 33
         # Corresponds to the JSON property `snippet`
         # @return [Google::Apis::YoutubeV3::LiveChatMessageSnippet]
         attr_accessor :snippet
@@ -4317,7 +4434,7 @@ module Google
         end
       end
       
-      # Next ID: 31
+      # Next ID: 33
       class LiveChatMessageSnippet
         include Google::Apis::Core::Hashable
       
@@ -4325,6 +4442,8 @@ module Google
         # textMessageEvent - the user that wrote the message fanFundingEvent - the user
         # that funded the broadcast newSponsorEvent - the user that just became a
         # sponsor memberMilestoneChatEvent - the member that sent the message
+        # membershipGiftingEvent - the user that made the purchase
+        # giftMembershipReceivedEvent - the user that received the gift membership
         # messageDeletedEvent - the moderator that took the action messageRetractedEvent
         # - the author that retracted their message userBannedEvent - the moderator that
         # took the action superChatEvent - the user that made the purchase
@@ -4346,6 +4465,12 @@ module Google
         # @return [Google::Apis::YoutubeV3::LiveChatFanFundingEventDetails]
         attr_accessor :fan_funding_event_details
       
+        # Details about the Gift Membership Received event, this is only set if the type
+        # is 'giftMembershipReceivedEvent'.
+        # Corresponds to the JSON property `giftMembershipReceivedDetails`
+        # @return [Google::Apis::YoutubeV3::LiveChatGiftMembershipReceivedDetails]
+        attr_accessor :gift_membership_received_details
+      
         # Whether the message has display content that should be displayed to users.
         # Corresponds to the JSON property `hasDisplayContent`
         # @return [Boolean]
@@ -4363,6 +4488,12 @@ module Google
         # @return [Google::Apis::YoutubeV3::LiveChatMemberMilestoneChatDetails]
         attr_accessor :member_milestone_chat_details
       
+        # Details about the Membership Gifting event, this is only set if the type is '
+        # membershipGiftingEvent'.
+        # Corresponds to the JSON property `membershipGiftingDetails`
+        # @return [Google::Apis::YoutubeV3::LiveChatMembershipGiftingDetails]
+        attr_accessor :membership_gifting_details
+      
         # 
         # Corresponds to the JSON property `messageDeletedDetails`
         # @return [Google::Apis::YoutubeV3::LiveChatMessageDeletedDetails]
@@ -4422,9 +4553,11 @@ module Google
           @author_channel_id = args[:author_channel_id] if args.key?(:author_channel_id)
           @display_message = args[:display_message] if args.key?(:display_message)
           @fan_funding_event_details = args[:fan_funding_event_details] if args.key?(:fan_funding_event_details)
+          @gift_membership_received_details = args[:gift_membership_received_details] if args.key?(:gift_membership_received_details)
           @has_display_content = args[:has_display_content] if args.key?(:has_display_content)
           @live_chat_id = args[:live_chat_id] if args.key?(:live_chat_id)
           @member_milestone_chat_details = args[:member_milestone_chat_details] if args.key?(:member_milestone_chat_details)
+          @membership_gifting_details = args[:membership_gifting_details] if args.key?(:membership_gifting_details)
           @message_deleted_details = args[:message_deleted_details] if args.key?(:message_deleted_details)
           @message_retracted_details = args[:message_retracted_details] if args.key?(:message_retracted_details)
           @new_sponsor_details = args[:new_sponsor_details] if args.key?(:new_sponsor_details)

data/lib/google/apis/youtube_v3/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module YoutubeV3
       # Version of the google-apis-youtube_v3 gem
-      GEM_VERSION = "0.15.0"
+      GEM_VERSION = "0.18.0"
 
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.4.1"
+      GENERATOR_VERSION = "0.5.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20220227"
+      REVISION = "20220608"
     end
   end
 end

data/lib/google/apis/youtube_v3/representations.rb

@@ -352,6 +352,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class Cuepoint
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Entity
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -496,12 +502,24 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class LiveChatGiftMembershipReceivedDetails
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class LiveChatMemberMilestoneChatDetails
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class LiveChatMembershipGiftingDetails
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class LiveChatMessage
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1652,6 +1670,7 @@ module Google
       class ChannelToStoreLinkDetails
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
+          property :merchant_id, :numeric_string => true, as: 'merchantId'
           property :store_name, as: 'storeName'
           property :store_url, as: 'storeUrl'
         end
@@ -1852,6 +1871,17 @@ module Google
         end
       end
       
+      class Cuepoint
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :cue_type, as: 'cueType'
+          property :duration_secs, as: 'durationSecs'
+          property :id, as: 'id'
+          property :insertion_offset_time_ms, :numeric_string => true, as: 'insertionOffsetTimeMs'
+          property :walltime_ms, :numeric_string => true, as: 'walltimeMs'
+        end
+      end
+      
       class Entity
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -2154,6 +2184,15 @@ module Google
         end
       end
       
+      class LiveChatGiftMembershipReceivedDetails
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :associated_membership_gifting_message_id, as: 'associatedMembershipGiftingMessageId'
+          property :gifter_channel_id, as: 'gifterChannelId'
+          property :member_level_name, as: 'memberLevelName'
+        end
+      end
+      
       class LiveChatMemberMilestoneChatDetails
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -2163,6 +2202,14 @@ module Google
         end
       end
       
+      class LiveChatMembershipGiftingDetails
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :gift_memberships_count, as: 'giftMembershipsCount'
+          property :gift_memberships_level_name, as: 'giftMembershipsLevelName'
+        end
+      end
+      
       class LiveChatMessage
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -2231,10 +2278,14 @@ module Google
           property :display_message, as: 'displayMessage'
           property :fan_funding_event_details, as: 'fanFundingEventDetails', class: Google::Apis::YoutubeV3::LiveChatFanFundingEventDetails, decorator: Google::Apis::YoutubeV3::LiveChatFanFundingEventDetails::Representation
       
+          property :gift_membership_received_details, as: 'giftMembershipReceivedDetails', class: Google::Apis::YoutubeV3::LiveChatGiftMembershipReceivedDetails, decorator: Google::Apis::YoutubeV3::LiveChatGiftMembershipReceivedDetails::Representation
+      
           property :has_display_content, as: 'hasDisplayContent'
           property :live_chat_id, as: 'liveChatId'
           property :member_milestone_chat_details, as: 'memberMilestoneChatDetails', class: Google::Apis::YoutubeV3::LiveChatMemberMilestoneChatDetails, decorator: Google::Apis::YoutubeV3::LiveChatMemberMilestoneChatDetails::Representation
       
+          property :membership_gifting_details, as: 'membershipGiftingDetails', class: Google::Apis::YoutubeV3::LiveChatMembershipGiftingDetails, decorator: Google::Apis::YoutubeV3::LiveChatMembershipGiftingDetails::Representation
+      
           property :message_deleted_details, as: 'messageDeletedDetails', class: Google::Apis::YoutubeV3::LiveChatMessageDeletedDetails, decorator: Google::Apis::YoutubeV3::LiveChatMessageDeletedDetails::Representation
       
           property :message_retracted_details, as: 'messageRetractedDetails', class: Google::Apis::YoutubeV3::LiveChatMessageRetractedDetails, decorator: Google::Apis::YoutubeV3::LiveChatMessageRetractedDetails::Representation

data/lib/google/apis/youtube_v3/service.rb

@@ -3819,6 +3819,86 @@ module Google
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           execute_or_queue_command(command, &block)
         end
+        
+        # Insert cuepoints in a broadcast
+        # @param [String] id
+        #   Broadcast to insert ads to, or equivalently `external_video_id` for internal
+        #   use.
+        # @param [String] on_behalf_of_content_owner
+        #   *Note:* This parameter is intended exclusively for YouTube content partners.
+        #   The *onBehalfOfContentOwner* parameter indicates that the request's
+        #   authorization credentials identify a YouTube CMS user who is acting on behalf
+        #   of the content owner specified in the parameter value. This parameter is
+        #   intended for YouTube content partners that own and manage many different
+        #   YouTube channels. It allows content owners to authenticate once and get access
+        #   to all their video and channel data, without having to provide authentication
+        #   credentials for each individual channel. The CMS account that the user
+        #   authenticates with must be linked to the specified YouTube content owner.
+        # @param [String] on_behalf_of_content_owner_channel
+        #   This parameter can only be used in a properly authorized request. *Note:* This
+        #   parameter is intended exclusively for YouTube content partners. The *
+        #   onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of
+        #   the channel to which a video is being added. This parameter is required when a
+        #   request specifies a value for the onBehalfOfContentOwner parameter, and it can
+        #   only be used in conjunction with that parameter. In addition, the request must
+        #   be authorized using a CMS account that is linked to the content owner that the
+        #   onBehalfOfContentOwner parameter specifies. Finally, the channel that the
+        #   onBehalfOfContentOwnerChannel parameter value specifies must be linked to the
+        #   content owner that the onBehalfOfContentOwner parameter specifies. This
+        #   parameter is intended for YouTube content partners that own and manage many
+        #   different YouTube channels. It allows content owners to authenticate once and
+        #   perform actions on behalf of the channel specified in the parameter value,
+        #   without having to provide authentication credentials for each separate channel.
+        # @param [Array<String>, String] part
+        #   The *part* parameter specifies a comma-separated list of one or more
+        #   liveBroadcast resource properties that the API response will include. The part
+        #   names that you can include in the parameter value are id, snippet,
+        #   contentDetails, and status.
+        # @param [String] resource_cue_type
+        # @param [Fixnum] resource_duration_secs
+        #   The duration of this cuepoint.
+        # @param [String] resource_id
+        #   The identifier for cuepoint resource.
+        # @param [Fixnum] resource_insertion_offset_time_ms
+        #   The time when the cuepoint should be inserted by offset to the broadcast
+        #   actual start time.
+        # @param [Fixnum] resource_walltime_ms
+        #   The wall clock time at which the cuepoint should be inserted. Only one of
+        #   insertion_offset_time_ms and walltime_ms may be set at a time.
+        # @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::YoutubeV3::Cuepoint] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::YoutubeV3::Cuepoint]
+        #
+        # @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_youtube_v3_live_broadcast_cuepoint(id: nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, part: nil, resource_cue_type: nil, resource_duration_secs: nil, resource_id: nil, resource_insertion_offset_time_ms: nil, resource_walltime_ms: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'youtube/v3/liveBroadcasts/cuepoint', options)
+          command.response_representation = Google::Apis::YoutubeV3::Cuepoint::Representation
+          command.response_class = Google::Apis::YoutubeV3::Cuepoint
+          command.query['id'] = id unless id.nil?
+          command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
+          command.query['onBehalfOfContentOwnerChannel'] = on_behalf_of_content_owner_channel unless on_behalf_of_content_owner_channel.nil?
+          command.query['part'] = part unless part.nil?
+          command.query['resource.cueType'] = resource_cue_type unless resource_cue_type.nil?
+          command.query['resource.durationSecs'] = resource_duration_secs unless resource_duration_secs.nil?
+          command.query['resource.id'] = resource_id unless resource_id.nil?
+          command.query['resource.insertionOffsetTimeMs'] = resource_insertion_offset_time_ms unless resource_insertion_offset_time_ms.nil?
+          command.query['resource.walltimeMs'] = resource_walltime_ms unless resource_walltime_ms.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
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-youtube_v3
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-07 00:00:00.000000000 Z
+date: 2022-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-youtube_v3/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-youtube_v3/v0.15.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-youtube_v3/v0.18.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-youtube_v3
 post_install_message: 
 rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
+rubygems_version: 3.3.14
 signing_key: 
 specification_version: 4
 summary: Simple REST client for YouTube Data API v3 V3