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 75 <h1><a href="reseller_v1.html">Enterprise Apps Reseller API</a> . <a href="reseller_v1.customers.html">customers</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#get">get(customerId)</a></code></p> 79 <p class="firstline">Get a customer account.</p> 80 <p class="toc_element"> 81 <code><a href="#insert">insert(body, customerAuthToken=None)</a></code></p> 82 <p class="firstline">Order a new customer's account.</p> 83 <p class="toc_element"> 84 <code><a href="#patch">patch(customerId, body)</a></code></p> 85 <p class="firstline">Update a customer account's settings. This method supports patch semantics.</p> 86 <p class="toc_element"> 87 <code><a href="#update">update(customerId, body)</a></code></p> 88 <p class="firstline">Update a customer account's settings.</p> 89 <h3>Method Details</h3> 90 <div class="method"> 91 <code class="details" id="get">get(customerId)</code> 92 <pre>Get a customer account. 93 94 Args: 95 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) 96 97 Returns: 98 An object of the form: 99 100 { # JSON template for a customer. 101 "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. 102 "customerDomainVerified": True or False, # Whether the customer's primary domain has been verified. 103 "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. 104 "kind": "reseller#customer", # Identifies the resource as a customer. Value: reseller#customer 105 "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. 106 "phoneNumber": "A String", # Customer contact phone number. This can be continuous numbers, with spaces, etc. But it must be a real phone number and not, for example, "123". See phone local format conventions. 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 "organizationName": "A String", # The company or company division name. This is required. 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 "locality": "A String", # An example of a locality value is the city of San Francisco. 112 "region": "A String", # An example of a region value is CA for the state of California. 113 "addressLine2": "A String", # Line 2 of the address. 114 "addressLine3": "A String", # Line 3 of the address. 115 "contactName": "A String", # The customer contact's name. This is required. 116 "addressLine1": "A String", # A customer's physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional. 117 "postalCode": "A String", # A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer. 118 }, 119 "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. 120 }</pre> 121 </div> 122 123 <div class="method"> 124 <code class="details" id="insert">insert(body, customerAuthToken=None)</code> 125 <pre>Order a new customer's account. 126 127 Args: 128 body: object, The request body. (required) 129 The object takes the form of: 130 131 { # JSON template for a customer. 132 "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. 133 "customerDomainVerified": True or False, # Whether the customer's primary domain has been verified. 134 "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. 135 "kind": "reseller#customer", # Identifies the resource as a customer. Value: reseller#customer 136 "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. 137 "phoneNumber": "A String", # Customer contact phone number. This can be continuous numbers, with spaces, etc. But it must be a real phone number and not, for example, "123". See phone local format conventions. 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 "organizationName": "A String", # The company or company division name. This is required. 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 "locality": "A String", # An example of a locality value is the city of San Francisco. 143 "region": "A String", # An example of a region value is CA for the state of California. 144 "addressLine2": "A String", # Line 2 of the address. 145 "addressLine3": "A String", # Line 3 of the address. 146 "contactName": "A String", # The customer contact's name. This is required. 147 "addressLine1": "A String", # A customer's physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional. 148 "postalCode": "A String", # A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer. 149 }, 150 "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. 151 } 152 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. 154 155 Returns: 156 An object of the form: 157 158 { # JSON template for a customer. 159 "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. 160 "customerDomainVerified": True or False, # Whether the customer's primary domain has been verified. 161 "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. 162 "kind": "reseller#customer", # Identifies the resource as a customer. Value: reseller#customer 163 "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. 164 "phoneNumber": "A String", # Customer contact phone number. This can be continuous numbers, with spaces, etc. But it must be a real phone number and not, for example, "123". See phone local format conventions. 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 "organizationName": "A String", # The company or company division name. This is required. 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 "locality": "A String", # An example of a locality value is the city of San Francisco. 170 "region": "A String", # An example of a region value is CA for the state of California. 171 "addressLine2": "A String", # Line 2 of the address. 172 "addressLine3": "A String", # Line 3 of the address. 173 "contactName": "A String", # The customer contact's name. This is required. 174 "addressLine1": "A String", # A customer's physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional. 175 "postalCode": "A String", # A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer. 176 }, 177 "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. 178 }</pre> 179 </div> 180 181 <div class="method"> 182 <code class="details" id="patch">patch(customerId, body)</code> 183 <pre>Update a customer account's settings. This method supports patch semantics. 184 185 Args: 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) 187 body: object, The request body. (required) 188 The object takes the form of: 189 190 { # JSON template for a customer. 191 "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. 192 "customerDomainVerified": True or False, # Whether the customer's primary domain has been verified. 193 "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. 194 "kind": "reseller#customer", # Identifies the resource as a customer. Value: reseller#customer 195 "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. 196 "phoneNumber": "A String", # Customer contact phone number. This can be continuous numbers, with spaces, etc. But it must be a real phone number and not, for example, "123". See phone local format conventions. 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 "organizationName": "A String", # The company or company division name. This is required. 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 "locality": "A String", # An example of a locality value is the city of San Francisco. 202 "region": "A String", # An example of a region value is CA for the state of California. 203 "addressLine2": "A String", # Line 2 of the address. 204 "addressLine3": "A String", # Line 3 of the address. 205 "contactName": "A String", # The customer contact's name. This is required. 206 "addressLine1": "A String", # A customer's physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional. 207 "postalCode": "A String", # A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer. 208 }, 209 "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. 210 } 211 212 213 Returns: 214 An object of the form: 215 216 { # JSON template for a customer. 217 "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. 218 "customerDomainVerified": True or False, # Whether the customer's primary domain has been verified. 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 customer and should not use the same domain as customerDomain. 220 "kind": "reseller#customer", # Identifies the resource as a customer. Value: reseller#customer 221 "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. 222 "phoneNumber": "A String", # Customer contact phone number. This can be continuous numbers, with spaces, etc. But it must be a real phone number and not, for example, "123". See phone local format conventions. 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 "organizationName": "A String", # The company or company division name. This is required. 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 "locality": "A String", # An example of a locality value is the city of San Francisco. 228 "region": "A String", # An example of a region value is CA for the state of California. 229 "addressLine2": "A String", # Line 2 of the address. 230 "addressLine3": "A String", # Line 3 of the address. 231 "contactName": "A String", # The customer contact's name. This is required. 232 "addressLine1": "A String", # A customer's physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional. 233 "postalCode": "A String", # A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer. 234 }, 235 "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. 236 }</pre> 237 </div> 238 239 <div class="method"> 240 <code class="details" id="update">update(customerId, body)</code> 241 <pre>Update a customer account's settings. 242 243 Args: 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) 245 body: object, The request body. (required) 246 The object takes the form of: 247 248 { # JSON template for a customer. 249 "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. 250 "customerDomainVerified": True or False, # Whether the customer's primary domain has been verified. 251 "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. 252 "kind": "reseller#customer", # Identifies the resource as a customer. Value: reseller#customer 253 "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. 254 "phoneNumber": "A String", # Customer contact phone number. This can be continuous numbers, with spaces, etc. But it must be a real phone number and not, for example, "123". See phone local format conventions. 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 "organizationName": "A String", # The company or company division name. This is required. 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 "locality": "A String", # An example of a locality value is the city of San Francisco. 260 "region": "A String", # An example of a region value is CA for the state of California. 261 "addressLine2": "A String", # Line 2 of the address. 262 "addressLine3": "A String", # Line 3 of the address. 263 "contactName": "A String", # The customer contact's name. This is required. 264 "addressLine1": "A String", # A customer's physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional. 265 "postalCode": "A String", # A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer. 266 }, 267 "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. 268 } 269 270 271 Returns: 272 An object of the form: 273 274 { # JSON template for a customer. 275 "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. 276 "customerDomainVerified": True or False, # Whether the customer's primary domain has been verified. 277 "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. 278 "kind": "reseller#customer", # Identifies the resource as a customer. Value: reseller#customer 279 "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. 280 "phoneNumber": "A String", # Customer contact phone number. This can be continuous numbers, with spaces, etc. But it must be a real phone number and not, for example, "123". See phone local format conventions. 281 "postalAddress": { # JSON template for address of a customer. # A customer's address information. Each field has a limit of 255 charcters. 282 "kind": "customers#address", # Identifies the resource as a customer address. Value: customers#address 283 "organizationName": "A String", # The company or company division name. This is required. 284 "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. 285 "locality": "A String", # An example of a locality value is the city of San Francisco. 286 "region": "A String", # An example of a region value is CA for the state of California. 287 "addressLine2": "A String", # Line 2 of the address. 288 "addressLine3": "A String", # Line 3 of the address. 289 "contactName": "A String", # The customer contact's name. This is required. 290 "addressLine1": "A String", # A customer's physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional. 291 "postalCode": "A String", # A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer. 292 }, 293 "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. 294 }</pre> 295 </div> 296 297 </body></html>
