google-apis-games_v1 0.20.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6fba9f51f3ab25458b218d1374f29ddcddfade893afd571850d3a27655ffc9e
-  data.tar.gz: 651c9c389a52dfaaa51e4f8a40a8fdb2915660ff9a7cffe5eaaf54de10d84bf2
+  metadata.gz: 33a657d23ba0e61a4cdf004885b65b70a60eaeef7322f3293f4b2b869eea4a3f
+  data.tar.gz: 23f586d791b40d94e01b3974a2520f034c57e56ed7c4cfe3709db89ba5dfee76
 SHA512:
-  metadata.gz: 219db66f2719d63441ef1155bb8b8e31a664f4a862cd1e9de1c1723fa729a4ecf77cf84e0297c9a71be669306854b1276f9f514f0df90be67f7dde5423d5106d
-  data.tar.gz: b6313f31f29275d5c35c11b6caebad96a73f1335ad40dee8999ee586a7a45267276bba4b49dabcfed349fd714667b0fcffcee42eae866b1bd504c1b114b47b05
+  metadata.gz: 28347eddf9f8d1f915ab658d512c8923c19d98450523b32ac86805a575d8c5ffbc08ef1f1f8a67c34ff1cfc25c899e647be9ee45b9a7f1dc307a402479021636
+  data.tar.gz: b1ae3f9ea31e3d54386b07ff02f28dcd32f094635252dfe56afd11962a49ce7c6de01c131dbe7145dba0f87f30f29d932c3865767f1543cba44ec96f9f6f93db

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-games_v1
 
+### v0.21.0 (2023-09-03)
+
+* Regenerated from discovery document revision 20230823
+
 ### v0.20.0 (2023-08-27)
 
 * Regenerated from discovery document revision 20230822

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

@@ -1624,6 +1624,86 @@ module Google
         end
       end
       
+      # Request to link an in-game account with a PGS principal (encoded in the
+      # session id).
+      class LinkPersonaRequest
+        include Google::Apis::Core::Hashable
+      
+        # Required. Cardinality constraint to observe when linking a persona to a player
+        # in the scope of a game.
+        # Corresponds to the JSON property `cardinalityConstraint`
+        # @return [String]
+        attr_accessor :cardinality_constraint
+      
+        # Required. Resolution policy to apply when the linking of a persona to a player
+        # would result in violating the specified cardinality constraint.
+        # Corresponds to the JSON property `conflictingLinksResolutionPolicy`
+        # @return [String]
+        attr_accessor :conflicting_links_resolution_policy
+      
+        # Input only. Optional expiration time.
+        # Corresponds to the JSON property `expireTime`
+        # @return [String]
+        attr_accessor :expire_time
+      
+        # Required. Stable identifier of the in-game account. Please refrain from re-
+        # using the same persona for different games.
+        # Corresponds to the JSON property `persona`
+        # @return [String]
+        attr_accessor :persona
+      
+        # Required. Opaque server-generated string that encodes all the necessary
+        # information to identify the PGS player / Google user and application.
+        # Corresponds to the JSON property `sessionId`
+        # @return [String]
+        attr_accessor :session_id
+      
+        # Required. Value of the token to create. Opaque to Play Games and assumed to be
+        # non-stable (encrypted with key rotation).
+        # Corresponds to the JSON property `token`
+        # @return [String]
+        attr_accessor :token
+      
+        # Input only. Optional time-to-live.
+        # Corresponds to the JSON property `ttl`
+        # @return [String]
+        attr_accessor :ttl
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @cardinality_constraint = args[:cardinality_constraint] if args.key?(:cardinality_constraint)
+          @conflicting_links_resolution_policy = args[:conflicting_links_resolution_policy] if args.key?(:conflicting_links_resolution_policy)
+          @expire_time = args[:expire_time] if args.key?(:expire_time)
+          @persona = args[:persona] if args.key?(:persona)
+          @session_id = args[:session_id] if args.key?(:session_id)
+          @token = args[:token] if args.key?(:token)
+          @ttl = args[:ttl] if args.key?(:ttl)
+        end
+      end
+      
+      # Outcome of a persona linking attempt.
+      class LinkPersonaResponse
+        include Google::Apis::Core::Hashable
+      
+        # Output only. State of a persona linking attempt.
+        # Corresponds to the JSON property `state`
+        # @return [String]
+        attr_accessor :state
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @state = args[:state] if args.key?(:state)
+        end
+      end
+      
       # The metagame config resource
       class MetagameConfig
         include Google::Apis::Core::Hashable
@@ -2358,6 +2438,99 @@ module Google
         end
       end
       
