{ "openapi": "3.0.1", "info": { "title": "Microsoft Ads Library", "description": "Scrape ads, advertisers, and ad details from the Microsoft Advertising Transparency Center (Bing Ads Library). Extract competitor ad copy, targeting data, impression stats, and advertiser information across all EU/EEA countries.", "version": "0.0", "x-build-id": "kh5z2fyFgIRtXlq7d" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/codebyte~microsoft-ads-library/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-codebyte-microsoft-ads-library", "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/codebyte~microsoft-ads-library/runs": { "post": { "operationId": "runs-sync-codebyte-microsoft-ads-library", "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/codebyte~microsoft-ads-library/run-sync": { "post": { "operationId": "run-sync-codebyte-microsoft-ads-library", "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", "required": [ "mode" ], "properties": { "mode": { "title": "Scraping Mode", "enum": [ "searchAds", "searchAdvertisers", "getAdDetails" ], "type": "string", "description": "Select what you want to scrape from the Microsoft Ads Library", "default": "searchAds" }, "maxSearchResults": { "title": "Total Max Results", "minimum": 24, "maximum": 1000, "type": "integer", "description": "Maximum total number of results to scrape across all pagination requests", "default": 1000 }, "advertiserId": { "title": "Advertiser ID", "type": "integer", "description": "Filter ads by specific advertiser ID (AccountId or VerifiedAdvertiserId). Used when mode is 'Search Ads'" }, "searchAdText": { "title": "Ad Search Text", "type": "string", "description": "Text to search for in ad content (title, description, etc.)", "default": "" }, "startDate": { "title": "Start Date", "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$", "type": "string", "description": "Filter ads that ran on or after this date (format: YYYY-MM-DD)" }, "endDate": { "title": "End Date", "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$", "type": "string", "description": "Filter ads that ran on or before this date (format: YYYY-MM-DD)" }, "countryCodes": { "title": "Country Codes", "type": "array", "description": "Filter ads by EU/EEA countries where they were shown. Select from available countries", "items": { "type": "string", "enum": [ "10", "14", "26", "49", "207", "51", "53", "61", "65", "66", "72", "76", "88", "92", "93", "104", "108", "109", "115", "129", "151", "152", "226", "165", "167", "170", "175", "89", "107", "139" ], "enumTitles": [ "Austria", "Belgium", "Bulgaria", "Croatia", "Cyprus", "Czechia", "Denmark", "Estonia", "Finland", "France", "Germany", "Greece", "Hungary", "Ireland", "Italy", "Latvia", "Lithuania", "Luxembourg", "Malta", "Netherlands", "Poland", "Portugal", "Romania", "Slovakia", "Slovenia", "Spain", "Sweden", "Iceland", "Liechtenstein", "Norway" ] } }, "includeAdDetails": { "title": "Include Ad Details", "type": "boolean", "description": "Retrieve ad details for each ad in the search results (will increase cost and runtime)", "default": false }, "searchAdvertiserText": { "title": "Advertiser Search Text", "type": "string", "description": "Text to search for in advertiser names (used when mode is 'Search Advertisers')", "default": "" }, "adIds": { "title": "Ad IDs", "type": "array", "description": "List of specific Ad IDs to retrieve detailed information for (used when mode is 'Get Ad Details'). Enter one ID per line", "items": { "type": "string" } } } }, "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 } } } } } } } } } }