REST Resource: customers

Ressource: Client

Lorsqu'un compte client Google est enregistré auprès d'un revendeur, les abonnements du client aux services Google sont gérés par ce revendeur. Un client est décrit par un nom de domaine principal et une adresse physique.

Représentation JSON
{
  "customerId": string,
  "customerDomain": string,
  "postalAddress": {
    object (Address)
  },
  "phoneNumber": string,
  "alternateEmail": string,
  "resourceUiUrl": string,
  "customerDomainVerified": boolean,
  "kind": string,
  "customerType": enum (CustomerType),
  "primaryAdmin": {
    object (PrimaryAdmin)
  }
}
Champs
customerId

string

Cette propriété est toujours renvoyée dans une réponse en tant qu'identifiant unique généré par Google. Dans une requête, cette propriété peut être le domaine principal ou l'identifiant unique généré par Google.

customerDomain

string

Chaîne de nom de domaine principal du client. customerDomain est obligatoire lors de la création d'un client. N'incluez pas le préfixe www dans le domaine lorsque vous ajoutez un client.

postalAddress

object (Address)

Informations sur l'adresse d'un client. Chaque champ est limité à 255 caractères.

phoneNumber

string

Numéro de téléphone du contact client. Doit commencer par "+", suivi de l'indicatif pays. Le reste du numéro peut être constitué de chiffres consécutifs ou respecter les conventions de format locales, mais il doit s'agir d'un vrai numéro de téléphone et non, par exemple, de "123". Ce champ est ignoré en silence s'il n'est pas valide.

alternateEmail

string

Comme l'adresse e-mail du client dans les outils du revendeur, cette adresse est utilisée comme contact secondaire en cas de problème avec le service du client, comme une panne ou un problème de sécurité. Cette propriété est obligatoire lorsque vous créez un client "domaine". Elle ne doit pas utiliser le même domaine que customerDomain. Le champ alternateEmail n'est pas nécessaire pour créer un client "équipe".

resourceUiUrl

string

URL du tableau de bord de la console d'administration du client. L'URL en lecture seule est générée par le service d'API. Cette option est utilisée si votre application cliente nécessite que le client effectue une tâche dans la console d'administration.

customerDomainVerified

boolean

Indique si le domaine principal du client a été validé.

kind

string

Identifie la ressource en tant que client. Valeur : reseller#customer

customerType

enum (CustomerType)

Identifie le type de client. Les valeurs acceptées sont les suivantes:

  • domain: implique un client dont le domaine a été validé (par défaut).
  • team: implique un client dont l'adresse e-mail a été validée.

Pour en savoir plus, consultez la section Équipes gérées.

primaryAdmin

object (PrimaryAdmin)

Informations sur le premier administrateur du client, présentes dans le cas d'un client TEAM.

Adresse

Modèle JSON pour l'adresse d'un client.

Représentation JSON
{
  "countryCode": string,
  "kind": string,
  "region": string,
  "addressLine2": string,
  "locality": string,
  "addressLine3": string,
  "postalCode": string,
  "addressLine1": string,
  "organizationName": string,
  "contactName": string
}
Champs
countryCode

string

Pour en savoir plus sur countryCode, consultez les éléments des codes pays ISO 3166. Vérifiez que le pays est autorisé à revendre des produits Google. Cette propriété est obligatoire lorsque vous créez un client.

kind

string

Identifie la ressource en tant qu'adresse client. Valeur : customers#address

region

string

Par exemple, CA est une valeur region pour l'État de Californie.

addressLine2

string

Ligne 2 de l'adresse.

locality

string

La ville San Francisco est un exemple de valeur locality.

addressLine3

string

Ligne 3 de l'adresse.

postalCode

string

Un exemple de postalCode est un code postal, comme 94043. Cette propriété est obligatoire lorsque vous créez un client.

addressLine1

string

Adresse physique du client. Une adresse peut être composée d'une à trois lignes. addressline2 et addressLine3 sont facultatifs.

organizationName

string

Nom de l'entreprise ou de la division de l'entreprise. Champ obligatoire

contactName

string

Nom du contact client. Champ obligatoire

CustomerType

Type de client

Enums
customerTypeUnspecified Type de client inconnu
domain Clients disposant d'un domaine ou en étant propriétaires
team Clients sans domaine ou dont l'adresse e-mail a été validée

PrimaryAdmin

Modèle JSON pour l'administrateur principal en cas de clients TEAM

Représentation JSON
{
  "primaryEmail": string
}
Champs
primaryEmail

string

Adresse e-mail professionnelle de l'administrateur principal du client.

Le lien de validation de l'adresse e-mail est envoyé à cette adresse au moment de la création du client. Les administrateurs principaux ont accès à la console d'administration du client, ce qui leur permet d'inviter et d'exclure des utilisateurs, et de gérer les besoins administratifs du client.

Méthodes

get

Récupère un compte client.

insert

Commande le compte d'un nouveau client.

patch

Met à jour les paramètres d'un compte client.

update

Met à jour les paramètres d'un compte client.