AppRequest

AppRequest to żądanie wysyłane przez Asystenta Google do realizacji, aby umożliwić interakcję z akcją. Wersja interfejsu API jest podana w nagłówku HTTP. W interfejsie API w wersji 1 nagłówek zawiera: Google-Assistant-API-Version: v1. W interfejsie API w wersji 2 nagłówek zawiera: Google-actions-API-Version: 2. Przykłady wykorzystania tych danych 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 zainicjował rozmowę.

device

object (Device)

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

surface

object (Surface)

Informacje o powierzchni, z którą użytkownik wchodzi w interakcję, np. czy może ona generować dźwięk lub mieć 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 akcję. W przypadku początkowego wyzwalacza 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 na powierzchnię krzyżową.

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 sieciowy Json zawierający zakodowany profil. Definicja jest dostępna pod adresem 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. Dostępne tylko wtedy, gdy użytkownik połączy swoje konto.

permissions[]

enum (Permission)

Zawiera uprawnienia przyznane tej akcji przez użytkownika.

locale

string

Ustawienie języka głównego użytkownika wysyłającego żądanie. Jest zgodny z kodem języka IETF BCP-47 http://www.rfc-editor.org/rfc/bcp/bcp47.txt Nie zawiera jednak subtagu skryptu.

lastSeen

string (Timestamp format)

Sygnatura czasowa ostatniej interakcji z tym użytkownikiem. To pole jest pomijane, jeśli użytkownik nie miał wcześniej kontaktu 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

Nieprzejrzysty token dostarczony przez aplikację, który jest trwały w rozmowach konkretnego użytkownika. Maksymalny rozmiar ciągu to 10 tys. znaków.

packageEntitlements[]

object (PackageEntitlement)

Lista uprawnień użytkowników związanych z każdą nazwą pakietu wymienionego w pakiecie akcji (jeśli jakieś 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 wyraził zgodę na działanie dla określonego pola.

Zapis JSON
{
  "displayName": string,
  "givenName": string,
  "familyName": string
}
Pola
displayName

string

Imię i nazwisko użytkownika podane na jego koncie Google. Wymaga uprawnienia NAME.

givenName

string

Imię użytkownika podane na koncie Google. Wymaga uprawnienia NAME.

familyName

string

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

PackageEntitlement

Lista uprawnień powiązanych z nazwą pakietu

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

string

Powinna odpowiadać nazwie pakietu w pakiecie akcji.

entitlements[]

object (Entitlement)

Lista uprawnień danej aplikacji

Uprawnienie

Określa cyfrowe uprawnienia 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, sufiks Docidu Finsky w przypadku zakupu w aplikacji i subskrypcji w aplikacji. Dopasuj do metody getSku() w interfejsie Play InApp Billing API.

skuType

enum (SkuType)

inAppDetails

object (SignedData)

Dostępne 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)

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

Platforma

Informacje specyficzne dla klienta Asystenta Google, z którymi użytkownik wchodzi w interakcję. Platforma różni się od urządzenia tym, że na tym samym urządzeniu może znajdować się wiele platform Asystenta.

Zapis JSON
{
  "capabilities": [
    {
      object (Capability)
    }
  ]
}
Pola
capabilities[]

object (Capability)

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

Funkcja

Reprezentuje jednostkę funkcji, którą może obsługiwać powierzchnia.

Zapis JSON
{
  "name": string
}
Pola
name

string

Nazwa możliwości, np. actions.capability.AUDIO_OUTPUT

Rozmowa

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

string

Unikalny identyfikator rozmowy wieloetapowej. Jest przypisana do pierwszej zakrętu. Po tym czasie rozmowa nie zmieni się, dopóki rozmowa nie zostanie zakończona.

type

enum (ConversationType)

Typ określa stan wątku w jego cyklu życia.

conversationToken

string

Nieprzezroczysty token określony przez akcję w ostatnim cyklu rozmowy. Akcja może go używać do śledzenia rozmowy lub do przechowywania danych dotyczących rozmowy.

Dane wejściowe

Zapis JSON
{
  "rawInputs": [
    {
      object (RawInput)
    }
  ],
  "intent": string,
  "arguments": [
    {
      object (Argument)
    }
  ]
}
Pola
rawInputs[]

object (RawInput)

Nieprzetworzona transkrypcja danych wejściowych z każdego etapu rozmowy. W przypadku działań w Google w celu dostarczenia do akcji niektórych typów danych wejściowych może być wymagane wielokrotne przejście do rozmowy.

intent

string

Wskazuje zamiar użytkownika. W przypadku pierwszej tury rozmowy intencja odwołuje się do intencji wyzwalającej akcję. W kolejnych sekwencjach rozmowy intencja będzie typowym działaniem w związku z intencją Google (zaczyna się od „działania”). Jeśli na przykład oczekiwane dane wejściowe to actions.intent.OPTION, intencja określona w tym miejscu będzie wyglądać tak: actions.intent.OPTION, jeśli Asystent Google 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 podanych wartości argumentów dla danych wejściowych wymaganych przez akcję.

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ź zapisana, głosowa, nieokreślona itp.

Pole sumy input. Rzeczywista wartość wejściowa input może być tylko jedną z tych wartości:
query

string

wpisywane lub odczytywane przez użytkownika;

url

string

URL wyzwalający.