Reference documentation and code samples for the Google Shopping Merchant Accounts V1 Client class Account.
The Account message represents a business's account within Shopping
Ads. It's the primary entity for managing product data, settings, and
interactions with Google's services and external providers.
Accounts can operate as standalone entities or be part of a advanced account
structure. In an advanced account setup the parent account manages multiple
sub-accounts.
Establishing an account involves configuring attributes like the account
name, time zone, and language preferences.
The Account message is the parent entity for many other resources, for
example, AccountRelationship, Homepage, BusinessInfo and so on.
Generated from protobuf message google.shopping.merchant.accounts.v1.Account
Namespace
Google \ Shopping \ Merchant \ Accounts \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The resource name of the account. Format: |
↳ account_id |
int|string
Output only. The ID of the account. |
↳ account_name |
string
Required. A human-readable name of the account. See store name and business name for more information. |
↳ adult_content |
bool
Optional. Whether this account contains adult content. |
↳ test_account |
bool
Output only. Whether this is a test account. |
↳ time_zone |
Google\Type\TimeZone
Required. The time zone of the account. On writes, |
↳ language_code |
string
Required. The account's BCP-47 language code, such as |
getName
Identifier. The resource name of the account.
Format: accounts/{account}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The resource name of the account.
Format: accounts/{account}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAccountId
Output only. The ID of the account.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setAccountId
Output only. The ID of the account.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAccountName
Required. A human-readable name of the account. See store name and business name for more information.
| Returns | |
|---|---|
| Type | Description |
string |
|
setAccountName
Required. A human-readable name of the account. See store name and business name for more information.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAdultContent
Optional. Whether this account contains adult content.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasAdultContent
clearAdultContent
setAdultContent
Optional. Whether this account contains adult content.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTestAccount
Output only. Whether this is a test account.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setTestAccount
Output only. Whether this is a test account.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTimeZone
Required. The time zone of the account.
On writes, time_zone sets both the reporting_time_zone and the
display_time_zone.
For reads, time_zone always returns the display_time_zone. If
display_time_zone doesn't exist for your account, time_zone is empty.
The version field is not supported, won't be set in responses and will be
silently ignored if specified in requests.
| Returns | |
|---|---|
| Type | Description |
Google\Type\TimeZone|null |
|
hasTimeZone
clearTimeZone
setTimeZone
Required. The time zone of the account.
On writes, time_zone sets both the reporting_time_zone and the
display_time_zone.
For reads, time_zone always returns the display_time_zone. If
display_time_zone doesn't exist for your account, time_zone is empty.
The version field is not supported, won't be set in responses and will be
silently ignored if specified in requests.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Type\TimeZone
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLanguageCode
Required. The account's BCP-47 language
code, such as en-US or sr-Latn.
| Returns | |
|---|---|
| Type | Description |
string |
|
setLanguageCode
Required. The account's BCP-47 language
code, such as en-US or sr-Latn.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|