Reference documentation and code samples for the Google Shopping Merchant Accounts V1 Client class TermsOfService.
The TermsOfService
message represents a specific version of the terms of
service that merchants must accept to access certain features or services.
For more information, see Terms of
Service
.
This message is important for the onboarding process, ensuring that merchants
agree to the necessary legal agreements for using the service. Merchants can
retrieve the latest terms of service for a given kind
and region
through RetrieveLatestTermsOfService
, and accept them as required through AcceptTermsOfService
.
Generated from protobuf message google.shopping.merchant.accounts.v1.TermsOfService
Namespace
Google \ Shopping \ Merchant \ Accounts \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Identifier. The resource name of the terms of service version. Format: termsOfService/{version}
↳ region_code
string
Region code as defined by CLDR
. This is either a country where the ToS applies specifically to that country or 001
when the same TermsOfService
can be signed in any country. However note that when signing a ToS that applies globally we still expect that a specific country is provided (this should be merchant business country or program country of participation).
↳ kind
int
The Kind this terms of service version applies to.
↳ file_uri
string
URI for terms of service file that needs to be displayed to signing users.
↳ external
bool
Whether this terms of service version is external. External terms of service versions can only be agreed through external processes and not directly by the merchant through UI or API.
getName
Identifier. The resource name of the terms of service version.
Format: termsOfService/{version}
string
setName
Identifier. The resource name of the terms of service version.
Format: termsOfService/{version}
var
string
$this
getRegionCode
Region code as defined by CLDR
. This is either
a country where the ToS applies specifically to that country or 001
when
the same TermsOfService
can be signed in any country. However note that
when signing a ToS that applies globally we still expect that a specific
country is provided (this should be merchant business country or program
country of participation).
string
setRegionCode
Region code as defined by CLDR
. This is either
a country where the ToS applies specifically to that country or 001
when
the same TermsOfService
can be signed in any country. However note that
when signing a ToS that applies globally we still expect that a specific
country is provided (this should be merchant business country or program
country of participation).
var
string
$this
getKind
The Kind this terms of service version applies to.
int
setKind
The Kind this terms of service version applies to.
var
int
$this
getFileUri
URI for terms of service file that needs to be displayed to signing users.
string
hasFileUri
clearFileUri
setFileUri
URI for terms of service file that needs to be displayed to signing users.
var
string
$this
getExternal
Whether this terms of service version is external. External terms of service versions can only be agreed through external processes and not directly by the merchant through UI or API.
bool
setExternal
Whether this terms of service version is external. External terms of service versions can only be agreed through external processes and not directly by the merchant through UI or API.
var
bool
$this
