Blame - docs/dyn/reseller_v1.customers.html - platform/external/python/google-api-python-client

blob: 85b8c6ca60b43fd6cc24ea4bb086427f8f663dd5 [file] [log] [blame]

John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	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
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	75	<h1><a href="reseller_v1.html">Google Workspace Reseller API</a> . <a href="reseller_v1.customers.html">customers</a></h1>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-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">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	81	<code><a href="#get">get(customerId, x__xgafv=None)</a></code></p>
yoshi-code-bot	a36e3b1	2021-07-27 00:20:26 -0700	[diff] [blame^]	82	<p class="firstline">Gets a customer account. Use this operation to see a customer account already in your reseller management, or to see the minimal account information for an existing customer that you do not manage. For more information about the API response for existing customers, see [retrieving a customer account](/admin-sdk/reseller/v1/how-tos/manage_customers#get_customer).</p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	83	<p class="toc_element">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	84	<code><a href="#insert">insert(body=None, customerAuthToken=None, x__xgafv=None)</a></code></p>
yoshi-code-bot	a36e3b1	2021-07-27 00:20:26 -0700	[diff] [blame^]	85	<p class="firstline">Orders a new customer's account. Before ordering a new customer account, establish whether the customer account already exists using the [`customers.get`](/admin-sdk/reseller/v1/reference/customers/get) If the customer account exists as a direct Google account or as a resold customer account from another reseller, use the `customerAuthToken\` as described in [order a resold account for an existing customer](/admin-sdk/reseller/v1/how-tos/manage_customers#create_existing_customer). For more information about ordering a new customer account, see [order a new customer account](/admin-sdk/reseller/v1/how-tos/manage_customers#create_customer). After creating a new customer account, you must provision a user as an administrator. The customer's administrator is required to sign in to the Admin console and sign the G Suite via Reseller agreement to activate the account. Resellers are prohibited from signing the G Suite via Reseller agreement on the customer's behalf. For more information, see [order a new customer account](/admin-sdk/reseller/v1/how-tos/manage_customers#tos).</p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	86	<p class="toc_element">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	87	<code><a href="#patch">patch(customerId, body=None, x__xgafv=None)</a></code></p>
yoshi-code-bot	a36e3b1	2021-07-27 00:20:26 -0700	[diff] [blame^]	88	<p class="firstline">Updates a customer account's settings. This method supports patch semantics. You cannot update `customerType` via the Reseller API, but a `"team"` customer can verify their domain and become `customerType = "domain"`. For more information, see [Verify your domain to unlock Essentials features](https://support.google.com/a/answer/9122284).</p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	89	<p class="toc_element">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	90	<code><a href="#update">update(customerId, body=None, x__xgafv=None)</a></code></p>
yoshi-code-bot	a36e3b1	2021-07-27 00:20:26 -0700	[diff] [blame^]	91	<p class="firstline">Updates a customer account's settings. You cannot update `customerType` via the Reseller API, but a `"team"` customer can verify their domain and become `customerType = "domain"`. For more information, see [update a customer's settings](/admin-sdk/reseller/v1/how-tos/manage_customers#update_customer).</p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	92	<h3>Method Details</h3>
				93	<div class="method">
Dmitry Frenkel	3e17f89	2020-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">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	99	<code class="details" id="get">get(customerId, x__xgafv=None)</code>
yoshi-code-bot	a36e3b1	2021-07-27 00:20:26 -0700	[diff] [blame^]	100	<pre>Gets a customer account. Use this operation to see a customer account already in your reseller management, or to see the minimal account information for an existing customer that you do not manage. For more information about the API response for existing customers, see [retrieving a customer account](/admin-sdk/reseller/v1/how-tos/manage_customers#get_customer).
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	101
				102	Args:
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	103	customerId: string, Either the customer's primary domain name or the customer'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)
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	104	x__xgafv: string, V1 error format.
				105	Allowed values
				106	1 - v1 error format
				107	2 - v2 error format
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	108
				109	Returns:
				110	An object of the form:
				111
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	112	{ # When a Google customer's account is registered with a reseller, the customer's subscriptions for Google services are managed by this reseller. A customer is described by a primary domain name and a physical address.
yoshi-code-bot	a36e3b1	2021-07-27 00:20:26 -0700	[diff] [blame^]	113	"alternateEmail": "A String", # Like the "Customer email" in the reseller tools, this email is the secondary contact used if something happens to the customer's service such as service outage or a security issue. This property is required when creating a new "domain" customer and should not use the same domain as `customerDomain`. The `alternateEmail` field is not necessary to create a "team" customer.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	114	"customerDomain": "A String", # The customer'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.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	115	"customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.
				116	"customerId": "A String", # 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.
yoshi-code-bot	a36e3b1	2021-07-27 00:20:26 -0700	[diff] [blame^]	117	"customerType": "A String", # Identifies the type of the customer. Acceptable values include: * `domain`: Implies a domain-verified customer (default). * `team`: Implies an email-verified customer. For more information, see [managed teams](https://support.google.com/a/users/answer/9939479).
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	118	"kind": "reseller#customer", # Identifies the resource as a customer. Value: `reseller#customer`
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	119	"phoneNumber": "A String", # Customer contact phone number. Must start with "+" 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, "123". This field is silently ignored if invalid.
				120	"postalAddress": { # JSON template for address of a customer. # A customer's address information. Each field has a limit of 255 charcters.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	121	"addressLine1": "A String", # A customer's physical address. An address can be composed of one to three lines. The `addressline2` and `addressLine3` are optional.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	122	"addressLine2": "A String", # Line 2 of the address.
				123	"addressLine3": "A String", # Line 3 of the address.
				124	"contactName": "A String", # The customer contact's name. This is required.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	125	"countryCode": "A String", # 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.
				126	"kind": "customers#address", # Identifies the resource as a customer address. Value: `customers#address`
				127	"locality": "A String", # An example of a `locality` value is the city of `San Francisco`.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	128	"organizationName": "A String", # The company or company division name. This is required.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	129	"postalCode": "A String", # A `postalCode` example is a postal zip code such as `94043`. This property is required when creating a new customer.
				130	"region": "A String", # An example of a `region` value is `CA` for the state of California.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	131	},
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	132	"primaryAdmin": { # JSON template for primary admin in case of TEAM customers # The first admin details of the customer, present in case of TEAM customer.
yoshi-code-bot	a36e3b1	2021-07-27 00:20:26 -0700	[diff] [blame^]	133	"primaryEmail": "A String", # The business email of the primary administrator of the customer. The email verification link is sent to this email address at the time of customer creation. Primary administrators have access to the customer's Admin Console, including the ability to invite and evict users and manage the administrative needs of the customer.
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	134	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	135	"resourceUiUrl": "A String", # URL to customer'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.
				136	}</pre>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	137	</div>
				138
				139	<div class="method">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	140	<code class="details" id="insert">insert(body=None, customerAuthToken=None, x__xgafv=None)</code>
yoshi-code-bot	a36e3b1	2021-07-27 00:20:26 -0700	[diff] [blame^]	141	<pre>Orders a new customer's account. Before ordering a new customer account, establish whether the customer account already exists using the [`customers.get`](/admin-sdk/reseller/v1/reference/customers/get) If the customer account exists as a direct Google account or as a resold customer account from another reseller, use the `customerAuthToken\` as described in [order a resold account for an existing customer](/admin-sdk/reseller/v1/how-tos/manage_customers#create_existing_customer). For more information about ordering a new customer account, see [order a new customer account](/admin-sdk/reseller/v1/how-tos/manage_customers#create_customer). After creating a new customer account, you must provision a user as an administrator. The customer's administrator is required to sign in to the Admin console and sign the G Suite via Reseller agreement to activate the account. Resellers are prohibited from signing the G Suite via Reseller agreement on the customer's behalf. For more information, see [order a new customer account](/admin-sdk/reseller/v1/how-tos/manage_customers#tos).
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	142
				143	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	144	body: object, The request body.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	145	The object takes the form of:
				146
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	147	{ # When a Google customer's account is registered with a reseller, the customer's subscriptions for Google services are managed by this reseller. A customer is described by a primary domain name and a physical address.
yoshi-code-bot	a36e3b1	2021-07-27 00:20:26 -0700	[diff] [blame^]	148	"alternateEmail": "A String", # Like the "Customer email" in the reseller tools, this email is the secondary contact used if something happens to the customer's service such as service outage or a security issue. This property is required when creating a new "domain" customer and should not use the same domain as `customerDomain`. The `alternateEmail` field is not necessary to create a "team" customer.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	149	"customerDomain": "A String", # The customer'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.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	150	"customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.
				151	"customerId": "A String", # 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.
yoshi-code-bot	a36e3b1	2021-07-27 00:20:26 -0700	[diff] [blame^]	152	"customerType": "A String", # Identifies the type of the customer. Acceptable values include: * `domain`: Implies a domain-verified customer (default). * `team`: Implies an email-verified customer. For more information, see [managed teams](https://support.google.com/a/users/answer/9939479).
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	153	"kind": "reseller#customer", # Identifies the resource as a customer. Value: `reseller#customer`
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	154	"phoneNumber": "A String", # Customer contact phone number. Must start with "+" 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, "123". This field is silently ignored if invalid.
				155	"postalAddress": { # JSON template for address of a customer. # A customer's address information. Each field has a limit of 255 charcters.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	156	"addressLine1": "A String", # A customer's physical address. An address can be composed of one to three lines. The `addressline2` and `addressLine3` are optional.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	157	"addressLine2": "A String", # Line 2 of the address.
				158	"addressLine3": "A String", # Line 3 of the address.
				159	"contactName": "A String", # The customer contact's name. This is required.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	160	"countryCode": "A String", # 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.
				161	"kind": "customers#address", # Identifies the resource as a customer address. Value: `customers#address`
				162	"locality": "A String", # An example of a `locality` value is the city of `San Francisco`.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	163	"organizationName": "A String", # The company or company division name. This is required.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	164	"postalCode": "A String", # A `postalCode` example is a postal zip code such as `94043`. This property is required when creating a new customer.
				165	"region": "A String", # An example of a `region` value is `CA` for the state of California.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	166	},
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	167	"primaryAdmin": { # JSON template for primary admin in case of TEAM customers # The first admin details of the customer, present in case of TEAM customer.
yoshi-code-bot	a36e3b1	2021-07-27 00:20:26 -0700	[diff] [blame^]	168	"primaryEmail": "A String", # The business email of the primary administrator of the customer. The email verification link is sent to this email address at the time of customer creation. Primary administrators have access to the customer's Admin Console, including the ability to invite and evict users and manage the administrative needs of the customer.
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	169	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	170	"resourceUiUrl": "A String", # URL to customer'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.
				171	}
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	172
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	173	customerAuthToken: string, The `customerAuthToken` query string is required when creating a resold account that transfers a direct customer's subscription or transfers another reseller customer'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.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	174	x__xgafv: string, V1 error format.
				175	Allowed values
				176	1 - v1 error format
				177	2 - v2 error format
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	178
				179	Returns:
				180	An object of the form:
				181
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	182	{ # When a Google customer's account is registered with a reseller, the customer's subscriptions for Google services are managed by this reseller. A customer is described by a primary domain name and a physical address.
yoshi-code-bot	a36e3b1	2021-07-27 00:20:26 -0700	[diff] [blame^]	183	"alternateEmail": "A String", # Like the "Customer email" in the reseller tools, this email is the secondary contact used if something happens to the customer's service such as service outage or a security issue. This property is required when creating a new "domain" customer and should not use the same domain as `customerDomain`. The `alternateEmail` field is not necessary to create a "team" customer.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	184	"customerDomain": "A String", # The customer'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.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	185	"customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.
				186	"customerId": "A String", # 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.
yoshi-code-bot	a36e3b1	2021-07-27 00:20:26 -0700	[diff] [blame^]	187	"customerType": "A String", # Identifies the type of the customer. Acceptable values include: * `domain`: Implies a domain-verified customer (default). * `team`: Implies an email-verified customer. For more information, see [managed teams](https://support.google.com/a/users/answer/9939479).
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	188	"kind": "reseller#customer", # Identifies the resource as a customer. Value: `reseller#customer`
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	189	"phoneNumber": "A String", # Customer contact phone number. Must start with "+" 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, "123". This field is silently ignored if invalid.
				190	"postalAddress": { # JSON template for address of a customer. # A customer's address information. Each field has a limit of 255 charcters.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	191	"addressLine1": "A String", # A customer's physical address. An address can be composed of one to three lines. The `addressline2` and `addressLine3` are optional.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	192	"addressLine2": "A String", # Line 2 of the address.
				193	"addressLine3": "A String", # Line 3 of the address.
				194	"contactName": "A String", # The customer contact's name. This is required.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	195	"countryCode": "A String", # 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.
				196	"kind": "customers#address", # Identifies the resource as a customer address. Value: `customers#address`
				197	"locality": "A String", # An example of a `locality` value is the city of `San Francisco`.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	198	"organizationName": "A String", # The company or company division name. This is required.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	199	"postalCode": "A String", # A `postalCode` example is a postal zip code such as `94043`. This property is required when creating a new customer.
				200	"region": "A String", # An example of a `region` value is `CA` for the state of California.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	201	},
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	202	"primaryAdmin": { # JSON template for primary admin in case of TEAM customers # The first admin details of the customer, present in case of TEAM customer.
yoshi-code-bot	a36e3b1	2021-07-27 00:20:26 -0700	[diff] [blame^]	203	"primaryEmail": "A String", # The business email of the primary administrator of the customer. The email verification link is sent to this email address at the time of customer creation. Primary administrators have access to the customer's Admin Console, including the ability to invite and evict users and manage the administrative needs of the customer.
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	204	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	205	"resourceUiUrl": "A String", # URL to customer'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.
				206	}</pre>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	207	</div>
				208
				209	<div class="method">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	210	<code class="details" id="patch">patch(customerId, body=None, x__xgafv=None)</code>
yoshi-code-bot	a36e3b1	2021-07-27 00:20:26 -0700	[diff] [blame^]	211	<pre>Updates a customer account's settings. This method supports patch semantics. You cannot update `customerType` via the Reseller API, but a `"team"` customer can verify their domain and become `customerType = "domain"`. For more information, see [Verify your domain to unlock Essentials features](https://support.google.com/a/answer/9122284).
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	212
				213	Args:
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	214	customerId: string, Either the customer's primary domain name or the customer'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'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	215	body: object, The request body.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	216	The object takes the form of:
				217
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	218	{ # When a Google customer's account is registered with a reseller, the customer's subscriptions for Google services are managed by this reseller. A customer is described by a primary domain name and a physical address.
yoshi-code-bot	a36e3b1	2021-07-27 00:20:26 -0700	[diff] [blame^]	219	"alternateEmail": "A String", # Like the "Customer email" in the reseller tools, this email is the secondary contact used if something happens to the customer's service such as service outage or a security issue. This property is required when creating a new "domain" customer and should not use the same domain as `customerDomain`. The `alternateEmail` field is not necessary to create a "team" customer.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	220	"customerDomain": "A String", # The customer'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.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	221	"customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.
				222	"customerId": "A String", # 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.
yoshi-code-bot	a36e3b1	2021-07-27 00:20:26 -0700	[diff] [blame^]	223	"customerType": "A String", # Identifies the type of the customer. Acceptable values include: * `domain`: Implies a domain-verified customer (default). * `team`: Implies an email-verified customer. For more information, see [managed teams](https://support.google.com/a/users/answer/9939479).
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	224	"kind": "reseller#customer", # Identifies the resource as a customer. Value: `reseller#customer`
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	225	"phoneNumber": "A String", # Customer contact phone number. Must start with "+" 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, "123". This field is silently ignored if invalid.
				226	"postalAddress": { # JSON template for address of a customer. # A customer's address information. Each field has a limit of 255 charcters.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	227	"addressLine1": "A String", # A customer's physical address. An address can be composed of one to three lines. The `addressline2` and `addressLine3` are optional.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	228	"addressLine2": "A String", # Line 2 of the address.
				229	"addressLine3": "A String", # Line 3 of the address.
				230	"contactName": "A String", # The customer contact's name. This is required.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	231	"countryCode": "A String", # 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.
				232	"kind": "customers#address", # Identifies the resource as a customer address. Value: `customers#address`
				233	"locality": "A String", # An example of a `locality` value is the city of `San Francisco`.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	234	"organizationName": "A String", # The company or company division name. This is required.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	235	"postalCode": "A String", # A `postalCode` example is a postal zip code such as `94043`. This property is required when creating a new customer.
				236	"region": "A String", # An example of a `region` value is `CA` for the state of California.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	237	},
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	238	"primaryAdmin": { # JSON template for primary admin in case of TEAM customers # The first admin details of the customer, present in case of TEAM customer.
yoshi-code-bot	a36e3b1	2021-07-27 00:20:26 -0700	[diff] [blame^]	239	"primaryEmail": "A String", # The business email of the primary administrator of the customer. The email verification link is sent to this email address at the time of customer creation. Primary administrators have access to the customer's Admin Console, including the ability to invite and evict users and manage the administrative needs of the customer.
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	240	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	241	"resourceUiUrl": "A String", # URL to customer'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	}
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	243
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	244	x__xgafv: string, V1 error format.
				245	Allowed values
				246	1 - v1 error format
				247	2 - v2 error format
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	248
				249	Returns:
				250	An object of the form:
				251
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	252	{ # When a Google customer's account is registered with a reseller, the customer's subscriptions for Google services are managed by this reseller. A customer is described by a primary domain name and a physical address.
yoshi-code-bot	a36e3b1	2021-07-27 00:20:26 -0700	[diff] [blame^]	253	"alternateEmail": "A String", # Like the "Customer email" in the reseller tools, this email is the secondary contact used if something happens to the customer's service such as service outage or a security issue. This property is required when creating a new "domain" customer and should not use the same domain as `customerDomain`. The `alternateEmail` field is not necessary to create a "team" customer.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	254	"customerDomain": "A String", # The customer'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.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	255	"customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.
				256	"customerId": "A String", # 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.
yoshi-code-bot	a36e3b1	2021-07-27 00:20:26 -0700	[diff] [blame^]	257	"customerType": "A String", # Identifies the type of the customer. Acceptable values include: * `domain`: Implies a domain-verified customer (default). * `team`: Implies an email-verified customer. For more information, see [managed teams](https://support.google.com/a/users/answer/9939479).
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	258	"kind": "reseller#customer", # Identifies the resource as a customer. Value: `reseller#customer`
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	259	"phoneNumber": "A String", # Customer contact phone number. Must start with "+" 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, "123". This field is silently ignored if invalid.
				260	"postalAddress": { # JSON template for address of a customer. # A customer's address information. Each field has a limit of 255 charcters.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	261	"addressLine1": "A String", # A customer's physical address. An address can be composed of one to three lines. The `addressline2` and `addressLine3` are optional.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	262	"addressLine2": "A String", # Line 2 of the address.
				263	"addressLine3": "A String", # Line 3 of the address.
				264	"contactName": "A String", # The customer contact's name. This is required.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	265	"countryCode": "A String", # 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.
				266	"kind": "customers#address", # Identifies the resource as a customer address. Value: `customers#address`
				267	"locality": "A String", # An example of a `locality` value is the city of `San Francisco`.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	268	"organizationName": "A String", # The company or company division name. This is required.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	269	"postalCode": "A String", # A `postalCode` example is a postal zip code such as `94043`. This property is required when creating a new customer.
				270	"region": "A String", # An example of a `region` value is `CA` for the state of California.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	271	},
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	272	"primaryAdmin": { # JSON template for primary admin in case of TEAM customers # The first admin details of the customer, present in case of TEAM customer.
yoshi-code-bot	a36e3b1	2021-07-27 00:20:26 -0700	[diff] [blame^]	273	"primaryEmail": "A String", # The business email of the primary administrator of the customer. The email verification link is sent to this email address at the time of customer creation. Primary administrators have access to the customer's Admin Console, including the ability to invite and evict users and manage the administrative needs of the customer.
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	274	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	275	"resourceUiUrl": "A String", # URL to customer'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.
				276	}</pre>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	277	</div>
				278
				279	<div class="method">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	280	<code class="details" id="update">update(customerId, body=None, x__xgafv=None)</code>
yoshi-code-bot	a36e3b1	2021-07-27 00:20:26 -0700	[diff] [blame^]	281	<pre>Updates a customer account's settings. You cannot update `customerType` via the Reseller API, but a `"team"` customer can verify their domain and become `customerType = "domain"`. For more information, see [update a customer's settings](/admin-sdk/reseller/v1/how-tos/manage_customers#update_customer).
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	282
				283	Args:
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	284	customerId: string, Either the customer's primary domain name or the customer'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'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	285	body: object, The request body.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	286	The object takes the form of:
				287
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	288	{ # When a Google customer's account is registered with a reseller, the customer's subscriptions for Google services are managed by this reseller. A customer is described by a primary domain name and a physical address.
yoshi-code-bot	a36e3b1	2021-07-27 00:20:26 -0700	[diff] [blame^]	289	"alternateEmail": "A String", # Like the "Customer email" in the reseller tools, this email is the secondary contact used if something happens to the customer's service such as service outage or a security issue. This property is required when creating a new "domain" customer and should not use the same domain as `customerDomain`. The `alternateEmail` field is not necessary to create a "team" customer.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	290	"customerDomain": "A String", # The customer'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.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	291	"customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.
				292	"customerId": "A String", # 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.
yoshi-code-bot	a36e3b1	2021-07-27 00:20:26 -0700	[diff] [blame^]	293	"customerType": "A String", # Identifies the type of the customer. Acceptable values include: * `domain`: Implies a domain-verified customer (default). * `team`: Implies an email-verified customer. For more information, see [managed teams](https://support.google.com/a/users/answer/9939479).
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	294	"kind": "reseller#customer", # Identifies the resource as a customer. Value: `reseller#customer`
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	295	"phoneNumber": "A String", # Customer contact phone number. Must start with "+" 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, "123". This field is silently ignored if invalid.
				296	"postalAddress": { # JSON template for address of a customer. # A customer's address information. Each field has a limit of 255 charcters.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	297	"addressLine1": "A String", # A customer's physical address. An address can be composed of one to three lines. The `addressline2` and `addressLine3` are optional.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	298	"addressLine2": "A String", # Line 2 of the address.
				299	"addressLine3": "A String", # Line 3 of the address.
				300	"contactName": "A String", # The customer contact's name. This is required.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	301	"countryCode": "A String", # 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.
				302	"kind": "customers#address", # Identifies the resource as a customer address. Value: `customers#address`
				303	"locality": "A String", # An example of a `locality` value is the city of `San Francisco`.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	304	"organizationName": "A String", # The company or company division name. This is required.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	305	"postalCode": "A String", # A `postalCode` example is a postal zip code such as `94043`. This property is required when creating a new customer.
				306	"region": "A String", # An example of a `region` value is `CA` for the state of California.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	307	},
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	308	"primaryAdmin": { # JSON template for primary admin in case of TEAM customers # The first admin details of the customer, present in case of TEAM customer.
yoshi-code-bot	a36e3b1	2021-07-27 00:20:26 -0700	[diff] [blame^]	309	"primaryEmail": "A String", # The business email of the primary administrator of the customer. The email verification link is sent to this email address at the time of customer creation. Primary administrators have access to the customer's Admin Console, including the ability to invite and evict users and manage the administrative needs of the customer.
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	310	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	311	"resourceUiUrl": "A String", # URL to customer'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.
				312	}
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	313
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	314	x__xgafv: string, V1 error format.
				315	Allowed values
				316	1 - v1 error format
				317	2 - v2 error format
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	318
				319	Returns:
				320	An object of the form:
				321
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	322	{ # When a Google customer's account is registered with a reseller, the customer's subscriptions for Google services are managed by this reseller. A customer is described by a primary domain name and a physical address.
yoshi-code-bot	a36e3b1	2021-07-27 00:20:26 -0700	[diff] [blame^]	323	"alternateEmail": "A String", # Like the "Customer email" in the reseller tools, this email is the secondary contact used if something happens to the customer's service such as service outage or a security issue. This property is required when creating a new "domain" customer and should not use the same domain as `customerDomain`. The `alternateEmail` field is not necessary to create a "team" customer.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	324	"customerDomain": "A String", # The customer'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.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	325	"customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.
				326	"customerId": "A String", # 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.
yoshi-code-bot	a36e3b1	2021-07-27 00:20:26 -0700	[diff] [blame^]	327	"customerType": "A String", # Identifies the type of the customer. Acceptable values include: * `domain`: Implies a domain-verified customer (default). * `team`: Implies an email-verified customer. For more information, see [managed teams](https://support.google.com/a/users/answer/9939479).
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	328	"kind": "reseller#customer", # Identifies the resource as a customer. Value: `reseller#customer`
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	329	"phoneNumber": "A String", # Customer contact phone number. Must start with "+" 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, "123". This field is silently ignored if invalid.
				330	"postalAddress": { # JSON template for address of a customer. # A customer's address information. Each field has a limit of 255 charcters.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	331	"addressLine1": "A String", # A customer's physical address. An address can be composed of one to three lines. The `addressline2` and `addressLine3` are optional.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	332	"addressLine2": "A String", # Line 2 of the address.
				333	"addressLine3": "A String", # Line 3 of the address.
				334	"contactName": "A String", # The customer contact's name. This is required.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	335	"countryCode": "A String", # 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.
				336	"kind": "customers#address", # Identifies the resource as a customer address. Value: `customers#address`
				337	"locality": "A String", # An example of a `locality` value is the city of `San Francisco`.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	338	"organizationName": "A String", # The company or company division name. This is required.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	339	"postalCode": "A String", # A `postalCode` example is a postal zip code such as `94043`. This property is required when creating a new customer.
				340	"region": "A String", # An example of a `region` value is `CA` for the state of California.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	341	},
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	342	"primaryAdmin": { # JSON template for primary admin in case of TEAM customers # The first admin details of the customer, present in case of TEAM customer.
yoshi-code-bot	a36e3b1	2021-07-27 00:20:26 -0700	[diff] [blame^]	343	"primaryEmail": "A String", # The business email of the primary administrator of the customer. The email verification link is sent to this email address at the time of customer creation. Primary administrators have access to the customer's Admin Console, including the ability to invite and evict users and manage the administrative needs of the customer.
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	344	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	345	"resourceUiUrl": "A String", # URL to customer'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.
				346	}</pre>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	347	</div>
				348
				349	</body></html>