This repository provides a deployment guide showcasing the application of Google Cloud's Generative AI for marketing scenarios. It offers detailed, step-by-step guidance for setting up and utilizing the Generative AI tools, including examples of their use in crafting marketing materials like blog posts and social media content.
Additionally, supplementary Jupyter notebooks are provided to aid users in grasping the concepts explored in the demonstration.
The architecture of all the demos that are implemented in this application is as follows.
.
├── app
└── backend_apis
└── frontend
└── notebooks
└── templates
└── installation_scripts
└── tf
/app
: Architecture diagrams. /backend_apis
: Source code for backend APIs. /frontend
: Source code for the front end UI. /notebooks
: Sample notebooks demonstrating the concepts covered in this demonstration. /templates
: Workspace Slides, Docs and Sheets templates used in the demonstration. /installation_scripts
: Installation scripts used by Terraform. /tf
: Terraform installation scripts.In this repository, the following demonstrations are provided:
The notebooks listed below were developed to explain the concepts exposed in this repository:
The following additional (external) notebooks provide supplementary information on the concepts discussed in this repository:
This section outlines the steps to configure the Google Cloud environment that is required in order to run the code provided in this repository.
You will be interacting with the following resources:
In the Google Cloud Console, on the project selector page, select or create a Google Cloud project.
As this is a DEMONSTRATION, you need to be a project owner in order to set up the environment.
From Cloud Shell, run the following commands to enable the required Cloud APIs.
Replace <CHANGE TO YOUR PROJECT ID>
to the id of your project and <CHANGE TO YOUR LOCATION>
to the location where your resources will be deployed.
export PROJECT_ID=<CHANGE TO YOUR PROJECT ID>
export LOCATION=<CHANGE TO YOUR LOCATION>
gcloud config set project $PROJECT_ID
Enable the services:
gcloud services enable \
run.googleapis.com \
cloudbuild.googleapis.com \
compute.googleapis.com \
cloudresourcemanager.googleapis.com \
iam.googleapis.com \
container.googleapis.com \
cloudapis.googleapis.com \
cloudtrace.googleapis.com \
containerregistry.googleapis.com \
iamcredentials.googleapis.com \
secretmanager.googleapis.com \
firebase.googleapis.com
gcloud services enable \
monitoring.googleapis.com \
logging.googleapis.com \
notebooks.googleapis.com \
aiplatform.googleapis.com \
storage.googleapis.com \
datacatalog.googleapis.com \
appengineflex.googleapis.com \
translate.googleapis.com \
admin.googleapis.com \
docs.googleapis.com \
drive.googleapis.com \
sheets.googleapis.com \
slides.googleapis.com \
firestore.googleapis.com
From Cloud Shell, execute the following commands:
Set your project id. Replace <CHANGE TO YOUR PROJECT ID>
with your project ID.
export PROJECT_ID=<CHANGE TO YOUR PROJECT ID>
Follow the instructions in your Shell to authenticate with the same user that has EDITOR/OWNER rights to this project.
gcloud auth application-default login
Set the Quota Project
gcloud auth application-default $PROJECT_ID
From Cloud Shell, execute the following command:
git clone https://github.com/GoogleCloudPlatform/genai-for-marketing
Open the configuration file and include your project id (line 16) and location (line 17).
From Cloud Shell, navigate to /installation_scripts, install the python packages and execute the following script.
Make sure you have set the environmental variables PROJECT_ID and LOCATION.
cd ./genai-for-marketing/installation_scripts
pip3 install -r requirements.txt
Run the python script to create the BigQuery dataset and the DataCatalog TagTemplate.
python3 1_env_setup_script.py
Follow the steps below to create a search engine for a website using Vertex AI Search.
After you finished creating the Vertex AI Search datastore, navigate back to the Apps
page and copy the ID of the datastore you just created.
Example:
Open the configuration file - line 33 and include the datastore ID. Don't forget to save the configuration file.
Important: Alternatively, you can create a search engine for structure or unstructured data.
In order to render your Looker Dashboards in the Marketing Insights and Campaing Performance pages, you need to update a HTML file with links to them.
1) Open this HTML file - lines 18 and 28 and include links to the Looker dashboards for Marketing Insights. Example:
Add a new line after line 18 (or replace line 18) and include the title and ID of your Looker Dashboard.
For each dashboard id/title you included the step above, include a link to it at the end of this file.
<div *ngIf="overview" class="overviewcss">
The allow_login_screen=true
in the URL will open the authentication page from Looker to secure the access to your account.
3) Open this HTML file - lines 27 and 37 and include links to the Looker dashboards for Campaign Performance.
[Optional] If you have your Google Ads and Google Analytics 4 accounts in production, you can deploy the Marketing Analytics Jumpstart
solution to your project, build the Dashboards and link them to the demonstration UI.
Next you will create a Generative AI Agent that will assist the users to answer questions about Google Ads, etc.
agent-id
from the HTML code snippet provided by the platform.
dialogFlowCxAgendId
with the agent-id
. Follow the steps below to setup the Workspace integration with this demonstration.
name-of-the-sa@my-project.iam.gserviceaccount.com
.IMPORTANT: For security reasons, DON'T push this credentials to a public Github repository.
This demonstration will create folders under Google Drive, Google Docs documents, Google Slides presentations and Google Sheets documents.
When we create the Drive folder, we set the permission to all users under a specific domain.
Be aware that this configuration will share the folder with all the users in that domain.
If you want to change that behavior, explore different ways of sharing resources from this documentation:
https://developers.google.com/drive/api/reference/rest/v3/permissions#resource:-permission
[template] Marketing Assets
):
File
and Save as Google Slides
. Take note of the Slides ID from the URL.[template] Gen AI for Marketing Google Doc Template
):
File
and Save as Google Docs
. Take note of the Docs ID from the URL.[template] GenAI for Marketing
):
File
and Save as Google Sheets
. Take note of the Sheets ID from the URL.cd ./genai-for-marketing/backend_apis/
gcloud run deploy genai-marketing --source . --region us-central1 --allow-unauthenticated
https://marketing-image-tlmb7xv43q-uc.a.run.app
Enable Firebase
After you have a Firebase project, you can register your web app with that project.
In the center of the Firebase console's project overview page, click the Web icon (plat_web) to launch the setup workflow.
If you've already added an app to your Firebase project, click Add app to display the platform options.
Open the frontend environment file - line 4 and include the Firebase information.
Angular is the framework for the Frontend. Execute the following commands to build your application.
npm install -g @angular/cli
npm install --legacy-peer-deps
cd ./genai-for-marketing/frontend
ng build
Firebase Hosting is used to serve the frontend.
npm install -g firebase-tools
firebase login --no-localhost
Follow the steps presented in the console to login to Firebase.
- Init hosting
```bash
cd frontend/dist/frontend
firebase init hosting
First type your Firebase project and then type browser
as the public folder.
Leave the defaults for the rest of the questions.
firebase deploy --only hosting
Navigate to the created URL to access the Gen AI for Marketing app.
Visit the following URL to create a database for Firestore.
Replace your-project-id
with your project ID.
https://console.cloud.google.com/datastore/setup?project=your-project-id
Visit the following URL to enable Firebase Authentication.
Replace your-project-id
with your project ID.
https://console.firebase.google.com/project/your-project-id/authentication/providers
If you have any questions or if you found any problems with this repository, please report through GitHub issues.