Class: Google::Shopping::Merchant::Accounts::V1beta::TermsOfServiceAgreementState

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/shopping/merchant/accounts/v1beta/termsofserviceagreementstate.rb

Overview

This resource represents the agreement state for a given account and terms of service kind. The state is as follows:

  • If the merchant has accepted a terms of service: accepted will be populated, otherwise it will be empty
  • If the merchant must sign a terms of service: required will be populated, otherwise it will be empty.

Note that both required and accepted can be present. In this case the accepted terms of services will have an expiration date set in the valid_until field. The required terms of services need to be accepted before valid_until in order for the account to continue having a valid agreement. When accepting new terms of services we expect 3Ps to display the text associated with the given terms of service agreement (the url to the file containing the text is added in the Required message below as tos_file_uri. The actual acceptance of the terms of service is done by calling accept on the TermsOfService resource.

Instance Attribute Summary collapse

Instance Attribute Details

#accepted ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::Accepted

Returns The accepted terms of service of this kind and for the associated region_code.

Returns:



67
68
69
70
 
# File 'proto_docs/google/shopping/merchant/accounts/v1beta/termsofserviceagreementstate.rb', line 67

class TermsOfServiceAgreementState
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

Returns Identifier. The resource name of the terms of service version. Format: accounts/{account}/termsOfServiceAgreementState/{identifier} The identifier format is: {TermsOfServiceKind}-{country} For example, an identifier could be: MERCHANT_CENTER-US.

Returns:

  • (::String) —

    Identifier. The resource name of the terms of service version. Format: accounts/{account}/termsOfServiceAgreementState/{identifier} The identifier format is: {TermsOfServiceKind}-{country} For example, an identifier could be: MERCHANT_CENTER-US



67
68
69
70
 
# File 'proto_docs/google/shopping/merchant/accounts/v1beta/termsofserviceagreementstate.rb', line 67

class TermsOfServiceAgreementState
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#region_code ⇒ ::String

Returns Region code as defined by https://cldr.unicode.org/. This is the country the current state applies to.

Returns:



67
68
69
70
 
# File 'proto_docs/google/shopping/merchant/accounts/v1beta/termsofserviceagreementstate.rb', line 67

class TermsOfServiceAgreementState
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#required ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::Required

Returns The required terms of service.

Returns:



67
68
69
70
 
# File 'proto_docs/google/shopping/merchant/accounts/v1beta/termsofserviceagreementstate.rb', line 67

class TermsOfServiceAgreementState
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#terms_of_service_kind ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::TermsOfServiceKind

Returns Terms of Service kind associated with the particular version.

Returns:



67
68
69
70
 
# File 'proto_docs/google/shopping/merchant/accounts/v1beta/termsofserviceagreementstate.rb', line 67

class TermsOfServiceAgreementState
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end