{ "openapi": "3.0.1", "info": { "title": "Microsoft Ads Library Scraper", "description": "Scrape the Microsoft Ad Library (Bing Ads): search ads by keyword, advertiser, date and EU/EEA country, find advertisers, and get ad details with impressions by country and targeting.", "version": "1.0", "x-build-id": "8s8F6IdIzPsRpP8c0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parsebird~microsoft-ads-library-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parsebird-microsoft-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/parsebird~microsoft-ads-library-scraper/runs": { "post": { "operationId": "runs-sync-parsebird-microsoft-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/parsebird~microsoft-ads-library-scraper/run-sync": { "post": { "operationId": "run-sync-parsebird-microsoft-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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "searchAds", "searchAdvertisers", "getAdDetails" ], "type": "string", "description": "Choose what to get: ads matching your filters, advertisers matching a name, or full details for ad IDs you already have.", "default": "searchAds" }, "maxSearchResults": { "title": "Max results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of unique ads or advertisers to return. One Ad Library search returns at most 1,000 rows, and some rows repeat the same ad. If you select several countries, the Actor searches them one by one to find more ads.", "default": 100 }, "searchAdText": { "title": "Keyword", "type": "string", "description": "Find ads whose text contains this keyword (e.g. cloud computing). Leave empty to browse all ads matching the other filters." }, "advertiserId": { "title": "Advertiser ID", "type": "integer", "description": "Only return ads from this advertiser. Get the ID with the 'Search advertisers' mode or from an advertiser page URL (adlibrary.ads.microsoft.com/advertiser/4295212599)." }, "startDate": { "title": "Start date", "type": "string", "description": "Only return ads shown on or after this date (YYYY-MM-DD)." }, "endDate": { "title": "End date", "type": "string", "description": "Only return ads shown on or before this date (YYYY-MM-DD)." }, "countryCodes": { "title": "Countries", "type": "array", "description": "Only return ads shown in these EU/EEA countries. Leave empty for all 30 countries.", "items": { "type": "string", "enum": [ "10", "14", "26", "49", "207", "51", "53", "61", "65", "66", "72", "76", "88", "89", "92", "93", "104", "107", "108", "109", "115", "129", "139", "151", "152", "226", "165", "167", "170", "175" ], "enumTitles": [ "Austria", "Belgium", "Bulgaria", "Croatia", "Cyprus", "Czechia", "Denmark", "Estonia", "Finland", "France", "Germany", "Greece", "Hungary", "Iceland", "Ireland", "Italy", "Latvia", "Liechtenstein", "Lithuania", "Luxembourg", "Malta", "Netherlands", "Norway", "Poland", "Portugal", "Romania", "Slovakia", "Slovenia", "Spain", "Sweden" ] } }, "includeAdDetails": { "title": "Include ad details", "type": "boolean", "description": "Also open each ad to get the paid-for-by entity, start and end dates, total impressions, impressions by country, targeting types and removal reason. Slower, and each ad is also billed as an ad details event.", "default": false }, "searchAdvertiserText": { "title": "Advertiser name", "type": "string", "description": "Find advertisers whose name contains this text (e.g. Microsoft). Used in the 'Search advertisers' mode." }, "adIds": { "title": "Ad IDs", "type": "array", "description": "Add ad IDs (e.g. 73598874340208) or ad URLs (https://adlibrary.ads.microsoft.com/ad/73598874340208). Used in the 'Get ad details by ID' mode.", "items": { "type": "string" } }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 32, "type": "integer", "description": "Number of requests sent at the same time when a proxy is used. Leave empty for the default (10)." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "The Ad Library allows only about 10 requests per minute from one IP address, so the Actor spreads requests over Apify Proxy IPs. Without a proxy, runs are much slower.", "default": { "useApifyProxy": true } } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }