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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
|
<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="reseller_v1.html">Enterprise Apps Reseller API</a> . <a href="reseller_v1.customers.html">customers</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(customerId)</a></code></p>
<p class="firstline">Get a customer account.</p>
<p class="toc_element">
<code><a href="#insert">insert(body, customerAuthToken=None)</a></code></p>
<p class="firstline">Order a new customer's account.</p>
<p class="toc_element">
<code><a href="#patch">patch(customerId, body)</a></code></p>
<p class="firstline">Update a customer account's settings. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(customerId, body)</a></code></p>
<p class="firstline">Update a customer account's settings.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(customerId)</code>
<pre>Get a customer account.
Args:
customerId: string, Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. (required)
Returns:
An object of the form:
{ # JSON template for a customer.
"customerDomain": "A String", # The customer's primary domain name string. customerDomain is required when creating a new customer. Do not include the www prefix in the domain when adding a customer.
"customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.
"alternateEmail": "A String", # Like the "Customer email" in the reseller tools, this email is the secondary contact used if something happens to the customer's service such as service outage or a security issue. This property is required when creating a new customer and should not use the same domain as customerDomain.
"kind": "reseller#customer", # Identifies the resource as a customer. Value: reseller#customer
"resourceUiUrl": "A String", # URL to customer's Admin console dashboard. The read-only URL is generated by the API service. This is used if your client application requires the customer to complete a task in the Admin console.
"phoneNumber": "A String", # Customer contact phone number. Must start with "+" followed by the country code. The rest of the number can be contiguous numbers or respect the phone local format conventions, but it must be a real phone number and not, for example, "123". This field is silently ignored if invalid.
"postalAddress": { # JSON template for address of a customer. # A customer's address information. Each field has a limit of 255 charcters.
"kind": "customers#address", # Identifies the resource as a customer address. Value: customers#address
"organizationName": "A String", # The company or company division name. This is required.
"countryCode": "A String", # For countryCode information, see the ISO 3166 country code elements. Verify that country is approved for resale of Google products. This property is required when creating a new customer.
"locality": "A String", # An example of a locality value is the city of San Francisco.
"region": "A String", # An example of a region value is CA for the state of California.
"addressLine2": "A String", # Line 2 of the address.
"addressLine3": "A String", # Line 3 of the address.
"contactName": "A String", # The customer contact's name. This is required.
"addressLine1": "A String", # A customer's physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional.
"postalCode": "A String", # A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer.
},
"customerId": "A String", # This property will always be returned in a response as the unique identifier generated by Google. In a request, this property can be either the primary domain or the unique identifier generated by Google.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(body, customerAuthToken=None)</code>
<pre>Order a new customer's account.
Args:
body: object, The request body. (required)
The object takes the form of:
{ # JSON template for a customer.
"customerDomain": "A String", # The customer's primary domain name string. customerDomain is required when creating a new customer. Do not include the www prefix in the domain when adding a customer.
"customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.
"alternateEmail": "A String", # Like the "Customer email" in the reseller tools, this email is the secondary contact used if something happens to the customer's service such as service outage or a security issue. This property is required when creating a new customer and should not use the same domain as customerDomain.
"kind": "reseller#customer", # Identifies the resource as a customer. Value: reseller#customer
"resourceUiUrl": "A String", # URL to customer's Admin console dashboard. The read-only URL is generated by the API service. This is used if your client application requires the customer to complete a task in the Admin console.
"phoneNumber": "A String", # Customer contact phone number. Must start with "+" followed by the country code. The rest of the number can be contiguous numbers or respect the phone local format conventions, but it must be a real phone number and not, for example, "123". This field is silently ignored if invalid.
"postalAddress": { # JSON template for address of a customer. # A customer's address information. Each field has a limit of 255 charcters.
"kind": "customers#address", # Identifies the resource as a customer address. Value: customers#address
"organizationName": "A String", # The company or company division name. This is required.
"countryCode": "A String", # For countryCode information, see the ISO 3166 country code elements. Verify that country is approved for resale of Google products. This property is required when creating a new customer.
"locality": "A String", # An example of a locality value is the city of San Francisco.
"region": "A String", # An example of a region value is CA for the state of California.
"addressLine2": "A String", # Line 2 of the address.
"addressLine3": "A String", # Line 3 of the address.
"contactName": "A String", # The customer contact's name. This is required.
"addressLine1": "A String", # A customer's physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional.
"postalCode": "A String", # A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer.
},
"customerId": "A String", # This property will always be returned in a response as the unique identifier generated by Google. In a request, this property can be either the primary domain or the unique identifier generated by Google.
}
customerAuthToken: string, The customerAuthToken query string is required when creating a resold account that transfers a direct customer's subscription or transfers another reseller customer's subscription to your reseller management. This is a hexadecimal authentication token needed to complete the subscription transfer. For more information, see the administrator help center.
Returns:
An object of the form:
{ # JSON template for a customer.
"customerDomain": "A String", # The customer's primary domain name string. customerDomain is required when creating a new customer. Do not include the www prefix in the domain when adding a customer.
"customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.
"alternateEmail": "A String", # Like the "Customer email" in the reseller tools, this email is the secondary contact used if something happens to the customer's service such as service outage or a security issue. This property is required when creating a new customer and should not use the same domain as customerDomain.
"kind": "reseller#customer", # Identifies the resource as a customer. Value: reseller#customer
"resourceUiUrl": "A String", # URL to customer's Admin console dashboard. The read-only URL is generated by the API service. This is used if your client application requires the customer to complete a task in the Admin console.
"phoneNumber": "A String", # Customer contact phone number. Must start with "+" followed by the country code. The rest of the number can be contiguous numbers or respect the phone local format conventions, but it must be a real phone number and not, for example, "123". This field is silently ignored if invalid.
"postalAddress": { # JSON template for address of a customer. # A customer's address information. Each field has a limit of 255 charcters.
"kind": "customers#address", # Identifies the resource as a customer address. Value: customers#address
"organizationName": "A String", # The company or company division name. This is required.
"countryCode": "A String", # For countryCode information, see the ISO 3166 country code elements. Verify that country is approved for resale of Google products. This property is required when creating a new customer.
"locality": "A String", # An example of a locality value is the city of San Francisco.
"region": "A String", # An example of a region value is CA for the state of California.
"addressLine2": "A String", # Line 2 of the address.
"addressLine3": "A String", # Line 3 of the address.
"contactName": "A String", # The customer contact's name. This is required.
"addressLine1": "A String", # A customer's physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional.
"postalCode": "A String", # A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer.
},
"customerId": "A String", # This property will always be returned in a response as the unique identifier generated by Google. In a request, this property can be either the primary domain or the unique identifier generated by Google.
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(customerId, body)</code>
<pre>Update a customer account's settings. This method supports patch semantics.
Args:
customerId: string, Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. (required)
body: object, The request body. (required)
The object takes the form of:
{ # JSON template for a customer.
"customerDomain": "A String", # The customer's primary domain name string. customerDomain is required when creating a new customer. Do not include the www prefix in the domain when adding a customer.
"customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.
"alternateEmail": "A String", # Like the "Customer email" in the reseller tools, this email is the secondary contact used if something happens to the customer's service such as service outage or a security issue. This property is required when creating a new customer and should not use the same domain as customerDomain.
"kind": "reseller#customer", # Identifies the resource as a customer. Value: reseller#customer
"resourceUiUrl": "A String", # URL to customer's Admin console dashboard. The read-only URL is generated by the API service. This is used if your client application requires the customer to complete a task in the Admin console.
"phoneNumber": "A String", # Customer contact phone number. Must start with "+" followed by the country code. The rest of the number can be contiguous numbers or respect the phone local format conventions, but it must be a real phone number and not, for example, "123". This field is silently ignored if invalid.
"postalAddress": { # JSON template for address of a customer. # A customer's address information. Each field has a limit of 255 charcters.
"kind": "customers#address", # Identifies the resource as a customer address. Value: customers#address
"organizationName": "A String", # The company or company division name. This is required.
"countryCode": "A String", # For countryCode information, see the ISO 3166 country code elements. Verify that country is approved for resale of Google products. This property is required when creating a new customer.
"locality": "A String", # An example of a locality value is the city of San Francisco.
"region": "A String", # An example of a region value is CA for the state of California.
"addressLine2": "A String", # Line 2 of the address.
"addressLine3": "A String", # Line 3 of the address.
"contactName": "A String", # The customer contact's name. This is required.
"addressLine1": "A String", # A customer's physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional.
"postalCode": "A String", # A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer.
},
"customerId": "A String", # This property will always be returned in a response as the unique identifier generated by Google. In a request, this property can be either the primary domain or the unique identifier generated by Google.
}
Returns:
An object of the form:
{ # JSON template for a customer.
"customerDomain": "A String", # The customer's primary domain name string. customerDomain is required when creating a new customer. Do not include the www prefix in the domain when adding a customer.
"customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.
"alternateEmail": "A String", # Like the "Customer email" in the reseller tools, this email is the secondary contact used if something happens to the customer's service such as service outage or a security issue. This property is required when creating a new customer and should not use the same domain as customerDomain.
"kind": "reseller#customer", # Identifies the resource as a customer. Value: reseller#customer
"resourceUiUrl": "A String", # URL to customer's Admin console dashboard. The read-only URL is generated by the API service. This is used if your client application requires the customer to complete a task in the Admin console.
"phoneNumber": "A String", # Customer contact phone number. Must start with "+" followed by the country code. The rest of the number can be contiguous numbers or respect the phone local format conventions, but it must be a real phone number and not, for example, "123". This field is silently ignored if invalid.
"postalAddress": { # JSON template for address of a customer. # A customer's address information. Each field has a limit of 255 charcters.
"kind": "customers#address", # Identifies the resource as a customer address. Value: customers#address
"organizationName": "A String", # The company or company division name. This is required.
"countryCode": "A String", # For countryCode information, see the ISO 3166 country code elements. Verify that country is approved for resale of Google products. This property is required when creating a new customer.
"locality": "A String", # An example of a locality value is the city of San Francisco.
"region": "A String", # An example of a region value is CA for the state of California.
"addressLine2": "A String", # Line 2 of the address.
"addressLine3": "A String", # Line 3 of the address.
"contactName": "A String", # The customer contact's name. This is required.
"addressLine1": "A String", # A customer's physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional.
"postalCode": "A String", # A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer.
},
"customerId": "A String", # This property will always be returned in a response as the unique identifier generated by Google. In a request, this property can be either the primary domain or the unique identifier generated by Google.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(customerId, body)</code>
<pre>Update a customer account's settings.
Args:
customerId: string, Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. (required)
body: object, The request body. (required)
The object takes the form of:
{ # JSON template for a customer.
"customerDomain": "A String", # The customer's primary domain name string. customerDomain is required when creating a new customer. Do not include the www prefix in the domain when adding a customer.
"customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.
"alternateEmail": "A String", # Like the "Customer email" in the reseller tools, this email is the secondary contact used if something happens to the customer's service such as service outage or a security issue. This property is required when creating a new customer and should not use the same domain as customerDomain.
"kind": "reseller#customer", # Identifies the resource as a customer. Value: reseller#customer
"resourceUiUrl": "A String", # URL to customer's Admin console dashboard. The read-only URL is generated by the API service. This is used if your client application requires the customer to complete a task in the Admin console.
"phoneNumber": "A String", # Customer contact phone number. Must start with "+" followed by the country code. The rest of the number can be contiguous numbers or respect the phone local format conventions, but it must be a real phone number and not, for example, "123". This field is silently ignored if invalid.
"postalAddress": { # JSON template for address of a customer. # A customer's address information. Each field has a limit of 255 charcters.
"kind": "customers#address", # Identifies the resource as a customer address. Value: customers#address
"organizationName": "A String", # The company or company division name. This is required.
"countryCode": "A String", # For countryCode information, see the ISO 3166 country code elements. Verify that country is approved for resale of Google products. This property is required when creating a new customer.
"locality": "A String", # An example of a locality value is the city of San Francisco.
"region": "A String", # An example of a region value is CA for the state of California.
"addressLine2": "A String", # Line 2 of the address.
"addressLine3": "A String", # Line 3 of the address.
"contactName": "A String", # The customer contact's name. This is required.
"addressLine1": "A String", # A customer's physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional.
"postalCode": "A String", # A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer.
},
"customerId": "A String", # This property will always be returned in a response as the unique identifier generated by Google. In a request, this property can be either the primary domain or the unique identifier generated by Google.
}
Returns:
An object of the form:
{ # JSON template for a customer.
"customerDomain": "A String", # The customer's primary domain name string. customerDomain is required when creating a new customer. Do not include the www prefix in the domain when adding a customer.
"customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.
"alternateEmail": "A String", # Like the "Customer email" in the reseller tools, this email is the secondary contact used if something happens to the customer's service such as service outage or a security issue. This property is required when creating a new customer and should not use the same domain as customerDomain.
"kind": "reseller#customer", # Identifies the resource as a customer. Value: reseller#customer
"resourceUiUrl": "A String", # URL to customer's Admin console dashboard. The read-only URL is generated by the API service. This is used if your client application requires the customer to complete a task in the Admin console.
"phoneNumber": "A String", # Customer contact phone number. Must start with "+" followed by the country code. The rest of the number can be contiguous numbers or respect the phone local format conventions, but it must be a real phone number and not, for example, "123". This field is silently ignored if invalid.
"postalAddress": { # JSON template for address of a customer. # A customer's address information. Each field has a limit of 255 charcters.
"kind": "customers#address", # Identifies the resource as a customer address. Value: customers#address
"organizationName": "A String", # The company or company division name. This is required.
"countryCode": "A String", # For countryCode information, see the ISO 3166 country code elements. Verify that country is approved for resale of Google products. This property is required when creating a new customer.
"locality": "A String", # An example of a locality value is the city of San Francisco.
"region": "A String", # An example of a region value is CA for the state of California.
"addressLine2": "A String", # Line 2 of the address.
"addressLine3": "A String", # Line 3 of the address.
"contactName": "A String", # The customer contact's name. This is required.
"addressLine1": "A String", # A customer's physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional.
"postalCode": "A String", # A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer.
},
"customerId": "A String", # This property will always be returned in a response as the unique identifier generated by Google. In a request, this property can be either the primary domain or the unique identifier generated by Google.
}</pre>
</div>
</body></html>
|
