close()

Close httplib2 connections.

get(customerId, x__xgafv=None)

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

Args:
customerId: string, This can be either the customer's primary domain name or the customer's unique identifier. If the domain name for a customer changes, the old domain name cannot be used to access the customer, but the customer's unique identifier (as returned by the API) can always be used. We recommend storing the unique identifier in your systems where applicable. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # 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.
"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.
"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.
"customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.
"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.
"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).
"kind": "reseller#customer", # Identifies the resource as a customer. Value: `reseller#customer`
"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.
"postalAddress": { # JSON template for address of a customer. # A customer's address information. Each field has a limit of 255 charcters.
"addressLine1": "A String", # A customer's physical address. An address can be composed of one to three lines. The `addressline2` and `addressLine3` are optional.
"addressLine2": "A String", # Line 2 of the address.
"addressLine3": "A String", # Line 3 of the address.
"contactName": "A String", # The customer contact's name. This is required.
"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.
"kind": "customers#address", # Identifies the resource as a customer address. Value: `customers#address`
"locality": "A String", # An example of a `locality` value is the city of `San Francisco`.
"organizationName": "A String", # The company or company division name. This is required.
"postalCode": "A String", # A `postalCode` example is a postal zip code such as `94043`. This property is required when creating a new customer.
"region": "A String", # An example of a `region` value is `CA` for the state of California.
},
"primaryAdmin": { # JSON template for primary admin in case of TEAM customers # The first admin details of the customer, present in case of TEAM customer.
"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.
},
"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.
}

insert(body=None, customerAuthToken=None, x__xgafv=None)

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

Args:
body: object, The request body.
The object takes the form of:

{ # 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.
"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.
"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.
"customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.
"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.
"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).
"kind": "reseller#customer", # Identifies the resource as a customer. Value: `reseller#customer`
"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.
"postalAddress": { # JSON template for address of a customer. # A customer's address information. Each field has a limit of 255 charcters.
"addressLine1": "A String", # A customer's physical address. An address can be composed of one to three lines. The `addressline2` and `addressLine3` are optional.
"addressLine2": "A String", # Line 2 of the address.
"addressLine3": "A String", # Line 3 of the address.
"contactName": "A String", # The customer contact's name. This is required.
"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.
"kind": "customers#address", # Identifies the resource as a customer address. Value: `customers#address`
"locality": "A String", # An example of a `locality` value is the city of `San Francisco`.
"organizationName": "A String", # The company or company division name. This is required.
"postalCode": "A String", # A `postalCode` example is a postal zip code such as `94043`. This property is required when creating a new customer.
"region": "A String", # An example of a `region` value is `CA` for the state of California.
},
"primaryAdmin": { # JSON template for primary admin in case of TEAM customers # The first admin details of the customer, present in case of TEAM customer.
"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.
},
"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.
}

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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # 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.
"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.
"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.
"customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.
"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.
"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).
"kind": "reseller#customer", # Identifies the resource as a customer. Value: `reseller#customer`
"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.
"postalAddress": { # JSON template for address of a customer. # A customer's address information. Each field has a limit of 255 charcters.
"addressLine1": "A String", # A customer's physical address. An address can be composed of one to three lines. The `addressline2` and `addressLine3` are optional.
"addressLine2": "A String", # Line 2 of the address.
"addressLine3": "A String", # Line 3 of the address.
"contactName": "A String", # The customer contact's name. This is required.
"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.
"kind": "customers#address", # Identifies the resource as a customer address. Value: `customers#address`
"locality": "A String", # An example of a `locality` value is the city of `San Francisco`.
"organizationName": "A String", # The company or company division name. This is required.
"postalCode": "A String", # A `postalCode` example is a postal zip code such as `94043`. This property is required when creating a new customer.
"region": "A String", # An example of a `region` value is `CA` for the state of California.
},
"primaryAdmin": { # JSON template for primary admin in case of TEAM customers # The first admin details of the customer, present in case of TEAM customer.
"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.
},
"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.
}

patch(customerId, body=None, x__xgafv=None)

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

Args:
customerId: string, This can be either the customer's primary domain name or the customer's unique identifier. If the domain name for a customer changes, the old domain name cannot be used to access the customer, but the customer's unique identifier (as returned by the API) can always be used. We recommend storing the unique identifier in your systems where applicable. (required)
body: object, The request body.
The object takes the form of:

