261 lines
15 KiB
HTML
261 lines
15 KiB
HTML
<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 SDK API</a> . <a href="admin_directory_v1.customers.html">customers</a></h1>
|
|
<h2>Instance Methods</h2>
|
|
<p class="toc_element">
|
|
<code><a href="admin_directory_v1.customers.chrome.html">chrome()</a></code>
|
|
</p>
|
|
<p class="firstline">Returns the chrome Resource.</p>
|
|
|
|
<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="#get">get(customerKey, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Retrieves a customer.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#patch">patch(customerKey, body=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Patches a customer.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#update">update(customerKey, body=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Updates a customer.</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="get">get(customerKey, x__xgafv=None)</code>
|
|
<pre>Retrieves a customer.
|
|
|
|
Args:
|
|
customerKey: string, Id of the customer to be retrieved (required)
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{
|
|
"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)
|
|
"customerDomain": "A String", # The customer's primary domain name string. Do not include the `www` prefix when creating a new customer.
|
|
"etag": "A String", # ETag of the resource.
|
|
"id": "A String", # The unique ID for the customer's Google Workspace account. (Readonly)
|
|
"kind": "admin#directory#customer", # Identifies the resource as a customer. Value: `admin#directory#customer`
|
|
"language": "A String", # The customer's ISO 639-2 language code. See the [Language Codes](/admin-sdk/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`.
|
|
"phoneNumber": "A String", # The customer's contact phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.
|
|
"postalAddress": { # The customer's postal address information.
|
|
"addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines.
|
|
"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.
|
|
"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).
|
|
"locality": "A String", # Name of the locality. An example of a locality value is the city of `San Francisco`.
|
|
"organizationName": "A String", # The company or company division name.
|
|
"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.
|
|
"region": "A String", # Name of the region. An example of a region value is `NY` for the state of New York.
|
|
},
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="patch">patch(customerKey, body=None, x__xgafv=None)</code>
|
|
<pre>Patches a customer.
|
|
|
|
Args:
|
|
customerKey: string, Id of the customer to be updated (required)
|
|
body: object, The request body.
|
|
The object takes the form of:
|
|
|
|
{
|
|
"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)
|
|
"customerDomain": "A String", # The customer's primary domain name string. Do not include the `www` prefix when creating a new customer.
|
|
"etag": "A String", # ETag of the resource.
|
|
"id": "A String", # The unique ID for the customer's Google Workspace account. (Readonly)
|
|
"kind": "admin#directory#customer", # Identifies the resource as a customer. Value: `admin#directory#customer`
|
|
"language": "A String", # The customer's ISO 639-2 language code. See the [Language Codes](/admin-sdk/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`.
|
|
"phoneNumber": "A String", # The customer's contact phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.
|
|
"postalAddress": { # The customer's postal address information.
|
|
"addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines.
|
|
"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.
|
|
"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).
|
|
"locality": "A String", # Name of the locality. An example of a locality value is the city of `San Francisco`.
|
|
"organizationName": "A String", # The company or company division name.
|
|
"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.
|
|
"region": "A String", # Name of the region. An example of a region value is `NY` for the state of New York.
|
|
},
|
|
}
|
|
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{
|
|
"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)
|
|
"customerDomain": "A String", # The customer's primary domain name string. Do not include the `www` prefix when creating a new customer.
|
|
"etag": "A String", # ETag of the resource.
|
|
"id": "A String", # The unique ID for the customer's Google Workspace account. (Readonly)
|
|
"kind": "admin#directory#customer", # Identifies the resource as a customer. Value: `admin#directory#customer`
|
|
"language": "A String", # The customer's ISO 639-2 language code. See the [Language Codes](/admin-sdk/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`.
|
|
"phoneNumber": "A String", # The customer's contact phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.
|
|
"postalAddress": { # The customer's postal address information.
|
|
"addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines.
|
|
"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.
|
|
"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).
|
|
"locality": "A String", # Name of the locality. An example of a locality value is the city of `San Francisco`.
|
|
"organizationName": "A String", # The company or company division name.
|
|
"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.
|
|
"region": "A String", # Name of the region. An example of a region value is `NY` for the state of New York.
|
|
},
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="update">update(customerKey, body=None, x__xgafv=None)</code>
|
|
<pre>Updates a customer.
|
|
|
|
Args:
|
|
customerKey: string, Id of the customer to be updated (required)
|
|
body: object, The request body.
|
|
The object takes the form of:
|
|
|
|
{
|
|
"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)
|
|
"customerDomain": "A String", # The customer's primary domain name string. Do not include the `www` prefix when creating a new customer.
|
|
"etag": "A String", # ETag of the resource.
|
|
"id": "A String", # The unique ID for the customer's Google Workspace account. (Readonly)
|
|
"kind": "admin#directory#customer", # Identifies the resource as a customer. Value: `admin#directory#customer`
|
|
"language": "A String", # The customer's ISO 639-2 language code. See the [Language Codes](/admin-sdk/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`.
|
|
"phoneNumber": "A String", # The customer's contact phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.
|
|
"postalAddress": { # The customer's postal address information.
|
|
"addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines.
|
|
"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.
|
|
"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).
|
|
"locality": "A String", # Name of the locality. An example of a locality value is the city of `San Francisco`.
|
|
"organizationName": "A String", # The company or company division name.
|
|
"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.
|
|
"region": "A String", # Name of the region. An example of a region value is `NY` for the state of New York.
|
|
},
|
|
}
|
|
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{
|
|
"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)
|
|
"customerDomain": "A String", # The customer's primary domain name string. Do not include the `www` prefix when creating a new customer.
|
|
"etag": "A String", # ETag of the resource.
|
|
"id": "A String", # The unique ID for the customer's Google Workspace account. (Readonly)
|
|
"kind": "admin#directory#customer", # Identifies the resource as a customer. Value: `admin#directory#customer`
|
|
"language": "A String", # The customer's ISO 639-2 language code. See the [Language Codes](/admin-sdk/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`.
|
|
"phoneNumber": "A String", # The customer's contact phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.
|
|
"postalAddress": { # The customer's postal address information.
|
|
"addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines.
|
|
"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.
|
|
"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).
|
|
"locality": "A String", # Name of the locality. An example of a locality value is the city of `San Francisco`.
|
|
"organizationName": "A String", # The company or company division name.
|
|
"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.
|
|
"region": "A String", # Name of the region. An example of a region value is `NY` for the state of New York.
|
|
},
|
|
}</pre>
|
|
</div>
|
|
|
|
</body></html> |