| 1 |
<html><body> |
| 2 |
<style> |
| 3 |
|
| 4 |
body, 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 |
|
| 15 |
body { |
| 16 |
font-size: 13px; |
| 17 |
padding: 1em; |
| 18 |
} |
| 19 |
|
| 20 |
h1 { |
| 21 |
font-size: 26px; |
| 22 |
margin-bottom: 1em; |
| 23 |
} |
| 24 |
|
| 25 |
h2 { |
| 26 |
font-size: 24px; |
| 27 |
margin-bottom: 1em; |
| 28 |
} |
| 29 |
|
| 30 |
h3 { |
| 31 |
font-size: 20px; |
| 32 |
margin-bottom: 1em; |
| 33 |
margin-top: 1em; |
| 34 |
} |
| 35 |
|
| 36 |
pre, code { |
| 37 |
line-height: 1.5; |
| 38 |
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 |
} |
| 40 |
|
| 41 |
pre { |
| 42 |
margin-top: 0.5em; |
| 43 |
} |
| 44 |
|
| 45 |
h1, h2, h3, p { |
| 46 |
font-family: Arial, sans serif; |
| 47 |
} |
| 48 |
|
| 49 |
h1, 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 SDK 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="admin_directory_v1.customers.chrome.html">chrome()</a></code> |
| 79 |
</p> |
| 80 |
<p class="firstline">Returns the chrome Resource.</p> |
| 81 |
|
| 82 |
<p class="toc_element"> |
| 83 |
<code><a href="#close">close()</a></code></p> |
| 84 |
<p class="firstline">Close httplib2 connections.</p> |
| 85 |
<p class="toc_element"> |
| 86 |
<code><a href="#get">get(customerKey, x__xgafv=None)</a></code></p> |
| 87 |
<p class="firstline">Retrieves a customer.</p> |
| 88 |
<p class="toc_element"> |
| 89 |
<code><a href="#patch">patch(customerKey, body=None, x__xgafv=None)</a></code></p> |
| 90 |
<p class="firstline">Patches a customer.</p> |
| 91 |
<p class="toc_element"> |
| 92 |
<code><a href="#update">update(customerKey, body=None, x__xgafv=None)</a></code></p> |
| 93 |
<p class="firstline">Updates a customer.</p> |
| 94 |
<h3>Method Details</h3> |
| 95 |
<div class="method"> |
| 96 |
<code class="details" id="close">close()</code> |
| 97 |
<pre>Close httplib2 connections.</pre> |
| 98 |
</div> |
| 99 |
|
| 100 |
<div class="method"> |
| 101 |
<code class="details" id="get">get(customerKey, x__xgafv=None)</code> |
| 102 |
<pre>Retrieves a customer. |
| 103 |
|
| 104 |
Args: |
| 105 |
customerKey: string, Id of the customer to be retrieved (required) |
| 106 |
x__xgafv: string, V1 error format. |
| 107 |
Allowed values |
| 108 |
1 - v1 error format |
| 109 |
2 - v2 error format |
| 110 |
|
| 111 |
Returns: |
| 112 |
An object of the form: |
| 113 |
|
| 114 |
{ |
| 115 |
"alternateEmail": "A String", # The customer's secondary contact email address. This email address cannot be on the same domain as the `customerDomain` |
| 116 |
"customerCreationTime": "A String", # The customer's creation time (Readonly) |
| 117 |
"customerDomain": "A String", # The customer's primary domain name string. Do not include the `www` prefix when creating a new customer. |
| 118 |
"etag": "A String", # ETag of the resource. |
| 119 |
"id": "A String", # The unique ID for the customer's Google Workspace account. (Readonly) |
| 120 |
"kind": "admin#directory#customer", # Identifies the resource as a customer. Value: `admin#directory#customer` |
| 121 |
"language": "A String", # The customer's ISO 639-2 language code. See the [Language Codes](https://developers.google.com/workspace/admin/directory/v1/languages) page for the list of supported codes. Valid language codes outside the supported set will be accepted by the API but may lead to unexpected behavior. The default value is `en`. |
| 122 |
"phoneNumber": "A String", # The customer's contact phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format. |
| 123 |
"postalAddress": { # The customer's postal address information. |
| 124 |
"addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines. |
| 125 |
"addressLine2": "A String", # Address line 2 of the address. |
| 126 |
"addressLine3": "A String", # Address line 3 of the address. |
| 127 |
"contactName": "A String", # The customer contact's name. |
| 128 |
"countryCode": "A String", # This is a required property. For `countryCode` information see the [ISO 3166 country code elements](https://www.iso.org/iso/country_codes.htm). |
| 129 |
"locality": "A String", # Name of the locality. An example of a locality value is the city of `San Francisco`. |
| 130 |
"organizationName": "A String", # The company or company division name. |
| 131 |
"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. |
| 132 |
"region": "A String", # Name of the region. An example of a region value is `NY` for the state of New York. |
| 133 |
}, |
| 134 |
}</pre> |
| 135 |
</div> |
| 136 |
|
| 137 |
<div class="method"> |
| 138 |
<code class="details" id="patch">patch(customerKey, body=None, x__xgafv=None)</code> |
| 139 |
<pre>Patches a customer. |
| 140 |
|
| 141 |
Args: |
| 142 |
customerKey: string, Id of the customer to be updated (required) |
| 143 |
body: object, The request body. |
| 144 |
The object takes the form of: |
| 145 |
|
| 146 |
{ |
| 147 |
"alternateEmail": "A String", # The customer's secondary contact email address. This email address cannot be on the same domain as the `customerDomain` |
| 148 |
"customerCreationTime": "A String", # The customer's creation time (Readonly) |
| 149 |
"customerDomain": "A String", # The customer's primary domain name string. Do not include the `www` prefix when creating a new customer. |
| 150 |
"etag": "A String", # ETag of the resource. |
| 151 |
"id": "A String", # The unique ID for the customer's Google Workspace account. (Readonly) |
| 152 |
"kind": "admin#directory#customer", # Identifies the resource as a customer. Value: `admin#directory#customer` |
| 153 |
"language": "A String", # The customer's ISO 639-2 language code. See the [Language Codes](https://developers.google.com/workspace/admin/directory/v1/languages) page for the list of supported codes. Valid language codes outside the supported set will be accepted by the API but may lead to unexpected behavior. The default value is `en`. |
| 154 |
"phoneNumber": "A String", # The customer's contact phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format. |
| 155 |
"postalAddress": { # The customer's postal address information. |
| 156 |
"addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines. |
| 157 |
"addressLine2": "A String", # Address line 2 of the address. |
| 158 |
"addressLine3": "A String", # Address line 3 of the address. |
| 159 |
"contactName": "A String", # The customer contact's name. |
| 160 |
"countryCode": "A String", # This is a required property. For `countryCode` information see the [ISO 3166 country code elements](https://www.iso.org/iso/country_codes.htm). |
| 161 |
"locality": "A String", # Name of the locality. An example of a locality value is the city of `San Francisco`. |
| 162 |
"organizationName": "A String", # The company or company division name. |
| 163 |
"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. |
| 164 |
"region": "A String", # Name of the region. An example of a region value is `NY` for the state of New York. |
| 165 |
}, |
| 166 |
} |
| 167 |
|
| 168 |
x__xgafv: string, V1 error format. |
| 169 |
Allowed values |
| 170 |
1 - v1 error format |
| 171 |
2 - v2 error format |
| 172 |
|
| 173 |
Returns: |
| 174 |
An object of the form: |
| 175 |
|
| 176 |
{ |
| 177 |
"alternateEmail": "A String", # The customer's secondary contact email address. This email address cannot be on the same domain as the `customerDomain` |
| 178 |
"customerCreationTime": "A String", # The customer's creation time (Readonly) |
| 179 |
"customerDomain": "A String", # The customer's primary domain name string. Do not include the `www` prefix when creating a new customer. |
| 180 |
"etag": "A String", # ETag of the resource. |
| 181 |
"id": "A String", # The unique ID for the customer's Google Workspace account. (Readonly) |
| 182 |
"kind": "admin#directory#customer", # Identifies the resource as a customer. Value: `admin#directory#customer` |
| 183 |
"language": "A String", # The customer's ISO 639-2 language code. See the [Language Codes](https://developers.google.com/workspace/admin/directory/v1/languages) page for the list of supported codes. Valid language codes outside the supported set will be accepted by the API but may lead to unexpected behavior. The default value is `en`. |
| 184 |
"phoneNumber": "A String", # The customer's contact phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format. |
| 185 |
"postalAddress": { # The customer's postal address information. |
| 186 |
"addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines. |
| 187 |
"addressLine2": "A String", # Address line 2 of the address. |
| 188 |
"addressLine3": "A String", # Address line 3 of the address. |
| 189 |
"contactName": "A String", # The customer contact's name. |
| 190 |
"countryCode": "A String", # This is a required property. For `countryCode` information see the [ISO 3166 country code elements](https://www.iso.org/iso/country_codes.htm). |
| 191 |
"locality": "A String", # Name of the locality. An example of a locality value is the city of `San Francisco`. |
| 192 |
"organizationName": "A String", # The company or company division name. |
| 193 |
"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. |
| 194 |
"region": "A String", # Name of the region. An example of a region value is `NY` for the state of New York. |
| 195 |
}, |
| 196 |
}</pre> |
| 197 |
</div> |
| 198 |
|
| 199 |
<div class="method"> |
| 200 |
<code class="details" id="update">update(customerKey, body=None, x__xgafv=None)</code> |
| 201 |
<pre>Updates a customer. |
| 202 |
|
| 203 |
Args: |
| 204 |
customerKey: string, Id of the customer to be updated (required) |
| 205 |
body: object, The request body. |
| 206 |
The object takes the form of: |
| 207 |
|
| 208 |
{ |
| 209 |
"alternateEmail": "A String", # The customer's secondary contact email address. This email address cannot be on the same domain as the `customerDomain` |
| 210 |
"customerCreationTime": "A String", # The customer's creation time (Readonly) |
| 211 |
"customerDomain": "A String", # The customer's primary domain name string. Do not include the `www` prefix when creating a new customer. |
| 212 |
"etag": "A String", # ETag of the resource. |
| 213 |
"id": "A String", # The unique ID for the customer's Google Workspace account. (Readonly) |
| 214 |
"kind": "admin#directory#customer", # Identifies the resource as a customer. Value: `admin#directory#customer` |
| 215 |
"language": "A String", # The customer's ISO 639-2 language code. See the [Language Codes](https://developers.google.com/workspace/admin/directory/v1/languages) page for the list of supported codes. Valid language codes outside the supported set will be accepted by the API but may lead to unexpected behavior. The default value is `en`. |
| 216 |
"phoneNumber": "A String", # The customer's contact phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format. |
| 217 |
"postalAddress": { # The customer's postal address information. |
| 218 |
"addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines. |
| 219 |
"addressLine2": "A String", # Address line 2 of the address. |
| 220 |
"addressLine3": "A String", # Address line 3 of the address. |
| 221 |
"contactName": "A String", # The customer contact's name. |
| 222 |
"countryCode": "A String", # This is a required property. For `countryCode` information see the [ISO 3166 country code elements](https://www.iso.org/iso/country_codes.htm). |
| 223 |
"locality": "A String", # Name of the locality. An example of a locality value is the city of `San Francisco`. |
| 224 |
"organizationName": "A String", # The company or company division name. |
| 225 |
"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. |
| 226 |
"region": "A String", # Name of the region. An example of a region value is `NY` for the state of New York. |
| 227 |
}, |
| 228 |
} |
| 229 |
|
| 230 |
x__xgafv: string, V1 error format. |
| 231 |
Allowed values |
| 232 |
1 - v1 error format |
| 233 |
2 - v2 error format |
| 234 |
|
| 235 |
Returns: |
| 236 |
An object of the form: |
| 237 |
|
| 238 |
{ |
| 239 |
"alternateEmail": "A String", # The customer's secondary contact email address. This email address cannot be on the same domain as the `customerDomain` |
| 240 |
"customerCreationTime": "A String", # The customer's creation time (Readonly) |
| 241 |
"customerDomain": "A String", # The customer's primary domain name string. Do not include the `www` prefix when creating a new customer. |
| 242 |
"etag": "A String", # ETag of the resource. |
| 243 |
"id": "A String", # The unique ID for the customer's Google Workspace account. (Readonly) |
| 244 |
"kind": "admin#directory#customer", # Identifies the resource as a customer. Value: `admin#directory#customer` |
| 245 |
"language": "A String", # The customer's ISO 639-2 language code. See the [Language Codes](https://developers.google.com/workspace/admin/directory/v1/languages) page for the list of supported codes. Valid language codes outside the supported set will be accepted by the API but may lead to unexpected behavior. The default value is `en`. |
| 246 |
"phoneNumber": "A String", # The customer's contact phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format. |
| 247 |
"postalAddress": { # The customer's postal address information. |
| 248 |
"addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines. |
| 249 |
"addressLine2": "A String", # Address line 2 of the address. |
| 250 |
"addressLine3": "A String", # Address line 3 of the address. |
| 251 |
"contactName": "A String", # The customer contact's name. |
| 252 |
"countryCode": "A String", # This is a required property. For `countryCode` information see the [ISO 3166 country code elements](https://www.iso.org/iso/country_codes.htm). |
| 253 |
"locality": "A String", # Name of the locality. An example of a locality value is the city of `San Francisco`. |
| 254 |
"organizationName": "A String", # The company or company division name. |
| 255 |
"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. |
| 256 |
"region": "A String", # Name of the region. An example of a region value is `NY` for the state of New York. |
| 257 |
}, |
| 258 |
}</pre> |
| 259 |
</div> |
| 260 |
|
| 261 |
</body></html> |