Package google.assistant.devices.v1alpha2

색인

DevicesPlatformService

이 서비스는 Google 이외의 기기를 관리합니다. 현재 이 API는 개발자에게 다음과 같은 서비스를 제공합니다. * 기기 모델 등록용 API 1개, * 기기 인스턴스 등록용 API 1개

기기 모델 등록은 기기 모델을 만들고 관리하며, 여기에는 해당 모델의 모든 기기에서 공유되는 기능 및 구성이 포함됩니다.

기기 인스턴스 등록은 모델에 정의된 기능 및 구성을 기반으로 기기 인스턴스를 인스턴스화하며 또한 개발자가 기기마다 다른 속성을 정의할 수 있게 해줍니다.등록 후 실행 시간에는 각 gRPC 요청에 device_model_id와 device_id가 모두 필요하며, Google Assistant API에서는 두 ID가 모두 이미 등록되어 있어야 하며, 그러지 않으면 오류가 반환됩니다.

CreateDevice

rpc CreateDevice(CreateDeviceRequest) returns (Device)

기기 1대를 등록하고, 성공하면 기기를 반환하고, 기기가 이미 존재하거나 실패하면 오류를 반환합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 인증 가이드를 참조하세요.

CreateDeviceModel

rpc CreateDeviceModel(CreateDeviceModelRequest) returns (DeviceModel)

서드 파티 기기 모델을 만듭니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 인증 가이드를 참조하세요.

DeleteDevice

rpc DeleteDevice(DeleteDeviceRequest) returns (Empty)

사용자가 소유한 특정 기기를 삭제합니다. 성공하면 비어 있고 성공하지 않으면 기기를 찾을 수 없거나 삭제에 실패했다는 오류가 반환됩니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 인증 가이드를 참조하세요.

DeleteDeviceModel

rpc DeleteDeviceModel(DeleteDeviceModelRequest) returns (Empty)

서드 파티 기기 모델을 삭제합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 인증 가이드를 참조하세요.

GetDevice

rpc GetDevice(GetDeviceRequest) returns (Device)

사용자가 소유한 특정 기기의 설정 정보를 가져옵니다. 성공하면 기기를 반환하고 실패하면 오류를 반환합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 인증 가이드를 참조하세요.

GetDeviceModel

rpc GetDeviceModel(GetDeviceModelRequest) returns (DeviceModel)

기기 모델 ID가 주어지면 기기 모델을 반환합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 인증 가이드를 참조하세요.

ListDeviceModels

rpc ListDeviceModels(ListDeviceModelsRequest) returns (ListDeviceModelsResponse)

이 REST API 호출과 연결된 프로젝트 ID의 기기 모델을 나열합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 인증 가이드를 참조하세요.

ListDevices

rpc ListDevices(ListDevicesRequest) returns (ListDevicesResponse)

OAuth 토큰의 지정된 project_id에 속한 사용자 소유 기기 목록을 가져옵니다. URL과 토큰의 project_id가 동일한지 확인해야 합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 인증 가이드를 참조하세요.

UpdateDeviceModel

rpc UpdateDeviceModel(UpdateDeviceModelRequest) returns (DeviceModel)

기기 모델을 업데이트하고 모델의 새 버전을 반환합니다. 참고: 전체 업데이트이므로 업데이트를 위해 전체 기기 모델을 전송해야 합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 인증 가이드를 참조하세요.

CreateDeviceModelRequest

DevicesPlatformService.CreateDeviceModel 요청 메시지입니다.

필드
parent

string

기기 모델을 만들 프로젝트의 리소스 이름(projects/{project_id} 형식)입니다.

device_model

DeviceModel

생성할 device_model입니다.

CreateDeviceRequest

DevicesPlatformService.CreateDevice 요청 메시지입니다.

필드
device

Device

사용자가 제공한 원시 기기 정보입니다. device_id는 프로젝트 소유자가 할당한 프로젝트 내에서 고유해야 합니다.

parent

string

기기가 속한 프로젝트의 이름으로, projects/{project_id} 형식입니다.

DeleteDeviceModelRequest

DevicesPlatformService.DeleteDeviceModel 요청 메시지입니다.

필드
name

string

기기 모델을 삭제할 프로젝트의 리소스 이름(projects/{project_id}/deviceModels/{device_model_id} 형식)

DeleteDeviceRequest

DevicesPlatformService.DeleteDevice 요청 메시지입니다.

필드
name

string

기기를 삭제할 프로젝트의 리소스 이름(projects/{project_id}/devices/{device_id} 형식).

기기

필드
name

string

기기의 리소스 이름으로, projects/{project_id}/devices/{device_id} 형식입니다. 기기를 만들 때 이름은 무시됩니다.

id

string

필수 항목입니다. 프로젝트 범위의 고유한 기기 ID로, 형식은 개발자가 정의합니다. 예: "06ba29e5-5f1c-1a89-303c-22de2580f2e2". Converse RPC를 전송할 때는 DeviceConfig.device_id와 일치해야 합니다. 이 ID는 초기화를 위해 재설정할 수 있습니다.

nickname

string

에서 지정한 기기의 닉네임으로, 사용자가 기기에 말할 때 음성 인식 및 기기 타겟팅에 사용됩니다. 예를 들어 사용자는 '내 스마트 로봇'이라는 기기를 사용할 때 '스마트 로봇을 왼쪽으로 움직여 줘'라고 말할 수 있습니다.

