# Microsoft Advertising

Microsoft Advertising is a platform that helps users reach their customers with online advertising solutions. Users can create and manage campaigns for search, display, video, and native ads across Microsoft's properties and partner sites. Microsoft Advertising also offers tools and features to optimize the performance, measure ads results, and target users audience. With Microsoft Advertising, users can grow their business and achieve their advertising goals.

## Prerequisites

- Basic knowledge of Treasure Data, including [TD Toolbelt](https://toolbelt.treasuredata.com/).
- Basic Knowledge of Microsoft Advertising > Audience Library.


## Static IP Address of Treasure Data Integration

If your security policy requires IP whitelisting, you must add Treasure Data's IP addresses to your allowlist to ensure a successful connection.

Please find the complete list of static IP addresses, organized by region, at the following link:
[https://api-docs.treasuredata.com/en/overview/ip-addresses-integrations-result-workers/](https://api-docs.treasuredata.com/en/overview/ip-addresses-integrations-result-workers/)

## Import from Microsoft Advertising using TD Console

### Create Authentication

This integration uses OAuth authentication. Follow bellow steps to establish a connection to your Microsoft Advertising account.

1. Select **Integrations Hub**.
2. Select **Catalog**.
![](/assets/26617500.ca92fa4ab9277dca95973c6bd413fc662a3f0d04b57d58f7a8c952a29f28bbec.6bd3f7a7.png)
3. Search for your Integration in the Catalog by name "*Microsoft Advertising*" or filter by category "*Advertising*".
![](/assets/logonew.60c091858440eb3032314be0330dc08f96562e4b57504bf658e583d96e18cb7d.6dca738e.png)
4. Hover your mouse over the icon and select **Create Authentication**.
5. Login to your Microsoft Advertising account and approve request in the OAuth consent screen. The system will re-direct to Catalog.
6. Open Microsoft Advertising again and save your authentication details.


### Create customer match audience on Audience Library (optional).

**If you already have customer match audiences, please skip this step.**

Audience with type customer match can be created from Audience Library of Microsoft Advertising by following steps:

1. Create Audience, provide Audience *name* and select type = *Customer match list*.
2. Use the template provided by Microsoft.
3. Accept Customer Match Terms to create new audience.
4. Get value of Account ID (aid=), Customer ID (cid=) and Audience ID to use in next step.


### Define your query

As of now, customer match audiences only support email, your query result may contains other columns but only email is required and would be pick up.

In this example, we are exporting email from all users over 35 years old.


```sql
SELECT
 email
FROM
 user_pii_short
WHERE  age > 35
```

### Configuring Export Result

Follow steps to export query result to Microsoft Advertising audience using the established authentication.

1. Upload Type: currently only *Customer List Items* is supported.
2. Account ID: from the URL to the audience from Audience Library, *aid=xxxxxx*.
3. Customer ID: from the URL to the audience from Audience Library, *cid=xxxxx*.
4. Audience ID: from Audience Library. Please use a customer match list audience.
5. Upload Action: select upload action in Add, Remove, Replace:
  - If the action is "Add", the service will attempt to add the Customer List Item records from your query result.
  - If the action is set to "Remove", the service will attempt to remove the Customer List Item records from your query result.
  - If the action type is set to "Replace", all previous customer match data for this list will be removed, and the service will attempt to add the Customer List Item records from your query result.
6. Max waiting time: in minutes, *15 <= max waiting time <= 1380*. *Default = 60*.
This is the waiting time for the next status of the upload job after we handover the upload to Microsoft services. If next status is reached before max waiting time, the upload job will be marked as completed.
7. Now that the query is defined, run your query.


### (Optional) Schedule Query Export Jobs

You can use Scheduled Jobs with Result Export to periodically write the output result to a target destination that you specify.

Treasure Data's scheduler feature supports periodic query execution to achieve high availability.

When two specifications provide conflicting schedule specifications, the specification requesting to execute more often is followed while the other schedule specification is ignored.

For example, if the cron schedule is `'0 0 1 * 1'`, then the 'day of month' specification and 'day of week' are discordant because the former specification requires it to run every first day of each month at midnight (00:00), while the latter specification requires it to run every Monday at midnight (00:00). The latter specification is followed.

#### Scheduling your Job Using TD Console

1. Navigate to **Data Workbench > Queries**
2. Create a new query or select an existing query.
3. Next to **Schedule**, select None.
![](/assets/image2021-1-15_17-28-51.f1b242f6ecc7666a0097fdf37edd1682786ec11ef80eff68c66f091bc405c371.0f87d8d4.png)
4. In the drop-down, select one of the following schedule options:
![](/assets/image2021-1-15_17-29-47.45289a1c99256f125f4d887e501e204ed61f02223fde0927af5f425a89ace0c0.0f87d8d4.png)
| Drop-down Value | Description |
|  --- | --- |
| Custom cron... | Review [Custom cron... details](#custom-cron-details). |
| @daily (midnight) | Run once a day at midnight (00:00 am) in the specified time zone. |
| @hourly (:00) | Run every hour at 00 minutes. |
| None | No schedule. |


#### Custom cron... Details

![](/assets/image2021-1-15_17-30-23.0f94a8aa5f75ea03e3fec0c25b0640cd59ee48d1804a83701e5f2372deae466c.0f87d8d4.png)

| **Cron Value** | **Description** |
|  --- | --- |
| `0 * * * *` | Run once an hour. |
| `0 0 * * *` | Run once a day at midnight. |
| `0 0 1 * *` | Run once a month at midnight on the morning of the first day of the month. |
| "" | Create a job that has no scheduled run time. |



```
 *    *    *    *    *
 -    -    -    -    -
 |    |    |    |    |
 |    |    |    |    +----- day of week (0 - 6) (Sunday=0)
 |    |    |    +---------- month (1 - 12)
 |    |    +--------------- day of month (1 - 31)
 |    +-------------------- hour (0 - 23)
 +------------------------- min (0 - 59)
```

The following named entries can be used:

- Day of Week: sun, mon, tue, wed, thu, fri, sat.
- Month: jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec.


A single space is required between each field. The values for each field can be composed of:

| Field Value | Example | Example Description |
|  --- | --- | --- |
| A single value, within the limits displayed above for each field. |  |  |
| A wildcard `'*'` to indicate no restriction based on the field. | `'0 0 1 * *'` | Configures the schedule to run at midnight (00:00) on the first day of each month. |
| A range `'2-5'`, indicating the range of accepted values for the field. | `'0 0 1-10 * *'` | Configures the schedule to run at midnight (00:00) on the first 10 days of each month. |
| A list of comma-separated values `'2,3,4,5'`, indicating the list of accepted values for the field. | `0 0 1,11,21 * *'` | Configures the schedule to run at midnight (00:00) every 1st, 11th, and 21st day of each month. |
| A periodicity indicator `'*/5'` to express how often based on the field's valid range of values a schedule is allowed to run. | `'30 */2 1 * *'` | Configures the schedule to run on the 1st of every month, every 2 hours starting at 00:30. `'0 0 */5 * *'` configures the schedule to run at midnight (00:00) every 5 days starting on the 5th of each month. |
| A comma-separated list of any of the above except the `'*'` wildcard is also supported `'2,*/5,8-10'`. | `'0 0 5,*/10,25 * *'` | Configures the schedule to run at midnight (00:00) every 5th, 10th, 20th, and 25th day of each month. |


1. (Optional) You can delay the start time of a query by enabling the Delay execution.


### Execute the Query

Save the query with a name and run, or just run the query. Upon successful completion of the query, the query result is automatically exported to the specified destination.

Scheduled jobs that continuously fail due to configuration errors may be disabled on the system side after several notifications.

(Optional) You can delay the start time of a query by enabling the Delay execution.

## Activate a Segment in Audience Studio

You can also send segment data to the target platform by creating an activation in the Audience Studio.

1. Navigate to **Audience Studio**.
2. Select a parent segment.
3. Open the target segment, right-mouse click, and then select **Create Activation.**
4. In the **Details** panel, enter an Activation name and configure the activation according to the previous section on Configuration Parameters.
5. Customize the activation output in the **Output Mapping** panel.


![](/assets/ouput.b2c7f1d909c4f98ed10f5300df858a4b19f71a3b0834df952f5fb24018a5ea78.8ebdf569.png)

- Attribute Columns
  - Select **Export All Columns** to export all columns without making any changes.
  - Select **+ Add Columns** to add specific columns for the export. The Output Column Name pre-populates with the same Source column name. You can update the Output Column Name. Continue to select **+ Add Columns**to add new columns for your activation output.
- String Builder
  - **+ Add string** to create strings for export. Select from the following values:
    - String: Choose any value; use text to create a custom value.
    - Timestamp: The date and time of the export.
    - Segment Id: The segment ID number.
    - Segment Name: The segment name.
    - Audience Id: The parent segment number.


1. Set a **Schedule**.


![](/assets/snippet-output-connector-on-audience-studio-2024-08-28.a99525173709da1eb537f839019fa7876ffae95045154c8f2941b030022f792c.8ebdf569.png)

- Select the values to define your schedule and optionally include email notifications.


1. Select **Create**.


If you need to create an activation for a batch journey, review [Creating a Batch Journey Activation](/products/customer-data-platform/journey-orchestration/batch/creating-a-batch-journey-activation).

## Import from Adobe Analytics using the CLI

Follow the steps bellow to set up the connector using CLI.

### Install ‘td’ Command v0.11.9 or Later

You can install the newest [Treasure Data Toolbelt](https://toolbelt.treasuredata.com/).


```bash
$ td --version
```

### Creating Your Configuration File

Prepare configuration file (for eg: load.yml) as shown in the following example.  Assumption
This example dumps data feed from a database and export them to Microsoft Advertising:

- database_type: the database that support by TD (mysql, postgres, ... etc)
- datatbase_url: the URL to connect the target database.
- database_port: the port to connect target database.
- user_name: credential for connect target database.
- password: credential for connect target database.
- database_schema: the existing schema name on target database.
- select: the SQL to select data from the target table.
- table: the table name.
- where: the SQL condition to select data.


### Execute Load Job

Submit the load job. It may take a couple of hours depending on the data size. Users need to specify the database and table where their data are stored.


```bash
td connector:issue load.yml
```

### Scheduling Your Execution

You can schedule periodic data connector execution for periodic Adobe Analytics import. We configure our scheduler carefully to ensure high availability. By using this feature, you no longer need a `cron` daemon on your local data center.

### Create the Schedule

A new schedule can be created using the `td connector:create` command.
The name of the schedule, cron-style schedule, the database and table where their data will be stored, and the Data Connector configuration file are required.
The `cron` parameter also accepts these three options: `@hourly`, `@daily` and `@monthly`.
By default, the schedule is setup in the UTC timezone. You can set the schedule in a timezone using -t or --timezone option. The `--timezone` option only supports extended timezone formats like 'Asia/Tokyo', 'America/Los_Angeles' etc. Timezone abbreviations like PST, CST are *not* supported and may lead to unexpected schedules.


```bash
$ td connector:create \    daily_ms_ads_import \    "10 0 * * *" \    load.yml
```

### List the Schedules

You can see the list of currently scheduled entries by `td connector:list`

### Show the Setting and History of Schedules

Show the execution setting of a schedule entry by `td connector:show`


```bash
td connector:show daily_ms_advertising_exportName
```

### Configurable Options

| **Parameters** | **Description** | **Type** | **Default value** | **Require?** |
|  --- | --- | --- | --- | --- |
| type | must be **ms_ads** | String |  | Required |
| refresh_client | Currently only *Customer List Items* is supported. | String |  | Required |
| upload_type |  | String |  | Required |
| account_id | Account ID: from the URL to the audience from Audience Library, *aid=xxxxxx*. | Number |  | Required |
| customer_id | Customer ID: from the URL to the audience from Audience Library, *cid=xxxxx*. | String |  | Required |
| audience_id | From Audience Library. Please use a customer match list audience. | String |  | Required |
| upload_action | Select upload action in   - Add - Remove - Replace | Enum | Add | Required |
| wait_for_next_status | For the large input, it needs to split into small batchs and update them one by one.  This attribute decides should wait or not wait the current upload complete (Success | Failed status) or not before moving to the next batch.   - true: wait for the next status until reach <waiting_time_in_minutes> - false: execute the batch and not wait for it complete. Process the next batch. | Boolean | true |
| waiting_time_in_minutes | How long the process wait for a batch complete before process treat it as timeout or failed. | Number | 60 |  |
| skip_invalid_record | - true: all invalid records are skipped. - false: send all records. | Boolean | true |  |