ActionPackage

ActionPackage enthält den Inhalt für den Entwurf einer App sowie für jede bereitgestellte Version. Dazu gehören Details zum Verzeichniseintrag, die Konfiguration der Unterhaltung 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 der Verzeichniseintrag sowie andere App-Identifikatoren wie „displayName“ gespeichert.

accountLinking

object (AccountLinking)

Details zur Kontoverknüpfung in dieser App.

actions[]

object (Action)

Liste der Aktionen, die die App verarbeiten kann.

types[]

object (Type)

Liste der Typen, die vom Entwickler definiert wurden.

conversations

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

Unterhaltungen auf Karten, die mit actions geteilt werden können. Sehen Sie sich beispielsweise conversationName in Fulfillment an.

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. Jedes unterstützte Gebietsschema hat ein eigenes ActionPackage. Wenn kein Wert angegeben ist, wird die Standardsprache des Agents impliziert.

Manifest

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

  1. Aktionen auf der Seite mit dem Eintrag im Google-Verzeichnis.
  2. Eindeutige Identifizierung einer App für einen expliziten Aufruf (displayName).
  3. Inhalte für andere Teile von ActionPackage (shortDescription wird für die 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 werden über die Aktionskonsole und nicht direkt im Aktionspaket angegeben.

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“. Er wird neben invocationName auch als Methode für Nutzer verwendet, diese App aufzurufen. Der Anzeigename muss eindeutig sein und der Telefonnummer invocationName sehr ähnlich sein.

invocationName

string

Dies ist der eindeutige Name für diese Anwendung, um sie direkt in einem Sprachkontext 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 auf Grundlage des aktuellen Standorts des Nutzers zulässig ist. Weitere Informationen erhalten Sie unter 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 wird. Weitere Informationen erhalten Sie unter 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). Er ist auf 80 Zeichen begrenzt.

longDescription

string

Die standardmäßige lange Beschreibung für die App (falls keine Übersetzung verfügbar ist). Er ist auf maximal 4.000 Zeichen beschränkt.

category

string

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

smallSquareLogoUrl

string

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

largeLandscapeLogoUrl

string

Großes Bild im Querformat. Die Größe muss 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 sich bezüglich der App kontaktieren können.

termsOfServiceUrl

string

Die URL zu den Nutzungsbedingungen für die App.

privacyUrl

string

Die URL für die Datenschutzerklärung der App.

sampleInvocation[]

string

Beispiel für eine Aufrufwortgruppe, die als Teil der App-Beschreibung im Verzeichnis aller Apps angezeigt wird. Es können maximal 5 Werte angegeben werden.

introduction

string

Zusammenfassung der Funktionen einer App. Wird verwendet, um Nutzern die App vorzustellen. Dies sollte eine Verbformulierung sein, die einen Satz wie „Mit dieser App kannst du...“ vervollständigt.

testingInstructions

string

Testanleitungen im freien Format für den App-Prüfer.

voiceName

string

Der zu verwendende Voice-Name. 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 Sprachinformationen.

voiceLocale

string

Die Sprache der Stimme für diesen Agent. Wird ein leerer String angegeben, wird er zur Laufzeit in die Sprache des Nutzers umgewandelt.

surfaceRequirements

object (SurfaceRequirements)

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

SurfaceRequirements

Enthält eine Reihe von Anforderungen an die Clientoberfläche, die erfüllt sein müssen, damit der Agent ausgelöst wird. Wenn eine der hier aufgeführten Anforderungen 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. Wenn auf der Oberfläche eine dieser Angaben fehlt, wird der Agent nicht ausgelöst.

Funktion

Stellt eine Anforderung zur Verfügbarkeit einer bestimmten Funktion dar

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

string

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

Typ

Ein Typ, auf den in einer Aktion verwiesen werden kann. Dabei kann es sich um benutzerdefinierte Typen handeln, die nur für die Aktion gelten, oder um gängige Typen, die von Google definiert und in der Aktion referenziert werden.

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

Ob die Entitäten benutzerdefiniert sind (je nach Nutzer unterschiedlich).

Entität

Jede Entity Entsprechung ist für diesen Typ 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 mit Synonymen, mit denen auf dieses Element verwiesen werden kann.