Conversational Actions were deprecated on June 13, 2023. For more information, see Conversational Actions sunset.

Settings

YAML representation
SurfaceRequirements
- YAML representation

Represents settings of an Actions project that are not locale specific.

YAML representation

YAML representation
projectId: string defaultLocale: string enabledRegions: - string disabledRegions: - string category: enum (`Category`) usesTransactionsApi: boolean usesDigitalPurchaseApi: boolean usesInteractiveCanvas: boolean usesHomeStorage: boolean designedForFamily: boolean containsAlcoholOrTobaccoContent: boolean keepsMicOpen: boolean surfaceRequirements: object (`SurfaceRequirements`) testingInstructions: string localizedSettings: object (`LocalizedSettings`) accountLinking: object (`AccountLinking`) selectedAndroidApps: - string

projectId: string
defaultLocale: string
enabledRegions: 
  - string
disabledRegions: 
  - string
category: enum (Category)
usesTransactionsApi: boolean
usesDigitalPurchaseApi: boolean
usesInteractiveCanvas: boolean
usesHomeStorage: boolean
designedForFamily: boolean
containsAlcoholOrTobaccoContent: boolean
keepsMicOpen: boolean
surfaceRequirements: 
  object (SurfaceRequirements)
testingInstructions: string
localizedSettings: 
  object (LocalizedSettings)
accountLinking: 
  object (AccountLinking)
selectedAndroidApps: 
  - string

Fields
`projectId`	`string` Actions project id.
`defaultLocale`	`string` Locale which is default for the project. For all files except under `resources/` with no locale in the path, the localized data is attributed to this `defaultLocale`. For files under `resources/` no locale means that the resource is applicable to all locales.
`enabledRegions[]`	`string` Represents the regions where users can invoke your Actions, which is based on the user's location of presence. Cannot be set if `disabledRegions` is set. If both `enabledRegions` and `disabledRegions` are not specified, users can invoke your Actions in all regions. Each region is represented using the Canonical Name of Adwords geotargets. See https://developers.google.com/adwords/api/docs/appendix/geotargeting Examples include: - "Germany" - "Ghana" - "Greece" - "Grenada" - "United Kingdom" - "United States" - "United States Minor Outlying Islands" - "Uruguay"
`disabledRegions[]`	`string` Represents the regions where your Actions are blocked, based on the user's location of presence. Cannot be set if `enabledRegions` is set. Each region is represented using the Canonical Name of Adwords geotargets. See https://developers.google.com/adwords/api/docs/appendix/geotargeting Examples include: - "Germany" - "Ghana" - "Greece" - "Grenada" - "United Kingdom" - "United States" - "United States Minor Outlying Islands" - "Uruguay"
`category`	`enum (Category)` The category for this Actions project.
`usesTransactionsApi`	`boolean` Whether Actions can use transactions (for example, making reservations, taking orders, etc.). If false, then attempts to use the Transactions APIs fail.
`usesDigitalPurchaseApi`	`boolean` Whether Actions can perform transactions for digital goods.
`usesInteractiveCanvas`	`boolean` Whether Actions use Interactive Canvas.
`usesHomeStorage`	`boolean` Whether Actions use the home storage feature.
`designedForFamily`	`boolean` Whether Actions content is designed for family (DFF).
`containsAlcoholOrTobaccoContent`	`boolean` Whether Actions contains alcohol or tobacco related content.
`keepsMicOpen`	`boolean` Whether Actions may leave mic open without an explicit prompt during conversation.
`surfaceRequirements`	`object (SurfaceRequirements)` The surface requirements that a client surface must support to invoke Actions in this project.
`testingInstructions`	`string` Free-form testing instructions for Actions reviewer (for example, account linking instructions).
`localizedSettings`	`object (LocalizedSettings)` Localized settings for the project's default locale. Every additional locale should have its own settings file in its own directory.
`accountLinking`	`object (AccountLinking)` Allow users to create or link accounts through Google sign-in and/or your own OAuth service.
`selectedAndroidApps[]`	`string` Android apps selected to acccess Google Play purchases for transactions. This is a selection from the Android apps connected to the actions project to verify brand ownership and enable additional features. See https://developers.google.com/assistant/console/brand-verification for more information.

SurfaceRequirements

Contains a set of requirements that the client surface must support to invoke Actions in your project.

YAML representation
minimumRequirements: - object (`CapabilityRequirement`)

Fields

Fields
`minimumRequirements[]`	`object (CapabilityRequirement)` The minimum set of capabilities needed to invoke the Actions in your project. If the surface is missing any of these, the Action will not be triggered.

minimumRequirements[]

object (CapabilityRequirement)

The minimum set of capabilities needed to invoke the Actions in your project. If the surface is missing any of these, the Action will not be triggered.