The Microsoft Ads connector is a Palantir-provided driver for Microsoft Ads.
To create a new Microsoft Ads source, follow the standard setup flow for Palantir-provided drivers, then use the sections below for Microsoft Ads-specific configuration and networking. For the complete property reference, see the official Microsoft Ads driver documentation ↗.
The properties below are mandatory or recommended.
| Property | Required? | Description | Default |
|---|---|---|---|
CustomerId ↗ | Mandatory | CustomerId of the currently authenticated user. | — |
DeveloperToken ↗ | Mandatory | DeveloperToken of the currently authenticated user. | — |
AccountId ↗ | Recommended | The id of the account that you want to get data for. | — |
InitiateOAuth ↗ | Recommended | Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. | REFRESH |
OAuthClientId ↗ | Recommended | Specifies the client Id that was assigned when the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server. | — |
OAuthClientSecret ↗ | Recommended | Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret). This secret registers the custom application with the OAuth authorization server. | — |
The table below lists the domains that the source needs to be able to access in order to successfully run.
For each domain, add a corresponding egress policy. If the source is hosted on-premises and not directly reachable from Foundry, use an agent proxy egress policy instead; the agent host itself must also be able to reach the listed domains. See using an agent as a proxy for details.
| Domain | Required |
|---|---|
| bingads.microsoft.com | Always |
| api.bingads.com | Always |
| clientcenter.api.bingads.microsoft.com | Always |
| login.microsoftonline.com | Always |
| campaign.api.bingads.microsoft.com | If UseSandbox=False |
| clientcenter.api.bingads.microsoft.com | If UseSandbox=False |
| adinsight.api.bingads.microsoft.com | If UseSandbox=False |
| reporting.api.bingads.microsoft.com | If UseSandbox=False |
| campaign.api.sandbox.bingads.microsoft.com | If UseSandbox=True |
| clientcenter.api.sandbox.bingads.microsoft.com | If UseSandbox=True |
| adinsight.api.sandbox.bingads.microsoft.com | If UseSandbox=True |
| reporting.api.sandbox.bingads.microsoft.com | If UseSandbox=True |