Admin Directory API . customers

Instance Methods

get(customerKey=*)

Retrieves a customer.

patch(customerKey=*, body=*)

Updates a customer. This method supports patch semantics.

update(customerKey=*, body=*)

Updates a customer.

Method Details

get(customerKey=*)
Retrieves a customer.

Args:
  customerKey: string, Id of the customer to be retrieved (required)

Returns:
  An object of the form:

    { # JSON template for Customer Resource object in Directory API.
      "customerDomain": "A String", # The customer's primary domain name string. Do not include the www prefix when creating a new customer.
      "language": "A String", # The customer's ISO 639-2 language code. The default value is en-US
      "alternateEmail": "A String", # The customer's secondary contact email address. This email address cannot be on the same domain as the customerDomain
      "customerCreationTime": "A String", # The customer's creation time (Readonly)
      "kind": "admin#directory#customer", # Identifies the resource as a customer. Value: admin#directory#customer
      "etag": "A String", # ETag of the resource.
      "phoneNumber": "A String", # The customer's contact phone number in E.164 format.
      "postalAddress": { # JSON template for postal address of a customer. # The customer's postal address information.
        "organizationName": "A String", # The company or company division name.
        "countryCode": "A String", # This is a required property. For countryCode information see the ISO 3166 country code elements.
        "locality": "A String", # Name of the locality. An example of a locality value is the city of San Francisco.
        "region": "A String", # Name of the region. An example of a region value is NY for the state of New York.
        "addressLine2": "A String", # Address line 2 of the address.
        "addressLine3": "A String", # Address line 3 of the address.
        "contactName": "A String", # The customer contact's name.
        "addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines.
        "postalCode": "A String", # The postal code. A postalCode example is a postal zip code such as 10009. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
      },
      "id": "A String", # The unique ID for the customer's G Suite account. (Readonly)
    }
patch(customerKey=*, body=*)
Updates a customer. This method supports patch semantics.

Args:
  customerKey: string, Id of the customer to be updated (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Customer Resource object in Directory API.
    "customerDomain": "A String", # The customer's primary domain name string. Do not include the www prefix when creating a new customer.
    "language": "A String", # The customer's ISO 639-2 language code. The default value is en-US
    "alternateEmail": "A String", # The customer's secondary contact email address. This email address cannot be on the same domain as the customerDomain
    "customerCreationTime": "A String", # The customer's creation time (Readonly)
    "kind": "admin#directory#customer", # Identifies the resource as a customer. Value: admin#directory#customer
    "etag": "A String", # ETag of the resource.
    "phoneNumber": "A String", # The customer's contact phone number in E.164 format.
    "postalAddress": { # JSON template for postal address of a customer. # The customer's postal address information.
      "organizationName": "A String", # The company or company division name.
      "countryCode": "A String", # This is a required property. For countryCode information see the ISO 3166 country code elements.
      "locality": "A String", # Name of the locality. An example of a locality value is the city of San Francisco.
      "region": "A String", # Name of the region. An example of a region value is NY for the state of New York.
      "addressLine2": "A String", # Address line 2 of the address.
      "addressLine3": "A String", # Address line 3 of the address.
      "contactName": "A String", # The customer contact's name.
      "addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines.
      "postalCode": "A String", # The postal code. A postalCode example is a postal zip code such as 10009. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
    },
    "id": "A String", # The unique ID for the customer's G Suite account. (Readonly)
  }


