Enterprise Apps Reseller API . customers

Instance Methods

close()

Close httplib2 connections.

get(customerId, x__xgafv=None)

Get a customer account.

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

Order a new customer's account.

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

Patch a customer account's settings via Apiary Patch Orchestration

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

Update a customer account's settings.

Method Details

close()
Close httplib2 connections.
get(customerId, x__xgafv=None)
Get a customer account.

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

Returns:
  An object of the form:

    { # JSON template for a customer.
  "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 .
  "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.
  "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.
  },
  "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)
Order a new customer's account.

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

{ # JSON template for a customer.
  "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 .
  "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.
  "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.
  },
  "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:

    { # JSON template for a customer.
  "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 .
  "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.
  "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.
  },
  "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)
Patch a customer account's settings via Apiary Patch Orchestration

Args:
  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)
  body: object, The request body.
    The object takes the form of:

{ # JSON template for a customer.
  "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 .
  "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.
  "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.
  },
  "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:

    { # JSON template for a customer.
  "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 .
  "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.
  "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.
  },
  "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)
Update a customer account's settings.

Args:
  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)
  body: object, The request body.
    The object takes the form of:

{ # JSON template for a customer.
  "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 .
  "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.
  "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.
  },
  "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:

    { # JSON template for a customer.
  "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 .
  "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.
  "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.
  },
  "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.
}