AppRequest

Eine App-Anfrage 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 für die Verwendung dieser Informationen in Actions on Google 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 gestartet hat

device

object (Device)

Informationen zu dem Gerät, das der Nutzer für die Interaktion mit der Aktion verwendet.

surface

object (Surface)

Informationen über die Oberfläche, mit der Nutzende interagieren, z.B. ob sie Audio ausgeben kann oder über einen Bildschirm verfügt.

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 von der Aktion angegeben wurden. Für den Trigger der ersten Unterhaltung enthält die Eingabe Informationen darüber, 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 Cross-Oberfläche-Übermittlung 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 mit einem codierten Profil. Die Definition finden Sie unter https://developers.google.com/identity/protocols/OpenIDConnect#obtainuserinfo.

profile

object (UserProfile)

Informationen über die Endnutzer. Einige Felder sind nur verfügbar, wenn der Nutzer die entsprechende Berechtigung für die Aktion erteilt hat.

accessToken

string

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

permissions[]

enum (Permission)

Enthält Berechtigungen, die der Nutzer für diese Aktion gewährt hat.

locale

string

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

lastSeen

string (Timestamp format)

Zeitstempel der letzten Interaktion mit diesem Nutzer Dieses Feld wird weggelassen, wenn der Nutzer noch nicht mit dem Agent interagiert hat.

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

userStorage

string

Ein von der Anwendung bereitgestelltes intransparentes Token, das für alle Konversationen eines bestimmten Nutzers beibehalten wird. Der String darf maximal 10.000 Zeichen lang sein.

packageEntitlements[]

object (PackageEntitlement)

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

userVerificationStatus

enum (UserVerificationStatus)

Gibt den Bestätigungsstatus des Nutzers an.

UserProfile

Enthält die personenbezogenen Daten des Nutzers. Die Felder werden nur gefüllt, wenn der Nutzer der Aktion die entsprechende Berechtigung für ein bestimmtes Feld erteilt hat.

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

string

Der vollständige Name des Nutzers, wie im Google-Konto angegeben. Erfordert die Berechtigung NAME.

givenName

string

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

familyName

string

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

PackageEntitlement

Liste der Berechtigungen für einen Paketnamen

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

string

Muss mit dem Paketnamen im Aktionspaket übereinstimmen

entitlements[]

object (Entitlement)

Liste der Berechtigungen für eine bestimmte App

Berechtigung

Definiert die digitale Berechtigung eines Nutzers. Arten möglicher 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 App, Suffix „Finsky docid“ für In-App-Käufe und In-App-Abos. Stimmt mit „getSku()“ in der Play InApp Billing API überein.

skuType

enum (SkuType)

inAppDetails

object (SignedData)

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

SignedData

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

object (Struct format)

Gleicht INAPP_PURCHASE_DATA aus der getPurchases()-Methode ab. 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 IN_APP_DATA_SIGNATURE aus der getPurchases()-Methode in der Play InApp Billing API überein.

Gerät

Informationen zu dem Gerät, das der Nutzer für die Interaktion mit der Aktion verwendet.

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

object (Location)

Gibt den tatsächlichen Gerätestandort an, z. B. Breitengrad, Längengrad und formatierte Adresse. Erfordert die Berechtigung DEVICE_COARSE_LOCATION oder DEVICE_PRECISE_LOCATION.

Plattform/Oberfläche

Informationen, die sich auf die Google Assistant-Clientoberfläche beziehen, mit der der Nutzer interagiert. Die Oberfläche unterscheidet sich dadurch von einem Gerät, dass 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 die Oberfläche zum Zeitpunkt der Anfrage unterstützt, z.B. actions.capability.AUDIO_OUTPUT

Funktion

Stellt eine Funktionseinheit dar, die die Oberfläche unterstützen kann.

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

string

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

Unterhaltung

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

string

Eindeutige ID für die Multi-Turn-Unterhaltung. Sie ist für die erste Abzweigung zugewiesen. Danach bleibt sie für alle nachfolgenden Unterhaltungen gleich, bis sie beendet wird.

type

enum (ConversationType)

type gibt den Status der Konversation in ihrem Lebenszyklus an.

conversationToken

string

Intransparentes Token, das von der Aktion in der letzten Unterhaltungsrunde angegeben wurde. Sie kann von einer Aktion verwendet werden, um die Unterhaltung zu verfolgen oder konversationelle Daten zu speichern.

Eingabe

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

object (RawInput)

Transkription von Rohdaten aus jeder Unterhaltungsrunde. Für Aktionen in Google, um bestimmte Arten von Input für die Aktion bereitzustellen, können mehrere Unterhaltungsrunden erforderlich sein.

intent

string

Gibt den Intent des Nutzers an. In der ersten Unterhaltungsrunde bezieht sich der Intent auf den auslösenden Intent für die Aktion. Bei nachfolgenden Unterhaltungsrunden ist der Intent eine gängige Aktion in Google-Intent, die mit „actions.“ beginnt. 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 weitere Informationen angegeben hat. Weitere Informationen finden Sie unter https://developers.google.com/assistant/df-asdk/reference/intents.

arguments[]

object (Argument)

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

RawInput

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 gemacht hat: eine eingegebene Antwort, eine Sprachantwort, keine Angabe usw.

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

string

Durch Tippen oder gesprochene Eingabe des Endnutzers

url

string

Die auslösende URL.