Class: Google::Shopping::Merchant::Accounts::V1::AccountService

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

Overview

The AccountService message represents a specific service that a provider account offers to a Merchant Center account.

AccountService defines the permissions and capabilities granted to the provider, allowing for operations such as product management or campaign management.

The lifecycle of an AccountService involves a proposal phase, where one party suggests the service, and an approval phase, where the other party accepts or rejects it. This handshake mechanism ensures mutual consent before any access is granted. This mechanism safeguards both parties by ensuring that access rights are granted appropriately and that both the business and provider are aware of the services enabled. In scenarios where a user is an admin of both accounts, the approval can happen automatically.

The mutability of a service is also managed through AccountService. Some services might be immutable, for example, if they were established through other systems or APIs, and you cannot alter them through this API.

Defined Under Namespace

Modules: Mutability

Instance Attribute Summary collapse

Instance Attribute Details

#account_aggregation ⇒ ::Google::Shopping::Merchant::Accounts::V1::AccountAggregation

Returns Service type for account aggregation. This enables the provider, which is an advanced account, to manage multiple sub-accounts (client accounts). Through this service, the advanced account provider can perform administrative and operational tasks across all linked sub-accounts.

This is useful for agencies, aggregators, or large retailers that need centralized control over many Merchant Center accounts.

Note: The following fields are mutually exclusive: account_aggregation, products_management, campaigns_management, account_management, local_listing_management, comparison_shopping. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Shopping::Merchant::Accounts::V1::AccountAggregation) —

    Service type for account aggregation. This enables the provider, which is an advanced account, to manage multiple sub-accounts (client accounts). Through this service, the advanced account provider can perform administrative and operational tasks across all linked sub-accounts.

    This is useful for agencies, aggregators, or large retailers that need centralized control over many Merchant Center accounts.

    Note: The following fields are mutually exclusive: account_aggregation, products_management, campaigns_management, account_management, local_listing_management, comparison_shopping. If a field in that set is populated, all other fields in the set will automatically be cleared.



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/accountservices.rb', line 125

class AccountService
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The list of mutability option settings a service can have.
  module Mutability
    # Unused default value
    MUTABILITY_UNSPECIFIED = 0

    # The service can be mutated without restrictions.
    MUTABLE = 1

    # The service is read-only and must not be mutated.
    IMMUTABLE = 2
  end
end

#account_management ⇒ ::Google::Shopping::Merchant::Accounts::V1::AccountManagement

Returns Service type for account management. Enables the provider to perform administrative actions on the business's account, such as configuring account settings, managing users, or updating business information.

Note: The following fields are mutually exclusive: account_management, products_management, campaigns_management, account_aggregation, local_listing_management, comparison_shopping. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Shopping::Merchant::Accounts::V1::AccountManagement) —

    Service type for account management. Enables the provider to perform administrative actions on the business's account, such as configuring account settings, managing users, or updating business information.

    Note: The following fields are mutually exclusive: account_management, products_management, campaigns_management, account_aggregation, local_listing_management, comparison_shopping. If a field in that set is populated, all other fields in the set will automatically be cleared.



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/accountservices.rb', line 125

class AccountService
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The list of mutability option settings a service can have.
  module Mutability
    # Unused default value
    MUTABILITY_UNSPECIFIED = 0

    # The service can be mutated without restrictions.
    MUTABLE = 1

    # The service is read-only and must not be mutated.
    IMMUTABLE = 2
  end
end

#campaigns_management ⇒ ::Google::Shopping::Merchant::Accounts::V1::CampaignsManagement

Returns Service type for managing advertising campaigns. Grants the provider access to create and manage the business's ad campaigns, including setting up campaigns, adjusting bids, and optimizing performance.

Note: The following fields are mutually exclusive: campaigns_management, products_management, account_management, account_aggregation, local_listing_management, comparison_shopping. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Shopping::Merchant::Accounts::V1::CampaignsManagement) —

    Service type for managing advertising campaigns. Grants the provider access to create and manage the business's ad campaigns, including setting up campaigns, adjusting bids, and optimizing performance.

    Note: The following fields are mutually exclusive: campaigns_management, products_management, account_management, account_aggregation, local_listing_management, comparison_shopping. If a field in that set is populated, all other fields in the set will automatically be cleared.



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/accountservices.rb', line 125

class AccountService
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The list of mutability option settings a service can have.
  module Mutability
    # Unused default value
    MUTABILITY_UNSPECIFIED = 0

    # The service can be mutated without restrictions.
    MUTABLE = 1

    # The service is read-only and must not be mutated.
    IMMUTABLE = 2
  end
end

#comparison_shopping ⇒ ::Google::Shopping::Merchant::Accounts::V1::ComparisonShopping

Returns Service type for comparison shopping. The provider is a CSS (Comparison Shopping Service) managing the account. See https://support.google.com/merchants/answer/12653197

Note: The following fields are mutually exclusive: comparison_shopping, products_management, campaigns_management, account_management, account_aggregation, local_listing_management. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/accountservices.rb', line 125

class AccountService
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The list of mutability option settings a service can have.
  module Mutability
    # Unused default value
    MUTABILITY_UNSPECIFIED = 0

    # The service can be mutated without restrictions.
    MUTABLE = 1

    # The service is read-only and must not be mutated.
    IMMUTABLE = 2
  end
