ActionPackage

ActionPackage enthält den Inhalt des Entwurfs einer App sowie jede bereitgestellte Version. Dazu gehören Details zu Verzeichniseinträgen, die Konfiguration von Unterhaltungen und die Kontoverknüpfung.

JSON-Darstellung
{
  "manifest": {
    object (Manifest)
  },
  "accountLinking": {
    object (AccountLinking)
  },
  "actions": [
    {
      object (Action)
    }
  ],
  "types": [
    {
      object (Type)
    }
  ],
  "conversations": {
    string: {
      object(ConversationFulfillment)
    },
    ...
  },
  "locale": string
}
Felder
manifest

object (Manifest)

Die Details der App. Hier werden die Verzeichnisliste sowie andere App-IDs wie displayName gespeichert.

accountLinking

object (AccountLinking)

Details zur Kontoverknüpfung in dieser App.

actions[]

object (Action)

Liste der Aktionen, die die App ausführen kann.

types[]

object (Type)

Liste der vom Entwickler definierten Typen.

conversations

map (key: string, value: object (ConversationFulfillment))

Unterhaltungen zuordnen, die in actions geteilt werden können. Ein Beispiel hierfür ist der conversationName in Fulfillment.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

locale

string

Die Sprache für dieses Aktionspaket. Dies wird durch BCP-47-Sprachstrings wie „en“, „en-US“, „fr“, „fr-CA“, „sr-Latn“, „zh-Hans“, „zh-Hans-CN“, „zh-Hant“, „zh-Hant-HK“ usw. dargestellt. Dies ist erforderlich, wenn eine App mehr als eine Sprache unterstützt. Jede unterstützte Sprache hat ein eigenes ActionPackage. Wenn kein Wert angegeben ist, wird die Standardsprache des Agents impliziert.

Manifest

Der Metadatensatz für die App. Der Inhalt dieser Nachricht wird in mehreren Kontexten verwendet:

  1. Aktionen auf der Eintragsseite des Google-Verzeichnisses.
  2. Eindeutige Identifizierung einer App für den expliziten Aufruf (displayName).
  3. Inhalte für andere Teile eines ActionPackage (shortDescription wird zur Anzeige in AccountLinking verwendet, displayName wird in actions verwendet, um Nutzern den App-Namen anzuzeigen).

Diese Nachricht ist schreibgeschützt. Die Felder in dieser Nachricht geben Sie über die Aktionskonsole und nicht direkt im Aktionspaket an.

JSON-Darstellung
{
  "displayName": string,
  "invocationName": string,
  "enabledRegions": [
    string
  ],
  "disabledRegions": [
    string
  ],
  "shortDescription": string,
  "longDescription": string,
  "category": string,
  "smallSquareLogoUrl": string,
  "largeLandscapeLogoUrl": string,
  "companyName": string,
  "contactEmail": string,
  "termsOfServiceUrl": string,
  "privacyUrl": string,
  "sampleInvocation": [
    string
  ],
  "introduction": string,
  "testingInstructions": string,
  "voiceName": string,
  "externalVoiceName": string,
  "voiceLocale": string,
  "surfaceRequirements": {
    object (SurfaceRequirements)
  }
}
Felder
displayName

string

Der standardmäßige Anzeigename für diese App (falls keine Übersetzung verfügbar ist), z.B. „Starbucks“. Dies wird auch als Methode für Nutzer zum Aufrufen dieser App (zusätzlich zu invocationName) verwendet. Der Anzeigename muss eindeutig sein und invocationName in ihrer Lautbildung sehr ähnlich sein.

invocationName

string

Dies ist der eindeutige Name für diese App, um sie direkt innerhalb eines Sprachkontexts (gesprochen) aufzurufen. Gemäß den Richtlinien muss der Aufrufname dem Feld displayName phonetisch sehr ähnlich sein.

enabledRegions[]

string (int64 format)

Die AdWords-Kriteriums-IDs für die Regionen, in denen die App zulässig ist (basierend auf dem Standort des Nutzers). Siehe https://developers.google.com/adwords/api/docs/appendix/geotargeting

disabledRegions[]

string (int64 format)

Die AdWords-Kriteriums-IDs für die Regionen, in denen die App auf Grundlage des aktuellen Standorts des Nutzers blockiert ist. Siehe https://developers.google.com/adwords/api/docs/appendix/geotargeting

