Class: Google::Shopping::Merchant::Accounts::V1::AccountRelationship

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/shopping/merchant/accounts/v1/accountrelationships.rb

Overview

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

Instance Attribute Summary collapse

Instance Attribute Details

#account_id_alias ⇒ ::String

Returns 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:

  • (::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 account_id_alias to assign a friendly name to this relationship for easier identification in your systems.



57
58
59
60
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/accountrelationships.rb', line 57

class AccountRelationship
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

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

Returns:

  • (::String) —

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



57
58
59
60
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/accountrelationships.rb', line 57

class AccountRelationship
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#provider ⇒ ::String

Returns 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:

  • (::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).



57
58
59
60
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/accountrelationships.rb', line 57

class AccountRelationship
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#provider_display_name ⇒ ::String (readonly)

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

Returns:

  • (::String) —

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



57
58
59
60
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/accountrelationships.rb', line 57

class AccountRelationship
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end