REST Resource: accounts.relationships

Resource: 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).

JSON representation 
{
  "name": string,
  "providerDisplayName": string,
  "accountIdAlias": string,
  "provider": string
}
Fields
name

string

Identifier. The resource name of the account relationship. Format: accounts/{account}/relationships/{relationship}. For example, accounts/123456/relationships/567890.
providerDisplayName

string

Output only. The human-readable display name of the provider account.
accountIdAlias

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 accountIdAlias to assign a friendly name to this relationship for easier identification in your systems.
provider

string

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).

Methods

get

 Retrieve an account relationship.

list

 List account relationships for the specified account.

patch

 Updates the account relationship.