- Zapis JSON
- Użytkownik
- UserProfile
- PackageEntitlement
- Uprawnienie
- SignedData
- Urządzenie
- Platforma
- Zdolność
- Rozmowa
- Dane wejściowe
- RawInput
AppRequest to żądanie wysłane przez Asystenta Google do realizacji, które umożliwia interakcję z akcją. Wersja interfejsu API jest podawana w nagłówku HTTP. W przypadku interfejsu API w wersji 1 nagłówek zawiera: Google-Assistant-API-Version: v1
. W przypadku interfejsu API w wersji 2 nagłówek zawiera: Google-actions-API-Version: 2
. Przykłady wykorzystania tego obiektu w działaniach Google znajdziesz na stronie https://developers.google.com/assistant/df-asdk/reference/conversation-webhook-json .
Zapis JSON | |
---|---|
{ "user": { object ( |
Pola | |
---|---|
user |
Użytkownik, który rozpoczął rozmowę. |
device |
Informacje o urządzeniu, którego użytkownik używa do interakcji z akcją. |
surface |
informacje o platformie, z którą użytkownik wchodzi w interakcję, np. czy może odtwarzać dźwięk czy ma ekran. |
conversation |
Przechowuje dane sesji, takie jak identyfikator i token rozmowy. |
inputs[] |
Lista danych wejściowych odpowiadających oczekiwanym danym wejściowym określonym przez działanie. W przypadku początkowego wywołania rozmowy dane wejściowe zawierają informacje o tym, jak użytkownik wywołał rozmowę. |
isInSandbox |
Wskazuje, czy żądanie powinno być obsługiwane w trybie piaskownicy. |
availableSurfaces[] |
Powierzchnie dostępne do przekazania przez inne powierzchnie. |
Użytkownik
Zapis JSON | |
---|---|
{ "idToken": string, "profile": { object ( |
Pola | |
---|---|
idToken |
token reprezentujący tożsamość użytkownika. To jest token internetowy JSON zawierający zakodowany profil. Definicja znajduje się na stronie https://developers.google.com/identity/protocols/OpenIDConnect#obtainuserinfo. |
profile |
Informacje o użytkowniku. Niektóre pola są dostępne tylko wtedy, gdy użytkownik zezwolił na przekazanie tych informacji do akcji. |
accessToken |
Token OAuth2, który identyfikuje użytkownika w Twoim systemie. Ta opcja jest dostępna tylko wtedy, gdy użytkownik połączy swoje konto. |
permissions[] |
Zawiera uprawnienia przyznane przez użytkownika do tej akcji. |
locale |
Główne ustawienie regionalne użytkownika wysyłającego żądanie. Jest zgodny z kodem języka IETF BCP-47 http://www.rfc-editor.org/rfc/bcp/bcp47.txt, jednak podtag skryptu nie został dołączony. |
lastSeen |
Sygnatura czasowa ostatniej interakcji z tym użytkownikiem. To pole jest pomijane, jeśli użytkownik nie wchodził wcześniej w interakcję z agentem. Znacznik czasu w formacie RFC3339 UTC „Zulu”, z dokładnością do nanosekund. Przykład: |
userStorage |
Nieprzezroczysty token udostępniany przez aplikację, który jest zachowywany we wszystkich wątkach danego użytkownika. Maksymalny rozmiar ciągu to 10 tys. znaków. |
packageEntitlements[] |
Lista uprawnień użytkowników do każdej nazwy pakietu wymienionej w pakiecie działań (jeśli występują). |
userVerificationStatus |
Wskazuje stan weryfikacji użytkownika. |
UserProfile
Zawiera dane osobowe użytkownika. Pola są wypełniane tylko wtedy, gdy użytkownik zezwoli na działanie w odniesieniu do określonego pola.
Zapis JSON | |
---|---|
{ "displayName": string, "givenName": string, "familyName": string } |
Pola | |
---|---|
displayName |
Pełne imię i nazwisko użytkownika określone na jego koncie Google Wymaga uprawnienia |
givenName |
Imię użytkownika zgodne z jego kontem Google. Wymaga uprawnienia |
familyName |
Nazwisko użytkownika podane na jego koncie Google. Pamiętaj, że to pole może być puste. Wymaga uprawnienia |
PackageEntitlement
Lista uprawnień związanych z nazwą pakietu
Zapis JSON | |
---|---|
{
"packageName": string,
"entitlements": [
{
object ( |
Pola | |
---|---|
packageName |
Nazwa powinna odpowiadać nazwie pakietu w pakiecie działań |
entitlements[] |
Lista uprawnień danej aplikacji |
Uprawnienie
Określa cyfrowe uprawnienie użytkownika. Rodzaje możliwych uprawnień: płatne aplikacje,zakupy w aplikacji, subskrypcje w aplikacji.
Zapis JSON | |
---|---|
{ "sku": string, "skuType": enum ( |
Pola | |
---|---|
sku |
Kod SKU produktu Nazwa pakietu płatnej aplikacji, przyrostek Docid Finsky w przypadku zakupów w aplikacji i subskrypcji. Dopasuj getSku() w interfejsie Play InApp Billing API. |
skuType |
|
inAppDetails |
Widoczny tylko w przypadku zakupów w aplikacji i subskrypcji w aplikacji. |
SignedData
Zapis JSON | |
---|---|
{ "inAppPurchaseData": { object }, "inAppDataSignature": string } |
Pola | |
---|---|
inAppPurchaseData |
Dopasuj INAPP_PURCHASE_DATA z metody getPurchases(). Zawiera wszystkie dane o zakupach w aplikacji w formacie JSON. Szczegółowe informacje znajdziesz w tabeli 6 na stronie https://developer.android.com/google/play/billing/billing_reference.html. |
inAppDataSignature |
Pasuje do IN_APP_DATA_SIGNATURE z metody getPurchases() w interfejsie Play InApp Billing API. |
Urządzenie
Informacje o urządzeniu, którego użytkownik używa do interakcji z akcją.
Zapis JSON | |
---|---|
{
"location": {
object ( |
Pola | |
---|---|
location |
Przedstawia faktyczną lokalizację urządzenia, np. szerokość i długość geograficzną oraz sformatowany adres. Wymaga uprawnienia |
Platforma
Informacje dotyczące platformy klienckiej Asystenta Google, z którą użytkownik wchodzi w interakcję. Platforma różni się od urządzenia tym, że na tym samym urządzeniu może się znajdować kilka platform z Asystentem.
Zapis JSON | |
---|---|
{
"capabilities": [
{
object ( |
Pola | |
---|---|
capabilities[] |
Lista funkcji obsługiwanych przez platformę w momencie żądania, np. |
Możliwości
Reprezentuje jednostkę funkcjonalności, którą może obsługiwać platforma.
Zapis JSON | |
---|---|
{ "name": string } |
Pola | |
---|---|
name |
Nazwa funkcji, np. |
Rozmowa
Zapis JSON | |
---|---|
{
"conversationId": string,
"type": enum ( |
Pola | |
---|---|
conversationId |
Unikalny identyfikator rozmowy wieloetapowej. Zostanie ono przypisane na pierwszą turę. Później pozostaje bez zmian w kolejnych etapach rozmowy, dopóki rozmowa nie zostanie zakończona. |
type |
typ wskazuje stan wątku w cyklu życia. |
conversationToken |
Nieprzezroczysty token określony przez działanie w ostatniej turze wątku. Akcja może służyć do śledzenia rozmowy lub przechowywania związanych z nią danych. |
Dane wejściowe
Zapis JSON | |
---|---|
{ "rawInputs": [ { object ( |
Pola | |
---|---|
rawInputs[] |
Nieprzetworzona transkrypcja tekstu z każdego etapu rozmowy. Aby działania w Google miały dostęp do pewnych rodzajów danych wejściowych, może być wymagane kilka turów rozmów. |
intent |
Wskazuje zamiar użytkownika. W pierwszej turze rozmowy intencja będzie odnosić się do intencji wyzwalającej działanie. W kolejnych etapach rozmowy intencją będzie częste działanie intencji Google (rozpoczyna się od „actions”). Jeśli na przykład oczekiwane dane wejściowe to |
arguments[] |
Lista wartości argumentów podanych dla danych wejściowych zażądanych przez działanie. |
RawInput
Zapis JSON | |
---|---|
{ "inputType": enum ( |
Pola | ||
---|---|---|
inputType |
Wskazuje, w jaki sposób użytkownik podał dane wejściowe: odpowiedź wpisaną, odpowiedź głosową, nieokreśloną odpowiedź itp. |
|
Pole sumy input . Rzeczywista wartość wejściowa input może mieć tylko jedną z tych wartości: |
||
query |
Wprowadzone lub wypowiadane przez użytkownika dane wejściowe. |
|
url |
Adres URL wyzwalający. |