No logo available for Microsoftads to DuckDB connector icon

Load Microsoftads data to DuckDB

Build a Microsoftads to DuckDB pipeline with your coding agent. One prompt scaffolds it with the dltHub AI harness, plus the Microsoftads API base URL, auth, endpoints, and incremental loading.

SourceMicrosoftadsMicrosoft Advertising - Microsoft Advertising API | Microsoft LearnDestinationDuckDBIn-process analytical database. The default local destination for dlt pipelines.

Microsoft Advertising API provides programmatic access to manage PPC advertising campaigns, reporting, and account data. Everything needed to build a working Microsoftads → DuckDB pipeline is on this page: the API's base URL, authentication, endpoints, pagination and incremental field — plus a prompt that hands the whole job to your coding agent.


Build your Microsoftads to DuckDB pipeline

Paste this prompt into Claude, Codex, or Cursor. The agent does the rest.

Prompt
Run uvx dlthub-init@latest to build a pipeline from Microsoftads to DuckDB and run it on dltHub

That scaffolds a dltHub workspace and installs the dltHub AI harness — the project rules, the secrets-management skill, and the dlt MCP server your agent needs to work safely. From there it reads the Microsoftads API, proposes the endpoints to load, then writes, runs and validates the pipeline while you review rather than type. Credentials are inspected through MCP tools, so your agent never reads secrets.toml itself. How the LLM-native workflow works →

Prefer to write it yourself? Every fact the agent uses is below.


Microsoftads API at a glance

Base URLhttps://api.ads.microsoft.com
Example endpointGET advertisers
Authenticationall requests require a Bearer token — sent in the AuthenticationToken header
Also requiredDeveloperToken, IdentityProvider
PaginationOffset-based via skip, page size via top
API referencehttps://learn.microsoft.com/en-us/advertising/guides/authentication-oauth?view=bingads-13

These values come from the Microsoftads API reference — the authoritative source if anything here looks out of date.


How do I authenticate with the Microsoftads API?

All requests require an Authorization header with a Bearer token. Additionally, a DeveloperToken header is required for all API requests.

1. Get your credentials

To obtain credentials for the Microsoft Advertising API, you must first register an application in the Microsoft Entra ID (Azure portal) to receive a client_id and client_secret. Navigate to the App registrations page in the Azure portal, select New registration, and choose 'Any Entra ID Tenant + Personal Microsoft accounts'. After registration, record the Application (client) ID. Next, you must obtain a Developer Token. Navigate to the Microsoft Advertising web application and go to the 'DevSettings' page (https://ads.microsoft.com/cc/Settings/DevSettings) to generate or retrieve your production Developer Token. Finally, obtain an OAuth access token and refresh token by directing the user to the Microsoft authorization endpoint to provide consent, as described in the OAuth 2.0 flow documentation.

2. Add them to .dlt/secrets.toml

[sources.microsoftads_source] api_key = "REPLACE_ME"

dlt reads this file automatically at runtime. With the harness, the setup-secrets skill prompts you for the values and never handles the raw credential in chat. For production, see setting up credentials with dlt.


What Microsoftads data can I load into DuckDB?

These are the Microsoftads endpoints dlt can load into DuckDB:

ResourceEndpointMethodData selectorDescription
advertisers/advertisersGETGet Advertisers by Name
advertiser_by_id/advertisers/{AdvertiserId}GETGet Advertiser by Id
ads/adsGETGet Ads by Advertiser/Content
ad_by_id/ads/{AdId}GETGet Ad by Id
products/productsGETResource used to manage products in a catalog

How do I load only new Microsoftads records?

The Microsoftads API reference does not document a timestamp or sequence field for these endpoints, so there is nothing to advertise here as verified. Pick a field from the endpoints table above that increases with every write, then set it as the cursor_path.

{"name": "advertisers", "endpoint": { "path": "advertisers", # Replace with a field that increases on every write. "incremental": {"cursor_path": "REPLACE_ME", "initial_value": "2024-01-01T00:00:00Z"}, }}

On the first run dlt loads everything from initial_value; on every run after that it requests only what changed and appends with write_disposition="merge" if you set a primary key. See incremental loading.


What does the generated Microsoftads pipeline look like?

A standard dlt REST API pipeline — the same code you would write by hand, loading CampaignManagementService and ReportingService from the Microsoftads API into DuckDB:

import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def microsoftads_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.ads.microsoft.com", "auth": {"type": "bearer", "token": api_key}, }, "resources": [ {"name": "advertisers", "endpoint": {"path": "advertisers"}}, {"name": "ads", "endpoint": {"path": "ads"}} ], } yield from rest_api_resources(config) def load_microsoftads_to_duckdb() -> None: pipeline = dlt.pipeline( pipeline_name="microsoftads_pipeline", destination="duckdb", dataset_name="microsoftads_data", ) load_info = pipeline.run(microsoftads_source()) print(load_info) if __name__ == "__main__": load_microsoftads_to_duckdb()

Run it with python microsoftads_pipeline.py. The agent iterates on this until it loads cleanly — you review and approve, rather than write it from scratch.


How do I query Microsoftads data in DuckDB?

dlt creates one table per resource. Query the loaded data with Python or SQL — or ask your agent to, through the MCP server's execute_sql_query tool.

Python (pandas DataFrame):

import dlt data = dlt.pipeline("microsoftads_pipeline").dataset() df = data.ads.df() print(df.head())

SQL:

SELECT * FROM microsoftads_data.ads LIMIT 10;

See querying your data with dataset and exploring it in marimo notebooks.


How do I deploy the Microsoftads to DuckDB pipeline in production?

The pipeline runs locally, which is ideal for prototyping and one-off analysis. When you need it on a schedule, monitored on every load, and shared with your team, deploy the same dlt code on the dltHub platform — no infrastructure to maintain. The prompt above already ends with "run it on dltHub", so your agent can take it there directly.

  • Deploy & schedule — run the pipeline as a managed job with automatic retries.
  • Monitor — observable job queues, alerting, and load metrics for every run.
  • Transform — promote raw Microsoftads loads into governed, documented models.
  • Visualize & share — explore data in notebooks and publish live dashboards instead of static screenshots.

Book a demo →


What other destinations can I load Microsoftads data to?

dlt loads into any of these — only the destination argument changes:

DestinationExample value
PostgreSQL"postgres"
BigQuery"bigquery"
Snowflake"snowflake"
Redshift"redshift"
Databricks"databricks"
Filesystem (S3, GCS, Azure)"filesystem"

Set dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. On the dltHub platform the same pipeline runs against a managed Iceberg lakehouse. See the full destinations list.


Next steps

Was this page helpful?

Community Hub

Need more dlt context for Microsoftads to DuckDB?

Request dlt skills, commands, AGENT.md files, and AI-native context.