Package google.assistant.devices.v1alpha2

Index

DevicesPlatformService

Ce service gère les appareils autres que Google. Actuellement, elle fournit aux développeurs les éléments suivants: * une API pour l'enregistrement de modèles d'appareils, * une API pour l'enregistrement d'instances d'appareil.

L'enregistrement du modèle d'appareil permet de créer et de gérer un modèle d'appareil, qui contient les fonctionnalités et configurations partagées entre tous les appareils associés à ce modèle.

L'enregistrement d'une instance d'appareil instancie une instance d'appareil en fonction des capacités et des configurations définies dans son modèle. Cela permet également aux développeurs de définir des attributs qui varient d'un appareil à l'autre. Pendant l'exécution après l'enregistrement, device_model_id et device_id sont requis dans chaque requête gRPC. L'API Google Assistant exige que les deux ID soient déjà enregistrés. Sinon, une erreur est renvoyée.

CreateDevice

rpc CreateDevice(CreateDeviceRequest) returns (Device)

Enregistrez un appareil, puis renvoyez-le en cas de réussite ou d'erreur s'il existe déjà ou échoue.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

  • https://www.googleapis.com/auth/assistant-sdk-prototype

Pour en savoir plus, consultez le guide d'authentification.
CreateDeviceModel

rpc CreateDeviceModel(CreateDeviceModelRequest) returns (DeviceModel)

Créez un modèle d'appareil tiers.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

  • https://www.googleapis.com/auth/assistant-sdk-prototype

Pour en savoir plus, consultez le guide d'authentification.
DeleteDevice

rpc DeleteDevice(DeleteDeviceRequest) returns (Empty)

Supprime un appareil spécifique appartenant à un utilisateur. La valeur renvoyée est vide en cas de réussite, sinon une erreur indiquant que l'appareil est introuvable ou impossible à supprimer.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

  • https://www.googleapis.com/auth/assistant-sdk-prototype

Pour en savoir plus, consultez le guide d'authentification.
DeleteDeviceModel

rpc DeleteDeviceModel(DeleteDeviceModelRequest) returns (Empty)

Supprimez un modèle d'appareil tiers.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

  • https://www.googleapis.com/auth/assistant-sdk-prototype

Pour en savoir plus, consultez le guide d'authentification.
GetDevice

rpc GetDevice(GetDeviceRequest) returns (Device)

Obtenir des informations sur les paramètres appartenant à un utilisateur spécifique, renvoyer l'appareil en cas de réussite ou renvoyer une erreur en cas d'échec.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

  • https://www.googleapis.com/auth/assistant-sdk-prototype

Pour en savoir plus, consultez le guide d'authentification.
GetDeviceModel

rpc GetDeviceModel(GetDeviceModelRequest) returns (DeviceModel)

Renvoie un modèle d'appareil en fonction de l'ID du modèle de l'appareil.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

  • https://www.googleapis.com/auth/assistant-sdk-prototype

Pour en savoir plus, consultez le guide d'authentification.
ListDeviceModels

rpc ListDeviceModels(ListDeviceModelsRequest) returns (ListDeviceModelsResponse)

Répertorier les modèles d'appareils pour l'ID de projet associé à cet appel d'API REST.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

  • https://www.googleapis.com/auth/assistant-sdk-prototype

Pour en savoir plus, consultez le guide d'authentification.
ListDevices

rpc ListDevices(ListDevicesRequest) returns (ListDevicesResponse)

Permet d'obtenir la liste des appareils appartenant à l'utilisateur et appartenant au project_id donné dans le jeton OAuth. Vous devez vérifier que l'URL et le jeton ont le même project_id.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

  • https://www.googleapis.com/auth/assistant-sdk-prototype

Pour en savoir plus, consultez le guide d'authentification.
UpdateDeviceModel

rpc UpdateDeviceModel(UpdateDeviceModelRequest) returns (DeviceModel)

Met à jour un modèle d'appareil, puis renvoie la nouvelle version du modèle. Remarque: il s'agit d'une mise à jour complète, ce qui signifie que vous devez envoyer la totalité du modèle de l'appareil pour mise à jour.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

  • https://www.googleapis.com/auth/assistant-sdk-prototype

Pour en savoir plus, consultez le guide d'authentification.

CreateDeviceModelRequest

Message de requête pour DevicesPlatformService.CreateDeviceModel.

Champs
parent

string

Nom de ressource du projet dans lequel créer le modèle de l'appareil, au format projects/{project_id}

device_model

DeviceModel

Device_model à créer.

CreateDeviceRequest

Message de requête pour DevicesPlatformService.CreateDevice.

Champs
device

Device

Informations brutes sur l'appareil fournies par l'utilisateur. La valeur device_id doit être unique dans le projet et attribuée par son propriétaire.

parent

string

Nom du projet auquel appartient l'appareil, au format projects/{project_id}

DeleteDeviceModelRequest

Message de requête pour DevicesPlatformService.DeleteDeviceModel.

Champs
name

string

Nom de ressource du projet dans lequel supprimer le modèle de l'appareil, au format projects/{project_id}/deviceModels/{device_model_id}.

DeleteDeviceRequest

Message de requête pour DevicesPlatformService.DeleteDevice.

Champs
name

string

Nom de ressource du projet dans lequel supprimer l'appareil, au format projects/{project_id}/devices/{device_id}.

Appareil

Champs
name

string

Nom de ressource de l'appareil, au format projects/{project_id}/devices/{device_id}. Le nom est ignoré lors de la création d'un appareil.

id

string

