Google Shopping Merchant Accounts V1beta Client - Class TermsOfServiceAgreementState (0.3.0)

Reference documentation and code samples for the Google Shopping Merchant Accounts V1beta Client class TermsOfServiceAgreementState.

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.

Generated from protobuf message google.shopping.merchant.accounts.v1beta.TermsOfServiceAgreementState

Namespace

Google \ Shopping \ Merchant \ Accounts \ V1beta

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`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`
`↳ region_code`	`string` Region code as defined by https://cldr.unicode.org/. This is the country the current state applies to.
`↳ terms_of_service_kind`	`int` Terms of Service kind associated with the particular version.
`↳ accepted`	`Google\Shopping\Merchant\Accounts\V1beta\Accepted` The accepted terms of service of this kind and for the associated region_code
`↳ required`	`Google\Shopping\Merchant\Accounts\V1beta\Required` The required terms of service

getName

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
Type	Description
`string`

setName

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getRegionCode

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

Returns
Type	Description
`string`

setRegionCode

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getTermsOfServiceKind

Returns
Type	Description
`int`

setTermsOfServiceKind

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getAccepted

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

Returns
Type	Description
`Google\Shopping\Merchant\Accounts\V1beta\Accepted\|null`

hasAccepted

clearAccepted

setAccepted

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

Parameter
Name	Description
`var`	`Google\Shopping\Merchant\Accounts\V1beta\Accepted`

Returns
Type	Description
`$this`

getRequired

The required terms of service

Returns
Type	Description
`Google\Shopping\Merchant\Accounts\V1beta\Required\|null`

hasRequired

clearRequired

setRequired

The required terms of service

Parameter
Name	Description
`var`	`Google\Shopping\Merchant\Accounts\V1beta\Required`

Returns
Type	Description
`$this`