Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space WSDA and version DigitalAgent2.1

Table of Contents

...

  1. From the left navigation panel, navigate to IAM & Admin > Service Accounts. (Refer the following screenshot)

    Figure: Google Console – Service Accounts
  2. Click + CREATE SERVICE ACCOUNT to create Service account for Digital Agent. (Refer the following screenshot)

    Figure:
    Google Console - Create Service Account 
  3. In the next screen fill in Service Account details in Step 1 such as Service account name, Service account ID, and Service account description.
  4. Click CREATE AND CONTINUE to create Service account.
    Image Modified
    Figure:
    Create Service Account - details 
  5. Steps 2 and 3 are optional and can be skipped.
  6. The details of the Service Account for your project are added successfully. Click the email link once the Service Account is created. (Refer the following screenshot)

    Figure: 
    Service Account - Click email link 
  7. Navigate to the KEYS tab. Click ADD KEY and select Create new key from the dropdown menu.

    Figure:
     Generate Key - Add New Key 
  8. A pop-up window will appear. Select the Key type as JSON. Click Create.

    Note
    titleNote

    Save this file carefully, as it cannot be recovered once it is lost.



    Figure: 
    Generate Key - Select Key Type 

  9. A new pop-up window displays a confirmation message "Private key saved to your computer."

    Figure: Generate Key - Private Key Saved

    Note
    titleNote

    Retrieve the Client Email and Private Key from the downloaded JSON file, then pass them along to the SymphonyAI team for configuration in the Bot setting.

...

To enable Google Chat API, perform the following steps:

  1. From the left navigation panel, click APIs & Services> Enabled APIs and services.
    Image Modified
    Figure: 
    Enable Google Chat API 
  2. Click + Enable APIs and services to enable the APIs for Digital Agent.

    Figure: Enable API and Services 
  3. Navigate to the search bar and search for Google Chat API and select it.

    Figure: Search Google Chat API
  4. Click Enableto enable the Google Chat API.
    Image Modified
    Figure: Enable Google Chat API
  5. Configure your Google Chatbot once the Google Chat API is enabled.

Step 4: Configure your Google Chat bot 

...

  1. Navigate to CONFIGURATION tab.

    Figure: Configuration tab
  2. Click Save to save all the configuration details. Mention the below details in the following screen to configure your Google Chatbot:
    Image Modified
    Figure: Google Chat bot - configuration details

    1. Enter the name for your app.
    2. Add the avatar URL.
    3. Enter the description relevant to your app.
    4. Toggle the switch next to Interactive features to enable it.
    5. Click on both the check boxes under the Functionalitysection.
    6. Under Connection settings, select App URL and add the app URL in the App URL field.

      Note
      titleNote

      The app URL will be provided by the SymphonyAI team.

    7. Scroll down to the Visibility section and enter the email addresses to add individuals and groups to your domain. 
    8. Click Save to save all the configuration details.

...

  1. Open the Google Cloud Console.
  2. Click Select a project from the top. Click the name of the project to switch between Google Cloud projects which are already open.
  3. Select Digital Agent app's Cloud project.
  4. Click Open.
  5. Type and search Google Workspace Marketplace SDK in the search bar at the top.
    Image Added
    Figure: Search Marketplace SDK
  6. Open Google Workspace Marketplace SDK page.

    Note
    titleImportant

    Make sure you enable the Google Workspace Marketplace SDK, not the API. The Google Workspace Marketplace API is a different tool used to integrate with Google's licensing and billing services.

  7. Click Enable to enable the Google Workspace Marketplace SDK, if it is not already enabled.
    Image Added
    Figure: Enable Marketplace SDK

Enter app settings in the Google Workspace Marketplace SDK

After enabling the Google Workspace Marketplace SDK in your Google Cloud project, configure the app settings in the Google Workspace Marketplace SDK.

To enter the app settings in the Google Workspace Marketplace SDK, perform the following steps:

  1. Open Google Workspace Marketplace SDK.
  2. Navigate to the App Configuration tab.
  3. Fill in all the fields with the details about your app. Refer to App configuration settings to know more about each setting.
  4. Click Save to save the details.
    Image Added
    Figure: App settings fields
App Configuration Settings

There are several settings in the App Configuration section of the Google Workspace Marketplace SDK.

App Visibility
Warning
titleImportant

Once a visibility option is selected and the changes are saved on the App Configuration page, it is not possible to change your selection afterwards.

If you are utilizing a Google Workspace account, which is typically set up by your work organization, you will see the App Visibility option. However, if you're using a consumer account, identifiable by its "@gmail.com" domain, your publishing capabilities are restricted to public settings only.

  • Public: People from outside your domain can find and install the app. Opting for public visibility means that Google will review and approve your app listing before publishing it.
  • Private: The app is exclusively discoverable and installable by individuals within your domain.

If you opt to publish as Unlisted, the app listing will not be displayed in browse or search results. Users will only be able to access the app's store page via the direct URL.

When creating the store listing, you can limit the countries and regions where your app will be available by configuring this in the Distribution section.

Installation Settings

The installation settings determine whether users or Workspace administrators can install your app directly from its store listing page on the Google Workspace Marketplace.

Note
titleNote

In the case of Google Chat apps, your options are limited to selecting Individual + Admin Install, as individuals can find and install Chat apps directly from Google Chat. For more information, refer to Publishing Google Chat apps.

  • Individual + Admin Install (default): Individual users as well as administrators can install the app either for themselves or on behalf of their domain, organizational unit, or a designated group of users. It's noteworthy that domain policies applicable to users may override individual installation permissions. This may potentially restrict app installation even when individual installs are enabled.
  • Admin Only Install: Select this option if your app requires domain installation. Only admins can install the app for their domain, organizational unit, or a designated group of users. Your app will solely appear in Google Workspace Marketplace search results accessible to admins and individuals not logged into their Google Account.

