This page describes the necessary steps for creating and connecting a Google Actions Endpoint. With this Endpoint, you can easily connect your Google App with Cognigy.AI

googleActions.PNG

Warning: Google is sunsetting Conversational Actions on June 13, 2023. This Endpoint will no longer function after this date, and will also be deprecated.

Within our Cognigy.AI platform, you're able to connect your Cognigy resources to your Google Actions app by using our Google Actions Endpoint integration.

Custom Messages

You can send custom Google Actions messages and templates with Code Nodes. For further information see here.

Description

With the implementation of a Google Actions Endpoint you can easily connect your Google App with Cognigy.AI.

This tutorial covers the necessary steps for creating and connecting a Google Actions Endpoint. If you want to get information about assigning a Flow to the Endpoint and setting up the Data Management see Endpoints.

Two Step Preparation Process

1 Create a Google App on Actions on Google
2 Create and Configure a Google Actions Endpoint on Cognigy.AI

1. Create a Google App

🔗 On Actions on Google

Requirements
✔ Google Account
✔ gactions CLI (see here)

1.1 Go to the Actions Console

On the Actions on Google page log into your Google Account and click then on the button in the upper right corner to open the Actions Console (see figure 1.1).

 

4893ccb-gotoactionsconsole.png

 

Figure 1.1: Button to navigate to the Actions Console

1.2 Create a Project

If not done yet, create a new project for the endpoint (see figure 1.2).

 

6fad53b-google-1.png

 

Figure 1.2: Prompt for creating a Project

1.3 Select Custom as Option

You are on the overview page for selecting a category for your project (after creating a project). Select the Custom option (see figure 1.3).

5317cfd-kindOfAction.png 

Figure 1.3: Custom Action Option

1.4 Select Blank Project

After creating a Custom action, you will be asked to select a project template. In order to connect the Google Action to Cognigy, we start with a Blank project. Thus, please select the Blank project option (see figure 1.4).

22988b9-newBlankProject.png 

Figure 1.4: New Blank Project

1.5 Enter the Information for the Google Action

You have to enter all the necessary information if you want to test and use your Google Action. Enter the invocation name in the "Display name" field you see after creation (see figure 1.5).

Screenshot_from_2020-10-08_14-59-53.png

Figure 1.5: Google Action Settings

 

 

2. Create and Configure a Google Actions Endpoint

🔗 On Cognigy.AI

2.1 Create a Google Actions Endpoint

First you have to create an Endpoint of the type Google Actions (see figure 2.1). Select your Flow in the Endpoint Editor and save it.

Create_endpoint.PNG

Figure 3.1: Google Actions Endpoint Creation

2.2 Get the Endpoint URL

Move to the top of the Endpoint Configuration page and copy the Endpoint URL which is displayed above the General Settings (see figure 2.2).

GAsettings.PNG

Figure 2.2: Endpoint URL

3 Final Step: Connect Your Google Actions App to the Endpoint

🔗 Via gactions CLI

Requirements
✔ Endpoint URL
✔ Update Command (see step 1.4)

Copy the following code snippet and paste it into a file called action.en.json:

{
  "locale": "en",
    "actions": [{
      "description": "Default Welcome Intent",
      "name": "MAIN",
      "fulfillment": {
        "conversationName": "connectToCognigy"
      },
      "intent": {
        "name": "actions.intent.MAIN"
      }
    }],
    "conversations": {
      "connectToCognigy": {
        "name": "connectToCognigy",
        "url": "https://endpoint-dev.cognigy.com/d279b53f72abc25dc93506afb3b09ce60b7bb66128b160bd7ab16915063aafe9",
        "inDialogIntents": [
          {
            "name": "actions.intent.CANCEL"
          }
      ]
    }
  }
}

Locales

You need to change the 'locale' setting at the top of the JSON object in case you want to publish an action in another language than English. See below

Change the value for the url field to the Endpoint URL gathered in step 2.2. Save the file as a JSON-file (see figure 3.1).

8912f66-Google_Actions_Configuration_Json.png

Figure 3.1: Google Actions Configuration

Next open a Terminal (Windows: Command Prompt) and enter the update command.

./gactions update --action_package PACKAGE_NAME --project PROJECT_ID

Edit the command by changing the PACKAGE_NAME parameter to the path of the JSON-file you just created, and the PROJECT_ID to the Project ID of your Google Action project. You can find the Project ID in the Google Actions Console under "Project Settings".

405d54b-projectid.png

Figure 3.2: Project ID

Execute the command. This is an example if your gactions file is in the same folder as your action.en.json file and your project ID is projectid :

./gactions update --action_package action.en.json --project projectid

Gactions cli Account approval

In case you are using the gactions cli tool for the first time, it will provide you with a link you need to follow to get a verification code. Please follow the on screen steps to verify your Account. Once this is done, re-enter the gactions command to update your Actions Project.

 

Now you should be all set up to use the Google Actions Endpoint you've created with a Flow of your choice.

 

4 Testing your Google Actions Endpoint

To test your Google Actions Endpoint, click on Test in the Google Actions Console. In case it has not yet updated with your changes from step 3, refresh your browser window. Here you can invoke your Google App with the name you chose, and the message will be sent to your Flow. In the right panel, you can see how any rich content such as cards would be rendered on a Phone.

7eb6978-GoogleAction_Test.png

Figure 4.1: The Google Actions Simulator

Functionality

Before you start testing the Google Actions Endpoint with your own actions, you should read the design guidelines in case you are going to add some rich content
🔗 On Rich responses

Not following certain requirements can result in the Google Actions not working properly.

Permissions

You need to give certain permissions in your Google Account in order to use the Simulator. If the Simulator doesn't work for you this can be the issue. The easiest way to grant these permissions is by invoking your Google App from the Google Assistant on your Device (e.g. Phone or Google Home).


Comments

0 comments

Please sign in to leave a comment.

Was this article helpful?
0 out of 0 found this helpful