Package google.assistant.devices.v1alpha2

Dizin

DevicesPlatformService

Bu hizmet Google dışı cihazları yönetir. Şu anda geliştiricilere: * cihaz modeli kaydı için bir API, * cihaz örneği kaydı için bir API sunulmaktadır.

Cihaz modeli kaydı, ilgili modeldeki tüm cihazlar arasında paylaşılan özellikleri ve yapılandırmaları içeren cihaz modelini oluşturur ve yönetir.

Cihaz örneği kaydı, modelinde tanımlanan özelliklere ve yapılandırmalara göre bir cihaz örneğini örnekler ve geliştiricinin, cihazlar arasında değişen bazı özellikler tanımlamasına olanak tanır. Kayıttan sonraki yürütme süresi sırasında her gRPC isteğinde hem device_model_id hem de device_id gerekir ve Google Assistant API'si her iki kimliğin de kayıtlı olmasını gerektirir. Aksi takdirde bir hata döndürülür.

CreateDevice

rpc CreateDevice(CreateDeviceRequest) returns (Device)

Bir cihaz kaydettirin. Cihaz zaten mevcut ya da başarısız olduysa işlem başarılı veya hatalıysa cihazı geri gönderin.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için Kimlik Doğrulama Kılavuzu'na bakın.
CreateDeviceModel

rpc CreateDeviceModel(CreateDeviceModelRequest) returns (DeviceModel)

3. taraf cihaz modeli oluşturun.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için Kimlik Doğrulama Kılavuzu'na bakın.
DeleteDevice

rpc DeleteDevice(DeleteDeviceRequest) returns (Empty)

Kullanıcının sahip olduğu belirli bir cihazı siler. Başarılı olursa boş döndürülür, aksi takdirde cihazın bulunamadığını veya silinemediğini belirten bir hata mesajı döndürülür.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için Kimlik Doğrulama Kılavuzu'na bakın.
DeleteDeviceModel

rpc DeleteDeviceModel(DeleteDeviceModelRequest) returns (Empty)

3. taraf cihaz modelini silin.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için Kimlik Doğrulama Kılavuzu'na bakın.
GetDevice

rpc GetDevice(GetDeviceRequest) returns (Device)

Kullanıcının sahip olduğu belirli bir cihazın ayar bilgilerini alma, başarılıysa cihazı geri, başarısız olursa cihazı geri gönderir.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için Kimlik Doğrulama Kılavuzu'na bakın.
GetDeviceModel

rpc GetDeviceModel(GetDeviceModelRequest) returns (DeviceModel)

Cihaz modeli kimliği belirtildiğinde bir cihaz modeli döndürün.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için Kimlik Doğrulama Kılavuzu'na bakın.
ListDeviceModels

rpc ListDeviceModels(ListDeviceModelsRequest) returns (ListDeviceModelsResponse)

Bu REST API çağrısıyla ilişkilendirilmiş proje kimliği için cihaz modellerini listeleyin.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için Kimlik Doğrulama Kılavuzu'na bakın.
ListDevices

rpc ListDevices(ListDevicesRequest) returns (ListDevicesResponse)

OAuth jetonunda, belirtilen project_id değerine ait kullanıcının sahip olduğu cihazların listesini alın. URL ve jetonun aynı project_id değerine sahip olup olmadığının kontrol edilmesi gerekiyor.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için Kimlik Doğrulama Kılavuzu'na bakın.
UpdateDeviceModel

rpc UpdateDeviceModel(UpdateDeviceModelRequest) returns (DeviceModel)

Bir cihaz modelini günceller, modelin yeni sürümünü döndürür. Not: Bu tam bir güncellemedir. Yani, güncelleme için tüm cihaz modelini göndermeniz gerekir.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için Kimlik Doğrulama Kılavuzu'na bakın.

CreateDeviceModelRequest

CihazlarPlatformService.CreateDeviceModel için istek mesajı.

Alanlar
parent

string

Cihaz modelinin oluşturulacağı projenin projects/{project_id} biçimindeki kaynak adı

device_model

DeviceModel

Oluşturulacak device_model.

CreateDeviceRequest

CihazlarPlatformService.CreateDevice için istek mesajı.

Alanlar
device

Device

Kullanıcı tarafından sağlanan ham cihaz bilgisi. device_id, projede benzersiz olmalı ve proje sahibi tarafından atanmalıdır.

parent

string

Cihazın ait olduğu projenin projects/{project_id} biçimindeki adı

DeleteDeviceModelRequest

CihazlarPlatformService.DeleteDeviceModel için mesaj isteyin.

Alanlar
name

string

Cihaz modelinin silineceği projenin projects/{project_id}/deviceModels/{device_model_id} biçimindeki kaynak adı

DeleteDeviceRequest

CihazlarPlatformService.DeleteDevice için mesaj isteyin.

Alanlar
name

string

Cihazın silineceği projenin projects/{project_id}/devices/{device_id} biçimindeki kaynak adı.

Cihaz

Alanlar
name

string

Cihazın projects/{project_id}/devices/{device_id} biçimindeki kaynak adı. Cihaz oluşturulurken bu ad yoksayılır.

id

string

Zorunlu. Proje kapsamındaki benzersiz cihaz kimliği. Biçim, geliştirici tarafından tanımlanır. Ör. "06ba29e5-5f1c-1a89-303c-22de2580f2e2". Converse RPC gönderilirken DeviceConfig.device_id ile eşleşmelidir. Bu kimlik FDR için sıfırlanabilir.

nickname

string

