Microsoft Ads

Introduction

This guide explains how to setup Microsoft Ads for use with Cyclr, as well as installing a Microsoft Ads Connector.

Setup & Authentication

Overview

Cyclr partners must setup an application for their customers and obtain a developer token.
Cyclr partner customers must obtain their customer ID and account ID.

Remote Setup in Microsoft Ads - performed by Cyclr Partner

Go to your Microsoft Azure account and follow Microsoft’s guide here to register an application. Make sure to follow the Register application settings and Set application permissions sections below. Create a developer token by following Microsoft’s guide here.

Register application settings

Use the following setting when creating an application:

When setting the Supported account types, select Accounts in any organizational directory (Any Microsoft Entra ID tenant - Multitenant).
When setting the Redirect URI (optional), enter your Cyclr service domain call-back URL. For example, https://{{Your Cyclr service domain e.g. http://app-h.cyclr.com }}/connector/callback. Set Select a platform to Web.

Set application permissions

From the Azure portal:

Select App registrations.
Select your application.
Select API permissions.
Select + Add a permission.
Select APIs my organization uses.
Search and select Search for Microsoft Advertising API Service.
Select Delegated permissions.
Use the checkboxes to select the required permissions, the Microsoft Ads requires the following permissions:

Category	Permissions
msads	msads.manage

In addition, select the following permissions: offline_access.
Select Add permissions.
Select Grand admin consent for <application name>.
Select Yes.

Remote Setup in Microsoft Ads - performed by your customer

Customers must follow Microsoft’s guide here to obtain their Account ID and Customer ID.

Partner Setup in Cyclr Console

Having created an application within Microsoft Ads, go to your Cyclr Partner Console:

Select Connectors > Application Connector Library.
Select the Installation User Experience pencil icon next to the Microsoft Ads Connector.
Select the Settings tab.
Enter the below values:

Property	Description
Client ID	The Application (client) ID from your application.
Client Secret	The Client secret from your application.
Developer Token	The Developer Token used to access the Bing Ads API.
Tenant ID	The tenant value in the path of the request can be used to control who can sign into the application. This will default to `common` if not set.
Scope	The scopes used to access the API. This will default to `offline_access https://ads.microsoft.com/msads.manage` if not set.

Select Save.

If you leave these values blank, they must be provided each time the Connector is installed.

Cyclr Connector Installation

When installing the Microsoft Ads Connector, the following values are used:

Property	Description
Client ID	The Application (client) ID from your or your customer's application.
Client Secret	The Client Secret from your or your customer's application.
Account ID	The account to authenticate against.
Customer ID	The customer to authenticate against.
Developer Token	The Developer Token used to access the Bing Ads API.