Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3e17f8990db54bec16c48c319072799a14f5a53f / . / docs / dyn / reseller_v1.customers.html
blob: bfc914f11f7c3646cedbd12bfcd1317c9611b205 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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="reseller_v1.html">Enterprise Apps Reseller API</a> . <a href="reseller_v1.customers.html">customers</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]81 <code><a href="#get">get(customerId)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]82<p class="firstline">Get a customer account.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]84 <code><a href="#insert">insert(body=None, customerAuthToken=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]85<p class="firstline">Order a new customer's account.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]86<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]87 <code><a href="#patch">patch(customerId, body=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]88<p class="firstline">Update a customer account's settings. This method supports patch semantics.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]89<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]90 <code><a href="#update">update(customerId, body=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]91<p class="firstline">Update a customer account's settings.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]92<h3>Method Details</h3>
93<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]94 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96</div>
97
98<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]99 <code class="details" id="get">get(customerId)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]100 <pre>Get a customer account.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]101
102Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]103 customerId: string, Either the customer&#x27;s primary domain name or the customer&#x27;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)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]104
105Returns:
106 An object of the form:
107
108 { # JSON template for a customer.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]109 &quot;customerDomainVerified&quot;: True or False, # Whether the customer&#x27;s primary domain has been verified.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]110 &quot;postalAddress&quot;: { # JSON template for address of a customer. # A customer&#x27;s address information. Each field has a limit of 255 charcters.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]111 &quot;countryCode&quot;: &quot;A String&quot;, # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]112 &quot;organizationName&quot;: &quot;A String&quot;, # The company or company division name. This is required.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]113 &quot;addressLine1&quot;: &quot;A String&quot;, # A customer&#x27;s physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]114 &quot;locality&quot;: &quot;A String&quot;, # An example of a locality value is the city of San Francisco.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]115 &quot;region&quot;: &quot;A String&quot;, # An example of a region value is CA for the state of California.
116 &quot;postalCode&quot;: &quot;A String&quot;, # A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer.
117 &quot;addressLine3&quot;: &quot;A String&quot;, # Line 3 of the address.
118 &quot;kind&quot;: &quot;customers#address&quot;, # Identifies the resource as a customer address. Value: customers#address
119 &quot;addressLine2&quot;: &quot;A String&quot;, # Line 2 of the address.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]120 &quot;contactName&quot;: &quot;A String&quot;, # The customer contact&#x27;s name. This is required.
121 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]122 &quot;customerDomain&quot;: &quot;A String&quot;, # The customer&#x27;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.
123 &quot;alternateEmail&quot;: &quot;A String&quot;, # Like the &quot;Customer email&quot; in the reseller tools, this email is the secondary contact used if something happens to the customer&#x27;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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]124 &quot;kind&quot;: &quot;reseller#customer&quot;, # Identifies the resource as a customer. Value: reseller#customer
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]125 &quot;resourceUiUrl&quot;: &quot;A String&quot;, # URL to customer&#x27;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.
126 &quot;phoneNumber&quot;: &quot;A String&quot;, # Customer contact phone number. Must start with &quot;+&quot; 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, &quot;123&quot;. This field is silently ignored if invalid.
127 &quot;customerId&quot;: &quot;A String&quot;, # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]128 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]129</div>
130
131<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]132 <code class="details" id="insert">insert(body=None, customerAuthToken=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]133 <pre>Order a new customer&#x27;s account.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]134
135Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]136 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]137 The object takes the form of:
138
139{ # JSON template for a customer.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]140 &quot;customerDomainVerified&quot;: True or False, # Whether the customer&#x27;s primary domain has been verified.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]141 &quot;postalAddress&quot;: { # JSON template for address of a customer. # A customer&#x27;s address information. Each field has a limit of 255 charcters.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]142 &quot;countryCode&quot;: &quot;A String&quot;, # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]143 &quot;organizationName&quot;: &quot;A String&quot;, # The company or company division name. This is required.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]144 &quot;addressLine1&quot;: &quot;A String&quot;, # A customer&#x27;s physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]145 &quot;locality&quot;: &quot;A String&quot;, # An example of a locality value is the city of San Francisco.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]146 &quot;region&quot;: &quot;A String&quot;, # An example of a region value is CA for the state of California.
147 &quot;postalCode&quot;: &quot;A String&quot;, # A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer.
148 &quot;addressLine3&quot;: &quot;A String&quot;, # Line 3 of the address.
149 &quot;kind&quot;: &quot;customers#address&quot;, # Identifies the resource as a customer address. Value: customers#address
150 &quot;addressLine2&quot;: &quot;A String&quot;, # Line 2 of the address.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]151 &quot;contactName&quot;: &quot;A String&quot;, # The customer contact&#x27;s name. This is required.
152 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]153 &quot;customerDomain&quot;: &quot;A String&quot;, # The customer&#x27;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.
154 &quot;alternateEmail&quot;: &quot;A String&quot;, # Like the &quot;Customer email&quot; in the reseller tools, this email is the secondary contact used if something happens to the customer&#x27;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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]155 &quot;kind&quot;: &quot;reseller#customer&quot;, # Identifies the resource as a customer. Value: reseller#customer
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]156 &quot;resourceUiUrl&quot;: &quot;A String&quot;, # URL to customer&#x27;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.
157 &quot;phoneNumber&quot;: &quot;A String&quot;, # Customer contact phone number. Must start with &quot;+&quot; 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, &quot;123&quot;. This field is silently ignored if invalid.
158 &quot;customerId&quot;: &quot;A String&quot;, # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]159 }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]160
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]161 customerAuthToken: string, The customerAuthToken query string is required when creating a resold account that transfers a direct customer&#x27;s subscription or transfers another reseller customer&#x27;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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]162
163Returns:
164 An object of the form:
165
166 { # JSON template for a customer.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]167 &quot;customerDomainVerified&quot;: True or False, # Whether the customer&#x27;s primary domain has been verified.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]168 &quot;postalAddress&quot;: { # JSON template for address of a customer. # A customer&#x27;s address information. Each field has a limit of 255 charcters.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]169 &quot;countryCode&quot;: &quot;A String&quot;, # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]170 &quot;organizationName&quot;: &quot;A String&quot;, # The company or company division name. This is required.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]171 &quot;addressLine1&quot;: &quot;A String&quot;, # A customer&#x27;s physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]172 &quot;locality&quot;: &quot;A String&quot;, # An example of a locality value is the city of San Francisco.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]173 &quot;region&quot;: &quot;A String&quot;, # An example of a region value is CA for the state of California.
174 &quot;postalCode&quot;: &quot;A String&quot;, # A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer.
175 &quot;addressLine3&quot;: &quot;A String&quot;, # Line 3 of the address.
176 &quot;kind&quot;: &quot;customers#address&quot;, # Identifies the resource as a customer address. Value: customers#address
177 &quot;addressLine2&quot;: &quot;A String&quot;, # Line 2 of the address.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]178 &quot;contactName&quot;: &quot;A String&quot;, # The customer contact&#x27;s name. This is required.
179 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]180 &quot;customerDomain&quot;: &quot;A String&quot;, # The customer&#x27;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.
181 &quot;alternateEmail&quot;: &quot;A String&quot;, # Like the &quot;Customer email&quot; in the reseller tools, this email is the secondary contact used if something happens to the customer&#x27;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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]182 &quot;kind&quot;: &quot;reseller#customer&quot;, # Identifies the resource as a customer. Value: reseller#customer
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]183 &quot;resourceUiUrl&quot;: &quot;A String&quot;, # URL to customer&#x27;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.
184 &quot;phoneNumber&quot;: &quot;A String&quot;, # Customer contact phone number. Must start with &quot;+&quot; 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, &quot;123&quot;. This field is silently ignored if invalid.
185 &quot;customerId&quot;: &quot;A String&quot;, # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]186 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]187</div>
188
189<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]190 <code class="details" id="patch">patch(customerId, body=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]191 <pre>Update a customer account&#x27;s settings. This method supports patch semantics.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]192
193Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]194 customerId: string, Either the customer&#x27;s primary domain name or the customer&#x27;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)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]195 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]196 The object takes the form of:
197
198{ # JSON template for a customer.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]199 &quot;customerDomainVerified&quot;: True or False, # Whether the customer&#x27;s primary domain has been verified.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]200 &quot;postalAddress&quot;: { # JSON template for address of a customer. # A customer&#x27;s address information. Each field has a limit of 255 charcters.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]201 &quot;countryCode&quot;: &quot;A String&quot;, # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]202 &quot;organizationName&quot;: &quot;A String&quot;, # The company or company division name. This is required.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]203 &quot;addressLine1&quot;: &quot;A String&quot;, # A customer&#x27;s physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]204 &quot;locality&quot;: &quot;A String&quot;, # An example of a locality value is the city of San Francisco.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]205 &quot;region&quot;: &quot;A String&quot;, # An example of a region value is CA for the state of California.
206 &quot;postalCode&quot;: &quot;A String&quot;, # A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer.
207 &quot;addressLine3&quot;: &quot;A String&quot;, # Line 3 of the address.
208 &quot;kind&quot;: &quot;customers#address&quot;, # Identifies the resource as a customer address. Value: customers#address
209 &quot;addressLine2&quot;: &quot;A String&quot;, # Line 2 of the address.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]210 &quot;contactName&quot;: &quot;A String&quot;, # The customer contact&#x27;s name. This is required.
211 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]212 &quot;customerDomain&quot;: &quot;A String&quot;, # The customer&#x27;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.
213 &quot;alternateEmail&quot;: &quot;A String&quot;, # Like the &quot;Customer email&quot; in the reseller tools, this email is the secondary contact used if something happens to the customer&#x27;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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]214 &quot;kind&quot;: &quot;reseller#customer&quot;, # Identifies the resource as a customer. Value: reseller#customer
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]215 &quot;resourceUiUrl&quot;: &quot;A String&quot;, # URL to customer&#x27;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.
216 &quot;phoneNumber&quot;: &quot;A String&quot;, # Customer contact phone number. Must start with &quot;+&quot; 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, &quot;123&quot;. This field is silently ignored if invalid.
217 &quot;customerId&quot;: &quot;A String&quot;, # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]218 }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]219
220
221Returns:
222 An object of the form:
223
224 { # JSON template for a customer.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]225 &quot;customerDomainVerified&quot;: True or False, # Whether the customer&#x27;s primary domain has been verified.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]226 &quot;postalAddress&quot;: { # JSON template for address of a customer. # A customer&#x27;s address information. Each field has a limit of 255 charcters.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]227 &quot;countryCode&quot;: &quot;A String&quot;, # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]228 &quot;organizationName&quot;: &quot;A String&quot;, # The company or company division name. This is required.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]229 &quot;addressLine1&quot;: &quot;A String&quot;, # A customer&#x27;s physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]230 &quot;locality&quot;: &quot;A String&quot;, # An example of a locality value is the city of San Francisco.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]231 &quot;region&quot;: &quot;A String&quot;, # An example of a region value is CA for the state of California.
232 &quot;postalCode&quot;: &quot;A String&quot;, # A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer.
233 &quot;addressLine3&quot;: &quot;A String&quot;, # Line 3 of the address.
234 &quot;kind&quot;: &quot;customers#address&quot;, # Identifies the resource as a customer address. Value: customers#address
235 &quot;addressLine2&quot;: &quot;A String&quot;, # Line 2 of the address.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]236 &quot;contactName&quot;: &quot;A String&quot;, # The customer contact&#x27;s name. This is required.
237 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]238 &quot;customerDomain&quot;: &quot;A String&quot;, # The customer&#x27;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.
239 &quot;alternateEmail&quot;: &quot;A String&quot;, # Like the &quot;Customer email&quot; in the reseller tools, this email is the secondary contact used if something happens to the customer&#x27;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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]240 &quot;kind&quot;: &quot;reseller#customer&quot;, # Identifies the resource as a customer. Value: reseller#customer
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]241 &quot;resourceUiUrl&quot;: &quot;A String&quot;, # URL to customer&#x27;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.
242 &quot;phoneNumber&quot;: &quot;A String&quot;, # Customer contact phone number. Must start with &quot;+&quot; 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, &quot;123&quot;. This field is silently ignored if invalid.
243 &quot;customerId&quot;: &quot;A String&quot;, # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]244 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]245</div>
246
247<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]248 <code class="details" id="update">update(customerId, body=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]249 <pre>Update a customer account&#x27;s settings.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]250
251Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]252 customerId: string, Either the customer&#x27;s primary domain name or the customer&#x27;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)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]253 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]254 The object takes the form of:
255
256{ # JSON template for a customer.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]257 &quot;customerDomainVerified&quot;: True or False, # Whether the customer&#x27;s primary domain has been verified.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]258 &quot;postalAddress&quot;: { # JSON template for address of a customer. # A customer&#x27;s address information. Each field has a limit of 255 charcters.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]259 &quot;countryCode&quot;: &quot;A String&quot;, # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]260 &quot;organizationName&quot;: &quot;A String&quot;, # The company or company division name. This is required.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]261 &quot;addressLine1&quot;: &quot;A String&quot;, # A customer&#x27;s physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]262 &quot;locality&quot;: &quot;A String&quot;, # An example of a locality value is the city of San Francisco.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]263 &quot;region&quot;: &quot;A String&quot;, # An example of a region value is CA for the state of California.
264 &quot;postalCode&quot;: &quot;A String&quot;, # A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer.
265 &quot;addressLine3&quot;: &quot;A String&quot;, # Line 3 of the address.
266 &quot;kind&quot;: &quot;customers#address&quot;, # Identifies the resource as a customer address. Value: customers#address
267 &quot;addressLine2&quot;: &quot;A String&quot;, # Line 2 of the address.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]268 &quot;contactName&quot;: &quot;A String&quot;, # The customer contact&#x27;s name. This is required.
269 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]270 &quot;customerDomain&quot;: &quot;A String&quot;, # The customer&#x27;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.
271 &quot;alternateEmail&quot;: &quot;A String&quot;, # Like the &quot;Customer email&quot; in the reseller tools, this email is the secondary contact used if something happens to the customer&#x27;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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]272 &quot;kind&quot;: &quot;reseller#customer&quot;, # Identifies the resource as a customer. Value: reseller#customer
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]273 &quot;resourceUiUrl&quot;: &quot;A String&quot;, # URL to customer&#x27;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.
274 &quot;phoneNumber&quot;: &quot;A String&quot;, # Customer contact phone number. Must start with &quot;+&quot; 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, &quot;123&quot;. This field is silently ignored if invalid.
275 &quot;customerId&quot;: &quot;A String&quot;, # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]276 }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]277
278
279Returns:
280 An object of the form:
281
282 { # JSON template for a customer.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]283 &quot;customerDomainVerified&quot;: True or False, # Whether the customer&#x27;s primary domain has been verified.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]284 &quot;postalAddress&quot;: { # JSON template for address of a customer. # A customer&#x27;s address information. Each field has a limit of 255 charcters.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]285 &quot;countryCode&quot;: &quot;A String&quot;, # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]286 &quot;organizationName&quot;: &quot;A String&quot;, # The company or company division name. This is required.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]287 &quot;addressLine1&quot;: &quot;A String&quot;, # A customer&#x27;s physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]288 &quot;locality&quot;: &quot;A String&quot;, # An example of a locality value is the city of San Francisco.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]289 &quot;region&quot;: &quot;A String&quot;, # An example of a region value is CA for the state of California.
290 &quot;postalCode&quot;: &quot;A String&quot;, # A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer.
291 &quot;addressLine3&quot;: &quot;A String&quot;, # Line 3 of the address.
292 &quot;kind&quot;: &quot;customers#address&quot;, # Identifies the resource as a customer address. Value: customers#address
293 &quot;addressLine2&quot;: &quot;A String&quot;, # Line 2 of the address.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]294 &quot;contactName&quot;: &quot;A String&quot;, # The customer contact&#x27;s name. This is required.
295 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]296 &quot;customerDomain&quot;: &quot;A String&quot;, # The customer&#x27;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.
297 &quot;alternateEmail&quot;: &quot;A String&quot;, # Like the &quot;Customer email&quot; in the reseller tools, this email is the secondary contact used if something happens to the customer&#x27;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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]298 &quot;kind&quot;: &quot;reseller#customer&quot;, # Identifies the resource as a customer. Value: reseller#customer
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]299 &quot;resourceUiUrl&quot;: &quot;A String&quot;, # URL to customer&#x27;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.
300 &quot;phoneNumber&quot;: &quot;A String&quot;, # Customer contact phone number. Must start with &quot;+&quot; 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, &quot;123&quot;. This field is silently ignored if invalid.
301 &quot;customerId&quot;: &quot;A String&quot;, # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]302 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]303</div>
304
305</body></html>