{ "openapi": "3.0.1", "info": { "title": "Bing Ads Library Scraper — Microsoft Ads Transparency API", "description": "Scrape the Microsoft/Bing Ads Library by advertiser, domain, or keyword. Ad creatives, titles, destination URLs, first/last-shown dates; filter by country & date. Bing ads library / Microsoft ads transparency / competitor ads on Bing. Clean JSON/CSV, company-level only.", "version": "1.0", "x-build-id": "AwuYhyJKy6Uf66cqE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mochiboo~bing-ads-library-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mochiboo-bing-ads-library-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/mochiboo~bing-ads-library-scraper/runs": { "post": { "operationId": "runs-sync-mochiboo-bing-ads-library-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/mochiboo~bing-ads-library-scraper/run-sync": { "post": { "operationId": "run-sync-mochiboo-bing-ads-library-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "searchMode": { "title": "Search mode", "enum": [ "advertiser", "advertiserId", "keyword" ], "type": "string", "description": "How to interpret your queries. 'advertiser' = free-text advertiser/brand name search (e.g. 'Nike'). 'advertiserId' = exact Microsoft advertiser IDs — get every ad for that advertiser. 'keyword' = words present in the ad copy (title/description).", "default": "advertiser" }, "queries": { "title": "Queries", "type": "array", "description": "List of advertiser names, advertiser IDs, or ad-copy keywords — must match your Search mode. Examples: advertiser mode -> [\"Nike\", \"Bosch\"]; advertiserId mode -> [\"123456789\"]; keyword mode -> [\"running shoes\"].", "default": [ "Nike" ], "items": { "type": "string" } }, "country": { "title": "Country", "type": "string", "description": "Restrict ads to where they were shown. The Bing Ad Library covers the EEA only, so use an EEA country name/code (e.g. \"DE\", \"Germany\", \"France\", \"IE\") or \"anywhere\" for all EEA. Unknown values fall back to anywhere (never a wrong-country leak).", "default": "anywhere" }, "dateFrom": { "title": "Active from (date)", "type": "string", "description": "Only ads active on/after this date. Format YYYY-MM-DD. Leave blank for no lower bound." }, "dateTo": { "title": "Active to (date)", "type": "string", "description": "Only ads active on/before this date. Format YYYY-MM-DD. Leave blank for no upper bound." }, "includeAdDetails": { "title": "Include ad details (slower)", "type": "boolean", "description": "Fetch per-ad detail (impressions range, impressions-by-country, targeting) with one extra request per ad. Off by default for fast, cheap runs. Only the Bing Ad Library single-ad endpoint exposes these.", "default": false }, "maxResults": { "title": "Max results", "minimum": 0, "type": "integer", "description": "Stop after this many ads (across all queries). Keep low for a fast preview; raise for full pulls. 0 = no limit.", "default": 20 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }