get(customerKey, x__xgafv=None)

Retrieves a customer.

Args:
  customerKey: string, Id of the customer to be retrieved (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "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)
  "customerDomain": "A String", # The customer's primary domain name string. Do not include the `www` prefix when creating a new customer.
  "etag": "A String", # ETag of the resource.
  "id": "A String", # The unique ID for the customer's Google Workspace account. (Readonly)
  "kind": "admin#directory#customer", # Identifies the resource as a customer. Value: `admin#directory#customer`
  "language": "A String", # The customer's ISO 639-2 language code. See the [Language Codes](/admin-sdk/directory/v1/languages) page for the list of supported codes. Valid language codes outside the supported set will be accepted by the API but may lead to unexpected behavior. The default value is `en`.
  "phoneNumber": "A String", # The customer's contact phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.
  "postalAddress": { # The customer's postal address information.
    "addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines.
    "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.
    "countryCode": "A String", # This is a required property. For `countryCode` information see the [ISO 3166 country code elements](https://www.iso.org/iso/country_codes.htm).
    "locality": "A String", # Name of the locality. An example of a locality value is the city of `San Francisco`.
    "organizationName": "A String", # The company or company division name.
    "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.
    "region": "A String", # Name of the region. An example of a region value is `NY` for the state of New York.
  },
}

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

Patches a customer.

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

{
  "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)
  "customerDomain": "A String", # The customer's primary domain name string. Do not include the `www` prefix when creating a new customer.
  "etag": "A String", # ETag of the resource.
  "id": "A String", # The unique ID for the customer's Google Workspace account. (Readonly)
  "kind": "admin#directory#customer", # Identifies the resource as a customer. Value: `admin#directory#customer`
  "language": "A String", # The customer's ISO 639-2 language code. See the [Language Codes](/admin-sdk/directory/v1/languages) page for the list of supported codes. Valid language codes outside the supported set will be accepted by the API but may lead to unexpected behavior. The default value is `en`.
  "phoneNumber": "A String", # The customer's contact phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.
  "postalAddress": { # The customer's postal address information.
    "addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines.
    "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.
    "countryCode": "A String", # This is a required property. For `countryCode` information see the [ISO 3166 country code elements](https://www.iso.org/iso/country_codes.htm).
    "locality": "A String", # Name of the locality. An example of a locality value is the city of `San Francisco`.
    "organizationName": "A String", # The company or company division name.
    "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.
    "region": "A String", # Name of the region. An example of a region value is `NY` for the state of New York.
  },
}

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

Returns:
  An object of the form:

    {
  "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)
  "customerDomain": "A String", # The customer's primary domain name string. Do not include the `www` prefix when creating a new customer.
  "etag": "A String", # ETag of the resource.
  "id": "A String", # The unique ID for the customer's Google Workspace account. (Readonly)
  "kind": "admin#directory#customer", # Identifies the resource as a customer. Value: `admin#directory#customer`
  "language": "A String", # The customer's ISO 639-2 language code. See the [Language Codes](/admin-sdk/directory/v1/languages) page for the list of supported codes. Valid language codes outside the supported set will be accepted by the API but may lead to unexpected behavior. The default value is `en`.
  "phoneNumber": "A String", # The customer's contact phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.
  "postalAddress": { # The customer's postal address information.
    "addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines.
    "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.
    "countryCode": "A String", # This is a required property. For `countryCode` information see the [ISO 3166 country code elements](https://www.iso.org/iso/country_codes.htm).
    "locality": "A String", # Name of the locality. An example of a locality value is the city of `San Francisco`.
    "organizationName": "A String", # The company or company division name.
    "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.
    "region": "A String", # Name of the region. An example of a region value is `NY` for the state of New York.
  },
}

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

Updates a customer.

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

{
  "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)
  "customerDomain": "A String", # The customer's primary domain name string. Do not include the `www` prefix when creating a new customer.
  "etag": "A String", # ETag of the resource.
  "id": "A String", # The unique ID for the customer's Google Workspace account. (Readonly)
  "kind": "admin#directory#customer", # Identifies the resource as a customer. Value: `admin#directory#customer`
  "language": "A String", # The customer's ISO 639-2 language code. See the [Language Codes](/admin-sdk/directory/v1/languages) page for the list of supported codes. Valid language codes outside the supported set will be accepted by the API but may lead to unexpected behavior. The default value is `en`.
  "phoneNumber": "A String", # The customer's contact phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.
  "postalAddress": { # The customer's postal address information.
    "addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines.
    "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.
    "countryCode": "A String", # This is a required property. For `countryCode` information see the [ISO 3166 country code elements](https://www.iso.org/iso/country_codes.htm).
    "locality": "A String", # Name of the locality. An example of a locality value is the city of `San Francisco`.
    "organizationName": "A String", # The company or company division name.
    "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.
    "region": "A String", # Name of the region. An example of a region value is `NY` for the state of New York.
  },
}

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

Returns:
  An object of the form:

    {
  "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)
  "customerDomain": "A String", # The customer's primary domain name string. Do not include the `www` prefix when creating a new customer.
  "etag": "A String", # ETag of the resource.
  "id": "A String", # The unique ID for the customer's Google Workspace account. (Readonly)
  "kind": "admin#directory#customer", # Identifies the resource as a customer. Value: `admin#directory#customer`
  "language": "A String", # The customer's ISO 639-2 language code. See the [Language Codes](/admin-sdk/directory/v1/languages) page for the list of supported codes. Valid language codes outside the supported set will be accepted by the API but may lead to unexpected behavior. The default value is `en`.
  "phoneNumber": "A String", # The customer's contact phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.
  "postalAddress": { # The customer's postal address information.
    "addressLine1": "A String", # A customer's physical address. The address can be composed of one to three lines.
    "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.
    "countryCode": "A String", # This is a required property. For `countryCode` information see the [ISO 3166 country code elements](https://www.iso.org/iso/country_codes.htm).
    "locality": "A String", # Name of the locality. An example of a locality value is the city of `San Francisco`.
    "organizationName": "A String", # The company or company division name.
    "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.
    "region": "A String", # Name of the region. An example of a region value is `NY` for the state of New York.
  },
}

Admin SDK API . customers

Instance Methods

Method Details