+      # Recall token data returned from RetrievePlayerTokens RPC
+      class RecallToken
+        include Google::Apis::Core::Hashable
+      
+        # Optional. Optional expiration time of the token
+        # Corresponds to the JSON property `expireTime`
+        # @return [String]
+        attr_accessor :expire_time
+      
+        # Required. Whether the persona identified by the token is linked to multiple
+        # PGS Players
+        # Corresponds to the JSON property `multiPlayerPersona`
+        # @return [Boolean]
+        attr_accessor :multi_player_persona
+        alias_method :multi_player_persona?, :multi_player_persona
+      
+        # Required. Value of the Recall token as it is provided by the client via
+        # LinkPersona RPC
+        # Corresponds to the JSON property `token`
+        # @return [String]
+        attr_accessor :token
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @expire_time = args[:expire_time] if args.key?(:expire_time)
+          @multi_player_persona = args[:multi_player_persona] if args.key?(:multi_player_persona)
+          @token = args[:token] if args.key?(:token)
+        end
+      end
+      
+      # Request to remove all Recall tokens associated with a persona for an app.
+      class ResetPersonaRequest
+        include Google::Apis::Core::Hashable
+      
+        # Value of the 'persona' field as it was provided by the client in LinkPersona
+        # RPC
+        # Corresponds to the JSON property `persona`
+        # @return [String]
+        attr_accessor :persona
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @persona = args[:persona] if args.key?(:persona)
+        end
+      end
+      
+      # Response for the ResetPersona RPC
+      class ResetPersonaResponse
+        include Google::Apis::Core::Hashable
+      
+        # Required. Whether any tokens were unlinked as a result of this request.
+        # Corresponds to the JSON property `unlinked`
+        # @return [Boolean]
+        attr_accessor :unlinked
+        alias_method :unlinked?, :unlinked
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @unlinked = args[:unlinked] if args.key?(:unlinked)
+        end
+      end
+      
+      # Response for the RetrievePlayerTokens RPC
+      class RetrievePlayerTokensResponse
+        include Google::Apis::Core::Hashable
+      
+        # Required. Recall tokens associated with the requested PGS Player principal
+        # Corresponds to the JSON property `tokens`
+        # @return [Array<Google::Apis::GamesV1::RecallToken>]
+        attr_accessor :tokens
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @tokens = args[:tokens] if args.key?(:tokens)
+        end
+      end
+      
       # A third party checking a revision response.
       class CheckRevisionResponse
         include Google::Apis::Core::Hashable
@@ -2721,6 +2894,61 @@ module Google
           @total_spend_next_28_days = args[:total_spend_next_28_days] if args.key?(:total_spend_next_28_days)
         end
       end
+      
+      # Request to remove a Recall token linking PGS principal and an in-game account
+      class UnlinkPersonaRequest
+        include Google::Apis::Core::Hashable
+      
+        # Value of the 'persona' field as it was provided by the client in LinkPersona
+        # RPC
+        # Corresponds to the JSON property `persona`
+        # @return [String]
+        attr_accessor :persona
+      
+        # Required. Opaque server-generated string that encodes all the necessary
+        # information to identify the PGS player / Google user and application.
+        # Corresponds to the JSON property `sessionId`
+        # @return [String]
+        attr_accessor :session_id
+      
+        # Value of the Recall token as it was provided by the client in LinkPersona RPC
+        # Corresponds to the JSON property `token`
+        # @return [String]
+        attr_accessor :token
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @persona = args[:persona] if args.key?(:persona)
+          @session_id = args[:session_id] if args.key?(:session_id)
+          @token = args[:token] if args.key?(:token)
+        end
+      end
+      
+      # Response for the UnlinkPersona RPC
+      class UnlinkPersonaResponse
+        include Google::Apis::Core::Hashable
+      
+        # Required. Whether a Recall token specified by the request was deleted. Can be '
+        # false' when there were no Recall tokens satisfied the criteria from the
+        # request.
+        # Corresponds to the JSON property `unlinked`
+        # @return [Boolean]
+        attr_accessor :unlinked
+        alias_method :unlinked?, :unlinked
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @unlinked = args[:unlinked] if args.key?(:unlinked)
+        end
+      end
     end
   end
 end

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

@@ -16,13 +16,13 @@ module Google
   module Apis
     module GamesV1
       # Version of the google-apis-games_v1 gem
-      GEM_VERSION = "0.20.0"
+      GEM_VERSION = "0.21.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.12.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20230822"
+      REVISION = "20230823"
     end
   end
 end

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

@@ -262,6 +262,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class LinkPersonaRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class LinkPersonaResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class MetagameConfig
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -364,6 +376,30 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class RecallToken
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class ResetPersonaRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class ResetPersonaResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class RetrievePlayerTokensResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class CheckRevisionResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -406,6 +442,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class UnlinkPersonaRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class UnlinkPersonaResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class AchievementDefinition
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -840,6 +888,26 @@ module Google
         end
       end
       
+      class LinkPersonaRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :cardinality_constraint, as: 'cardinalityConstraint'
+          property :conflicting_links_resolution_policy, as: 'conflictingLinksResolutionPolicy'
+          property :expire_time, as: 'expireTime'
+          property :persona, as: 'persona'
+          property :session_id, as: 'sessionId'
+          property :token, as: 'token'
+          property :ttl, as: 'ttl'
+        end
+      end
+      
+      class LinkPersonaResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :state, as: 'state'
+        end
+      end
+      
       class MetagameConfig
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1039,6 +1107,37 @@ module Google
         end
       end
       
