Skip to content

Latest commit

 

History

History
164 lines (105 loc) · 7.36 KB

walkthrough.md

File metadata and controls

164 lines (105 loc) · 7.36 KB
Raw

Deploying DG-Pulse

Introduction

In this walkthrough, you'll generate OAuth credentials in preparation for the deployment of DG-Pulse.

Google Cloud Project Setup

GCP organizes resources into projects. This allows you to collect all of the related resources for a single application in one place.

Begin by creating a new project or selecting an existing project for this dashboard.

For details, see Creating a project.

Enable Google Cloud APIs

Enable the Google Ads API and the BigQuery API so that they're incorporated in the credentials you will generate in the next step.

Switch Off Ephemeral Mode

First, let's switch off your shell's ephemeral mode.

Click More and look for the Ephemeral Mode option. If it is turned on turn it off. This allows the dashboard code to persist across sessions.

Authorize shell scripts commands

Copy the following command into the shell, press enter and follow the instructions:

cd
git clone https://github.com/google-marketing-solutions/dgpulse.git
cd dgpulse
gcloud auth login

Configure OAuth Consent Screen

An authorization token is needed for the dashboard to communicate with Google Ads.

  1. Go to the APIs & Services > OAuth consent screen page in the Cloud Console. You can use the button below to find the section.

  2. Choose External as the user type for your application.

    • If you have an organization for your application, select Internal.
    • If you don't have an organization configured for your application, select External.

  3. Click Create to continue.

  4. Under App information, enter the Application name you want to display. You can copy the name below and enter it as the application name.

    DemandGen-Pulse

  5. For the Support email dropdown menu, select the email address you want to display as a public contact. This email address must be your email address, or a Google Group you own.

  6. Under Developer contact information, enter a valid email address.

Click Save and continue.

Add Sensitive Scopes to Consent Screen

Scope the consent screen for Big Query API and the Google Ads API.

  1. Click Add or remove scopes
  2. Now in Enter property name or value search for the BigQuery API, check the box for the first option to choose it.
  3. Do the same for Google Ads API.
  4. Click Update

Creating OAuth Credentials

Create the credentials that are needed for generating a refresh token.

Make sure to copy each of the credentials you create, you will need them later.

  1. On the APIs & Services page, click the Credentials tab.

  2. On the Create credentials drop-down list, select OAuth client ID.

  3. Under Application type, select Web application.

  4. Add a Name for your OAuth client ID.

  5. Click Authorized redirect URI and copy the following:

    https://developers.google.com/oauthplayground

  6. Click Create. Your OAuth client ID and client secret are generated and displayed on the OAuth client window.

After generating the client_id and client_secret keep the confirmation screen open and go to the next step.

Generate Refresh Token

  1. Go to the OAuth2 Playground (opens in a new window)

  2. On the right-hand pane, paste the client_id and client_secret in the appropriate fields paste credentials

  3. Then on the left hand side of the screen, click the blue Authorize APIs button Authorize APIs

    If you are prompted to authorize access, please choose your Google account that has access to Google Ads and approve.

  4. Now, click the new blue button Exchange authorization code for tokens Exchange authorization code for tokens

  5. Finally, in the middle of the screen you'll see your refresh token on the last line. Copy it and save it for future reference. refresh_token Do not copy the quotation marks

Join Google Group to access dashboard template

Use this link to access the group URL and click on "Join Group"

join_group

Deploy Solution

Run the following command and follow the steps:

sh install-or-upgrade.sh

Conclusion

Congratulations. You've set up DG-Pulse!