{ # 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.
"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.
"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.
"customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.
"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.
"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).
"kind": "reseller#customer", # Identifies the resource as a customer. Value: `reseller#customer`
"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.
"postalAddress": { # JSON template for address of a customer. # A customer's address information. Each field has a limit of 255 charcters.
"addressLine1": "A String", # A customer's physical address. An address can be composed of one to three lines. The `addressline2` and `addressLine3` are optional.
"addressLine2": "A String", # Line 2 of the address.
"addressLine3": "A String", # Line 3 of the address.
"contactName": "A String", # The customer contact's name. This is required.
"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.
"kind": "customers#address", # Identifies the resource as a customer address. Value: `customers#address`
"locality": "A String", # An example of a `locality` value is the city of `San Francisco`.
"organizationName": "A String", # The company or company division name. This is required.
"postalCode": "A String", # A `postalCode` example is a postal zip code such as `94043`. This property is required when creating a new customer.
"region": "A String", # An example of a `region` value is `CA` for the state of California.
},
"primaryAdmin": { # JSON template for primary admin in case of TEAM customers # The first admin details of the customer, present in case of TEAM customer.
"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.
},
"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.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # 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.
"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.
"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.
"customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.
"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.
"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).
"kind": "reseller#customer", # Identifies the resource as a customer. Value: `reseller#customer`
"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.
"postalAddress": { # JSON template for address of a customer. # A customer's address information. Each field has a limit of 255 charcters.
"addressLine1": "A String", # A customer's physical address. An address can be composed of one to three lines. The `addressline2` and `addressLine3` are optional.
"addressLine2": "A String", # Line 2 of the address.
"addressLine3": "A String", # Line 3 of the address.
"contactName": "A String", # The customer contact's name. This is required.
"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.
"kind": "customers#address", # Identifies the resource as a customer address. Value: `customers#address`
"locality": "A String", # An example of a `locality` value is the city of `San Francisco`.
"organizationName": "A String", # The company or company division name. This is required.
"postalCode": "A String", # A `postalCode` example is a postal zip code such as `94043`. This property is required when creating a new customer.
"region": "A String", # An example of a `region` value is `CA` for the state of California.
},
"primaryAdmin": { # JSON template for primary admin in case of TEAM customers # The first admin details of the customer, present in case of TEAM customer.
"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.
},
"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.
}

update(customerId, body=None, x__xgafv=None)

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

Args:
customerId: string, This can be either the customer's primary domain name or the customer's unique identifier. If the domain name for a customer changes, the old domain name cannot be used to access the customer, but the customer's unique identifier (as returned by the API) can always be used. We recommend storing the unique identifier in your systems where applicable. (required)
body: object, The request body.
The object takes the form of:

{ # 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.
"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.
"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.
"customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.
"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.
"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).
"kind": "reseller#customer", # Identifies the resource as a customer. Value: `reseller#customer`
"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.
"postalAddress": { # JSON template for address of a customer. # A customer's address information. Each field has a limit of 255 charcters.
"addressLine1": "A String", # A customer's physical address. An address can be composed of one to three lines. The `addressline2` and `addressLine3` are optional.
"addressLine2": "A String", # Line 2 of the address.
"addressLine3": "A String", # Line 3 of the address.
"contactName": "A String", # The customer contact's name. This is required.
"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.
"kind": "customers#address", # Identifies the resource as a customer address. Value: `customers#address`
"locality": "A String", # An example of a `locality` value is the city of `San Francisco`.
"organizationName": "A String", # The company or company division name. This is required.
"postalCode": "A String", # A `postalCode` example is a postal zip code such as `94043`. This property is required when creating a new customer.
"region": "A String", # An example of a `region` value is `CA` for the state of California.
},
"primaryAdmin": { # JSON template for primary admin in case of TEAM customers # The first admin details of the customer, present in case of TEAM customer.
"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.
},
"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.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # 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.
"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.
"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.
"customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.
"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.
"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).
"kind": "reseller#customer", # Identifies the resource as a customer. Value: `reseller#customer`
"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.
"postalAddress": { # JSON template for address of a customer. # A customer's address information. Each field has a limit of 255 charcters.
"addressLine1": "A String", # A customer's physical address. An address can be composed of one to three lines. The `addressline2` and `addressLine3` are optional.
"addressLine2": "A String", # Line 2 of the address.
"addressLine3": "A String", # Line 3 of the address.
"contactName": "A String", # The customer contact's name. This is required.
"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.
"kind": "customers#address", # Identifies the resource as a customer address. Value: `customers#address`
"locality": "A String", # An example of a `locality` value is the city of `San Francisco`.
"organizationName": "A String", # The company or company division name. This is required.
"postalCode": "A String", # A `postalCode` example is a postal zip code such as `94043`. This property is required when creating a new customer.
"region": "A String", # An example of a `region` value is `CA` for the state of California.
},
"primaryAdmin": { # JSON template for primary admin in case of TEAM customers # The first admin details of the customer, present in case of TEAM customer.
"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.
},
"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.
}

Google Workspace Reseller API . customers

Instance Methods

Method Details