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).
Implements
Namespace: Google.Shopping.Merchant.Accounts.V1
Assembly: Google.Shopping.Merchant.Accounts.V1.dll
Syntax
public sealed class AccountRelationship : IMessage<AccountRelationship>, IEquatable<AccountRelationship>, IDeepCloneable<AccountRelationship>, IBufferMessage, IMessage
Constructors
AccountRelationship()
Declaration
public AccountRelationship()
AccountRelationship(AccountRelationship)
Declaration
public AccountRelationship(AccountRelationship other)
Parameters
Type | Name | Description |
---|---|---|
AccountRelationship | other |
Properties
AccountIdAlias
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.
Declaration
public string AccountIdAlias { get; set; }
Property Value
Type | Description |
---|---|
string |
AccountRelationshipName
AccountRelationshipName-typed view over the Name resource name property.
Declaration
public AccountRelationshipName AccountRelationshipName { get; set; }
Property Value
Type | Description |
---|---|
AccountRelationshipName |
HasProvider
Gets whether the "provider" field is set
Declaration
public bool HasProvider { get; }
Property Value
Type | Description |
---|---|
bool |
Name
Identifier. The resource name of the account relationship.
Format: accounts/{account}/relationships/{relationship}
. For example,
accounts/123456/relationships/567890
.
Declaration
public string Name { get; set; }
Property Value
Type | Description |
---|---|
string |
Provider
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
).
Declaration
public string Provider { get; set; }
Property Value
Type | Description |
---|---|
string |
ProviderDisplayName
Output only. The human-readable display name of the provider account.
Declaration
public string ProviderDisplayName { get; set; }
Property Value
Type | Description |
---|---|
string |