shortDescription

string

Die standardmäßige Kurzbeschreibung für die App (falls keine Übersetzung verfügbar ist). Dieser ist auf 80 Zeichen beschränkt.

longDescription

string

Die standardmäßige lange Beschreibung der App (falls keine Übersetzung verfügbar ist). Dieser ist auf 4.000 Zeichen beschränkt.

category

string

Die Kategorie der App. Der Wert muss eine der zulässigen Kategorien für Apps sein. Eine Liste der zulässigen Kategorien finden Sie unter den Aktionen in der Google Console.

smallSquareLogoUrl

string

Kleines quadratisches Bild. Die Größe muss 192 x 192 Pixel betragen.

largeLandscapeLogoUrl

string

Großes Bild im Querformat. Die Abmessungen müssen 2.208 x 1.242 Pixel betragen.

companyName

string

Der Name des Unternehmens, mit dem die App verknüpft ist.

contactEmail

string

Die Kontakt-E-Mail-Adresse, über die Nutzer bezüglich der App Kontakt aufnehmen können.

termsOfServiceUrl

string

Die URL zu den Nutzungsbedingungen für die App.

privacyUrl

string

Die URL der Datenschutzerklärung der App.

sampleInvocation[]

string

Beispielaufruf-Wortgruppe, die als Teil der App-Beschreibung im Verzeichnis aller Apps angezeigt wird. Es können nur fünf Werte angegeben werden.

introduction

string

Zusammenfassung der Funktionen einer App Wird für die App-Einführung für die Nutzer verwendet. Dies sollte eine Verbformulierung sein, die einen Satz wie „Du kannst diese App für...“ verwenden.

testingInstructions

string

Anleitung zum Testen im freien Format für den App-Prüfer.

voiceName

string

Der zu verwendende Name der Stimme. Unterstützte Beispielwerte: male_1, male_2, female_1, female_2.

externalVoiceName

string

Der Name der externen Stimme für diesen Agent. Enthält keine Informationen zum Gebietsschema.

voiceLocale

string

Die Sprache der Stimme für diesen Agent. Wenn er auf einen leeren String gesetzt ist, wird er zur Laufzeit in die Sprache des Nutzers aufgelöst.

surfaceRequirements

object (SurfaceRequirements)

Eine Reihe von Anforderungen für die Google Assistant-Clientoberfläche, die erfüllt sein müssen, damit die App ausgelöst wird.

SurfaceRequirements

Enthält eine Reihe von Anforderungen an die Client-Oberfläche, die erfüllt sein müssen, damit der Agent ausgelöst wird. Wenn eine hier aufgeführte Anforderung nicht erfüllt ist, wird der Agent nicht ausgelöst.

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

object (Capability)

Die Mindestfunktionen, die für das Funktionieren des Agents erforderlich sind. Fehlt auf der Oberfläche eine dieser Angaben, wird der Agent nicht ausgelöst.

Funktion

Stellt eine Anforderung an die Verfügbarkeit einer bestimmten Funktion dar

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

string

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

Typ

Typ, auf den in einer Aktion verwiesen werden kann. Dabei kann es sich um benutzerdefinierte Typen handeln, die für die Aktion eindeutig sind, oder um allgemeine Typen, die von Google definiert wurden und auf die in der Aktion verwiesen wird.

JSON-Darstellung
{
  "name": string,
  "entities": [
    {
      object (Entity)
    }
  ],
  "isUserDefined": boolean
}
Felder
name

string

Name des benutzerdefinierten Typs im Format type.

entities[]
(deprecated)

object (Entity)

Liste der Entitäten für diesen Typ. Jede enthält einen Schlüssel und eine Liste mit Synonymen.

isUserDefined

boolean

Gibt an, ob die Entitäten benutzerdefiniert sind (je nach Nutzer).

Entität

Jede Entität, die dem entsprechenden Typ entspricht, ist eindeutig. Der Schlüssel muss eindeutig sein und die Liste der Synonyme wird zum Auslösen verwendet.

JSON-Darstellung
{
  "key": string,
  "synonyms": [
    string
  ]
}
Felder
key

string

Eindeutiger Schlüssel für dieses Element.

synonyms[]

string

Liste der Synonyme, die als Verweis auf dieses Element verwendet werden können.