Class: Google::Shopping::Merchant::Accounts::V1beta::BusinessIdentity

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

Overview

Collection of information related to the identity of a business.

Defined Under Namespace

Modules: PromotionsConsent Classes: IdentityAttribute

Instance Attribute Summary collapse

Instance Attribute Details

#black_owned ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::BusinessIdentity::IdentityAttribute

Returns Optional. Specifies whether the business identifies itself as being black-owned. This optional field will only be available for merchants with a business country set to US. It is also not applicable for marketplaces or marketplace sellers.

Returns:



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/shopping/merchant/accounts/v1beta/businessidentity.rb', line 63

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

  # All information related to an identity attribute.
  # @!attribute [rw] identity_declaration
  #   @return [::Google::Shopping::Merchant::Accounts::V1beta::BusinessIdentity::IdentityAttribute::IdentityDeclaration]
  #     Required. The declaration of identity for this attribute.
  class IdentityAttribute
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # All possible settings regarding the declaration of an identity.
    module IdentityDeclaration
      # Default value indicating that no selection was made.
      IDENTITY_DECLARATION_UNSPECIFIED = 0

      # Indicates that the account identifies with the attribute.
      SELF_IDENTIFIES_AS = 1

      # Indicates that the account does not identify with the attribute.
      DOES_NOT_SELF_IDENTIFY_AS = 2
    end
  end

  # All possible settings regarding promotions related to the business
  # identity.
  module PromotionsConsent
    # Default value indicating that no selection was made.
    PROMOTIONS_CONSENT_UNSPECIFIED = 0

    # Indicates that the account consented to having their business identity
    # used for promotions.
    PROMOTIONS_CONSENT_GIVEN = 1

    # Indicates that the account did not consent to having their business
    # identity used for promotions.
    PROMOTIONS_CONSENT_DENIED = 2
  end
end

#latino_owned ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::BusinessIdentity::IdentityAttribute

Returns Optional. Specifies whether the business identifies itself as being latino-owned. This optional field will only be available for merchants with a business country set to US. It is also not applicable for marketplaces or marketplace sellers.

Returns:



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/shopping/merchant/accounts/v1beta/businessidentity.rb', line 63

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

  # All information related to an identity attribute.
  # @!attribute [rw] identity_declaration
  #   @return [::Google::Shopping::Merchant::Accounts::V1beta::BusinessIdentity::IdentityAttribute::IdentityDeclaration]
  #     Required. The declaration of identity for this attribute.
  class IdentityAttribute
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # All possible settings regarding the declaration of an identity.
    module IdentityDeclaration
      # Default value indicating that no selection was made.
      IDENTITY_DECLARATION_UNSPECIFIED = 0

      # Indicates that the account identifies with the attribute.
      SELF_IDENTIFIES_AS = 1

      # Indicates that the account does not identify with the attribute.
      DOES_NOT_SELF_IDENTIFY_AS = 2
    end
  end

  # All possible settings regarding promotions related to the business
  # identity.
  module PromotionsConsent
    # Default value indicating that no selection was made.
    PROMOTIONS_CONSENT_UNSPECIFIED = 0

    # Indicates that the account consented to having their business identity
    # used for promotions.
    PROMOTIONS_CONSENT_GIVEN = 1

    # Indicates that the account did not consent to having their business
    # identity used for promotions.
    PROMOTIONS_CONSENT_DENIED = 2
  end
end

#name ⇒ ::String

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

Returns:

  • (::String) —

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/shopping/merchant/accounts/v1beta/businessidentity.rb', line 63

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

  # All information related to an identity attribute.
  # @!attribute [rw] identity_declaration
  #   @return [::Google::Shopping::Merchant::Accounts::V1beta::BusinessIdentity::IdentityAttribute::IdentityDeclaration]
  #     Required. The declaration of identity for this attribute.
  class IdentityAttribute
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # All possible settings regarding the declaration of an identity.
    module IdentityDeclaration
      # Default value indicating that no selection was made.
      IDENTITY_DECLARATION_UNSPECIFIED = 0

      # Indicates that the account identifies with the attribute.
      SELF_IDENTIFIES_AS = 1

      # Indicates that the account does not identify with the attribute.
      DOES_NOT_SELF_IDENTIFY_AS = 2
    end
  end

  # All possible settings regarding promotions related to the business
  # identity.
  module PromotionsConsent
    # Default value indicating that no selection was made.
    PROMOTIONS_CONSENT_UNSPECIFIED = 0

    # Indicates that the account consented to having their business identity
    # used for promotions.
    PROMOTIONS_CONSENT_GIVEN = 1

    # Indicates that the account did not consent to having their business
    # identity used for promotions.
    PROMOTIONS_CONSENT_DENIED = 2
  end
end

#promotions_consent ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::BusinessIdentity::PromotionsConsent

Returns Optional. Whether the identity attributes may be used for promotions.

