• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5  margin: 0;
6  padding: 0;
7  border: 0;
8  font-weight: inherit;
9  font-style: inherit;
10  font-size: 100%;
11  font-family: inherit;
12  vertical-align: baseline;
13}
14
15body {
16  font-size: 13px;
17  padding: 1em;
18}
19
20h1 {
21  font-size: 26px;
22  margin-bottom: 1em;
23}
24
25h2 {
26  font-size: 24px;
27  margin-bottom: 1em;
28}
29
30h3 {
31  font-size: 20px;
32  margin-bottom: 1em;
33  margin-top: 1em;
34}
35
36pre, code {
37  line-height: 1.5;
38  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42  margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46  font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50  border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54  margin-top: 0.5em;
55}
56
57.firstline {
58  margin-left: 2 em;
59}
60
61.method  {
62  margin-top: 1em;
63  border: solid 1px #CCC;
64  padding: 1em;
65  background: #EEE;
66}
67
68.details {
69  font-weight: bold;
70  font-size: 14px;
71}
72
73</style>
74
75<h1><a href="admin_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.customers.html">customers</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#get">get(customerKey)</a></code></p>
79<p class="firstline">Retrieves a customer.</p>
80<p class="toc_element">
81  <code><a href="#patch">patch(customerKey, body)</a></code></p>
82<p class="firstline">Updates a customer. This method supports patch semantics.</p>
83<p class="toc_element">
84  <code><a href="#update">update(customerKey, body)</a></code></p>
85<p class="firstline">Updates a customer.</p>
86<h3>Method Details</h3>
87<div class="method">
88    <code class="details" id="get">get(customerKey)</code>
89  <pre>Retrieves a customer.
90
91Args:
92  customerKey: string, Id of the customer to be retrieved (required)
93
94Returns:
95  An object of the form:
96
97    { # JSON template for Customer Resource object in Directory API.
98      "customerDomain": "A String", # The customer's primary domain name string. Do not include the www prefix when creating a new customer.
99      "language": "A String", # The customer's ISO 639-2 language code. The default value is en-US
100      "alternateEmail": "A String", # The customer's secondary contact email address. This email address cannot be on the same domain as the customerDomain
101      "customerCreationTime": "A String", # The customer's creation time (Readonly)
102      "kind": "admin#directory#customer", # Identifies the resource as a customer. Value: admin#directory#customer
103      "etag": "A String", # ETag of the resource.
104      "phoneNumber": "A String", # The customer's contact phone number in E.164 format.
105      "postalAddress": { # JSON template for postal address of a customer. # The customer's postal address information.
106        "organizationName": "A String", # The company or company division name.
107        "countryCode": "A String", # This is a required property. For countryCode information see the ISO 3166 country code elements.
108        "locality": "A String", # Name of the locality. An example of a locality value is the city of San Francisco.
109        "region": "A String", # Name of the region. An example of a region value is NY for the state of New York.
110        "addressLine2": "A String", # Address line 2 of the address.
111        "addressLine3": "A String", # Address line 3 of the address.
112        "contactName": "A String", # The customer contact's name.
113        "addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines.
114        "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.
115      },
116      "id": "A String", # The unique ID for the customer's G Suite account. (Readonly)
117    }</pre>
118</div>
119
120<div class="method">
121    <code class="details" id="patch">patch(customerKey, body)</code>
122  <pre>Updates a customer. This method supports patch semantics.
123
124Args:
125  customerKey: string, Id of the customer to be updated (required)
126  body: object, The request body. (required)
127    The object takes the form of:
128
129{ # JSON template for Customer Resource object in Directory API.
130    "customerDomain": "A String", # The customer's primary domain name string. Do not include the www prefix when creating a new customer.
131    "language": "A String", # The customer's ISO 639-2 language code. The default value is en-US
132    "alternateEmail": "A String", # The customer's secondary contact email address. This email address cannot be on the same domain as the customerDomain
133    "customerCreationTime": "A String", # The customer's creation time (Readonly)
134    "kind": "admin#directory#customer", # Identifies the resource as a customer. Value: admin#directory#customer
135    "etag": "A String", # ETag of the resource.
136    "phoneNumber": "A String", # The customer's contact phone number in E.164 format.
137    "postalAddress": { # JSON template for postal address of a customer. # The customer's postal address information.
138      "organizationName": "A String", # The company or company division name.
139      "countryCode": "A String", # This is a required property. For countryCode information see the ISO 3166 country code elements.
140      "locality": "A String", # Name of the locality. An example of a locality value is the city of San Francisco.
141      "region": "A String", # Name of the region. An example of a region value is NY for the state of New York.
142      "addressLine2": "A String", # Address line 2 of the address.
143      "addressLine3": "A String", # Address line 3 of the address.
144      "contactName": "A String", # The customer contact's name.
145      "addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines.
146      "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.
147    },
148    "id": "A String", # The unique ID for the customer's G Suite account. (Readonly)
149  }
150
151
152Returns:
153  An object of the form:
154
155    { # JSON template for Customer Resource object in Directory API.
156      "customerDomain": "A String", # The customer's primary domain name string. Do not include the www prefix when creating a new customer.
157      "language": "A String", # The customer's ISO 639-2 language code. The default value is en-US
158      "alternateEmail": "A String", # The customer's secondary contact email address. This email address cannot be on the same domain as the customerDomain
159      "customerCreationTime": "A String", # The customer's creation time (Readonly)
160      "kind": "admin#directory#customer", # Identifies the resource as a customer. Value: admin#directory#customer
161      "etag": "A String", # ETag of the resource.
162      "phoneNumber": "A String", # The customer's contact phone number in E.164 format.
163      "postalAddress": { # JSON template for postal address of a customer. # The customer's postal address information.
164        "organizationName": "A String", # The company or company division name.
165        "countryCode": "A String", # This is a required property. For countryCode information see the ISO 3166 country code elements.
166        "locality": "A String", # Name of the locality. An example of a locality value is the city of San Francisco.
167        "region": "A String", # Name of the region. An example of a region value is NY for the state of New York.
168        "addressLine2": "A String", # Address line 2 of the address.
169        "addressLine3": "A String", # Address line 3 of the address.
170        "contactName": "A String", # The customer contact's name.
171        "addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines.
172        "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.
173      },
174      "id": "A String", # The unique ID for the customer's G Suite account. (Readonly)
175    }</pre>
176</div>
177
178<div class="method">
179    <code class="details" id="update">update(customerKey, body)</code>
180  <pre>Updates a customer.
181
182Args:
183  customerKey: string, Id of the customer to be updated (required)
184  body: object, The request body. (required)
185    The object takes the form of:
186
187{ # JSON template for Customer Resource object in Directory API.
188    "customerDomain": "A String", # The customer's primary domain name string. Do not include the www prefix when creating a new customer.
189    "language": "A String", # The customer's ISO 639-2 language code. The default value is en-US
190    "alternateEmail": "A String", # The customer's secondary contact email address. This email address cannot be on the same domain as the customerDomain
191    "customerCreationTime": "A String", # The customer's creation time (Readonly)
192    "kind": "admin#directory#customer", # Identifies the resource as a customer. Value: admin#directory#customer
193    "etag": "A String", # ETag of the resource.
194    "phoneNumber": "A String", # The customer's contact phone number in E.164 format.
195    "postalAddress": { # JSON template for postal address of a customer. # The customer's postal address information.
196      "organizationName": "A String", # The company or company division name.
197      "countryCode": "A String", # This is a required property. For countryCode information see the ISO 3166 country code elements.
198      "locality": "A String", # Name of the locality. An example of a locality value is the city of San Francisco.
199      "region": "A String", # Name of the region. An example of a region value is NY for the state of New York.
200      "addressLine2": "A String", # Address line 2 of the address.
201      "addressLine3": "A String", # Address line 3 of the address.
202      "contactName": "A String", # The customer contact's name.
203      "addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines.
204      "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.
205    },
206    "id": "A String", # The unique ID for the customer's G Suite account. (Readonly)
207  }
208
209
210Returns:
211  An object of the form:
212
213    { # JSON template for Customer Resource object in Directory API.
214      "customerDomain": "A String", # The customer's primary domain name string. Do not include the www prefix when creating a new customer.
215      "language": "A String", # The customer's ISO 639-2 language code. The default value is en-US
216      "alternateEmail": "A String", # The customer's secondary contact email address. This email address cannot be on the same domain as the customerDomain
217      "customerCreationTime": "A String", # The customer's creation time (Readonly)
218      "kind": "admin#directory#customer", # Identifies the resource as a customer. Value: admin#directory#customer
219      "etag": "A String", # ETag of the resource.
220      "phoneNumber": "A String", # The customer's contact phone number in E.164 format.
221      "postalAddress": { # JSON template for postal address of a customer. # The customer's postal address information.
222        "organizationName": "A String", # The company or company division name.
223        "countryCode": "A String", # This is a required property. For countryCode information see the ISO 3166 country code elements.
224        "locality": "A String", # Name of the locality. An example of a locality value is the city of San Francisco.
225        "region": "A String", # Name of the region. An example of a region value is NY for the state of New York.
226        "addressLine2": "A String", # Address line 2 of the address.
227        "addressLine3": "A String", # Address line 3 of the address.
228        "contactName": "A String", # The customer contact's name.
229        "addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines.
230        "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.
231      },
232      "id": "A String", # The unique ID for the customer's G Suite account. (Readonly)
233    }</pre>
234</div>
235
236</body></html>