List your Microsoft Ads campaigns — status, budget
microsoft-ads.queryCampaigns in your Microsoft Advertising account, with status, budget and bid strategy
- Preço
- freePelo preço de tabela
- Taxa de sucesso
- —Ainda não há dados da taxa de sucessoAinda não há dados da taxa de sucesso
- Latência p50
- ——
- Última verificação
- —Ainda não verificado
POSThttps://toolswitch.dev/v1/tools/microsoft-ads.queryBeta- Usa a cota da plataforma
- Resposta síncrona
- Lê dados públicos
Parâmetros
returns Campaigns[] with Id, Name, Status, DailyBudget, BudgetType, BiddingScheme, StartDate/EndDate, Languages and CampaignType. DailyBudget is a plain decimal in the ACCOUNT CURRENCY — not micros, not cents, unlike Google and Meta. No performance metrics: pair with the Reporting service for spend and clicks
| Parâmetro | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|
| Corpo (JSON) | ||||
AccountId | inteiro | Obrigatório | the ad account id (a long). Must equal the CustomerAccountId header | 123456789 |
CampaignType | string | Opcional | SPACE-DELIMITED flags, not an array: "Search Shopping DynamicSearchAds Audience PerformanceMax". DEFAULTS TO Search — omit it and Shopping/PMax campaigns are silently missing from the result | Search Shopping PerformanceMax |
ReturnAdditionalFields | string | Opcional | space-delimited opt-ins for newer properties, e.g. "AdScheduleUseSearcherTimeZone BidStrategyId" | BidStrategyId |
- Corpo (JSON)
AccountIdinteiroObrigatóriothe ad account id (a long). Must equal the CustomerAccountId header
Exemplo:
123456789CampaignTypestringOpcionalSPACE-DELIMITED flags, not an array: "Search Shopping DynamicSearchAds Audience PerformanceMax". DEFAULTS TO Search — omit it and Shopping/PMax campaigns are silently missing from the result
Exemplo:
Search Shopping PerformanceMaxReturnAdditionalFieldsstringOpcionalspace-delimited opt-ins for newer properties, e.g. "AdScheduleUseSearcherTimeZone BidStrategyId"
Exemplo:
BidStrategyId
Exemplos de código
Substitua $TOOLSWITCH_KEY pela chave criada no console.
curl -X POST 'https://toolswitch.dev/v1/tools/microsoft-ads.query' \
-H "X-Toolswitch-Key: $TOOLSWITCH_KEY"import os
import requests
response = requests.request(
"POST",
"https://toolswitch.dev/v1/tools/microsoft-ads.query",
headers={"X-Toolswitch-Key": os.environ["TOOLSWITCH_KEY"]},
)
response.raise_for_status()
print(response.text)const response = await fetch("https://toolswitch.dev/v1/tools/microsoft-ads.query", {
method: "POST",
headers: {
"X-Toolswitch-Key": process.env.TOOLSWITCH_KEY ?? "",
},
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
console.log(await response.text());Esta API de gateway está em Beta; a URL e a autenticação podem mudar. Os parâmetros do exemplo são dados de amostra. As chamadas são cobradas a free, incluindo a taxa de serviço.