Overview
-
Install the Marketplace App from the Alli Marketplace.
-
Enter the required inputs such as account details and domain performance criteria.
-
The app will: Identify the relevant datasource (or create one if needed). Generate SQL dynamically using the provided criteria. Extract domains that meet the exclusion criteria. Call the Bing API to exclude domains at the account level.
-
Monitor success/failure logs through the app interface.
Variables
|
Name |
Reference |
Type |
Required |
Default |
Options |
Description |
|---|---|---|---|---|---|---|
|
Microsoft Ads Account ID |
MICROSOFT_ADS_ACCOUNT_ID |
Alphanumeric |
✅ |
- |
- |
The account ID to which URL Negations have to be applied. This can be found in the URL when you login to Microsoft Ads. There will be a URL Parameter called 'aid=' which corresponds to the account ID. |
|
Clicks Threshold |
CLICKS_THRESHOLD |
Alphanumeric |
➖ |
-1 |
- |
If the clicks are lower than this number, Alli will negate those URLs |
|
Conversions Threshold |
CONVERSIONS_THRESHOLD |
Alphanumeric |
➖ |
-1 |
- |
If the conversions are lower than this number, Alli will negate those URLs |
|
Spend Threshold |
SPEND_THRESHOLD |
Alphanumeric |
➖ |
-1 |
- |
If the spend is higher than this number and the clicks and/conversions are lower than their thresholds, Alli will negate those URLs |
|
Impressions Threshold |
IMPRESSIONS_THRESHOLD |
Alphanumeric |
➖ |
-1 |
- |
If the Impressions are higher than this number and the clicks and/conversions are lower than their thresholds, Alli will negate those URLs |
|
Run Type |
RUN_TYPE |
Select |
✅ |
- |
historical
|
Set this to Historical Refresh if you are setting up the app for the first time or encountered an error which requires you to pull all historically negated URLs again. Otherwise, set it to "Daily Run" |
|
whitelisted urls |
WHITELISTED_URLS |
Alphanumeric |
➖ |
- |
- |
Do not negate these URLs even if they fall within the threshold. |
|
datasource owner email |
DATASOURCE_EMAIL_OWNER |
Alphanumeric |
✅ |
example@pmg.com |
- |
The PMG email of the person who should own the Microsoft Performance Datasource created on a first run on this app. |
|
datasource owner alli user id |
DATASOURCE_OWNER_ALLI_USER_ID |
Alphanumeric |
✅ |
https://app.alliplatform.com/me |
- |
The ID of alli user who should own the publisher performance datasource that will be created on an initial run. Find this at https://app.alliplatform.com/me |
|
OAuth Code |
OAUTH_AUTHORIZATION_CODE |
Alphanumeric |
✅ |
- |
- |
Authorization tokens needed for Google Ads Access. In order to get credentials for OAuth Code, State, and Response, add credentials using the blue "Use Credentials" button at the top and then click on "add credential group". Then follow the instructions, and save credential group to be easily identifiable. The user adding the credential group must HAVE ACCESS to the google ads account. |
|
OAuth State |
OAUTH_STATE |
Alphanumeric |
✅ |
- |
- |
|
|
OAuth Response |
OAUTH_ACCESS_TOKEN_RESPONSE |
Alphanumeric |
✅ |
- |
- |
YAML
Below is the YAML template
source:
template: Microsoft Ads - Negate Domains
inputs:
MICROSOFT_ADS_ACCOUNT_ID:
CLICKS_THRESHOLD: '-1'
CONVERSIONS_THRESHOLD: '-1'
SPEND_THRESHOLD: '-1'
IMPRESSIONS_THRESHOLD: '-1'
RUN_TYPE:
WHITELISTED_URLS:
DATASOURCE_EMAIL_OWNER: example@pmg.com
DATASOURCE_OWNER_ALLI_USER_ID: https://app.alliplatform.com/me
OAUTH_AUTHORIZATION_CODE:
OAUTH_STATE:
OAUTH_ACCESS_TOKEN_RESPONSE:
type: TEMPLATE
guardrails:
retry_count: 1
retry_wait: 0h0m0s
runtime_cutoff: 1h0m0s
exclude_exit_code_ranges:
- 101