Returns:
  An object of the form:

    { # JSON template for Customer Resource object in Directory API.
      "customerDomain": "A String", # The customer's primary domain name string. Do not include the www prefix when creating a new customer.
      "language": "A String", # The customer's ISO 639-2 language code. The default value is en-US
      "alternateEmail": "A String", # The customer's secondary contact email address. This email address cannot be on the same domain as the customerDomain
      "customerCreationTime": "A String", # The customer's creation time (Readonly)
      "kind": "admin#directory#customer", # Identifies the resource as a customer. Value: admin#directory#customer
      "etag": "A String", # ETag of the resource.
      "phoneNumber": "A String", # The customer's contact phone number in E.164 format.
      "postalAddress": { # JSON template for postal address of a customer. # The customer's postal address information.
        "organizationName": "A String", # The company or company division name.
        "countryCode": "A String", # This is a required property. For countryCode information see the ISO 3166 country code elements.
        "locality": "A String", # Name of the locality. An example of a locality value is the city of San Francisco.
        "region": "A String", # Name of the region. An example of a region value is NY for the state of New York.
        "addressLine2": "A String", # Address line 2 of the address.
        "addressLine3": "A String", # Address line 3 of the address.
        "contactName": "A String", # The customer contact's name.
        "addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines.
        "postalCode": "A String", # The postal code. A postalCode example is a postal zip code such as 10009. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
      },
      "id": "A String", # The unique ID for the customer's G Suite account. (Readonly)
    }
update(customerKey=*, body=*)
Updates a customer.

Args:
  customerKey: string, Id of the customer to be updated (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Customer Resource object in Directory API.
    "customerDomain": "A String", # The customer's primary domain name string. Do not include the www prefix when creating a new customer.
    "language": "A String", # The customer's ISO 639-2 language code. The default value is en-US
    "alternateEmail": "A String", # The customer's secondary contact email address. This email address cannot be on the same domain as the customerDomain
    "customerCreationTime": "A String", # The customer's creation time (Readonly)
    "kind": "admin#directory#customer", # Identifies the resource as a customer. Value: admin#directory#customer
    "etag": "A String", # ETag of the resource.
    "phoneNumber": "A String", # The customer's contact phone number in E.164 format.
    "postalAddress": { # JSON template for postal address of a customer. # The customer's postal address information.
      "organizationName": "A String", # The company or company division name.
      "countryCode": "A String", # This is a required property. For countryCode information see the ISO 3166 country code elements.
      "locality": "A String", # Name of the locality. An example of a locality value is the city of San Francisco.
      "region": "A String", # Name of the region. An example of a region value is NY for the state of New York.
      "addressLine2": "A String", # Address line 2 of the address.
      "addressLine3": "A String", # Address line 3 of the address.
      "contactName": "A String", # The customer contact's name.
      "addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines.
      "postalCode": "A String", # The postal code. A postalCode example is a postal zip code such as 10009. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
    },
    "id": "A String", # The unique ID for the customer's G Suite account. (Readonly)
  }


Returns:
  An object of the form:

    { # JSON template for Customer Resource object in Directory API.
      "customerDomain": "A String", # The customer's primary domain name string. Do not include the www prefix when creating a new customer.
      "language": "A String", # The customer's ISO 639-2 language code. The default value is en-US
      "alternateEmail": "A String", # The customer's secondary contact email address. This email address cannot be on the same domain as the customerDomain
      "customerCreationTime": "A String", # The customer's creation time (Readonly)
      "kind": "admin#directory#customer", # Identifies the resource as a customer. Value: admin#directory#customer
      "etag": "A String", # ETag of the resource.
      "phoneNumber": "A String", # The customer's contact phone number in E.164 format.
      "postalAddress": { # JSON template for postal address of a customer. # The customer's postal address information.
        "organizationName": "A String", # The company or company division name.
        "countryCode": "A String", # This is a required property. For countryCode information see the ISO 3166 country code elements.
        "locality": "A String", # Name of the locality. An example of a locality value is the city of San Francisco.
        "region": "A String", # Name of the region. An example of a region value is NY for the state of New York.
        "addressLine2": "A String", # Address line 2 of the address.
        "addressLine3": "A String", # Address line 3 of the address.
        "contactName": "A String", # The customer contact's name.
        "addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines.
        "postalCode": "A String", # The postal code. A postalCode example is a postal zip code such as 10009. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
      },
      "id": "A String", # The unique ID for the customer's G Suite account. (Readonly)
    }