Reference documentation and code samples for the Google Shopping Merchant Accounts V1 Client class AddAccountService.
Additional instructions to add account services during creation of the account.
Generated from protobuf message google.shopping.merchant.accounts.v1.CreateAndConfigureAccountRequest.AddAccountService
Namespace
Google \ Shopping \ Merchant \ Accounts \ V1 \ CreateAndConfigureAccountRequestMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ account_aggregation |
Google\Shopping\Merchant\Accounts\V1\AccountAggregation
The provider is an aggregator for the account. Payload for service type Account Aggregation. |
↳ account_management |
Google\Shopping\Merchant\Accounts\V1\AccountManagement
The provider manages this account. Payload for service type Account Management. |
↳ comparison_shopping |
Google\Shopping\Merchant\Accounts\V1\ComparisonShopping
The provider is a CSS (Comparison Shopping Service) of this account. Payload for service type Comparison Shopping. |
↳ products_management |
Google\Shopping\Merchant\Accounts\V1\ProductsManagement
The provider manages products for this account. Payload for service type products management. |
↳ campaigns_management |
Google\Shopping\Merchant\Accounts\V1\CampaignsManagement
The provider manages campaigns for this account. Payload for service type campaigns management. |
↳ provider |
string
Required. The provider of the service. Either the reference to an account such as |
↳ external_account_id |
string
Immutable. An optional, immutable identifier that Google uses to refer to this account when communicating with the provider. This should be the unique account ID within the provider's system (for example, your shop ID in Shopify). If you have multiple accounts with the same provider - for instance, different accounts for various regions — the |
getAccountAggregation
The provider is an aggregator for the account. Payload for service type Account Aggregation.
| Returns | |
|---|---|
| Type | Description |
Google\Shopping\Merchant\Accounts\V1\AccountAggregation|null |
|
hasAccountAggregation
setAccountAggregation
The provider is an aggregator for the account. Payload for service type Account Aggregation.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Shopping\Merchant\Accounts\V1\AccountAggregation
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAccountManagement
The provider manages this account. Payload for service type Account Management.
| Returns | |
|---|---|
| Type | Description |
Google\Shopping\Merchant\Accounts\V1\AccountManagement|null |
|
hasAccountManagement
setAccountManagement
The provider manages this account. Payload for service type Account Management.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Shopping\Merchant\Accounts\V1\AccountManagement
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getComparisonShopping
The provider is a CSS (Comparison Shopping Service) of this account.
Payload for service type Comparison Shopping.
| Returns | |
|---|---|
| Type | Description |
Google\Shopping\Merchant\Accounts\V1\ComparisonShopping|null |
|
hasComparisonShopping
setComparisonShopping
The provider is a CSS (Comparison Shopping Service) of this account.
Payload for service type Comparison Shopping.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Shopping\Merchant\Accounts\V1\ComparisonShopping
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProductsManagement
The provider manages products for this account. Payload for service type products management.
| Returns | |
|---|---|
| Type | Description |
Google\Shopping\Merchant\Accounts\V1\ProductsManagement|null |
|
hasProductsManagement
setProductsManagement
The provider manages products for this account. Payload for service type products management.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Shopping\Merchant\Accounts\V1\ProductsManagement
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCampaignsManagement
The provider manages campaigns for this account. Payload for service type campaigns management.
| Returns | |
|---|---|
| Type | Description |
Google\Shopping\Merchant\Accounts\V1\CampaignsManagement|null |
|
hasCampaignsManagement
setCampaignsManagement
The provider manages campaigns for this account. Payload for service type campaigns management.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Shopping\Merchant\Accounts\V1\CampaignsManagement
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProvider
Required. The provider of the service. Either the reference to an account
such as providers/123 or a well-known service provider (one of
providers/GOOGLE_ADS or providers/GOOGLE_BUSINESS_PROFILE).
| Returns | |
|---|---|
| Type | Description |
string |
|
hasProvider
clearProvider
setProvider
Required. The provider of the service. Either the reference to an account
such as providers/123 or a well-known service provider (one of
providers/GOOGLE_ADS or providers/GOOGLE_BUSINESS_PROFILE).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExternalAccountId
Immutable. An optional, immutable identifier that Google uses to refer to this account when communicating with the provider. This should be the unique account ID within the provider's system (for example, your shop ID in Shopify).
If you have multiple accounts with the same provider - for instance,
different accounts for various regions — the external_account_id
differentiates between them, ensuring accurate linking and integration
between Google and the provider.
The external account ID must be specified for the campaigns management
service type.
The external account ID must not be specified for the account aggregation
service type.
The external account ID is optional / may be specified for all other
service types.
| Returns | |
|---|---|
| Type | Description |
string |
|
setExternalAccountId
Immutable. An optional, immutable identifier that Google uses to refer to this account when communicating with the provider. This should be the unique account ID within the provider's system (for example, your shop ID in Shopify).
If you have multiple accounts with the same provider - for instance,
different accounts for various regions — the external_account_id
differentiates between them, ensuring accurate linking and integration
between Google and the provider.
The external account ID must be specified for the campaigns management
service type.
The external account ID must not be specified for the account aggregation
service type.
The external account ID is optional / may be specified for all other
service types.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getServiceType
| Returns | |
|---|---|
| Type | Description |
string |
|