AppRequest

AppRequest ist eine Anfrage, die von Google Assistant an eine Auftragsausführung gesendet wird, um mit einer Aktion zu interagieren. Die API-Version wird im HTTP-Header angegeben. Bei API-Version 1 enthält der Header Google-Assistant-API-Version: v1. Bei API-Version 2 enthält der Header Google-actions-API-Version: 2. Beispiele dafür, wie diese Funktionen in Google-Aktionen verwendet werden, finden Sie unter https://developers.google.com/assistant/df-asdk/reference/conversation-webhook-json .

JSON-Darstellung
{
  "user": {
    object (User)
  },
  "device": {
    object (Device)
  },
  "surface": {
    object (Surface)
  },
  "conversation": {
    object (Conversation)
  },
  "inputs": [
    {
      object (Input)
    }
  ],
  "isInSandbox": boolean,
  "availableSurfaces": [
    {
      object (Surface)
    }
  ]
}
Felder
user

object (User)

Nutzer, der die Unterhaltung initiiert hat.

device

object (Device)

Informationen zu dem Gerät, über das der Nutzer mit der Aktion interagiert.

surface

object (Surface)

Informationen zu der Oberfläche, mit der der Nutzer interagiert, z. B. ob es Audio ausgeben oder einen Bildschirm haben kann

conversation

object (Conversation)

Enthält Sitzungsdaten wie die Unterhaltungs-ID und das Unterhaltungstoken.

inputs[]

object (Input)

Liste der Eingaben, die den erwarteten Eingaben entsprechen, die durch die Aktion angegeben werden. Beim ersten Trigger für die Unterhaltung enthält die Eingabe Informationen dazu, wie der Nutzer die Unterhaltung ausgelöst hat.

isInSandbox

boolean

Gibt an, ob die Anfrage im Sandbox-Modus verarbeitet werden soll.

availableSurfaces[]

object (Surface)

Oberflächen, die für die plattformübergreifende Übergabe verfügbar sind

Nutzer

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

string

Token, das die Identität des Nutzers darstellt. Dies ist ein JSON-Webtoken, das ein codiertes Profil enthält. Die Definition findest du unter https://developers.google.com/identity/protokolls/OpenIDConnect#obtainuserinfo.

profile

object (UserProfile)

Informationen zum Endnutzer. Einige Felder sind nur verfügbar, wenn der Nutzer die Berechtigung zur Bereitstellung dieser Informationen für die Aktion erteilt hat.

accessToken

string

Ein OAuth2-Token, das den Nutzer in Ihrem System identifiziert. Nur verfügbar, wenn der Nutzer sein Konto verknüpft.

permissions[]

enum (Permission)

Enthält Berechtigungen, die der Nutzer dieser Aktion gewährt hat.

locale

string

Primäre Sprache des Nutzers, der die Anfrage stellt. Folgt dem IETF-BCP-47-Sprachcode http://www.rfc-editor.org/rfc/bcp/bcp47.txt, aber das Skript-Subtag ist nicht enthalten.

lastSeen

string (Timestamp format)

Der Zeitstempel der letzten Interaktion mit diesem Nutzer. Das Feld wird weggelassen, wenn der Nutzer noch nie mit dem Agent interagiert hat.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ in Nanosekunden. Beispiel: "2014-10-02T15:01:23.045123456Z".

userStorage

string

Ein verschlüsseltes Token, das von der Anwendung bereitgestellt wird und in Unterhaltungen für einen bestimmten Nutzer gespeichert wird. Der String darf maximal 10.000 Zeichen lang sein.

packageEntitlements[]

object (PackageEntitlement)

Liste der Nutzerberechtigungen für jeden im Aktionspaket aufgeführten Paketnamen.

userVerificationStatus

enum (UserVerificationStatus)

Gibt den Bestätigungsstatus des Nutzers an.

Benutzerprofil

Enthält die personenbezogenen Daten des Nutzers. Felder werden nur ausgefüllt, wenn der Nutzer die Berechtigung für die Aktion in einem bestimmten Feld erteilt.

JSON-Darstellung
{
  "displayName": string,
  "givenName": string,
  "familyName": string
}
Felder
displayName

string

Der vollständige Name des Nutzers, wie er in seinem Google-Konto angegeben ist. Erfordert die Berechtigung NAME.

givenName

string

Der Vorname des Nutzers, wie er in seinem Google-Konto angegeben ist. Erfordert die Berechtigung NAME.

familyName

string

Der Nachname des Nutzers, wie er in seinem Google-Konto angegeben ist. Dieses Feld kann leer sein. Erfordert die Berechtigung NAME.

Paketentfernung

Liste der Berechtigungen für einen Paketnamen

JSON-Darstellung
{
  "packageName": string,
  "entitlements": [
    {
      object (Entitlement)
    }
  ]
}
Felder
packageName

string

Sollte mit dem Paketnamen im Aktionspaket übereinstimmen

entitlements[]

object (Entitlement)

Liste der Berechtigungen für eine bestimmte App

Entitlement