model_id

string

필수 항목입니다. 에이전트 ID의 모든 기기 중에서 기기 '클래스'(모델)를 고유하게 식별합니다. 예: "manufacturer-2017-v2". 한 프로젝트에 서로 다른 여러 기기 모델이 있을 수 있습니다.

client_type

ClientType

필수 항목입니다. 어시스턴트 SDK는 어시스턴트를 기기에 통합하는 두 가지 옵션을 제공합니다. 이 필드는 클라이언트가 어시스턴트 SDK 라이브러리를 기반으로 하는지 아니면 SDK 서비스 API를 호출하는지 식별하는 데 사용됩니다.

ClientType

클라이언트 유형을 식별합니다.

열거형
CLIENT_TYPE_UNSPECIFIED 클라이언트의 유형을 알 수 없습니다. 기본값입니다.
SDK_SERVICE 어시스턴트 요청 및 응답의 오디오 바이트를 직접 조작하는 하위 수준의 API를 노출하는 SDK gRPC Service API의 경우 Service
SDK_LIBRARY Google 어시스턴트 클라이언트 라이브러리의 경우 상위 수준의 이벤트 기반 API를 사용하는 턴키 솔루션입니다.

DeviceModel

기기 제품군의 메타데이터를 정의합니다. 기기 모델은 또한 기기 제품군의 공통 기능을 정의합니다.

필드
name

string

기기 모델의 리소스 이름(projects/project-id/deviceModels/device-model-id 형식)입니다.

device_model_id

string

필수 항목입니다. 개발자가 지정한 전역 고유 ID입니다(예: 'comcast-voice-assistant-2017-v1'). 기기 모델 ID가 이미 있으면 오류가 반환됩니다.

project_id

string

필수 항목입니다. 기기 모델과 연결된 Cloud 프로젝트 ID입니다. 각 프로젝트는 여러 기기 모델을 만들 수 있습니다.

device_type

string

필수 항목입니다. 유효한 기기 유형: 'action.devices.types.LIGHT' 'action.devices.types.OUTLET' 'action.devices.types.SWITCH' 'action.devices.types.AC_HEATING'

traits[]

string

기기가 지원할 수 있는 내장 특성의 목록입니다(선택사항). 예: 'action.devices.traits.OnOff'

manifest

Manifest

필수 항목입니다. 기기 모델 및 제조업체를 설명하는 메타데이터입니다. 이 이름은 SDK 콘솔, 측정항목 대시보드, 기타 관련된 시각적 인터페이스에 표시됩니다.

execution_modes[]

ExecutionMode

기기 작업의 실행 모드(선택사항) DIRECT_응답을 설정하면 기기가 기기 제어에 사용 설정됩니다.

ExecutionMode

기기 작업 실행 모드. 현재 직접 응답만 지원합니다.

열거형
MODE_UNSPECIFIED 지정되지 않음
DIRECT_RESPONSE 기기에서 직접 실행을 지원합니다. 기기에서 오는 쿼리의 경우 어시스턴트는 명령어와 매개변수를 포함하여 DeviceControlRequest를 반환합니다.

GetDeviceModelRequest

DevicesPlatformService.GetDeviceModel 요청 메시지입니다.

필드
name

string

기기 모델을 가져올 프로젝트의 리소스 이름(형식: projects/{project_id}/deviceModels/{device_model_id})

GetDeviceRequest

DevicesPlatformService.GetDevice 요청 메시지입니다.

필드
name

string

기기를 가져올 리소스 이름이며 projects/{project_id}/devices/{device_id} 형식입니다.

ListDeviceModelsRequest

DevicesPlatformService.ListDeviceModel 요청 메시지입니다.

필드
parent

string

요청 중인 기기 모델의 리소스 이름(projects/{project_id} 형식)입니다.

ListDeviceModelsResponse

DevicesPlatformService.CreateDeviceModel의 응답 메시지입니다.

필드
device_models[]

DeviceModel

ListDevicesRequest

DevicesPlatformService.ListDevices 요청 메시지입니다.

필드
parent

string

기기를 나열할 프로젝트의 이름으로, `projects/{project_id}' 형식입니다.

ListDevicesResponse

DevicesPlatformService.ListDevices의 응답 메시지입니다.

필드
devices[]

Device

해당 프로젝트에서 이 사용자가 소유한 모든 기기입니다.

매니페스트

기기 모델 및 제조업체를 설명하는 메타데이터입니다. 이 이름은 SDK 콘솔, 측정항목 대시보드, 기타 관련된 시각적 인터페이스에 표시됩니다.

필드
manufacturer

string

필수 항목입니다. 기기의 제조업체입니다(예: 'Google').

product_name

string

필수 항목입니다. 이 기기 모델의 소비자 대상 제품 이름입니다(예: 'Google 어시스턴트 프로토타입 기기').

device_description

string

이 기기 모델에 관한 설명(선택사항)입니다(예: 'Google 어시스턴트 내장 Google 스마트 스피커').

UpdateDeviceModelRequest

DevicesPlatformService.UpdateDeviceModel 요청 메시지입니다.

필드
name

string

기기 모델을 업데이트할 프로젝트의 리소스 이름(projects/{project_id}/deviceModels/{device_model_id} 형식)입니다.

device_model

DeviceModel

새로운 기기 모델 개발자가 업데이트하려고 합니다.