This tutorial will explain how to obtain the required Google Perspective API key for the toxicity analysis on Communalytic.
- Troubleshooting tips for obtaining a Perspective API Key
- The Google account used to obtain a Google Perspective API Key differs from the Google account you used to create your Communalytic account.
- Occasionally, Google might not allow you to create a Google Cloud project with your academic/institutional email. If that is the case, you will need to use a Google account ending with @gmail.com.
Step 1 #
To begin, click on the “My Profile” button in the upper-right corner of the homepage.
Step 2 #
From here, look for a section called “API keys”. If you already have an API key for Google Perspective, click the “Enter Key” button to add your API key. If you don’t have a Perspective API key, we will explain how to apply for one from Google.
To request access to the API, please visit the Perspective API Developer Home Page to begin obtaining your Perspective API key. As it might take several hours to get approval from Google, request access ASAP.
Step 3 #
Go to the “Google Cloud console” on the Perspective API Developer Home Page, then click on it. It will take you to the Google Cloud console. We suggest using your Gmail account to create a new Google Cloud account.
Step 4 #
You must create a new project if you haven’t used Google API before. Click the “Create Project” button on the right to open a new project.
Step 5 #
From here, begin by creating a name for your project. When you have completed the form, click “Create”.
Step 6 #
After creating a new Google Cloud project, you must apply for academic access to Perspective API via this online form.
Google will send you an email confirmation once your request is approved.
Please note that Perspective API is a service provided by Google, so any questions about this API should be directed to Google using their contact form.
Step 7 #
Once you have created a new project and your Perspective API access request has been approved, go to the API’s page to enable it by clicking the Enable button:
https://console.cloud.google.com/apis/api/commentanalyzer.googleapis.com/
Step 8 #
After your “Perspective Comment Analyzer API” has been enabled, you will need to obtain your API key. To do so, begin by clicking the “Credentials” menu on the top left corner of your browser.
Step 9 #
Click on the “+ Create Credentials” and then “API key”
Step 10 #
This is your API key for Google Perspective Service. Copy it and close the pop-up.
Step 11 #
Return to your Communalytic profile page and click “Enter Key”. Paste your API key into the text box and click “Submit”. Now your API key is all set.
Step 12 #
You’re ready to conduct Toxicity Analysis with your data.
You can remove your API key anytime using the “remove key” button.