REST Resource: customers

Ressource: Customer

Lorsque le compte d'un client Google est enregistré auprès d'un revendeur, ses abonnements 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 correspondre au domaine principal ou à l'identifiant unique généré par Google.

customerDomain

string

Chaîne du nom de domaine principal du client. Vous devez renseigner le champ customerDomain lorsque vous créez un client. N'incluez pas le préfixe www dans le domaine lorsque vous ajoutez un client.

postalAddress

object (Address)

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 du code pays. Le reste du numéro peut être des numéros contigus ou respecter les conventions relatives au format local des téléphones, à la différence qu'il doit s'agir d'un vrai numéro de téléphone et non de "123", par exemple. Ce champ est ignoré sans notification s'il n'est pas valide.

alternateEmail

string

Par exemple, "Adresse e-mail du client" dans les outils pour les revendeurs, cette adresse e-mail est le contact secondaire à utiliser en cas de problème avec le service client, par exemple en cas d'interruption de service ou de problème de sécurité. Cette propriété est obligatoire lorsque vous créez un "domaine" et ne doit pas utiliser le même domaine que customerDomain. Le champ alternateEmail n'est pas nécessaire pour créer une "équipe". client.

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 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 de client. Les valeurs possibles 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 d'administration du premier compte 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 de code pays ISO 3166. Vérifiez que la revente de produits Google est autorisée dans ce pays. 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

CA pour l'État de Californie est un exemple de valeur region.

addressLine2

string

Ligne 2 de l'adresse.

locality

string

La ville de 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 tel que 94043. Cette propriété est obligatoire lorsque vous créez un client.

addressLine1

string

Adresse physique d'un client. Une adresse peut comporter une à trois lignes. Les champs 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 d'un domaine ou propriétaires d'un domaine
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 par e-mail est envoyé à cette adresse e-mail au moment de la création du client. Les administrateurs principaux ont accès à la console d'administration du client. Ils 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 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.