Publish an app

After enabling the Google Workspace Marketplace SDK and entering the app settings in Google Workspace Marketplace SDK, you need to publish the app.

To publish the app, perform the following steps:

  1. Login to Google Cloud console.
  2. Click Menu > APIs & Services > Google Workspace Marketplace SDK > Store Listing.
  3. Fill in the details in the sections for App Details, Graphic Assets, and Support Links. If your app uses or references any Google trademarks, ensure compliance with the Google Workspace Marketplace branding guidelines.
    Image Added
  4. This step is optional. In the Distribution section, deselect All Regions and choose only the specific regions where you wish to publish your app. For users located outside of the selected regions based on their IP address, the following occurs:
    1. Your app listing does not appear when users search for apps in the Google Workspace Marketplace.
    2. When attempting to access the listing through a direct link, they get the error message: "Sorry, this app is not available in your country or region".
      Make sure to include the language specific to each region in the App Details section.
  5. Click Publish to save the details and publish.
  6. The app is published right away if your app listing is marked as private.
  7. The app undergoes a review process before getting published, if the app listing is marked as public. For more information, refer to App review process and requirements.
Create a store listing

The details you provide on the Store Listing page serve as promotional material for your app, reaching out to potential users browsing through the Google Workspace Marketplace. While certain fields are not mandatory, completing them can significantly enhance the descriptive quality of your app listing.

Ensure that you have information about the following assets before filling out the Store Listing page:

App Details

App details section contains general details about the app such as application name, description.

The Store Listing page in the Google Workspace Marketplace displays the App Details section with the following fields:

FieldDescription
LanguageThe language(s) chosen for your app's details determine the localized version displayed to users who have selected that language. In cases where multiple languages are included, users will view the app details in their selected language. Alternatively, if only one language is chosen, users will see the details in the default language that you choose.

Application name

The Application name is the name displayed in the app listing. This name should match the name in your OAuth consent screen. Keep the name under 50 characters for optimal display. Avoid using "Google" or any other Google product names.

Short description

A brief overview of your app and its functionality (limited to 200 characters).

Detailed description

A detailed description of your app. This description will be within the Overview section below the screenshots that you add. Ensure that the content does not exceed 16,000 characters.

Category

Choose the category that best suits your app listing. Upon publishing, your app listing will be featured in that collection, increasing its discoverability.
Graphic Assets

Graphics are used in the Google Workspace Marketplace to visually depict and advertise apps.

Refer the below table for the fields present in the Graphic Assets section:

FieldDescription

Application icons

You need a minimum of two icon images: one sized at 128 x 128 pixels and another at 32 x 32 pixels. Also, for apps that integrate with a web app, icons sized at 96 x 96 and 48 x 48 pixels are also required.

Application card banner

Upload application card banner up to 220 x 140 pixels.

Screenshots

Include a minimum of one screenshot demonstrating your app's integration with Google services. You can include a maximum of five screenshots. These screenshots should be 1280 x 800 pixels. If needed, you can also use screenshots sized at 640 x 400 pixels or 2560 x 1600 pixels. Ensure that your screenshots have square corners and are displayed without padding, achieving a full bleed effect.

Support links help users to seek assistance with your app and review your terms and policies.

Refer the below table for the fields present in the Support Links section:

FieldDescription

Terms of service

Provide a link to the web page that details your terms of service.

Privacy policy

Provide a link to the web page that describes your privacy policy.
SupportProvide a link to a web page detailing the process for users to seek assistance in case they encounter any difficulties with your application.

Check you app listing's publication status

During the review process for public app listings, you will receive email notifications regarding the publication status. These notifications will be sent to the Developer email that you supplied for your app listing.

Follow the below steps to check whether your app listing is published or not:

  1. Go to Google Cloud console.

  2. Open your app's Google Cloud project.
  3. From the left panel, click Menu APIs & Services.
  4. Click Google Workspace Marketplace SDK Store Listing tab.
  5. On the top of the Store Listing tab, status of app listing publication is displayed. (Refer below screenshot)
    Image Added
    Figure: App listing publication status

Below table describes the possible publication statuses of app listings along with their definitions:

StatusDefinition

Unpublished

Unpublished status means that the app listing is not live. This status appears when:

  • You have not published the app listing yet.
  • You have unpublished your app listing. Existing users will no longer have access to your app, if you have unpublished it.
  • Your app listing did not meet the requirements of the app review process. In such cases, Google will send you detailed information via email regarding the areas that require improvement. Take steps to resolve these issues and proceed with resubmitting your app for review.

Under review

Under review status means that your app listing is not live and is currently undergoing review by the Google team. You will be notified via email upon completion of the review process. For more information, refer to App Review.
Approved

Approved status means that your app listing is live. If your app hasn't been published as unlisted, it's accessible for new users to discover and install on the Google Workspace Marketplace.

If you published your app listing as unlisted, then new users will require the direct URL to gain access to it.

Certain domain administrators may have implemented limitations that restrict users' access your app.

Note
titleNotes

If your app functions as a Chat app, the permissions configurations and app status in the Google Chat API could impose additional restrictions on post-publication access to your app. For example:

  • Users will be unable to find or use your app, if your Chat app is marked as "Published" in the Google Workspace Marketplace SDK, but marked as "Disabled" in the Google Chat API.
  • If your Chat app is deployed to your domain via the Google Workspace Marketplace SDK, and the Google Chat API permissions restrict access to specific individuals and groups, only those designated people and groups will have access to your app.