+      class RecallToken
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :expire_time, as: 'expireTime'
+          property :multi_player_persona, as: 'multiPlayerPersona'
+          property :token, as: 'token'
+        end
+      end
+      
+      class ResetPersonaRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :persona, as: 'persona'
+        end
+      end
+      
+      class ResetPersonaResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :unlinked, as: 'unlinked'
+        end
+      end
+      
+      class RetrievePlayerTokensResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :tokens, as: 'tokens', class: Google::Apis::GamesV1::RecallToken, decorator: Google::Apis::GamesV1::RecallToken::Representation
+      
+        end
+      end
+      
       class CheckRevisionResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1122,6 +1221,22 @@ module Google
           property :total_spend_next_28_days, as: 'total_spend_next_28_days'
         end
       end
+      
+      class UnlinkPersonaRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :persona, as: 'persona'
+          property :session_id, as: 'sessionId'
+          property :token, as: 'token'
+        end
+      end
+      
+      class UnlinkPersonaResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :unlinked, as: 'unlinked'
+        end
+      end
     end
   end
 end

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

@@ -825,6 +825,133 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Associate the PGS Player principal encoded in the provided recall session id
+        # with an in-game account
+        # @param [Google::Apis::GamesV1::LinkPersonaRequest] link_persona_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::GamesV1::LinkPersonaResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::GamesV1::LinkPersonaResponse]
+        #
+        # @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 link_recall_persona(link_persona_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'games/v1/recall:linkPersona', options)
+          command.request_representation = Google::Apis::GamesV1::LinkPersonaRequest::Representation
+          command.request_object = link_persona_request_object
+          command.response_representation = Google::Apis::GamesV1::LinkPersonaResponse::Representation
+          command.response_class = Google::Apis::GamesV1::LinkPersonaResponse
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Delete all Recall tokens linking the given persona to any player (with or
+        # without a profile).
+        # @param [Google::Apis::GamesV1::ResetPersonaRequest] reset_persona_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::GamesV1::ResetPersonaResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::GamesV1::ResetPersonaResponse]
+        #
+        # @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 reset_recall_persona(reset_persona_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'games/v1/recall:resetPersona', options)
+          command.request_representation = Google::Apis::GamesV1::ResetPersonaRequest::Representation
+          command.request_object = reset_persona_request_object
+          command.response_representation = Google::Apis::GamesV1::ResetPersonaResponse::Representation
+          command.response_class = Google::Apis::GamesV1::ResetPersonaResponse
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Retrieve all Recall tokens associated with the PGS Player principal encoded in
+        # the provided recall session id. The API is only available for users that have
+        # active PGS Player profile.
+        # @param [String] session_id
+        #   Required. Opaque server-generated string that encodes all the necessary
+        #   information to identify the PGS player / Google user and application.
+        # @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::GamesV1::RetrievePlayerTokensResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::GamesV1::RetrievePlayerTokensResponse]
+        #
+        # @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 retrieve_recall_tokens(session_id, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'games/v1/recall/tokens/{sessionId}', options)
+          command.response_representation = Google::Apis::GamesV1::RetrievePlayerTokensResponse::Representation
+          command.response_class = Google::Apis::GamesV1::RetrievePlayerTokensResponse
+          command.params['sessionId'] = session_id unless session_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
+        
+        # Delete a Recall token linking the PGS Player principal identified by the
+        # Recall session and an in-game account identified either by the 'persona' or by
+        # the token value.
+        # @param [Google::Apis::GamesV1::UnlinkPersonaRequest] unlink_persona_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::GamesV1::UnlinkPersonaResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::GamesV1::UnlinkPersonaResponse]
+        #
+        # @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 unlink_recall_persona(unlink_persona_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'games/v1/recall:unlinkPersona', options)
+          command.request_representation = Google::Apis::GamesV1::UnlinkPersonaRequest::Representation
+          command.request_object = unlink_persona_request_object
+          command.response_representation = Google::Apis::GamesV1::UnlinkPersonaResponse::Representation
+          command.response_class = Google::Apis::GamesV1::UnlinkPersonaResponse
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Checks whether the games client is out of date.
         # @param [String] client_revision
         #   Required. The revision of the client SDK used by your application. Format: `[

data/lib/google/apis/games_v1.rb

@@ -30,6 +30,9 @@ module Google
       # This is NOT the gem version.
       VERSION = 'V1'
 
+      # View and manage your Google Play Developer account
+      AUTH_ANDROIDPUBLISHER = 'https://www.googleapis.com/auth/androidpublisher'
+
       # See, create, and delete its own configuration data in your Google Drive
       AUTH_DRIVE_APPDATA = 'https://www.googleapis.com/auth/drive.appdata'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-games_v1
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-27 00:00:00.000000000 Z
+date: 2023-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -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-games_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-games_v1/v0.20.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-games_v1/v0.21.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-games_v1
 post_install_message: 
 rdoc_options: []