MCP-tool
Advertentieactie voorbereiden
sosoapi_ads_actions_prepareLeg een exact commando campaign/adset/ad/creative/saved-audience en de gecontroleerde gevolgen vast. Nieuwe objecten starten met PAUSED; activering of budgetgevolgen vereisen afzonderlijke bevoegdheid voor livebewerkingen.
Lezen als MarkdownProfielen en transporten
Profielen: full · Transporten: stdio, http
Kies core of full om te bepalen welke tools je client ziet; dit verandert geen machtigingen. Lokale bestandsupload vereist stdio en is niet beschikbaar via HTTP. Stel SOSOAPI_OUTPUT_SCHEMAS=1 in om uitvoerschema's bij detectie op te nemen. Tools geven met en zonder die instelling gestructureerde resultaten terug.
Machtigingen en neveneffecten
Annotaties helpen clients een tool te beschrijven. Elke aanroep controleert nog steeds gebruikersauthenticatie, rol, resourcetoegang en verleende bevoegdheden.
{
"readOnlyHint": false,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": true
}- /advertising-api/actions/prepare: agent:advertising_manage · synchronous_http_response
Invoervelden
Verplicht betekent verplicht binnen het bovenliggende object en de gekozen variant. Een verplicht onderliggend veld maakt een optioneel bovenliggend object niet verplicht. Onderstaande regels en veldnamen zijn uit het contract gekopieerd.
| Veld / variant | Type / verplicht | Beperkingen |
|---|---|---|
$ | objectVerplicht in bovenliggend object |
|
workspace_id | stringVerplicht in bovenliggend object |
|
advertising_account_id | stringVerplicht in bovenliggend object |
|
mutation_id | stringVerplicht in bovenliggend object |
|
command | objectVerplicht in bovenliggend object | — |
commandanyOf 1 | objectVerplicht in bovenliggend object |
|
command.operationanyOf 1 | stringVerplicht in bovenliggend object |
|
command.nameanyOf 1 | stringVerplicht in bovenliggend object |
|
command.budgetanyOf 1 | objectOptioneel / item |
|
command.budget.kindanyOf 1 | stringVerplicht in bovenliggend object |
|
command.budget.amount_minoranyOf 1 | stringVerplicht in bovenliggend object |
|
command.objectiveanyOf 1 | stringVerplicht in bovenliggend object |
|
command.special_ad_categoriesanyOf 1 | arrayOptioneel / item |
|
command.special_ad_categories[]anyOf 1 | stringOptioneel / item |
|
command.statusanyOf 1 | stringOptioneel / item |
|
commandanyOf 2 | objectVerplicht in bovenliggend object |
|
command.operationanyOf 2 | stringVerplicht in bovenliggend object |
|
command.object_idanyOf 2 | stringVerplicht in bovenliggend object |
|
command.nameanyOf 2 | stringOptioneel / item |
|
command.budgetanyOf 2 | objectOptioneel / item |
|
command.budget.kindanyOf 2 | stringVerplicht in bovenliggend object |
|
command.budget.amount_minoranyOf 2 | stringVerplicht in bovenliggend object |
|
command.statusanyOf 2 | stringOptioneel / item |
|
commandanyOf 3 | objectVerplicht in bovenliggend object |
|
command.operationanyOf 3 | stringVerplicht in bovenliggend object |
|
command.campaign_idanyOf 3 | stringVerplicht in bovenliggend object |
|
command.nameanyOf 3 | stringVerplicht in bovenliggend object |
|
command.budgetanyOf 3 | objectOptioneel / item |
|
command.budget.kindanyOf 3 | stringVerplicht in bovenliggend object |
|
command.budget.amount_minoranyOf 3 | stringVerplicht in bovenliggend object |
|
command.targetinganyOf 3 | objectVerplicht in bovenliggend object |
|
command.targeting.geo_locationsanyOf 3 | objectVerplicht in bovenliggend object |
|
command.targeting.geo_locations.countriesanyOf 3 | arrayVerplicht in bovenliggend object |
|
command.targeting.geo_locations.countries[]anyOf 3 | stringOptioneel / item |
|
command.targeting.age_minanyOf 3 | integerOptioneel / item |
|
command.targeting.age_maxanyOf 3 | integerOptioneel / item |
|
command.targeting.gendersanyOf 3 | arrayOptioneel / item |
|
command.targeting.genders[]anyOf 3 | numberOptioneel / item | — |
command.targeting.genders[]anyOf 3 / anyOf 1 | numberOptioneel / item |
|
command.targeting.genders[]anyOf 3 / anyOf 2 | numberOptioneel / item |
|
command.targeting.localesanyOf 3 | arrayOptioneel / item |
|
command.targeting.locales[]anyOf 3 | integerOptioneel / item |
|
command.targeting.publisher_platformsanyOf 3 | arrayVerplicht in bovenliggend object |
|
command.targeting.publisher_platforms[]anyOf 3 | stringOptioneel / item |
|
command.targeting.facebook_positionsanyOf 3 | arrayOptioneel / item |
|
command.targeting.facebook_positions[]anyOf 3 | stringOptioneel / item |
|
command.targeting.instagram_positionsanyOf 3 | arrayOptioneel / item |
|
command.targeting.instagram_positions[]anyOf 3 | stringOptioneel / item |
|
command.targeting.threads_positionsanyOf 3 | arrayOptioneel / item |
|
command.targeting.threads_positions[]anyOf 3 | stringOptioneel / item |
|
command.targeting.custom_audience_idsanyOf 3 | arrayOptioneel / item |
|
command.targeting.custom_audience_ids[]anyOf 3 | stringOptioneel / item |
|
command.targeting.excluded_custom_audience_idsanyOf 3 | arrayOptioneel / item |
|
command.targeting.excluded_custom_audience_ids[]anyOf 3 | stringOptioneel / item |
|
command.billing_eventanyOf 3 | stringVerplicht in bovenliggend object |
|
command.optimization_goalanyOf 3 | stringVerplicht in bovenliggend object |
|
command.bid_strategyanyOf 3 | stringOptioneel / item |
|
command.start_timeanyOf 3 | stringOptioneel / item |
|
command.end_timeanyOf 3 | stringOptioneel / item |
|
command.promoted_objectanyOf 3 | objectOptioneel / item |
|
command.promoted_object.page_idanyOf 3 | stringOptioneel / item |
|
command.promoted_object.pixel_idanyOf 3 | stringOptioneel / item |
|
command.promoted_object.custom_event_typeanyOf 3 | stringOptioneel / item |
|
command.statusanyOf 3 | stringOptioneel / item |
|
commandanyOf 4 | objectVerplicht in bovenliggend object |
|
command.operationanyOf 4 | stringVerplicht in bovenliggend object |
|
command.object_idanyOf 4 | stringVerplicht in bovenliggend object |
|
command.nameanyOf 4 | stringOptioneel / item |
|
command.budgetanyOf 4 | objectOptioneel / item |
|
command.budget.kindanyOf 4 | stringVerplicht in bovenliggend object |
|
command.budget.amount_minoranyOf 4 | stringVerplicht in bovenliggend object |
|
command.statusanyOf 4 | stringOptioneel / item |
|
command.targetinganyOf 4 | objectOptioneel / item |
|
command.targeting.geo_locationsanyOf 4 | objectVerplicht in bovenliggend object |
|
command.targeting.geo_locations.countriesanyOf 4 | arrayVerplicht in bovenliggend object |
|
command.targeting.geo_locations.countries[]anyOf 4 | stringOptioneel / item |
|
command.targeting.age_minanyOf 4 | integerOptioneel / item |
|
command.targeting.age_maxanyOf 4 | integerOptioneel / item |
|
command.targeting.gendersanyOf 4 | arrayOptioneel / item |
|
command.targeting.genders[]anyOf 4 | numberOptioneel / item | — |
command.targeting.genders[]anyOf 4 / anyOf 1 | numberOptioneel / item |
|
command.targeting.genders[]anyOf 4 / anyOf 2 | numberOptioneel / item |
|
command.targeting.localesanyOf 4 | arrayOptioneel / item |
|
command.targeting.locales[]anyOf 4 | integerOptioneel / item |
|
command.targeting.publisher_platformsanyOf 4 | arrayVerplicht in bovenliggend object |
|
command.targeting.publisher_platforms[]anyOf 4 | stringOptioneel / item |
|
command.targeting.facebook_positionsanyOf 4 | arrayOptioneel / item |
|
command.targeting.facebook_positions[]anyOf 4 | stringOptioneel / item |
|
command.targeting.instagram_positionsanyOf 4 | arrayOptioneel / item |
|
command.targeting.instagram_positions[]anyOf 4 | stringOptioneel / item |
|
command.targeting.threads_positionsanyOf 4 | arrayOptioneel / item |
|
command.targeting.threads_positions[]anyOf 4 | stringOptioneel / item |
|
command.targeting.custom_audience_idsanyOf 4 | arrayOptioneel / item |
|
command.targeting.custom_audience_ids[]anyOf 4 | stringOptioneel / item |
|
command.targeting.excluded_custom_audience_idsanyOf 4 | arrayOptioneel / item |
|
command.targeting.excluded_custom_audience_ids[]anyOf 4 | stringOptioneel / item |
|
command.start_timeanyOf 4 | stringOptioneel / item |
|
command.end_timeanyOf 4 | stringOptioneel / item |
|
commandanyOf 5 | objectVerplicht in bovenliggend object |
|
command.operationanyOf 5 | stringVerplicht in bovenliggend object |
|
command.nameanyOf 5 | stringVerplicht in bovenliggend object |
|
command.adset_idanyOf 5 | stringVerplicht in bovenliggend object |
|
command.creative_idanyOf 5 | stringVerplicht in bovenliggend object |
|
command.statusanyOf 5 | stringOptioneel / item |
|
commandanyOf 6 | objectVerplicht in bovenliggend object |
|
command.operationanyOf 6 | stringVerplicht in bovenliggend object |
|
command.object_idanyOf 6 | stringVerplicht in bovenliggend object |
|
command.nameanyOf 6 | stringOptioneel / item |
|
command.creative_idanyOf 6 | stringOptioneel / item |
|
command.statusanyOf 6 | stringOptioneel / item |
|
commandanyOf 7 | objectVerplicht in bovenliggend object |
|
command.operationanyOf 7 | stringVerplicht in bovenliggend object |
|
command.nameanyOf 7 | stringVerplicht in bovenliggend object |
|
command.object_story_specanyOf 7 | objectOptioneel / item |
|
command.object_story_spec.page_idanyOf 7 | stringVerplicht in bovenliggend object |
|
command.object_story_spec.instagram_user_idanyOf 7 | stringOptioneel / item |
|
command.object_story_spec.link_dataanyOf 7 | objectVerplicht in bovenliggend object |
|
command.object_story_spec.link_data.linkanyOf 7 | stringVerplicht in bovenliggend object |
|
command.object_story_spec.link_data.messageanyOf 7 | stringVerplicht in bovenliggend object |
|
command.object_story_spec.link_data.nameanyOf 7 | stringOptioneel / item |
|
command.object_story_spec.link_data.image_hashanyOf 7 | stringVerplicht in bovenliggend object |
|
command.object_story_spec.link_data.call_to_actionanyOf 7 | stringOptioneel / item |
|
command.object_story_idanyOf 7 | stringOptioneel / item |
|
commandanyOf 8 | objectVerplicht in bovenliggend object |
|
command.operationanyOf 8 | stringVerplicht in bovenliggend object |
|
command.nameanyOf 8 | stringVerplicht in bovenliggend object |
|
command.targetinganyOf 8 | objectVerplicht in bovenliggend object |
|
command.targeting.geo_locationsanyOf 8 | objectVerplicht in bovenliggend object |
|
command.targeting.geo_locations.countriesanyOf 8 | arrayVerplicht in bovenliggend object |
|
command.targeting.geo_locations.countries[]anyOf 8 | stringOptioneel / item |
|
command.targeting.age_minanyOf 8 | integerOptioneel / item |
|
command.targeting.age_maxanyOf 8 | integerOptioneel / item |
|
command.targeting.gendersanyOf 8 | arrayOptioneel / item |
|
command.targeting.genders[]anyOf 8 | numberOptioneel / item | — |
command.targeting.genders[]anyOf 8 / anyOf 1 | numberOptioneel / item |
|
command.targeting.genders[]anyOf 8 / anyOf 2 | numberOptioneel / item |
|
command.targeting.localesanyOf 8 | arrayOptioneel / item |
|
command.targeting.locales[]anyOf 8 | integerOptioneel / item |
|
command.targeting.publisher_platformsanyOf 8 | arrayVerplicht in bovenliggend object |
|
command.targeting.publisher_platforms[]anyOf 8 | stringOptioneel / item |
|
command.targeting.facebook_positionsanyOf 8 | arrayOptioneel / item |
|
command.targeting.facebook_positions[]anyOf 8 | stringOptioneel / item |
|
command.targeting.instagram_positionsanyOf 8 | arrayOptioneel / item |
|
command.targeting.instagram_positions[]anyOf 8 | stringOptioneel / item |
|
command.targeting.threads_positionsanyOf 8 | arrayOptioneel / item |
|
command.targeting.threads_positions[]anyOf 8 | stringOptioneel / item |
|
command.targeting.custom_audience_idsanyOf 8 | arrayOptioneel / item |
|
command.targeting.custom_audience_ids[]anyOf 8 | stringOptioneel / item |
|
command.targeting.excluded_custom_audience_idsanyOf 8 | arrayOptioneel / item |
|
command.targeting.excluded_custom_audience_ids[]anyOf 8 | stringOptioneel / item |
|
commandanyOf 9 | objectVerplicht in bovenliggend object |
|
command.operationanyOf 9 | stringVerplicht in bovenliggend object |
|
command.object_idanyOf 9 | stringVerplicht in bovenliggend object |
|
command.nameanyOf 9 | stringOptioneel / item |
|
command.targetinganyOf 9 | objectOptioneel / item |
|
command.targeting.geo_locationsanyOf 9 | objectVerplicht in bovenliggend object |
|
command.targeting.geo_locations.countriesanyOf 9 | arrayVerplicht in bovenliggend object |
|
command.targeting.geo_locations.countries[]anyOf 9 | stringOptioneel / item |
|
command.targeting.age_minanyOf 9 | integerOptioneel / item |
|
command.targeting.age_maxanyOf 9 | integerOptioneel / item |
|
command.targeting.gendersanyOf 9 | arrayOptioneel / item |
|
command.targeting.genders[]anyOf 9 | numberOptioneel / item | — |
command.targeting.genders[]anyOf 9 / anyOf 1 | numberOptioneel / item |
|
command.targeting.genders[]anyOf 9 / anyOf 2 | numberOptioneel / item |
|
command.targeting.localesanyOf 9 | arrayOptioneel / item |
|
command.targeting.locales[]anyOf 9 | integerOptioneel / item |
|
command.targeting.publisher_platformsanyOf 9 | arrayVerplicht in bovenliggend object |
|
command.targeting.publisher_platforms[]anyOf 9 | stringOptioneel / item |
|
command.targeting.facebook_positionsanyOf 9 | arrayOptioneel / item |
|
command.targeting.facebook_positions[]anyOf 9 | stringOptioneel / item |
|
command.targeting.instagram_positionsanyOf 9 | arrayOptioneel / item |
|
command.targeting.instagram_positions[]anyOf 9 | stringOptioneel / item |
|
command.targeting.threads_positionsanyOf 9 | arrayOptioneel / item |
|
command.targeting.threads_positions[]anyOf 9 | stringOptioneel / item |
|
command.targeting.custom_audience_idsanyOf 9 | arrayOptioneel / item |
|
command.targeting.custom_audience_ids[]anyOf 9 | stringOptioneel / item |
|
command.targeting.excluded_custom_audience_idsanyOf 9 | arrayOptioneel / item |
|
command.targeting.excluded_custom_audience_ids[]anyOf 9 | stringOptioneel / item |
|
Volledig JSON Schema
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
},
"advertising_account_id": {
"type": "string",
"format": "uuid"
},
"mutation_id": {
"type": "string",
"format": "uuid"
},
"command": {
"anyOf": [
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"create_campaign"
]
},
"name": {
"$ref": "#/$defs/s4"
},
"budget": {
"$ref": "#/$defs/s2"
},
"objective": {
"type": "string",
"enum": [
"OUTCOME_AWARENESS",
"OUTCOME_ENGAGEMENT",
"OUTCOME_LEADS",
"OUTCOME_SALES",
"OUTCOME_TRAFFIC",
"OUTCOME_APP_PROMOTION"
]
},
"special_ad_categories": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"enum": [
"CREDIT",
"EMPLOYMENT",
"HOUSING",
"ISSUES_ELECTIONS_POLITICS"
]
}
},
"status": {
"$ref": "#/$defs/s6"
}
},
"required": [
"operation",
"name",
"objective"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"update_campaign"
]
},
"object_id": {
"$ref": "#/$defs/s3"
},
"name": {
"$ref": "#/$defs/s4"
},
"budget": {
"$ref": "#/$defs/s2"
},
"status": {
"$ref": "#/$defs/s5"
}
},
"required": [
"operation",
"object_id"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"create_adset"
]
},
"campaign_id": {
"$ref": "#/$defs/s3"
},
"name": {
"$ref": "#/$defs/s4"
},
"budget": {
"$ref": "#/$defs/s2"
},
"targeting": {
"$ref": "#/$defs/s0"
},
"billing_event": {
"type": "string",
"enum": [
"IMPRESSIONS",
"LINK_CLICKS"
]
},
"optimization_goal": {
"type": "string",
"enum": [
"REACH",
"IMPRESSIONS",
"LINK_CLICKS",
"LANDING_PAGE_VIEWS",
"OFFSITE_CONVERSIONS",
"LEAD_GENERATION"
]
},
"bid_strategy": {
"type": "string",
"enum": [
"LOWEST_COST_WITHOUT_CAP"
]
},
"start_time": {
"$ref": "#/$defs/s1"
},
"end_time": {
"$ref": "#/$defs/s1"
},
"promoted_object": {
"type": "object",
"properties": {
"page_id": {
"$ref": "#/$defs/s3"
},
"pixel_id": {
"$ref": "#/$defs/s3"
},
"custom_event_type": {
"type": "string",
"enum": [
"PURCHASE",
"LEAD",
"COMPLETE_REGISTRATION",
"ADD_TO_CART"
]
}
},
"additionalProperties": false
},
"status": {
"$ref": "#/$defs/s6"
}
},
"required": [
"operation",
"campaign_id",
"name",
"targeting",
"billing_event",
"optimization_goal"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"update_adset"
]
},
"object_id": {
"$ref": "#/$defs/s3"
},
"name": {
"$ref": "#/$defs/s4"
},
"budget": {
"$ref": "#/$defs/s2"
},
"status": {
"$ref": "#/$defs/s5"
},
"targeting": {
"$ref": "#/$defs/s0"
},
"start_time": {
"$ref": "#/$defs/s1"
},
"end_time": {
"$ref": "#/$defs/s1"
}
},
"required": [
"operation",
"object_id"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"create_ad"
]
},
"name": {
"$ref": "#/$defs/s4"
},
"adset_id": {
"$ref": "#/$defs/s3"
},
"creative_id": {
"$ref": "#/$defs/s3"
},
"status": {
"$ref": "#/$defs/s6"
}
},
"required": [
"operation",
"name",
"adset_id",
"creative_id"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"update_ad"
]
},
"object_id": {
"$ref": "#/$defs/s3"
},
"name": {
"$ref": "#/$defs/s4"
},
"creative_id": {
"$ref": "#/$defs/s3"
},
"status": {
"$ref": "#/$defs/s5"
}
},
"required": [
"operation",
"object_id"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"create_creative"
]
},
"name": {
"$ref": "#/$defs/s4"
},
"object_story_spec": {
"type": "object",
"properties": {
"page_id": {
"$ref": "#/$defs/s3"
},
"instagram_user_id": {
"$ref": "#/$defs/s3"
},
"link_data": {
"type": "object",
"properties": {
"link": {
"type": "string",
"maxLength": 2048,
"format": "uri"
},
"message": {
"type": "string",
"maxLength": 5000
},
"name": {
"$ref": "#/$defs/s4"
},
"image_hash": {
"type": "string",
"pattern": "^[a-fA-F0-9]{16,128}$"
},
"call_to_action": {
"type": "string",
"enum": [
"LEARN_MORE",
"SHOP_NOW",
"SIGN_UP",
"CONTACT_US"
]
}
},
"required": [
"link",
"message",
"image_hash"
],
"additionalProperties": false
}
},
"required": [
"page_id",
"link_data"
],
"additionalProperties": false
},
"object_story_id": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}_[1-9]\\d{1,24}$"
}
},
"required": [
"operation",
"name"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"create_saved_audience"
]
},
"name": {
"$ref": "#/$defs/s4"
},
"targeting": {
"$ref": "#/$defs/s0"
}
},
"required": [
"operation",
"name",
"targeting"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"update_saved_audience"
]
},
"object_id": {
"$ref": "#/$defs/s3"
},
"name": {
"$ref": "#/$defs/s4"
},
"targeting": {
"$ref": "#/$defs/s0"
}
},
"required": [
"operation",
"object_id"
],
"additionalProperties": false
}
]
}
},
"required": [
"workspace_id",
"advertising_account_id",
"mutation_id",
"command"
],
"additionalProperties": false,
"$defs": {
"s0": {
"type": "object",
"properties": {
"geo_locations": {
"type": "object",
"properties": {
"countries": {
"minItems": 1,
"maxItems": 25,
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Z]{2}$"
}
}
},
"required": [
"countries"
],
"additionalProperties": false
},
"age_min": {
"type": "integer",
"minimum": 18,
"maximum": 65
},
"age_max": {
"type": "integer",
"minimum": 18,
"maximum": 65
},
"genders": {
"minItems": 1,
"maxItems": 2,
"type": "array",
"items": {
"anyOf": [
{
"type": "number",
"enum": [
1
]
},
{
"type": "number",
"enum": [
2
]
}
]
}
},
"locales": {
"maxItems": 25,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"publisher_platforms": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"type": "string",
"enum": [
"facebook",
"instagram",
"threads"
]
}
},
"facebook_positions": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"enum": [
"feed",
"story",
"facebook_reels",
"video_feeds"
]
}
},
"instagram_positions": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"enum": [
"stream",
"story",
"reels",
"explore"
]
}
},
"threads_positions": {
"maxItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"threads_stream"
]
}
},
"custom_audience_ids": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
}
},
"excluded_custom_audience_ids": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
}
}
},
"required": [
"geo_locations",
"publisher_platforms"
],
"additionalProperties": false
},
"s1": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"s2": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"daily",
"lifetime"
]
},
"amount_minor": {
"type": "string",
"pattern": "^[1-9]\\d{0,11}$"
}
},
"required": [
"kind",
"amount_minor"
],
"additionalProperties": false
},
"s3": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
},
"s4": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"s5": {
"type": "string",
"enum": [
"ACTIVE",
"PAUSED",
"ARCHIVED"
]
},
"s6": {
"type": "string",
"enum": [
"PAUSED"
]
}
}
}Gestructureerde uitvoer
Dit schema beschrijft structuredContent in een geslaagd toolresultaat. Het MCP-antwoord bevat ook content en kan isError instellen wanneer een aanroep mislukt. Lees bij publiceren het definitieve berichtresultaat; beschouw een geaccepteerd verzoek of tekstantwoord niet als bevestiging. De gekoppelde API-bewerking beschrijft machtigingen en regels voor opnieuw proberen.
Verplicht betekent verplicht binnen het bovenliggende object en de gekozen variant. Een verplicht onderliggend veld maakt een optioneel bovenliggend object niet verplicht. Onderstaande regels en veldnamen zijn uit het contract gekopieerd.
| Veld / variant | Type / verplicht | Beperkingen |
|---|---|---|
$ | objectVerplicht in bovenliggend object |
|
contract_version | stringVerplicht in bovenliggend object |
|
prepare_token | stringVerplicht in bovenliggend object |
|
expires_at | stringVerplicht in bovenliggend object |
|
action | objectVerplicht in bovenliggend object |
|
action.id | stringVerplicht in bovenliggend object |
|
action.workspace_id | stringVerplicht in bovenliggend object |
|
action.advertising_account_id | stringVerplicht in bovenliggend object |
|
action.mutation_id | stringVerplicht in bovenliggend object |
|
action.status | stringVerplicht in bovenliggend object |
|
action.command | objectVerplicht in bovenliggend object | — |
action.commandoneOf 1 | objectVerplicht in bovenliggend object |
|
action.command.operationoneOf 1 | stringVerplicht in bovenliggend object |
|
action.command.nameoneOf 1 | stringVerplicht in bovenliggend object |
|
action.command.budgetoneOf 1 | objectOptioneel / item |
|
action.command.budget.kindoneOf 1 | stringVerplicht in bovenliggend object |
|
action.command.budget.amount_minoroneOf 1 | stringVerplicht in bovenliggend object |
|
action.command.objectiveoneOf 1 | stringVerplicht in bovenliggend object |
|
action.command.special_ad_categoriesoneOf 1 | arrayVerplicht in bovenliggend object |
|
action.command.special_ad_categories[]oneOf 1 | stringOptioneel / item |
|
action.command.statusoneOf 1 | stringVerplicht in bovenliggend object |
|
action.commandoneOf 2 | objectVerplicht in bovenliggend object |
|
action.command.operationoneOf 2 | stringVerplicht in bovenliggend object |
|
action.command.object_idoneOf 2 | stringVerplicht in bovenliggend object |
|
action.command.nameoneOf 2 | stringOptioneel / item |
|
action.command.budgetoneOf 2 | objectOptioneel / item |
|
action.command.budget.kindoneOf 2 | stringVerplicht in bovenliggend object |
|
action.command.budget.amount_minoroneOf 2 | stringVerplicht in bovenliggend object |
|
action.command.statusoneOf 2 | stringOptioneel / item |
|
action.commandoneOf 3 | objectVerplicht in bovenliggend object |
|
action.command.operationoneOf 3 | stringVerplicht in bovenliggend object |
|
action.command.campaign_idoneOf 3 | stringVerplicht in bovenliggend object |
|
action.command.nameoneOf 3 | stringVerplicht in bovenliggend object |
|
action.command.budgetoneOf 3 | objectOptioneel / item |
|
action.command.budget.kindoneOf 3 | stringVerplicht in bovenliggend object |
|
action.command.budget.amount_minoroneOf 3 | stringVerplicht in bovenliggend object |
|
action.command.targetingoneOf 3 | objectVerplicht in bovenliggend object |
|
action.command.targeting.geo_locationsoneOf 3 | objectVerplicht in bovenliggend object |
|
action.command.targeting.geo_locations.countriesoneOf 3 | arrayVerplicht in bovenliggend object |
|
action.command.targeting.geo_locations.countries[]oneOf 3 | stringOptioneel / item |
|
action.command.targeting.age_minoneOf 3 | integerVerplicht in bovenliggend object |
|
action.command.targeting.age_maxoneOf 3 | integerVerplicht in bovenliggend object |
|
action.command.targeting.gendersoneOf 3 | arrayOptioneel / item |
|
action.command.targeting.genders[]oneOf 3 | numberOptioneel / item | — |
action.command.targeting.genders[]oneOf 3 / anyOf 1 | numberOptioneel / item |
|
action.command.targeting.genders[]oneOf 3 / anyOf 2 | numberOptioneel / item |
|
action.command.targeting.localesoneOf 3 | arrayOptioneel / item |
|
action.command.targeting.locales[]oneOf 3 | integerOptioneel / item |
|
action.command.targeting.publisher_platformsoneOf 3 | arrayVerplicht in bovenliggend object |
|
action.command.targeting.publisher_platforms[]oneOf 3 | stringOptioneel / item |
|
action.command.targeting.facebook_positionsoneOf 3 | arrayOptioneel / item |
|
action.command.targeting.facebook_positions[]oneOf 3 | stringOptioneel / item |
|
action.command.targeting.instagram_positionsoneOf 3 | arrayOptioneel / item |
|
action.command.targeting.instagram_positions[]oneOf 3 | stringOptioneel / item |
|
action.command.targeting.threads_positionsoneOf 3 | arrayOptioneel / item |
|
action.command.targeting.threads_positions[]oneOf 3 | stringOptioneel / item |
|
action.command.targeting.custom_audience_idsoneOf 3 | arrayOptioneel / item |
|
action.command.targeting.custom_audience_ids[]oneOf 3 | stringOptioneel / item |
|
action.command.targeting.excluded_custom_audience_idsoneOf 3 | arrayOptioneel / item |
|
action.command.targeting.excluded_custom_audience_ids[]oneOf 3 | stringOptioneel / item |
|
action.command.billing_eventoneOf 3 | stringVerplicht in bovenliggend object |
|
action.command.optimization_goaloneOf 3 | stringVerplicht in bovenliggend object |
|
action.command.bid_strategyoneOf 3 | stringVerplicht in bovenliggend object |
|
action.command.start_timeoneOf 3 | stringOptioneel / item |
|
action.command.end_timeoneOf 3 | stringOptioneel / item |
|
action.command.promoted_objectoneOf 3 | objectOptioneel / item |
|
action.command.promoted_object.page_idoneOf 3 | stringOptioneel / item |
|
action.command.promoted_object.pixel_idoneOf 3 | stringOptioneel / item |
|
action.command.promoted_object.custom_event_typeoneOf 3 | stringOptioneel / item |
|
action.command.statusoneOf 3 | stringVerplicht in bovenliggend object |
|
action.commandoneOf 4 | objectVerplicht in bovenliggend object |
|
action.command.operationoneOf 4 | stringVerplicht in bovenliggend object |
|
action.command.object_idoneOf 4 | stringVerplicht in bovenliggend object |
|
action.command.nameoneOf 4 | stringOptioneel / item |
|
action.command.budgetoneOf 4 | objectOptioneel / item |
|
action.command.budget.kindoneOf 4 | stringVerplicht in bovenliggend object |
|
action.command.budget.amount_minoroneOf 4 | stringVerplicht in bovenliggend object |
|
action.command.statusoneOf 4 | stringOptioneel / item |
|
action.command.targetingoneOf 4 | objectOptioneel / item |
|
action.command.targeting.geo_locationsoneOf 4 | objectVerplicht in bovenliggend object |
|
action.command.targeting.geo_locations.countriesoneOf 4 | arrayVerplicht in bovenliggend object |
|
action.command.targeting.geo_locations.countries[]oneOf 4 | stringOptioneel / item |
|
action.command.targeting.age_minoneOf 4 | integerVerplicht in bovenliggend object |
|
action.command.targeting.age_maxoneOf 4 | integerVerplicht in bovenliggend object |
|
action.command.targeting.gendersoneOf 4 | arrayOptioneel / item |
|
action.command.targeting.genders[]oneOf 4 | numberOptioneel / item | — |
action.command.targeting.genders[]oneOf 4 / anyOf 1 | numberOptioneel / item |
|
action.command.targeting.genders[]oneOf 4 / anyOf 2 | numberOptioneel / item |
|
action.command.targeting.localesoneOf 4 | arrayOptioneel / item |
|
action.command.targeting.locales[]oneOf 4 | integerOptioneel / item |
|
action.command.targeting.publisher_platformsoneOf 4 | arrayVerplicht in bovenliggend object |
|
action.command.targeting.publisher_platforms[]oneOf 4 | stringOptioneel / item |
|
action.command.targeting.facebook_positionsoneOf 4 | arrayOptioneel / item |
|
action.command.targeting.facebook_positions[]oneOf 4 | stringOptioneel / item |
|
action.command.targeting.instagram_positionsoneOf 4 | arrayOptioneel / item |
|
action.command.targeting.instagram_positions[]oneOf 4 | stringOptioneel / item |
|
action.command.targeting.threads_positionsoneOf 4 | arrayOptioneel / item |
|
action.command.targeting.threads_positions[]oneOf 4 | stringOptioneel / item |
|
action.command.targeting.custom_audience_idsoneOf 4 | arrayOptioneel / item |
|
action.command.targeting.custom_audience_ids[]oneOf 4 | stringOptioneel / item |
|
action.command.targeting.excluded_custom_audience_idsoneOf 4 | arrayOptioneel / item |
|
action.command.targeting.excluded_custom_audience_ids[]oneOf 4 | stringOptioneel / item |
|
action.command.start_timeoneOf 4 | stringOptioneel / item |
|
action.command.end_timeoneOf 4 | stringOptioneel / item |
|
action.commandoneOf 5 | objectVerplicht in bovenliggend object |
|
action.command.operationoneOf 5 | stringVerplicht in bovenliggend object |
|
action.command.nameoneOf 5 | stringVerplicht in bovenliggend object |
|
action.command.adset_idoneOf 5 | stringVerplicht in bovenliggend object |
|
action.command.creative_idoneOf 5 | stringVerplicht in bovenliggend object |
|
action.command.statusoneOf 5 | stringVerplicht in bovenliggend object |
|
action.commandoneOf 6 | objectVerplicht in bovenliggend object |
|
action.command.operationoneOf 6 | stringVerplicht in bovenliggend object |
|
action.command.object_idoneOf 6 | stringVerplicht in bovenliggend object |
|
action.command.nameoneOf 6 | stringOptioneel / item |
|
action.command.creative_idoneOf 6 | stringOptioneel / item |
|
action.command.statusoneOf 6 | stringOptioneel / item |
|
action.commandoneOf 7 | objectVerplicht in bovenliggend object |
|
action.command.operationoneOf 7 | stringVerplicht in bovenliggend object |
|
action.command.nameoneOf 7 | stringVerplicht in bovenliggend object |
|
action.command.object_story_speconeOf 7 | objectOptioneel / item |
|
action.command.object_story_spec.page_idoneOf 7 | stringVerplicht in bovenliggend object |
|
action.command.object_story_spec.instagram_user_idoneOf 7 | stringOptioneel / item |
|
action.command.object_story_spec.link_dataoneOf 7 | objectVerplicht in bovenliggend object |
|
action.command.object_story_spec.link_data.linkoneOf 7 | stringVerplicht in bovenliggend object |
|
action.command.object_story_spec.link_data.messageoneOf 7 | stringVerplicht in bovenliggend object |
|
action.command.object_story_spec.link_data.nameoneOf 7 | stringOptioneel / item |
|
action.command.object_story_spec.link_data.image_hashoneOf 7 | stringVerplicht in bovenliggend object |
|
action.command.object_story_spec.link_data.call_to_actiononeOf 7 | stringOptioneel / item |
|
action.command.object_story_idoneOf 7 | stringOptioneel / item |
|
action.commandoneOf 8 | objectVerplicht in bovenliggend object |
|
action.command.operationoneOf 8 | stringVerplicht in bovenliggend object |
|
action.command.nameoneOf 8 | stringVerplicht in bovenliggend object |
|
action.command.targetingoneOf 8 | objectVerplicht in bovenliggend object |
|
action.command.targeting.geo_locationsoneOf 8 | objectVerplicht in bovenliggend object |
|
action.command.targeting.geo_locations.countriesoneOf 8 | arrayVerplicht in bovenliggend object |
|
action.command.targeting.geo_locations.countries[]oneOf 8 | stringOptioneel / item |
|
action.command.targeting.age_minoneOf 8 | integerVerplicht in bovenliggend object |
|
action.command.targeting.age_maxoneOf 8 | integerVerplicht in bovenliggend object |
|
action.command.targeting.gendersoneOf 8 | arrayOptioneel / item |
|
action.command.targeting.genders[]oneOf 8 | numberOptioneel / item | — |
action.command.targeting.genders[]oneOf 8 / anyOf 1 | numberOptioneel / item |
|
action.command.targeting.genders[]oneOf 8 / anyOf 2 | numberOptioneel / item |
|
action.command.targeting.localesoneOf 8 | arrayOptioneel / item |
|
action.command.targeting.locales[]oneOf 8 | integerOptioneel / item |
|
action.command.targeting.publisher_platformsoneOf 8 | arrayVerplicht in bovenliggend object |
|
action.command.targeting.publisher_platforms[]oneOf 8 | stringOptioneel / item |
|
action.command.targeting.facebook_positionsoneOf 8 | arrayOptioneel / item |
|
action.command.targeting.facebook_positions[]oneOf 8 | stringOptioneel / item |
|
action.command.targeting.instagram_positionsoneOf 8 | arrayOptioneel / item |
|
action.command.targeting.instagram_positions[]oneOf 8 | stringOptioneel / item |
|
action.command.targeting.threads_positionsoneOf 8 | arrayOptioneel / item |
|
action.command.targeting.threads_positions[]oneOf 8 | stringOptioneel / item |
|
action.command.targeting.custom_audience_idsoneOf 8 | arrayOptioneel / item |
|
action.command.targeting.custom_audience_ids[]oneOf 8 | stringOptioneel / item |
|
action.command.targeting.excluded_custom_audience_idsoneOf 8 | arrayOptioneel / item |
|
action.command.targeting.excluded_custom_audience_ids[]oneOf 8 | stringOptioneel / item |
|
action.commandoneOf 9 | objectVerplicht in bovenliggend object |
|
action.command.operationoneOf 9 | stringVerplicht in bovenliggend object |
|
action.command.object_idoneOf 9 | stringVerplicht in bovenliggend object |
|
action.command.nameoneOf 9 | stringOptioneel / item |
|
action.command.targetingoneOf 9 | objectOptioneel / item |
|
action.command.targeting.geo_locationsoneOf 9 | objectVerplicht in bovenliggend object |
|
action.command.targeting.geo_locations.countriesoneOf 9 | arrayVerplicht in bovenliggend object |
|
action.command.targeting.geo_locations.countries[]oneOf 9 | stringOptioneel / item |
|
action.command.targeting.age_minoneOf 9 | integerVerplicht in bovenliggend object |
|
action.command.targeting.age_maxoneOf 9 | integerVerplicht in bovenliggend object |
|
action.command.targeting.gendersoneOf 9 | arrayOptioneel / item |
|
action.command.targeting.genders[]oneOf 9 | numberOptioneel / item | — |
action.command.targeting.genders[]oneOf 9 / anyOf 1 | numberOptioneel / item |
|
action.command.targeting.genders[]oneOf 9 / anyOf 2 | numberOptioneel / item |
|
action.command.targeting.localesoneOf 9 | arrayOptioneel / item |
|
action.command.targeting.locales[]oneOf 9 | integerOptioneel / item |
|
action.command.targeting.publisher_platformsoneOf 9 | arrayVerplicht in bovenliggend object |
|
action.command.targeting.publisher_platforms[]oneOf 9 | stringOptioneel / item |
|
action.command.targeting.facebook_positionsoneOf 9 | arrayOptioneel / item |
|
action.command.targeting.facebook_positions[]oneOf 9 | stringOptioneel / item |
|
action.command.targeting.instagram_positionsoneOf 9 | arrayOptioneel / item |
|
action.command.targeting.instagram_positions[]oneOf 9 | stringOptioneel / item |
|
action.command.targeting.threads_positionsoneOf 9 | arrayOptioneel / item |
|
action.command.targeting.threads_positions[]oneOf 9 | stringOptioneel / item |
|
action.command.targeting.custom_audience_idsoneOf 9 | arrayOptioneel / item |
|
action.command.targeting.custom_audience_ids[]oneOf 9 | stringOptioneel / item |
|
action.command.targeting.excluded_custom_audience_idsoneOf 9 | arrayOptioneel / item |
|
action.command.targeting.excluded_custom_audience_ids[]oneOf 9 | stringOptioneel / item |
|
action.reviewed_digest | stringVerplicht in bovenliggend object |
|
action.effects | objectVerplicht in bovenliggend object |
|
action.effects.creates_object | booleanVerplicht in bovenliggend object | — |
action.effects.initial_status | string | nullVerplicht in bovenliggend object | — |
action.effects.initial_statusanyOf 1 | stringVerplicht in bovenliggend object |
|
action.effects.initial_statusanyOf 2 | nullVerplicht in bovenliggend object | — |
action.effects.activates_delivery | booleanVerplicht in bovenliggend object | — |
action.effects.changes_budget | booleanVerplicht in bovenliggend object | — |
action.effects.changes_audience | booleanVerplicht in bovenliggend object | — |
action.effects.changes_creative | booleanVerplicht in bovenliggend object | — |
action.effects.currency | stringVerplicht in bovenliggend object |
|
action.effects.timezone | stringVerplicht in bovenliggend object |
|
action.effects.budget | object | nullVerplicht in bovenliggend object | — |
action.effects.budgetanyOf 1 | objectVerplicht in bovenliggend object |
|
action.effects.budget.kindanyOf 1 | stringVerplicht in bovenliggend object |
|
action.effects.budget.amount_minoranyOf 1 | stringVerplicht in bovenliggend object |
|
action.effects.budgetanyOf 2 | nullVerplicht in bovenliggend object | — |
action.live_approval | objectVerplicht in bovenliggend object |
|
action.live_approval.required | booleanVerplicht in bovenliggend object | — |
action.live_approval.state | stringVerplicht in bovenliggend object |
|
action.live_approval.reason | string | nullVerplicht in bovenliggend object | — |
action.live_approval.reasonanyOf 1 | stringVerplicht in bovenliggend object |
|
action.live_approval.reasonanyOf 2 | nullVerplicht in bovenliggend object | — |
action.live_approval.expires_at | string | nullVerplicht in bovenliggend object | — |
action.live_approval.expires_atanyOf 1 | stringVerplicht in bovenliggend object |
|
action.live_approval.expires_atanyOf 2 | nullVerplicht in bovenliggend object | — |
action.live_approval.approved_by | string | nullVerplicht in bovenliggend object | — |
action.live_approval.approved_byanyOf 1 | stringVerplicht in bovenliggend object |
|
action.live_approval.approved_byanyOf 2 | nullVerplicht in bovenliggend object | — |
action.provider_object_id | string | nullVerplicht in bovenliggend object | — |
action.provider_object_idanyOf 1 | stringVerplicht in bovenliggend object |
|
action.provider_object_idanyOf 2 | nullVerplicht in bovenliggend object | — |
action.failure_code | string | nullVerplicht in bovenliggend object | — |
action.failure_codeanyOf 1 | stringVerplicht in bovenliggend object |
|
action.failure_codeanyOf 2 | nullVerplicht in bovenliggend object | — |
action.created_at | stringVerplicht in bovenliggend object |
|
action.completed_at | string | nullVerplicht in bovenliggend object | — |
action.completed_atanyOf 1 | stringVerplicht in bovenliggend object |
|
action.completed_atanyOf 2 | nullVerplicht in bovenliggend object | — |
Volledig JSON Schema
{
"type": "object",
"properties": {
"contract_version": {
"type": "string",
"const": "advertising/v1"
},
"prepare_token": {
"type": "string",
"minLength": 32,
"maxLength": 128
},
"expires_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"action": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspace_id": {
"type": "string",
"format": "uuid"
},
"advertising_account_id": {
"type": "string",
"format": "uuid"
},
"mutation_id": {
"type": "string",
"format": "uuid"
},
"status": {
"type": "string",
"enum": [
"prepared",
"queued",
"processing",
"succeeded",
"failed",
"unknown",
"cancelled"
]
},
"command": {
"oneOf": [
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"const": "create_campaign"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"budget": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"daily",
"lifetime"
]
},
"amount_minor": {
"type": "string",
"pattern": "^[1-9]\\d{0,11}$"
}
},
"required": [
"kind",
"amount_minor"
],
"additionalProperties": false
},
"objective": {
"type": "string",
"enum": [
"OUTCOME_AWARENESS",
"OUTCOME_ENGAGEMENT",
"OUTCOME_LEADS",
"OUTCOME_SALES",
"OUTCOME_TRAFFIC",
"OUTCOME_APP_PROMOTION"
]
},
"special_ad_categories": {
"default": [],
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"enum": [
"CREDIT",
"EMPLOYMENT",
"HOUSING",
"ISSUES_ELECTIONS_POLITICS"
]
}
},
"status": {
"default": "PAUSED",
"type": "string",
"const": "PAUSED"
}
},
"required": [
"operation",
"name",
"objective",
"special_ad_categories",
"status"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"const": "update_campaign"
},
"object_id": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"budget": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"daily",
"lifetime"
]
},
"amount_minor": {
"type": "string",
"pattern": "^[1-9]\\d{0,11}$"
}
},
"required": [
"kind",
"amount_minor"
],
"additionalProperties": false
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"PAUSED",
"ARCHIVED"
]
}
},
"required": [
"operation",
"object_id"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"const": "create_adset"
},
"campaign_id": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"budget": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"daily",
"lifetime"
]
},
"amount_minor": {
"type": "string",
"pattern": "^[1-9]\\d{0,11}$"
}
},
"required": [
"kind",
"amount_minor"
],
"additionalProperties": false
},
"targeting": {
"type": "object",
"properties": {
"geo_locations": {
"type": "object",
"properties": {
"countries": {
"minItems": 1,
"maxItems": 25,
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Z]{2}$"
}
}
},
"required": [
"countries"
],
"additionalProperties": false
},
"age_min": {
"default": 18,
"type": "integer",
"minimum": 18,
"maximum": 65
},
"age_max": {
"default": 65,
"type": "integer",
"minimum": 18,
"maximum": 65
},
"genders": {
"minItems": 1,
"maxItems": 2,
"type": "array",
"items": {
"anyOf": [
{
"type": "number",
"const": 1
},
{
"type": "number",
"const": 2
}
]
}
},
"locales": {
"maxItems": 25,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"publisher_platforms": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"type": "string",
"enum": [
"facebook",
"instagram",
"threads"
]
}
},
"facebook_positions": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"enum": [
"feed",
"story",
"facebook_reels",
"video_feeds"
]
}
},
"instagram_positions": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"enum": [
"stream",
"story",
"reels",
"explore"
]
}
},
"threads_positions": {
"maxItems": 1,
"type": "array",
"items": {
"type": "string",
"const": "threads_stream"
}
},
"custom_audience_ids": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
}
},
"excluded_custom_audience_ids": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
}
}
},
"required": [
"geo_locations",
"age_min",
"age_max",
"publisher_platforms"
],
"additionalProperties": false
},
"billing_event": {
"type": "string",
"enum": [
"IMPRESSIONS",
"LINK_CLICKS"
]
},
"optimization_goal": {
"type": "string",
"enum": [
"REACH",
"IMPRESSIONS",
"LINK_CLICKS",
"LANDING_PAGE_VIEWS",
"OFFSITE_CONVERSIONS",
"LEAD_GENERATION"
]
},
"bid_strategy": {
"default": "LOWEST_COST_WITHOUT_CAP",
"type": "string",
"const": "LOWEST_COST_WITHOUT_CAP"
},
"start_time": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"end_time": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"promoted_object": {
"type": "object",
"properties": {
"page_id": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
},
"pixel_id": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
},
"custom_event_type": {
"type": "string",
"enum": [
"PURCHASE",
"LEAD",
"COMPLETE_REGISTRATION",
"ADD_TO_CART"
]
}
},
"additionalProperties": false
},
"status": {
"default": "PAUSED",
"type": "string",
"const": "PAUSED"
}
},
"required": [
"operation",
"campaign_id",
"name",
"targeting",
"billing_event",
"optimization_goal",
"bid_strategy",
"status"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"const": "update_adset"
},
"object_id": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"budget": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"daily",
"lifetime"
]
},
"amount_minor": {
"type": "string",
"pattern": "^[1-9]\\d{0,11}$"
}
},
"required": [
"kind",
"amount_minor"
],
"additionalProperties": false
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"PAUSED",
"ARCHIVED"
]
},
"targeting": {
"type": "object",
"properties": {
"geo_locations": {
"type": "object",
"properties": {
"countries": {
"minItems": 1,
"maxItems": 25,
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Z]{2}$"
}
}
},
"required": [
"countries"
],
"additionalProperties": false
},
"age_min": {
"default": 18,
"type": "integer",
"minimum": 18,
"maximum": 65
},
"age_max": {
"default": 65,
"type": "integer",
"minimum": 18,
"maximum": 65
},
"genders": {
"minItems": 1,
"maxItems": 2,
"type": "array",
"items": {
"anyOf": [
{
"type": "number",
"const": 1
},
{
"type": "number",
"const": 2
}
]
}
},
"locales": {
"maxItems": 25,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"publisher_platforms": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"type": "string",
"enum": [
"facebook",
"instagram",
"threads"
]
}
},
"facebook_positions": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"enum": [
"feed",
"story",
"facebook_reels",
"video_feeds"
]
}
},
"instagram_positions": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"enum": [
"stream",
"story",
"reels",
"explore"
]
}
},
"threads_positions": {
"maxItems": 1,
"type": "array",
"items": {
"type": "string",
"const": "threads_stream"
}
},
"custom_audience_ids": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
}
},
"excluded_custom_audience_ids": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
}
}
},
"required": [
"geo_locations",
"age_min",
"age_max",
"publisher_platforms"
],
"additionalProperties": false
},
"start_time": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"end_time": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"operation",
"object_id"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"const": "create_ad"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"adset_id": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
},
"creative_id": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
},
"status": {
"default": "PAUSED",
"type": "string",
"const": "PAUSED"
}
},
"required": [
"operation",
"name",
"adset_id",
"creative_id",
"status"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"const": "update_ad"
},
"object_id": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"creative_id": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"PAUSED",
"ARCHIVED"
]
}
},
"required": [
"operation",
"object_id"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"const": "create_creative"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"object_story_spec": {
"type": "object",
"properties": {
"page_id": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
},
"instagram_user_id": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
},
"link_data": {
"type": "object",
"properties": {
"link": {
"type": "string",
"maxLength": 2048,
"format": "uri"
},
"message": {
"type": "string",
"maxLength": 5000
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"image_hash": {
"type": "string",
"pattern": "^[a-fA-F0-9]{16,128}$"
},
"call_to_action": {
"type": "string",
"enum": [
"LEARN_MORE",
"SHOP_NOW",
"SIGN_UP",
"CONTACT_US"
]
}
},
"required": [
"link",
"message",
"image_hash"
],
"additionalProperties": false
}
},
"required": [
"page_id",
"link_data"
],
"additionalProperties": false
},
"object_story_id": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}_[1-9]\\d{1,24}$"
}
},
"required": [
"operation",
"name"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"const": "create_saved_audience"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"targeting": {
"type": "object",
"properties": {
"geo_locations": {
"type": "object",
"properties": {
"countries": {
"minItems": 1,
"maxItems": 25,
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Z]{2}$"
}
}
},
"required": [
"countries"
],
"additionalProperties": false
},
"age_min": {
"default": 18,
"type": "integer",
"minimum": 18,
"maximum": 65
},
"age_max": {
"default": 65,
"type": "integer",
"minimum": 18,
"maximum": 65
},
"genders": {
"minItems": 1,
"maxItems": 2,
"type": "array",
"items": {
"anyOf": [
{
"type": "number",
"const": 1
},
{
"type": "number",
"const": 2
}
]
}
},
"locales": {
"maxItems": 25,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"publisher_platforms": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"type": "string",
"enum": [
"facebook",
"instagram",
"threads"
]
}
},
"facebook_positions": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"enum": [
"feed",
"story",
"facebook_reels",
"video_feeds"
]
}
},
"instagram_positions": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"enum": [
"stream",
"story",
"reels",
"explore"
]
}
},
"threads_positions": {
"maxItems": 1,
"type": "array",
"items": {
"type": "string",
"const": "threads_stream"
}
},
"custom_audience_ids": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
}
},
"excluded_custom_audience_ids": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
}
}
},
"required": [
"geo_locations",
"age_min",
"age_max",
"publisher_platforms"
],
"additionalProperties": false
}
},
"required": [
"operation",
"name",
"targeting"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"const": "update_saved_audience"
},
"object_id": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"targeting": {
"type": "object",
"properties": {
"geo_locations": {
"type": "object",
"properties": {
"countries": {
"minItems": 1,
"maxItems": 25,
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Z]{2}$"
}
}
},
"required": [
"countries"
],
"additionalProperties": false
},
"age_min": {
"default": 18,
"type": "integer",
"minimum": 18,
"maximum": 65
},
"age_max": {
"default": 65,
"type": "integer",
"minimum": 18,
"maximum": 65
},
"genders": {
"minItems": 1,
"maxItems": 2,
"type": "array",
"items": {
"anyOf": [
{
"type": "number",
"const": 1
},
{
"type": "number",
"const": 2
}
]
}
},
"locales": {
"maxItems": 25,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"publisher_platforms": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"type": "string",
"enum": [
"facebook",
"instagram",
"threads"
]
}
},
"facebook_positions": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"enum": [
"feed",
"story",
"facebook_reels",
"video_feeds"
]
}
},
"instagram_positions": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"enum": [
"stream",
"story",
"reels",
"explore"
]
}
},
"threads_positions": {
"maxItems": 1,
"type": "array",
"items": {
"type": "string",
"const": "threads_stream"
}
},
"custom_audience_ids": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
}
},
"excluded_custom_audience_ids": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
}
}
},
"required": [
"geo_locations",
"age_min",
"age_max",
"publisher_platforms"
],
"additionalProperties": false
}
},
"required": [
"operation",
"object_id"
],
"additionalProperties": false
}
]
},
"reviewed_digest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"effects": {
"type": "object",
"properties": {
"creates_object": {
"type": "boolean"
},
"initial_status": {
"anyOf": [
{
"type": "string",
"const": "PAUSED"
},
{
"type": "null"
}
]
},
"activates_delivery": {
"type": "boolean"
},
"changes_budget": {
"type": "boolean"
},
"changes_audience": {
"type": "boolean"
},
"changes_creative": {
"type": "boolean"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$"
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"budget": {
"anyOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"daily",
"lifetime"
]
},
"amount_minor": {
"type": "string",
"pattern": "^[1-9]\\d{0,11}$"
}
},
"required": [
"kind",
"amount_minor"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"creates_object",
"initial_status",
"activates_delivery",
"changes_budget",
"changes_audience",
"changes_creative",
"currency",
"timezone",
"budget"
],
"additionalProperties": false
},
"live_approval": {
"type": "object",
"properties": {
"required": {
"type": "boolean"
},
"state": {
"type": "string",
"enum": [
"not_required",
"missing",
"approved",
"expired",
"revoked",
"invalid"
]
},
"reason": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
]
},
"expires_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"approved_by": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
}
},
"required": [
"required",
"state",
"reason",
"expires_at",
"approved_by"
],
"additionalProperties": false
},
"provider_object_id": {
"anyOf": [
{
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
},
{
"type": "null"
}
]
},
"failure_code": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
]
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"completed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"workspace_id",
"advertising_account_id",
"mutation_id",
"status",
"command",
"reviewed_digest",
"effects",
"live_approval",
"provider_object_id",
"failure_code",
"created_at",
"completed_at"
],
"additionalProperties": false
}
},
"required": [
"contract_version",
"prepare_token",
"expires_at",
"action"
],
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false
}Voorbeeld van een toolaanroep
Deze voorbeelden gebruiken fictieve waarden die tegen de schema's zijn gecontroleerd. Vervang IDs door toegestane IDs, media door gereedstaande bestanden en datums door je bevestigde publicatietijd. Controleer accountgeschiktheid vóór een schrijfhandeling. Deze pagina verstuurt geen API-verzoeken.
{
"name": "sosoapi_ads_actions_prepare",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111",
"advertising_account_id": "11111111-1111-4111-8111-111111111111",
"mutation_id": "11111111-1111-4111-8111-111111111111",
"command": {
"operation": "create_campaign",
"name": "example",
"objective": "OUTCOME_AWARENESS"
}
}
}structuredContent
{
"contract_version": "advertising/v1",
"prepare_token": "exampleaaaaaaaaaaaaaaaaaaaaaaaaa",
"expires_at": "2099-01-15T09:00:00Z",
"action": {
"id": "11111111-1111-4111-8111-111111111111",
"workspace_id": "11111111-1111-4111-8111-111111111111",
"advertising_account_id": "11111111-1111-4111-8111-111111111111",
"mutation_id": "11111111-1111-4111-8111-111111111111",
"status": "prepared",
"command": {
"operation": "create_campaign",
"name": "example",
"objective": "OUTCOME_AWARENESS",
"special_ad_categories": [],
"status": "PAUSED"
},
"reviewed_digest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"effects": {
"creates_object": false,
"initial_status": null,
"activates_delivery": false,
"changes_budget": false,
"changes_audience": false,
"changes_creative": false,
"currency": "USD",
"timezone": "UTC",
"budget": null
},
"live_approval": {
"required": false,
"state": "not_required",
"reason": null,
"expires_at": null,
"approved_by": null
},
"provider_object_id": null,
"failure_code": null,
"created_at": "2099-01-15T09:00:00Z",
"completed_at": null
}
}