1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="merchantapi_accounts_v1.html">Merchant API</a> . <a href="merchantapi_accounts_v1.accounts.html">accounts</a> . <a href="merchantapi_accounts_v1.accounts.businessIdentity.html">businessIdentity</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#getBusinessIdentity">getBusinessIdentity(name, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves the business identity of an account.</p>
<p class="toc_element">
<code><a href="#updateBusinessIdentity">updateBusinessIdentity(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the business identity of an account. Executing this method requires admin access.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="getBusinessIdentity">getBusinessIdentity(name, x__xgafv=None)</code>
<pre>Retrieves the business identity of an account.
Args:
name: string, Required. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`. For example, `accounts/123456/businessIdentity`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Collection of information related to the [identity of a business](https://support.google.com/merchants/answer/12564247).
"blackOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being black-owned. This optional field will only be available for businesses with the business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
"identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
},
"latinoOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being latino-owned. This optional field will only be available for businesses with the business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
"identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
},
"name": "A String", # Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`
"promotionsConsent": "A String", # Required. Whether the identity attributes may be used for promotions.
"smallBusiness": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as a small business. This optional field will only be available for businesses with a business country set to `US`. It is also not applicable for marketplaces.
"identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
},
"veteranOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being veteran-owned. This optional field will only be available for businesses with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
"identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
},
"womenOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being women-owned. This optional field will only be available for businesses with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
"identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
},
}</pre>
</div>
<div class="method">
<code class="details" id="updateBusinessIdentity">updateBusinessIdentity(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates the business identity of an account. Executing this method requires admin access.
Args:
name: string, Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity` (required)
body: object, The request body.
The object takes the form of:
{ # Collection of information related to the [identity of a business](https://support.google.com/merchants/answer/12564247).
"blackOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being black-owned. This optional field will only be available for businesses with the business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
"identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
},
"latinoOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being latino-owned. This optional field will only be available for businesses with the business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
"identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
},
"name": "A String", # Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`
"promotionsConsent": "A String", # Required. Whether the identity attributes may be used for promotions.
"smallBusiness": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as a small business. This optional field will only be available for businesses with a business country set to `US`. It is also not applicable for marketplaces.
"identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
},
"veteranOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being veteran-owned. This optional field will only be available for businesses with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
"identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
},
"womenOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being women-owned. This optional field will only be available for businesses with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
"identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
},
}
updateMask: string, Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `black_owned` - `latino_owned` - `promotions_consent` - `small_business` - `veteran_owned` - `women_owned`
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Collection of information related to the [identity of a business](https://support.google.com/merchants/answer/12564247).
"blackOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being black-owned. This optional field will only be available for businesses with the business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
"identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
},
"latinoOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being latino-owned. This optional field will only be available for businesses with the business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
"identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
},
"name": "A String", # Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`
"promotionsConsent": "A String", # Required. Whether the identity attributes may be used for promotions.
"smallBusiness": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as a small business. This optional field will only be available for businesses with a business country set to `US`. It is also not applicable for marketplaces.
"identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
},
"veteranOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being veteran-owned. This optional field will only be available for businesses with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
"identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
},
"womenOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being women-owned. This optional field will only be available for businesses with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
"identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
},
}</pre>
</div>
</body></html>
|
