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

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

[diff] [blame]

96

97

Returns:

98

An object of the form:

99

100

{ # JSON template for a customer.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

101

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

102

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

103

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

104

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

105

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

106

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

107

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

108

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

109

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

110

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

111

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

112

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

113

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

114

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

115

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

116

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

117

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

118

},

119

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

120

}</pre>

John Asmuth

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

124

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

Bu Sun Kim

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

[diff] [blame]

125

<pre>Order a new customer's account.

John Asmuth

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

[diff] [blame]

126

127

Args:

Dan O'Meara

dd49464

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

[diff] [blame]

128

body: object, The request body.

John Asmuth

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

[diff] [blame]

129

The object takes the form of:

130

131

{ # JSON template for a customer.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

132

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

133

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

134

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

135

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

136

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

137

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

138

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

139

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

140

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

141

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

142

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

143

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

144

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

145

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

146

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

147

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

148

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

149

},

150

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

151

}

John Asmuth

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

[diff] [blame]

152

Bu Sun Kim

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

[diff] [blame]

153

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.

John Asmuth

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

[diff] [blame]

154

155

Returns:

156

An object of the form:

157

158

{ # JSON template for a customer.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

159

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

160

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

161

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

162

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

163

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

164

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

165

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

166

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

167

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

168

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

169

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

170

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

171

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

172

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

173

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

174

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

175

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

176

},

177

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

178

}</pre>

John Asmuth

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

182

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

Bu Sun Kim

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

[diff] [blame]

183

<pre>Update a customer account's settings. This method supports patch semantics.

John Asmuth

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

[diff] [blame]

184

185

Args:

Bu Sun Kim

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

[diff] [blame]

186

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]

187

body: object, The request body.

John Asmuth

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

[diff] [blame]

188

The object takes the form of:

189

190

{ # JSON template for a customer.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

191

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

192

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

193

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

194

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

195

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

196

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

197

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

198

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

199

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

200

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

201

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

202

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

203

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

204

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

205

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

206

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

207

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

208

},

209

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

210

}

John Asmuth

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

[diff] [blame]

Returns:

An object of the form:

215

216

{ # JSON template for a customer.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

217

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

218

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

219

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

220

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

221

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

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.

223

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

224

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

225

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

226

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

227

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

228

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

229

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

230

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

231

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

232

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

233

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

234

},

235

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

236

}</pre>

John Asmuth

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

240

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

Bu Sun Kim

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

[diff] [blame]

241

<pre>Update a customer account's settings.

John Asmuth

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

[diff] [blame]

242

243

Args:

Bu Sun Kim

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

[diff] [blame]

244

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]

245

body: object, The request body.

John Asmuth

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

[diff] [blame]

246

The object takes the form of:

247

248

{ # JSON template for a customer.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

249

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

250

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

251

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

252

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

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

254

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

255

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

256

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

257

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

258

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

259

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

260

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

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.

262

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

263

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

264

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

265

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

266

},

267

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

268

}

John Asmuth

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

[diff] [blame]

Returns:

An object of the form:

273

274

{ # JSON template for a customer.

Bu Sun Kim