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 für die Verwendung 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 begonnen hat.
device

object (Device)

Informationen zu dem Gerät, das der Nutzer verwendet, um mit der Aktion zu interagieren.
surface

object (Surface)

Informationen über die Oberfläche, mit der der Nutzer interagiert, z.B. ob es Audio ausgibt oder einen Bildschirm hat.
conversation

object (Conversation)

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

object (Input)

Liste der Eingaben, die den von der Aktion angegebenen erwarteten Eingaben entsprechen. Für den ersten Unterhaltungstrigger 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)

Verfügbare Oberflächen für die oberflächenübergreifende Übergabe.

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 codiertem Profil. Die Definition finden Sie unter https://developers.google.com/identity/protocols/OpenIDConnect#obtainuserinfo.
profile

object (UserProfile)

Informationen über den Endanwendenden. Einige Felder sind nur verfügbar, wenn der Benutzer die Berechtigung erteilt hat, diese Informationen an die Aktion bereitzustellen.
accessToken

string

Ein OAuth2-Token, das den Nutzer in Ihrem System identifiziert. Diese Option ist nur verfügbar, wenn der Nutzer sein Konto verknüpft hat.
permissions[]

enum (Permission)

Enthält Berechtigungen, die der Nutzer für diese Aktion erteilt hat.
locale

string

Einstellung des primären Gebietsschemas des Nutzers, der die Anfrage stellt. Entspricht dem IETF-BCP-47-Sprachcode http://www.rfc-editor.org/rfc/bcp/bcp47.txt. Das Script-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 intransparentes Token, das von der Anwendung bereitgestellt wird und in den Unterhaltungen 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, sofern vorhanden.
userVerificationStatus

enum (UserVerificationStatus)

Zeigt den Bestätigungsstatus des Nutzers an.

UserProfile

Enthält die personenbezogenen Daten des Nutzers. Felder werden nur ausgefüllt, wenn der User-User der Aktion die Berechtigung für ein bestimmtes Feld gewährt.

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

string

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

string

Der im Google-Konto des Nutzers angegebene Vorname. Erfordert die Berechtigung NAME.
familyName

string

Der im Google-Konto des Nutzers angegebene Nachname. Dieses Feld kann leer sein. Erfordert die Berechtigung NAME.

PackageEntitlement

Liste der Berechtigungen, die sich auf einen Paketnamen beziehen

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-Artikelposition (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)

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

Gerät

Informationen zu dem Gerät, das der Nutzer verwendet, um mit der Aktion zu interagieren.

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

object (Location)

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

Plattform/Oberfläche

Informationen, die für die Google Assistant-Clientoberfläche spezifisch sind, mit der der Nutzer interagiert. Geräte unterscheiden sich von Geräten dadurch, dass auf demselben Gerät mehrere Assistant-Oberflächen verwendet werden 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 von der Oberfläche unterstützt werden 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 Unterhaltung in mehreren Schritten. Es wird für die erste Abzweigung zugewiesen. Danach bleibt sie für alle nachfolgenden Unterhaltungsrunden gleich, bis die Unterhaltung beendet wird.
type

enum (ConversationType)

type gibt den Status der Unterhaltung in ihrem Lebenszyklus an.
conversationToken

string

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

Eingabe

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

object (RawInput)

Transkription von Rohdaten zu jeder Unterhaltungsrunde. Damit Aktionen auf Google bestimmte Arten von Eingaben für die Aktion ermöglichen können, sind möglicherweise mehrere Unterhaltungsrunden erforderlich.
intent

string

Gibt die Absicht 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 auf Google-Intent und 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 weitere Informationen angegeben hat. Weitere Informationen finden Sie unter https://developers.google.com/assistant/df-asdk/reference/intents.
arguments[]

object (Argument)

Eine Liste der angegebenen 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 die Eingabe eingegeben hat: eine getippte Antwort, eine Sprachantwort, nicht angegeben usw.
Union-Feld input. Der tatsächliche Eingabewert input darf nur einer der folgenden Werte sein:
query

string

Eingabe oder gesprochene Eingabe des Endnutzers
url

string

Die Trigger-URL.