Deploy your Actions

After you have created a Conversation Action and deployed your fulfillment endpoint, you must register and deploy your action using the Google Actions API and the Google API Manager for it to be live and usable by other users.

Before registering and deploying your action, go through the launch checklist.

Create a new cloud project

  1. Go to the Google Actions API page in the Google API Manager.

  2. In the Dashboard pop-up, click Create a project. The New Project dialog box appears.

  3. Specify a name in the Project name field. The project name doesn't need to be the same as your invocation name. Make note of the project ID that is generated for you.

    If you didn't make a note of the auto-generated Project ID, you can find it in the project settings.

  4. Click Create.

Register your Conversation Action

  1. If you're not already there, go to the Google Actions API page in the Google API Manager.

  2. Open the Directory listing tab and fill out the required fields. Follow these guidelines:

    • Display Name: The official, readable name of your agent. It is displayed in white font over the large banner image in your Directory listing.
    • Invocation Name: Provide the pronunciation of your display name. This helps Google ensure that your agent is triggered when users speak its display name. To make sure you get it right, follow our guide to choosing a good invocation name.
    • Short description: A brief overview of what your actions can do, shown in the list of agents users can browse through in the Directory. Keep the short description concise, but we recommend that you include enough of a description to give users a clear overview of what you can help them with.
    • Full Description: A complete description of your actions. The full description appears on your specific listing, but you still want to keep it short. Descriptions that are too long may make your listing difficult to look through.
    • Small square logo: A 192x192-pixel logo displayed in your Directory listing and wherever your listing appears in the Home app. Make sure your logo stands out against both a white background and your banner image. Use the right aspect ratio: Logos that are not 192x192 pixels will be cropped and resized.
    • Large banner image: A 2208x1242-pixel image that appears at the top of your listing in the Directory. Your display name and invocation name appear across the bottom of the image, in white text. Make sure your banner image has a solid background (no transparency). Use the right aspect ratio: Banner images that are not 2208x1242 pixels will be cropped and resized.
    • Sample Invocations: Add examples of phrases users say to interact with or activate your actions. For each invocation phrase, use the following structure: Ok Google, talk to <invocation name>

      Note that the "k" in "Ok" and the first letter of your invocation phrase are both lowercase.

    • Privacy Policy, Terms of Service, and Contact Information: Provide a contact email for users who need to reach you, a link to your privacy policy, and a link to your terms of service page (if you have one). Both the privacy policy and contact information are required.
  3. Click Register. You can come back to this page later and make changes.

Deploy your actions

Now that you have a Google Cloud project, you can add the project and deploy your actions from API.AI's deployment UI or, if you used the Actions SDK, from the gactions Command Line Interface.

API.AI
  1. Go to the API.AI console.
  2. Click Integrations in the left-hand navigation.
  3. Click the Settings link on the Actions on Google card.
  4. In the Google Project ID field, enter the project ID:
  5. Click Deploy.
Actions SDK
  1. Open your action package's JSON file in a text editor.
  2. Enter your project ID in the agentInfo.projectId field, as the following example shows:
    {
      "versionLabel":"Start Date v0.1",
      "agentInfo": {
        "languageCode":"en-US",
        "projectId":"my-project-1234567",
        "invocationNames": ["Start Date"],
        "voiceName":"sfg-vocoded#male_1",
        "logoUrl":"logo"
    },
    ...
    
  3. Save your action package JSON file.
  4. From the same folder as the action package, issue the following command:
    ./gactions deploy --action_package PACKAGE_NAME --project YOUR_PROJECT_ID
    

    For example:

    ./gactions deploy --action_package agent.json --project my-project-1234567
    

    The gactions CLI should return a message that indicates that the deployment was successful. For more information, see gactions Command Line Interface.

Confirm your deployment

After you deploy your actions, you can check the status in the Deployment history tab.

  1. Go to the Google Actions API page in the Google API Manager.
  2. Open the Deployment history tab.
  3. Check the Status column for the deployment status:

When your actions are approved, the Google review team updates your deployment status from Under review to Deployed.

Learn more about the different deployment states.

Interact with your Conversation Action

After you have confirmed that your actions are Deployed in the Google Assistant console, you should be able to interact with them on Google Home. Invoke them with one of the triggers that you specified in your action package or in API.AI.

If your version is Deployed, but you can’t interact with it, wait about 24 hours and try again. There may be a slight delay in updating your actions. If they still don't work, contact us.

You can also test your Conversation Action with the Google Home Web Simulator.