AppRequest

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 (User)
  },
  "device": {
    object (Device)
  },
  "surface": {
    object (Surface)
  },
  "conversation": {
    object (Conversation)
  },
  "inputs": [
    {
      object (Input)
    }
  ],
  "isInSandbox": boolean,
  "availableSurfaces": [
    {
      object (Surface)
    }
  ]
}
Pola
user

object (User)

Użytkownik, który rozpoczął rozmowę.

device

object (Device)

Informacje o urządzeniu, którego użytkownik używa do interakcji z akcją.

surface

object (Surface)

informacje o platformie, z którą użytkownik wchodzi w interakcję, np. czy może odtwarzać dźwięk czy ma ekran.

conversation

object (Conversation)

Przechowuje dane sesji, takie jak identyfikator i token rozmowy.

inputs[]

object (Input)

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

boolean

Wskazuje, czy żądanie powinno być obsługiwane w trybie piaskownicy.

availableSurfaces[]

object (Surface)

Powierzchnie dostępne do przekazania przez inne powierzchnie.

Użytkownik

Zapis JSON
{
  "idToken": string,
  "profile": {
    object (UserProfile)
  },
  "accessToken": string,
  "permissions": [
    enum (Permission)
  ],
  "locale": string,
  "lastSeen": string,
  "userStorage": string,
  "packageEntitlements": [
    {
      object (PackageEntitlement)
    }
  ],
  "userVerificationStatus": enum (UserVerificationStatus)
}
Pola
idToken

string

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

object (UserProfile)

Informacje o użytkowniku. Niektóre pola są dostępne tylko wtedy, gdy użytkownik zezwolił na przekazanie tych informacji do akcji.

accessToken

string

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[]

enum (Permission)

Zawiera uprawnienia przyznane przez użytkownika do tej akcji.

locale

string

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

string (Timestamp format)

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: "2014-10-02T15:01:23.045123456Z".

userStorage

string

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[]

object (PackageEntitlement)

Lista uprawnień użytkowników do każdej nazwy pakietu wymienionej w pakiecie działań (jeśli występują).

userVerificationStatus

enum (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

string

Pełne imię i nazwisko użytkownika określone na jego koncie Google Wymaga uprawnienia NAME.

givenName

string

Imię użytkownika zgodne z jego kontem Google. Wymaga uprawnienia NAME.

familyName

string

Nazwisko użytkownika podane na jego koncie Google. Pamiętaj, że to pole może być puste. Wymaga uprawnienia NAME.

PackageEntitlement

Lista uprawnień związanych z nazwą pakietu

Zapis JSON
{
  "packageName": string,
  "entitlements": [
    {
      object (Entitlement)
    }
  ]
}
Pola
packageName

string

Nazwa powinna odpowiadać nazwie pakietu w pakiecie działań

entitlements[]

object (Entitlement)

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 (SkuType),
  "inAppDetails": {
    object (SignedData)
  }
}
Pola
sku

string

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

enum (SkuType)

inAppDetails

object (SignedData)

Widoczny tylko w przypadku zakupów w aplikacji i subskrypcji w aplikacji.

SignedData

Zapis JSON
{
  "inAppPurchaseData": {
    object
  },
  "inAppDataSignature": string
}
Pola
inAppPurchaseData

object (Struct format)

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

string

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 (Location)
  }
}
Pola
location

object (Location)

Przedstawia faktyczną lokalizację urządzenia, np. szerokość i długość geograficzną oraz sformatowany adres. Wymaga uprawnienia DEVICE_COARSE_LOCATION lub DEVICE_PRECISE_LOCATION.

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 (Capability)
    }
  ]
}
Pola
capabilities[]

object (Capability)

Lista funkcji obsługiwanych przez platformę w momencie żądania, np. actions.capability.AUDIO_OUTPUT

Możliwości

Reprezentuje jednostkę funkcjonalności, którą może obsługiwać platforma.

Zapis JSON
{
  "name": string
}
Pola
name

string

Nazwa funkcji, np. actions.capability.AUDIO_OUTPUT

Rozmowa

Zapis JSON
{
  "conversationId": string,
  "type": enum (ConversationType),
  "conversationToken": string
}
Pola
conversationId

string

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

enum (ConversationType)

typ wskazuje stan wątku w cyklu życia.

conversationToken

string

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 (RawInput)
    }
  ],
  "intent": string,
  "arguments": [
    {
      object (Argument)
    }
  ]
}
Pola
rawInputs[]

object (RawInput)

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

string

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 actions.intent.OPTION, to intencja wskazana w tym miejscu będzie miała postać actions.intent.OPTION, jeśli Asystent Google był w stanie spełnić tę intencję, lub actions.intent.TEXT, jeśli użytkownik podał inne informacje. Więcej informacji znajdziesz na stronie https://developers.google.com/assistant/df-asdk/reference/intents.

arguments[]

object (Argument)

Lista wartości argumentów podanych dla danych wejściowych zażądanych przez działanie.

RawInput

Zapis JSON
{
  "inputType": enum (InputType),

  // Union field input can be only one of the following:
  "query": string,
  "url": string
  // End of list of possible types for union field input.
}
Pola
inputType

enum (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

string

Wprowadzone lub wypowiadane przez użytkownika dane wejściowe.

url

string

Adres URL wyzwalający.