REST Resource: customers

Ressource: Customer

Lorsque le compte d'un client Google est enregistré auprès d'un revendeur, ce dernier gère les abonnements de ce client pour les services Google. 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é sera 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 du nom de domaine principal du client. customerDomain est requis pour créer un client. N'incluez pas le préfixe www dans le domaine lorsque vous ajoutez un client.

postalAddress

object (Address)

L'adresse du client. Chaque champ est limité à 255 caractères.

phoneNumber

string

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

alternateEmail

string

Tout comme l'adresse e-mail du client dans les outils pour les revendeurs, cette adresse e-mail est le contact secondaire utilisé en cas d'incident au niveau du service du client, par exemple en cas de panne ou de problème de sécurité. Cette propriété est obligatoire lors de la création d'un nouveau domaine "domaine et ne doit pas utiliser le même domaine que customerDomain. Le champ alternateEmail n'est pas nécessaire pour créer un client d'é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. Elle est utilisée si votre application cliente exige 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 du client. Valeurs possibles:

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

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

primaryAdmin

object (PrimaryAdmin)

Premières informations d'administration du client, présentées pour le 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 obtenir des informations sur countryCode, consultez les éléments de code pays ISO 3166. Vérifiez que le pays est approuvé pour la revente de produits Google. Cette propriété est obligatoire lors de la création d'un client.

kind

string

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

region

string

Exemple de valeur region : CA 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 postalCode est un code postal tel que 94043. Cette propriété est obligatoire lors de la création d'un client.

addressLine1

string

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

organizationName

string

Nom de l'entreprise ou de sa division. Ce champ est obligatoire.

contactName

string

Nom du contact du client. Ce champ est obligatoire.

Type de client

Type de client

Enums
customerTypeUnspecified Type de client inconnu
domain Domaines appartenant au domaine
team Clients sans domaine ou dont l'adresse e-mail a été validée

Administrateur principal

Modèle JSON pour l'administrateur principal pour les clients TEAM

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

string

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

Le lien de validation est envoyé à cette adresse e-mail lors de la création du compte. Les administrateurs principaux ont accès à la console d'administration du client, et peuvent inviter et expulser des utilisateurs, et gérer les besoins administratifs du client.

Méthodes

get

Récupère un compte client.

insert

Commande un nouveau compte client.

patch

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

update

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