Obligatoire. ID d'appareil unique dans le champ d'application du projet, le format est défini par le développeur (par exemple, "06ba29e5-5f1c-1a89-303c-22de2580f2e2". Doit correspondre à DeviceConfig.device_id lors de l'envoi d'un RPC Converse. Cet identifiant peut être réinitialisé pour le rétablissement de la configuration d'usine.

nickname

string

Pseudo de cet appareil spécifié par, qui est utilisé pour la reconnaissance vocale et le ciblage par types d'appareil lorsque l'utilisateur s'adresse à un appareil. Par exemple, l'utilisateur peut dire "déplacer mon robot intelligent vers la gauche" lorsqu'il possède un appareil nommé "mon robot intelligent".

model_id

string

Obligatoire. Identifie la "classe" (modèle) de manière unique parmi tous les appareils pour l'agent-id (ex. : "manufacturer-2017-v2". Notez qu'un projet peut être associé à plusieurs modèles d'appareils différents.

client_type

ClientType

Obligatoire. Le SDK de l'Assistant propose deux options pour intégrer l'Assistant à votre appareil. Ce champ permet de déterminer si le client est basé sur la bibliothèque du SDK Assistant ou sur l'appel de l'API du service SDK.

ClientType

Identifie le type de client.

Enums
CLIENT_TYPE_UNSPECIFIED Le type du client n'est pas connu (valeur par défaut).
SDK_SERVICE Pour l'API de service gRPC du SDK, qui expose une API de bas niveau qui manipule directement les octets audio d'une requête et d'une réponse de l'Assistant. Service
SDK_LIBRARY Pour la bibliothèque cliente de l'Assistant Google, une solution clé en main dotée d'une API de haut niveau basée sur des événements.

DeviceModel

Définit les métadonnées d'une famille d'appareils. Un modèle d'appareil définit également les fonctionnalités communes à une famille d'appareils.

Champs
name

string

Nom de ressource du modèle de l'appareil, au format projects/project-id/deviceModels/device-model-id

device_model_id

string

Obligatoire. ID unique global spécifié par le développeur, par exemple "comcast-voice-assistant-2017-v1". Si un ID de modèle d'appareil existe déjà, une erreur s'affiche.

project_id

string

Obligatoire. ID du projet cloud associé au modèle de l'appareil. Chaque projet peut créer plusieurs modèles d'appareils.

device_type

string

Obligatoire. Un type d'appareil valide: "action.devices.types.Light" "action.devices.types.OUTLET" "action.devices.types.SWITCH" "action.devices.types.AC_HEATING"

traits[]

string

Liste facultative des caractéristiques intégrées que l'appareil peut prendre en charge. Exemple: "action.devices.traits.OnOff"

manifest

Manifest

Obligatoire. Métadonnées qui décrivent le modèle et le fabricant de l'appareil. Il s'affichera dans la SDK Console, les tableaux de bord des métriques et d'autres interfaces visuelles associées.

execution_modes[]

ExecutionMode

Mode d'exécution facultatif pour les actions sur l'appareil. Si DIRECT_ANSWER est défini, les appareils peuvent être contrôlés par des appareils.

ExecutionMode

Mode d'exécution pour les actions sur l'appareil (actuellement compatible uniquement avec la réponse directe).

Enums
MODE_UNSPECIFIED Non spécifié.
DIRECT_RESPONSE L'appareil est compatible avec l'exécution directe. Pour les requêtes provenant de l'appareil, l'Assistant renvoie DeviceControlRequest, y compris la commande et les paramètres.

GetDeviceModelRequest

Message de requête pour DevicesPlatformService.GetDeviceModel.

Champs
name

string

Nom de ressource du projet dans lequel obtenir un modèle d'appareil, au format projects/{project_id}/deviceModels/{device_model_id}

GetDeviceRequest

Message de requête pour DevicesPlatformService.GetDevice.

Champs
name

string

Nom de la ressource permettant d'obtenir un appareil, au format projects/{project_id}/devices/{device_id}.

ListDeviceModelsRequest

Message de requête pour DevicesPlatformService.ListDeviceModel.

Champs
parent

string

Le nom de ressource des modèles d'appareils est en cours de demande, au format projects/{project_id}

ListDeviceModelsResponse

Message de réponse pour DevicesPlatformService.CreateDeviceModel.

Champs
device_models[]

DeviceModel

ListDevicesRequest

Message de requête pour DevicesPlatformService.ListDevices.

Champs
parent

string

Nom du projet dont nous souhaitons répertorier les appareils, au format "projects/{project_id}".

ListDevicesResponse

Message de réponse pour DevicesPlatformService.ListDevices.

Champs
devices[]

Device

tous les appareils dont cet utilisateur est propriétaire dans le projet donné.

Manifest

Métadonnées qui décrivent le modèle et le fabricant de l'appareil. Il s'affichera dans la SDK Console, les tableaux de bord des métriques et d'autres interfaces visuelles associées.

Champs
manufacturer

string

Obligatoire. Fabricant de cet appareil (par exemple, "Google").

product_name

string

Obligatoire. Nom du produit présenté aux consommateurs pour ce modèle d'appareil, par exemple "Prototype de l'Assistant Google".

device_description

string

Description facultative de ce modèle d'appareil, par exemple "Enceinte intelligente de Google avec l'Assistant Google Intégré".

UpdateDeviceModelRequest

Message de requête pour DevicesPlatformService.UpdateDeviceModel.

Champs
name

string

Nom de ressource du projet dans lequel mettre à jour le modèle de l'appareil, au format projects/{project_id}/deviceModels/{device_model_id}.

device_model

DeviceModel

Le développeur du nouveau modèle d'appareil souhaite effectuer la mise à jour.