end

#external_account_id ⇒ ::String

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

Returns:

  • (::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 external_account_id differentiates between them, ensuring accurate linking and integration between Google and the provider.



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/accountservices.rb', line 125

class AccountService
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The list of mutability option settings a service can have.
  module Mutability
    # Unused default value
    MUTABILITY_UNSPECIFIED = 0

    # The service can be mutated without restrictions.
    MUTABLE = 1

    # The service is read-only and must not be mutated.
    IMMUTABLE = 2
  end
end

#handshake ⇒ ::Google::Shopping::Merchant::Accounts::V1::Handshake (readonly)

Returns Output only. Information about the state of the service in terms of establishing it (e.g. is it pending approval or approved).

Returns:



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/accountservices.rb', line 125

class AccountService
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The list of mutability option settings a service can have.
  module Mutability
    # Unused default value
    MUTABILITY_UNSPECIFIED = 0

    # The service can be mutated without restrictions.
    MUTABLE = 1

    # The service is read-only and must not be mutated.
    IMMUTABLE = 2
  end
end

#local_listing_management ⇒ ::Google::Shopping::Merchant::Accounts::V1::LocalListingManagement

Returns Service type for local listings management. The business group associated with the external account id will be used to provide local inventory to this Merchant Center account.

Note: The following fields are mutually exclusive: local_listing_management, products_management, campaigns_management, account_management, account_aggregation, comparison_shopping. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Shopping::Merchant::Accounts::V1::LocalListingManagement) —

    Service type for local listings management. The business group associated with the external account id will be used to provide local inventory to this Merchant Center account.

    Note: The following fields are mutually exclusive: local_listing_management, products_management, campaigns_management, account_management, account_aggregation, comparison_shopping. If a field in that set is populated, all other fields in the set will automatically be cleared.



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/accountservices.rb', line 125

class AccountService
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The list of mutability option settings a service can have.
  module Mutability
    # Unused default value
    MUTABILITY_UNSPECIFIED = 0

    # The service can be mutated without restrictions.
    MUTABLE = 1

    # The service is read-only and must not be mutated.
    IMMUTABLE = 2
  end
end

#mutability ⇒ ::Google::Shopping::Merchant::Accounts::V1::AccountService::Mutability (readonly)

Returns Output only. Whether the service is mutable (e.g. through Approve / Reject RPCs). A service that was created through another system or API might be immutable.

Returns:



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/accountservices.rb', line 125

class AccountService
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The list of mutability option settings a service can have.
  module Mutability
    # Unused default value
    MUTABILITY_UNSPECIFIED = 0

    # The service can be mutated without restrictions.
    MUTABLE = 1

    # The service is read-only and must not be mutated.
    IMMUTABLE = 2
  end
end

#name ⇒ ::String

Returns Identifier. The resource name of the account service. Format: accounts/{account}/services/{service}.

Returns:

  • (::String) —

    Identifier. The resource name of the account service. Format: accounts/{account}/services/{service}



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/accountservices.rb', line 125

class AccountService
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The list of mutability option settings a service can have.
  module Mutability
    # Unused default value
    MUTABILITY_UNSPECIFIED = 0

    # The service can be mutated without restrictions.
    MUTABLE = 1

    # The service is read-only and must not be mutated.
    IMMUTABLE = 2
  end
end

#products_management ⇒ ::Google::Shopping::Merchant::Accounts::V1::ProductsManagement

Returns Service type for managing products. This allows the provider to handle product data on behalf of the business, including reading and writing product listings. It's commonly used when the provider offers inventory management or catalog synchronization services to keep the business's product information up-to-date across platforms.

Note: The following fields are mutually exclusive: products_management, campaigns_management, account_management, account_aggregation, local_listing_management, comparison_shopping. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Shopping::Merchant::Accounts::V1::ProductsManagement) —

    Service type for managing products. This allows the provider to handle product data on behalf of the business, including reading and writing product listings. It's commonly used when the provider offers inventory management or catalog synchronization services to keep the business's product information up-to-date across platforms.

    Note: The following fields are mutually exclusive: products_management, campaigns_management, account_management, account_aggregation, local_listing_management, comparison_shopping. If a field in that set is populated, all other fields in the set will automatically be cleared.



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/accountservices.rb', line 125

class AccountService
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The list of mutability option settings a service can have.
  module Mutability
    # Unused default value
    MUTABILITY_UNSPECIFIED = 0

    # The service can be mutated without restrictions.
    MUTABLE = 1

    # The service is read-only and must not be mutated.
    IMMUTABLE = 2
  end
end

#provider ⇒ ::String (readonly)

Returns Output only. 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) —

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



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/accountservices.rb', line 125

class AccountService
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The list of mutability option settings a service can have.
  module Mutability
    # Unused default value
    MUTABILITY_UNSPECIFIED = 0

    # The service can be mutated without restrictions.
    MUTABLE = 1

    # The service is read-only and must not be mutated.
    IMMUTABLE = 2
  end
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.



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/accountservices.rb', line 125

class AccountService
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The list of mutability option settings a service can have.
  module Mutability
    # Unused default value
    MUTABILITY_UNSPECIFIED = 0

    # The service can be mutated without restrictions.
    MUTABLE = 1

    # The service is read-only and must not be mutated.
    IMMUTABLE = 2
  end
end