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

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

2014-04-24 15:46:26 -0400

[diff] [blame]

108

109

Returns:

110

An object of the form:

111

112

{ # JSON template for a customer.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[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 customer and should not use the same domain as customerDomain .

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.

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.

117

"kind": "reseller#customer", # Identifies the resource as a customer. Value: reseller#customer

118

"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.

119

"postalAddress": { # JSON template for address of a customer. # A customer's address information. Each field has a limit of 255 charcters.

120

"addressLine1": "A String", # A customer's physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional.

121

"addressLine2": "A String", # Line 2 of the address.

122

"addressLine3": "A String", # Line 3 of the address.

123

"contactName": "A String", # The customer contact's name. This is required.

124

"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.

125

"kind": "customers#address", # Identifies the resource as a customer address. Value: customers#address

126

"locality": "A String", # An example of a locality value is the city of San Francisco.

127

"organizationName": "A String", # The company or company division name. This is required.

128

"postalCode": "A String", # A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer.

129

"region": "A String", # An example of a region value is CA for the state of California.

130

},

131

"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.

132

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

136

<code class="details" id="insert">insert(body=None, customerAuthToken=None, x__xgafv=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

137

<pre>Order a new customer's account.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

138

139

Args:

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

140

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

141

The object takes the form of:

142

143

{ # JSON template for a customer.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

144

"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 customer and should not use the same domain as customerDomain .

145

"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.

146

"customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.

147

"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.

148

"kind": "reseller#customer", # Identifies the resource as a customer. Value: reseller#customer

149

"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.

150

"postalAddress": { # JSON template for address of a customer. # A customer's address information. Each field has a limit of 255 charcters.

151

"addressLine1": "A String", # A customer's physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional.

152

"addressLine2": "A String", # Line 2 of the address.

153

"addressLine3": "A String", # Line 3 of the address.

154

"contactName": "A String", # The customer contact's name. This is required.

155

"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.

156

"kind": "customers#address", # Identifies the resource as a customer address. Value: customers#address

157

"locality": "A String", # An example of a locality value is the city of San Francisco.

158

"organizationName": "A String", # The company or company division name. This is required.

159

"postalCode": "A String", # A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer.

160

"region": "A String", # An example of a region value is CA for the state of California.

161

},

162

"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.

163

}

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

164

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

165

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

2021-01-15 07:10:04 -0800

[diff] [blame^]

166

x__xgafv: string, V1 error format.

167

Allowed values

168

1 - v1 error format

169

2 - v2 error format

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

170

171

Returns:

172

An object of the form:

173

174

{ # JSON template for a customer.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

175

"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 customer and should not use the same domain as customerDomain .

176

"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.

177

"customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.

178

"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.

179

"kind": "reseller#customer", # Identifies the resource as a customer. Value: reseller#customer

180

"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.

181

"postalAddress": { # JSON template for address of a customer. # A customer's address information. Each field has a limit of 255 charcters.

182

"addressLine1": "A String", # A customer's physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional.

183

"addressLine2": "A String", # Line 2 of the address.

184

"addressLine3": "A String", # Line 3 of the address.

185

"contactName": "A String", # The customer contact's name. This is required.

186

"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.

187

"kind": "customers#address", # Identifies the resource as a customer address. Value: customers#address

188

"locality": "A String", # An example of a locality value is the city of San Francisco.

189

"organizationName": "A String", # The company or company division name. This is required.

190

"postalCode": "A String", # A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer.

191

"region": "A String", # An example of a region value is CA for the state of California.

192

},

193

"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.

194

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

198

<code class="details" id="patch">patch(customerId, body=None, x__xgafv=None)</code>

199

<pre>Patch a customer account's settings via Apiary Patch Orchestration

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

200

201

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

202

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]

203

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

204

The object takes the form of:

205

206

{ # JSON template for a customer.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

207

"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 customer and should not use the same domain as customerDomain .

208

"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.

209

"customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.

210

"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.

211

"kind": "reseller#customer", # Identifies the resource as a customer. Value: reseller#customer

212

"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.

213

"postalAddress": { # JSON template for address of a customer. # A customer's address information. Each field has a limit of 255 charcters.

214

"addressLine1": "A String", # A customer's physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional.

215

"addressLine2": "A String", # Line 2 of the address.

216

"addressLine3": "A String", # Line 3 of the address.

217

"contactName": "A String", # The customer contact's name. This is required.

218

"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.

219

"kind": "customers#address", # Identifies the resource as a customer address. Value: customers#address

220

"locality": "A String", # An example of a locality value is the city of San Francisco.

221

"organizationName": "A String", # The company or company division name. This is required.

222

"postalCode": "A String", # A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer.

223

"region": "A String", # An example of a region value is CA for the state of California.

224

},

225

"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.

226

}

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

227

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

228

x__xgafv: string, V1 error format.

229

Allowed values

230

1 - v1 error format

231

2 - v2 error format

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

232

233

Returns:

234

An object of the form:

235

236

{ # JSON template for a customer.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

237

"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 customer and should not use the same domain as customerDomain .

238

"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.

239

"customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.

240

"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.

241

"kind": "reseller#customer", # Identifies the resource as a customer. Value: reseller#customer

242

"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.

243

"postalAddress": { # JSON template for address of a customer. # A customer's address information. Each field has a limit of 255 charcters.

244

"addressLine1": "A String", # A customer's physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional.

245

"addressLine2": "A String", # Line 2 of the address.

246

"addressLine3": "A String", # Line 3 of the address.

247

"contactName": "A String", # The customer contact's name. This is required.

248

"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.

249

"kind": "customers#address", # Identifies the resource as a customer address. Value: customers#address

250

"locality": "A String", # An example of a locality value is the city of San Francisco.

251

"organizationName": "A String", # The company or company division name. This is required.

252

"postalCode": "A String", # A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer.

253

"region": "A String", # An example of a region value is CA for the state of California.

254

},

255

"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.

256

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

260

<code class="details" id="update">update(customerId, body=None, x__xgafv=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

261

<pre>Update a customer account's settings.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

262

263

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

264

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]

265

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

266

The object takes the form of:

267

268

{ # JSON template for a customer.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

269

"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 customer and should not use the same domain as customerDomain .

270

"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.

271

"customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.

272

"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.

273

"kind": "reseller#customer", # Identifies the resource as a customer. Value: reseller#customer

274

"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.

275

"postalAddress": { # JSON template for address of a customer. # A customer's address information. Each field has a limit of 255 charcters.

276

"addressLine1": "A String", # A customer's physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional.

277

"addressLine2": "A String", # Line 2 of the address.

278

"addressLine3": "A String", # Line 3 of the address.

279

"contactName": "A String", # The customer contact's name. This is required.

280

"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.

281

"kind": "customers#address", # Identifies the resource as a customer address. Value: customers#address

282

"locality": "A String", # An example of a locality value is the city of San Francisco.

283

"organizationName": "A String", # The company or company division name. This is required.

284

"postalCode": "A String", # A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer.

285

"region": "A String", # An example of a region value is CA for the state of California.

286

},

287

"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.

288

}

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

289

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

290

x__xgafv: string, V1 error format.

291

Allowed values

292

1 - v1 error format

293

2 - v2 error format

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

294

295

Returns:

296

An object of the form:

297

298

{ # JSON template for a customer.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

299

"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 customer and should not use the same domain as customerDomain .

300

"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.

301

"customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.

302

"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.

303

"kind": "reseller#customer", # Identifies the resource as a customer. Value: reseller#customer

304

"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.

305

"postalAddress": { # JSON template for address of a customer. # A customer's address information. Each field has a limit of 255 charcters.

306

"addressLine1": "A String", # A customer's physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional.

307

"addressLine2": "A String", # Line 2 of the address.

308

"addressLine3": "A String", # Line 3 of the address.

309

"contactName": "A String", # The customer contact's name. This is required.

310

"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.

311

"kind": "customers#address", # Identifies the resource as a customer address. Value: customers#address

312

"locality": "A String", # An example of a locality value is the city of San Francisco.

313

"organizationName": "A String", # The company or company division name. This is required.

314

"postalCode": "A String", # A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer.

315

"region": "A String", # An example of a region value is CA for the state of California.

316

},

317

"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.

318

}</pre>

John Asmuth