Class: Google::Shopping::Merchant::Accounts::V1::Account

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

Overview

The Account message represents a business's account within Shopping Ads. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers.

Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts.

Establishing an account involves configuring attributes like the account name, time zone, and language preferences.

The Account message is the parent entity for many other resources, for example, AccountRelationship, Homepage, BusinessInfo and so on.

Instance Attribute Summary collapse

Instance Attribute Details

#account_id ⇒ ::Integer (readonly)

Returns Output only. The ID of the account.

Returns:

  • (::Integer) —

    Output only. The ID of the account.



73
74
75
76
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/accounts.rb', line 73

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

#account_name ⇒ ::String

Returns Required. A human-readable name of the account. See store name and business name for more information.

Returns:

  • (::String) —

    Required. A human-readable name of the account. See store name and business name for more information.



73
74
75
76
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/accounts.rb', line 73

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

#adult_content ⇒ ::Boolean

Returns Optional. Whether this account contains adult content.

Returns:

  • (::Boolean) —

    Optional. Whether this account contains adult content.



73
74
75
76
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/accounts.rb', line 73

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

#language_code ⇒ ::String

Returns Required. The account's BCP-47 language code, such as en-US or sr-Latn.

Returns:



73
74
75
76
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/accounts.rb', line 73

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

#name ⇒ ::String

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

Returns:

  • (::String) —

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



73
74
75
76
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/accounts.rb', line 73

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

#test_account ⇒ ::Boolean (readonly)

Returns Output only. Whether this is a test account.

Returns:

  • (::Boolean) —

    Output only. Whether this is a test account.



73
74
75
76
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/accounts.rb', line 73

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

#time_zone ⇒ ::Google::Type::TimeZone

Returns Required. The time zone of the account.

On writes, time_zone sets both the reporting_time_zone and the display_time_zone.

For reads, time_zone always returns the display_time_zone. If display_time_zone doesn't exist for your account, time_zone is empty.

The version field is not supported, won't be set in responses and will be silently ignored if specified in requests.

Returns:

  • (::Google::Type::TimeZone) —

    Required. The time zone of the account.

    On writes, time_zone sets both the reporting_time_zone and the display_time_zone.

    For reads, time_zone always returns the display_time_zone. If display_time_zone doesn't exist for your account, time_zone is empty.

    The version field is not supported, won't be set in responses and will be silently ignored if specified in requests.



73
74
75
76
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/accounts.rb', line 73

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