Bu cihaz için tarafından belirtilen takma ad.Kullanıcı bir cihazla konuştuğunda konuşma tanıma ve cihaz hedefleme için kullanılır. Örneğin, kullanıcı "akıllı robotum" adlı bir cihazı olduğunda "akıllı robotumu sola taşı" diyebilir.

model_id

string

Zorunlu. Aracı kimliği için tüm cihazlar arasında cihaz "sınıfını" (model) benzersiz bir şekilde tanımlar (ör. "manufacturer-2017-v2". Bir projenin birden fazla farklı cihaz modeli olabileceğini unutmayın.

client_type

ClientType

Zorunlu. Asistan SDK'sı, Asistan'ı cihazınıza entegre etmek için iki seçenek sunar. Bu alan, istemcinin Asistan SDK kitaplığına dayalı mı yoksa SDK hizmet API'sini mi çağırdığını belirlemek içindir.

ClientType

İstemci türünü tanımlar.

Sıralamalar
CLIENT_TYPE_UNSPECIFIED İstemcinin türü bilinmiyor, varsayılan değer.
SDK_SERVICE SDK gRPC service API'si için bir Asistan isteğinin ve yanıtının ses baytlarını doğrudan değiştiren düşük düzey bir API'yi gösterir. Service
SDK_LIBRARY Google Asistan istemci kitaplığı için yüksek düzeyde, etkinliğe dayalı bir API'ye sahip kullanıma hazır bir çözüm.

DeviceModel

Cihaz ailesi için meta verileri tanımlar Cihaz modeli ayrıca bir cihaz ailesi için ortak özellikleri de tanımlar.

Alanlar
name

string

Cihaz modelinin projects/project-id/deviceModels/device-model-id biçimindeki kaynak adı

device_model_id

string

Zorunlu. Geliştirici tarafından belirtilen, "comcast-voice-assistant-2017-v1" gibi genel benzersiz kimlik. Halihazırda bir cihaz modeli kimliği varsa bir hata döndürülür.

project_id

string

Zorunlu. Cihaz Modeli ile ilişkilendirilmiş Cloud projesi kimliği. Her projenin birden fazla cihaz modeli oluşturmasına izin verilir.

device_type

string

Zorunlu. Bazı Geçerli Cihaz Türleri: "action.devices.types.LIGHT" "action.devices.types.OUTLET" "action.devices.types.SWITCH" "action.devices.types.AC_HEATING"

traits[]

string

İsteğe bağlı. Cihazın destekleyebileceği yerleşik özelliklerin listesi. Örneğin: "action.devices.traits.OnKapalı"

manifest

Manifest

Zorunlu. Cihaz modelini ve üreticisini açıklayan meta veriler. Bu ad SDK konsolunda, metrik kontrol panellerinde ve ilgili diğer görsel arayüzlerde gösterilir.

execution_modes[]

ExecutionMode

Cihaz işlemleri için isteğe bağlı Yürütme modu. DIRECT_RESPONSE ayarlanırsa cihaz kontrolü için cihazlar etkinleştirilir.

ExecutionMode

Cihaz İşlemleri için yürütme modu; şu anda yalnızca doğrudan yanıtı desteklemektedir.

Sıralamalar
MODE_UNSPECIFIED Belirtilmedi.
DIRECT_RESPONSE Cihaz doğrudan yürütmeyi destekliyor. Cihazdan gelen sorgularda asistan, komut ve parametrelerle birlikte DeviceControlRequest değerini döndürür.

GetDeviceModelRequest

CihazlarPlatformService.GetDeviceModel için mesaj isteyin.

Alanlar
name

string

Cihaz modelinin alınacağı projenin projects/{project_id}/deviceModels/{device_model_id} biçimindeki kaynak adı

GetDeviceRequest

CihazlarPlatformService.GetDevice için mesaj isteyin.

Alanlar
name

string

Cihazı almak için projects/{project_id}/devices/{device_id} biçimindeki kaynak adı.

ListDeviceModelsRequest

CihazlarPlatformService.ListDeviceModel için istek mesajı.

Alanlar
parent

string

Cihaz modellerinin projects/{project_id} biçiminde kaynak adı isteniyor

ListDeviceModelsResponse

CihazlarPlatformService.CreateDeviceModel için yanıt mesajı.

Alanlar
device_models[]

DeviceModel

ListDevicesRequest

DevicePlatformService.ListDevices için mesaj isteği gönderin.

Alanlar
parent

string

Cihazlarını listelemek istediğimiz projenin "projects/{project_id}" biçimindeki adı.

ListDevicesResponse

DevicePlatformService.ListDevices için yanıt mesajı.

Alanlar
devices[]

Device

bu kullanıcının ilgili projede sahip olduğu tüm cihazlar.

Manifest

Cihaz modelini ve üreticisini açıklayan meta veriler. Bu ad SDK konsolunda, metrik kontrol panellerinde ve ilgili diğer görsel arayüzlerde gösterilir.

Alanlar
manufacturer

string

Zorunlu. Bu cihazın üreticisi (ör. "Google").

product_name

string

Zorunlu. Bu cihaz modeli için tüketicilere yönelik ürün adı (ör. "Google Asistan prototip cihazı").

device_description

string

Bu cihaz modeliyle ilgili isteğe bağlı açıklama (ör. "Google'ın sunduğu, Google Asistan özellikli akıllı hoparlör")

UpdateDeviceModelRequest

CihazlarPlatformService.UpdateDeviceModel için mesaj isteyin.

Alanlar
name

string

Cihaz modelinin güncelleneceği projenin projects/{project_id}/deviceModels/{device_model_id} biçimindeki kaynak adı

device_model

DeviceModel

Geliştiricinin güncelleme yapmak istediği yeni cihaz modeli.