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
|
<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="admin_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.customers.html">customers</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(customerKey)</a></code></p>
<p class="firstline">Retrieves a customer.</p>
<p class="toc_element">
<code><a href="#patch">patch(customerKey, body)</a></code></p>
<p class="firstline">Updates a customer. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(customerKey, body)</a></code></p>
<p class="firstline">Updates a customer.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(customerKey)</code>
<pre>Retrieves a customer.
Args:
customerKey: string, Id of the customer to be retrieved (required)
Returns:
An object of the form:
{ # JSON template for Customer Resource object in Directory API.
"customerDomain": "A String", # The customer's primary domain name string. Do not include the www prefix when creating a new customer.
"language": "A String", # The customer's ISO 639-2 language code. The default value is en-US
"alternateEmail": "A String", # The customer's secondary contact email address. This email address cannot be on the same domain as the customerDomain
"customerCreationTime": "A String", # The customer's creation time (Readonly)
"kind": "admin#directory#customer", # Identifies the resource as a customer. Value: admin#directory#customer
"etag": "A String", # ETag of the resource.
"phoneNumber": "A String", # The customer's contact phone number in E.164 format.
"postalAddress": { # JSON template for postal address of a customer. # The customer's postal address information.
"organizationName": "A String", # The company or company division name.
"countryCode": "A String", # This is a required property. For countryCode information see the ISO 3166 country code elements.
"locality": "A String", # Name of the locality. An example of a locality value is the city of San Francisco.
"region": "A String", # Name of the region. An example of a region value is NY for the state of New York.
"addressLine2": "A String", # Address line 2 of the address.
"addressLine3": "A String", # Address line 3 of the address.
"contactName": "A String", # The customer contact's name.
"addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines.
"postalCode": "A String", # The postal code. A postalCode example is a postal zip code such as 10009. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
},
"id": "A String", # The unique ID for the customer's G Suite account. (Readonly)
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(customerKey, body)</code>
<pre>Updates a customer. This method supports patch semantics.
Args:
customerKey: string, Id of the customer to be updated (required)
body: object, The request body. (required)
The object takes the form of:
{ # JSON template for Customer Resource object in Directory API.
"customerDomain": "A String", # The customer's primary domain name string. Do not include the www prefix when creating a new customer.
"language": "A String", # The customer's ISO 639-2 language code. The default value is en-US
"alternateEmail": "A String", # The customer's secondary contact email address. This email address cannot be on the same domain as the customerDomain
"customerCreationTime": "A String", # The customer's creation time (Readonly)
"kind": "admin#directory#customer", # Identifies the resource as a customer. Value: admin#directory#customer
"etag": "A String", # ETag of the resource.
"phoneNumber": "A String", # The customer's contact phone number in E.164 format.
"postalAddress": { # JSON template for postal address of a customer. # The customer's postal address information.
"organizationName": "A String", # The company or company division name.
"countryCode": "A String", # This is a required property. For countryCode information see the ISO 3166 country code elements.
"locality": "A String", # Name of the locality. An example of a locality value is the city of San Francisco.
"region": "A String", # Name of the region. An example of a region value is NY for the state of New York.
"addressLine2": "A String", # Address line 2 of the address.
"addressLine3": "A String", # Address line 3 of the address.
"contactName": "A String", # The customer contact's name.
"addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines.
"postalCode": "A String", # The postal code. A postalCode example is a postal zip code such as 10009. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
},
"id": "A String", # The unique ID for the customer's G Suite account. (Readonly)
}
Returns:
An object of the form:
{ # JSON template for Customer Resource object in Directory API.
"customerDomain": "A String", # The customer's primary domain name string. Do not include the www prefix when creating a new customer.
"language": "A String", # The customer's ISO 639-2 language code. The default value is en-US
"alternateEmail": "A String", # The customer's secondary contact email address. This email address cannot be on the same domain as the customerDomain
"customerCreationTime": "A String", # The customer's creation time (Readonly)
"kind": "admin#directory#customer", # Identifies the resource as a customer. Value: admin#directory#customer
"etag": "A String", # ETag of the resource.
"phoneNumber": "A String", # The customer's contact phone number in E.164 format.
"postalAddress": { # JSON template for postal address of a customer. # The customer's postal address information.
"organizationName": "A String", # The company or company division name.
"countryCode": "A String", # This is a required property. For countryCode information see the ISO 3166 country code elements.
"locality": "A String", # Name of the locality. An example of a locality value is the city of San Francisco.
"region": "A String", # Name of the region. An example of a region value is NY for the state of New York.
"addressLine2": "A String", # Address line 2 of the address.
"addressLine3": "A String", # Address line 3 of the address.
"contactName": "A String", # The customer contact's name.
"addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines.
"postalCode": "A String", # The postal code. A postalCode example is a postal zip code such as 10009. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
},
"id": "A String", # The unique ID for the customer's G Suite account. (Readonly)
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(customerKey, body)</code>
<pre>Updates a customer.
Args:
customerKey: string, Id of the customer to be updated (required)
body: object, The request body. (required)
The object takes the form of:
{ # JSON template for Customer Resource object in Directory API.
"customerDomain": "A String", # The customer's primary domain name string. Do not include the www prefix when creating a new customer.
"language": "A String", # The customer's ISO 639-2 language code. The default value is en-US
"alternateEmail": "A String", # The customer's secondary contact email address. This email address cannot be on the same domain as the customerDomain
"customerCreationTime": "A String", # The customer's creation time (Readonly)
"kind": "admin#directory#customer", # Identifies the resource as a customer. Value: admin#directory#customer
"etag": "A String", # ETag of the resource.
"phoneNumber": "A String", # The customer's contact phone number in E.164 format.
"postalAddress": { # JSON template for postal address of a customer. # The customer's postal address information.
"organizationName": "A String", # The company or company division name.
"countryCode": "A String", # This is a required property. For countryCode information see the ISO 3166 country code elements.
"locality": "A String", # Name of the locality. An example of a locality value is the city of San Francisco.
"region": "A String", # Name of the region. An example of a region value is NY for the state of New York.
"addressLine2": "A String", # Address line 2 of the address.
"addressLine3": "A String", # Address line 3 of the address.
"contactName": "A String", # The customer contact's name.
"addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines.
"postalCode": "A String", # The postal code. A postalCode example is a postal zip code such as 10009. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
},
"id": "A String", # The unique ID for the customer's G Suite account. (Readonly)
}
Returns:
An object of the form:
{ # JSON template for Customer Resource object in Directory API.
"customerDomain": "A String", # The customer's primary domain name string. Do not include the www prefix when creating a new customer.
"language": "A String", # The customer's ISO 639-2 language code. The default value is en-US
"alternateEmail": "A String", # The customer's secondary contact email address. This email address cannot be on the same domain as the customerDomain
"customerCreationTime": "A String", # The customer's creation time (Readonly)
"kind": "admin#directory#customer", # Identifies the resource as a customer. Value: admin#directory#customer
"etag": "A String", # ETag of the resource.
"phoneNumber": "A String", # The customer's contact phone number in E.164 format.
"postalAddress": { # JSON template for postal address of a customer. # The customer's postal address information.
"organizationName": "A String", # The company or company division name.
"countryCode": "A String", # This is a required property. For countryCode information see the ISO 3166 country code elements.
"locality": "A String", # Name of the locality. An example of a locality value is the city of San Francisco.
"region": "A String", # Name of the region. An example of a region value is NY for the state of New York.
"addressLine2": "A String", # Address line 2 of the address.
"addressLine3": "A String", # Address line 3 of the address.
"contactName": "A String", # The customer contact's name.
"addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines.
"postalCode": "A String", # The postal code. A postalCode example is a postal zip code such as 10009. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
},
"id": "A String", # The unique ID for the customer's G Suite account. (Readonly)
}</pre>
</div>
</body></html>
|