Returns:



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/shopping/merchant/accounts/v1beta/businessidentity.rb', line 63

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

  # All information related to an identity attribute.
  # @!attribute [rw] identity_declaration
  #   @return [::Google::Shopping::Merchant::Accounts::V1beta::BusinessIdentity::IdentityAttribute::IdentityDeclaration]
  #     Required. The declaration of identity for this attribute.
  class IdentityAttribute
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # All possible settings regarding the declaration of an identity.
    module IdentityDeclaration
      # Default value indicating that no selection was made.
      IDENTITY_DECLARATION_UNSPECIFIED = 0

      # Indicates that the account identifies with the attribute.
      SELF_IDENTIFIES_AS = 1

      # Indicates that the account does not identify with the attribute.
      DOES_NOT_SELF_IDENTIFY_AS = 2
    end
  end

  # All possible settings regarding promotions related to the business
  # identity.
  module PromotionsConsent
    # Default value indicating that no selection was made.
    PROMOTIONS_CONSENT_UNSPECIFIED = 0

    # Indicates that the account consented to having their business identity
    # used for promotions.
    PROMOTIONS_CONSENT_GIVEN = 1

    # Indicates that the account did not consent to having their business
    # identity used for promotions.
    PROMOTIONS_CONSENT_DENIED = 2
  end
end

#small_business ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::BusinessIdentity::IdentityAttribute

Returns Optional. Specifies whether the business identifies itself as a small business. This optional field will only be available for merchants with a business country set to US. It is also not applicable for marketplaces.

Returns:



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/shopping/merchant/accounts/v1beta/businessidentity.rb', line 63

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

  # All information related to an identity attribute.
  # @!attribute [rw] identity_declaration
  #   @return [::Google::Shopping::Merchant::Accounts::V1beta::BusinessIdentity::IdentityAttribute::IdentityDeclaration]
  #     Required. The declaration of identity for this attribute.
  class IdentityAttribute
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # All possible settings regarding the declaration of an identity.
    module IdentityDeclaration
      # Default value indicating that no selection was made.
      IDENTITY_DECLARATION_UNSPECIFIED = 0

      # Indicates that the account identifies with the attribute.
      SELF_IDENTIFIES_AS = 1

      # Indicates that the account does not identify with the attribute.
      DOES_NOT_SELF_IDENTIFY_AS = 2
    end
  end

  # All possible settings regarding promotions related to the business
  # identity.
  module PromotionsConsent
    # Default value indicating that no selection was made.
    PROMOTIONS_CONSENT_UNSPECIFIED = 0

    # Indicates that the account consented to having their business identity
    # used for promotions.
    PROMOTIONS_CONSENT_GIVEN = 1

    # Indicates that the account did not consent to having their business
    # identity used for promotions.
    PROMOTIONS_CONSENT_DENIED = 2
  end
end

#veteran_owned ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::BusinessIdentity::IdentityAttribute

Returns Optional. Specifies whether the business identifies itself as being veteran-owned. This optional field will only be available for merchants with a business country set to US. It is also not applicable for marketplaces or marketplace sellers.

Returns:



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/shopping/merchant/accounts/v1beta/businessidentity.rb', line 63

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

  # All information related to an identity attribute.
  # @!attribute [rw] identity_declaration
  #   @return [::Google::Shopping::Merchant::Accounts::V1beta::BusinessIdentity::IdentityAttribute::IdentityDeclaration]
  #     Required. The declaration of identity for this attribute.
  class IdentityAttribute
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # All possible settings regarding the declaration of an identity.
    module IdentityDeclaration
      # Default value indicating that no selection was made.
      IDENTITY_DECLARATION_UNSPECIFIED = 0

      # Indicates that the account identifies with the attribute.
      SELF_IDENTIFIES_AS = 1

      # Indicates that the account does not identify with the attribute.
      DOES_NOT_SELF_IDENTIFY_AS = 2
    end
  end

  # All possible settings regarding promotions related to the business
  # identity.
  module PromotionsConsent
    # Default value indicating that no selection was made.
    PROMOTIONS_CONSENT_UNSPECIFIED = 0

    # Indicates that the account consented to having their business identity
    # used for promotions.
    PROMOTIONS_CONSENT_GIVEN = 1

    # Indicates that the account did not consent to having their business
    # identity used for promotions.
    PROMOTIONS_CONSENT_DENIED = 2
  end
end

#women_owned ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::BusinessIdentity::IdentityAttribute

Returns Optional. Specifies whether the business identifies itself as being women-owned. This optional field will only be available for merchants with a business country set to US. It is also not applicable for marketplaces or marketplace sellers.

Returns:



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/shopping/merchant/accounts/v1beta/businessidentity.rb', line 63

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

  # All information related to an identity attribute.
  # @!attribute [rw] identity_declaration
  #   @return [::Google::Shopping::Merchant::Accounts::V1beta::BusinessIdentity::IdentityAttribute::IdentityDeclaration]
  #     Required. The declaration of identity for this attribute.
  class IdentityAttribute
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # All possible settings regarding the declaration of an identity.
    module IdentityDeclaration
      # Default value indicating that no selection was made.
      IDENTITY_DECLARATION_UNSPECIFIED = 0

      # Indicates that the account identifies with the attribute.
      SELF_IDENTIFIES_AS = 1

      # Indicates that the account does not identify with the attribute.
      DOES_NOT_SELF_IDENTIFY_AS = 2
    end
  end

  # All possible settings regarding promotions related to the business
  # identity.
  module PromotionsConsent
    # Default value indicating that no selection was made.
    PROMOTIONS_CONSENT_UNSPECIFIED = 0

    # Indicates that the account consented to having their business identity
    # used for promotions.
    PROMOTIONS_CONSENT_GIVEN = 1

    # Indicates that the account did not consent to having their business
    # identity used for promotions.
    PROMOTIONS_CONSENT_DENIED = 2
  end
end