Definiert die digitale Berechtigung eines Nutzers. Mögliche Berechtigungen: kostenpflichtige Apps,In-App-Käufe, In-App-Abos

JSON-Darstellung
{
  "sku": string,
  "skuType": enum (SkuType),
  "inAppDetails": {
    object (SignedData)
  }
}
Felder
sku

string

Produkt-SKU. Paketname für kostenpflichtige Apps, Suffix von Finsky Docid für In-App-Kauf und In-App-Abo. Gleicht „getSku()“ in der Play InApp Billing API ab.

skuType

enum (SkuType)

inAppDetails

object (SignedData)

Nur für In-App-Käufe und In-App-Abos vorhanden.

Signierte Daten

JSON-Darstellung
{
  "inAppPurchaseData": {
    object
  },
  "inAppDataSignature": string
}
Felder
inAppPurchaseData

object (Struct format)

Übereinstimmung mit INAPP_PURCHASE_DATA der Methode „getPurchases()“. Enthält alle Daten zu In-App-Käufen im JSON-Format. Weitere Informationen finden Sie in Tabelle 6 unter https://developer.android.com/google/play/billing/billing_reference.html.

inAppDataSignature

string

Stimmt mit der IN_APP_DATA_SIGNATURE der Methode „getPurchases()“ in der Play InApp Billing API überein.

Geräte

Informationen zu dem Gerät, über das der Nutzer mit der Aktion interagiert.

JSON-Darstellung
{
  "location": {
    object (Location)
  }
}
Felder
location

object (Location)

Der tatsächliche Gerätestandort, z. B. Breitengrad, Längengrad und formatierte Adresse. Erfordert die Berechtigung DEVICE_COARSE_LOCATION oder DEVICE_PRECISE_LOCATION.

Erdoberfläche

Spezifische Informationen für die Google Assistant-Clientoberfläche, mit der der Nutzer interagiert. Die Oberfläche unterscheidet sich vom Gerät, da sich mehrere Assistant-Oberflächen auf demselben Gerät befinden können.

JSON-Darstellung
{
  "capabilities": [
    {
      object (Capability)
    }
  ]
}
Felder
capabilities[]

object (Capability)

Eine Liste der Funktionen, die zum Zeitpunkt der Anfrage von der Oberfläche unterstützt werden, z.B. actions.capability.AUDIO_OUTPUT

Rechte

Eine Funktionseinheit, die die Oberfläche unterstützt.

JSON-Darstellung
{
  "name": string
}
Felder
name

string

Der Name der Funktion, z. B. actions.capability.AUDIO_OUTPUT.

Unterhaltung

JSON-Darstellung
{
  "conversationId": string,
  "type": enum (ConversationType),
  "conversationToken": string
}
Felder
conversationId

string

Eindeutige ID für die Unterhaltung mit mehreren Richtungen. Sie ist für die erste Abzweigung zugewiesen. Danach bleibt es bei einer nachfolgenden Unterhaltung unverändert, bis die Unterhaltung beendet wird.

type

enum (ConversationType)

type gibt den Status der Unterhaltung im Lebenszyklus an.

conversationToken

string

Undurchsichtiges Token, das durch die Aktion in der letzten Unterhaltung angegeben wurde. Damit kann eine Aktion verwendet werden, um die Unterhaltung zu verfolgen oder Daten in Unterhaltung zu speichern.

Eingabe

JSON-Darstellung
{
  "rawInputs": [
    {
      object (RawInput)
    }
  ],
  "intent": string,
  "arguments": [
    {
      object (Argument)
    }
  ]
}
Felder
rawInputs[]

object (RawInput)

Rohtranskription der einzelnen Unterhaltungsrunden. Damit Aktionen auf Google eine Art von Eingabe liefern können, sind unter Umständen mehrere Unterhaltungsrunden erforderlich.

intent

string

Damit wird die Absicht des Nutzers angegeben. In der ersten Unterhaltungsrunde bezieht sich der Intent auf den auslösenden Intent für die Aktion. Bei weiteren Unterhaltungsthreads ist der Intent eine gängige Aktion bei Google Intent (beginnt mit „actions“). Wenn die erwartete Eingabe beispielsweise actions.intent.OPTION ist, ist der hier angegebene Intent entweder actions.intent.OPTION, wenn Google Assistant diesen Intent erfüllen konnte, oder actions.intent.TEXT, wenn der Nutzer andere Informationen angegeben hat. Weitere Informationen finden Sie unter https://developers.google.com/assistant/df-asdk/reference/intents.

arguments[]

object (Argument)

Eine Liste mit bereitgestellten Argumentwerten für die von der Aktion angeforderte Eingabe.

Roheingabe

JSON-Darstellung
{
  "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.
}
Felder
inputType

enum (InputType)

Gibt an, wie der Nutzer diese Eingabe bereitgestellt hat: eine eingegebene Antwort, eine Sprachantwort, nicht angegeben usw.

Union-Feld input. Der tatsächliche Eingabewert input kann nur einer der folgenden Werte sein:
query

string

Eingegebene oder gesprochene Eingabe des Endnutzers.

url

string

Die auslösende URL.