Reference documentation and code samples for the Google Shopping Merchant Accounts V1 Client class AccountRelationship.
The AccountRelationship message defines a formal connection between a
merchant's account and a service provider's account. This relationship
enables the provider to offer specific services to the business, such as
product management or campaign management. It specifies the access rights
and permissions to the business's data relevant to those services.
Establishing an account relationship involves linking the merchant's account with a provider's account. The provider could be another Google account (like Google Ads or Google My Business) or a third-party platform (such as Shopify or WooCommerce).
Generated from protobuf message google.shopping.merchant.accounts.v1.AccountRelationship
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 relationship. Format: |
↳ provider |
string
Immutable. The provider of the service. Either the reference to an account such as |
↳ provider_display_name |
string
Output only. The human-readable display name of the provider account. |
↳ account_id_alias |
string
Optional. An optional alias you can assign to this account relationship. This alias acts as a convenient identifier for your own reference and management. It must be unique among all your account relationships with the same provider. For example, you might use |
getName
Identifier. The resource name of the account relationship.
Format: accounts/{account}/relationships/{relationship}. For example,
accounts/123456/relationships/567890.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The resource name of the account relationship.
Format: accounts/{account}/relationships/{relationship}. For example,
accounts/123456/relationships/567890.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProvider
Immutable. 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
Immutable. 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 |
|
getProviderDisplayName
Output only. The human-readable display name of the provider account.
| Returns | |
|---|---|
| Type | Description |
string |
|
setProviderDisplayName
Output only. The human-readable display name of the provider account.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAccountIdAlias
Optional. An optional alias you can assign to this account relationship.
This alias acts as a convenient identifier for your own reference and
management. It must be unique among all your account relationships with the
same provider.
For example, you might use account_id_alias to assign a friendly name
to this relationship for easier identification in your systems.
| Returns | |
|---|---|
| Type | Description |
string |
|
setAccountIdAlias
Optional. An optional alias you can assign to this account relationship.
This alias acts as a convenient identifier for your own reference and
management. It must be unique among all your account relationships with the
same provider.
For example, you might use account_id_alias to assign a friendly name
to this relationship for easier identification in your systems.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|