MCP-Tool
Status einer Werbeaktion
sosoapi_ads_actions_statusLies den unveränderlichen Status des Werbevorgangs und den ursprünglichen Befehl. Annahme bedeutet keinen Plattform-Erfolg; unbekannte Auswirkungen dürfen nicht erneut gesendet werden.
Als Markdown lesenProfile und Transporte
Profile: full · Transporte: stdio, http
Wähle core oder full für die sichtbaren Tools deines Clients; dies ändert keine Berechtigungen. Lokaler Dateiupload benötigt stdio und ist über HTTP nicht verfügbar. Setze SOSOAPI_OUTPUT_SCHEMAS=1 für Ausgabeschemas in der Erkennung. Tools liefern unabhängig davon strukturierte Ergebnisse.
Berechtigungen und Nebeneffekte
Annotationen helfen Clients, Tools zu beschreiben. Jeder Aufruf prüft weiterhin Authentifizierung, Rolle, Ressourcenzugriff und erteilte Funktionen des Nutzers.
{
"readOnlyHint": true,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": true
}- /advertising-api/actions/status: agent:advertising_read · synchronous_http_response
Eingabefelder
Erforderlich bedeutet innerhalb des übergeordneten Objekts und gewählten Zweigs erforderlich. Ein erforderliches Kind macht kein optionales Elternobjekt erforderlich. Regeln und Feldnamen unten stammen aus dem Vertrag.
| Feld / Variante | Typ / erforderlich | Einschränkungen |
|---|---|---|
$ | objectIm Elternobjekt erforderlich |
|
workspace_id | stringIm Elternobjekt erforderlich |
|
action_id | stringIm Elternobjekt erforderlich |
|
Vollständiges JSON Schema
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
},
"action_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"workspace_id",
"action_id"
],
"additionalProperties": false
}Strukturierte Ausgabe
Dieses Schema beschreibt structuredContent in einem erfolgreichen Tool-Ergebnis. Die MCP-Antwort enthält auch content und kann bei fehlgeschlagenem Aufruf isError setzen. Lies bei Veröffentlichungen das endgültige Beitragsergebnis, statt eine angenommene Anfrage oder Textantwort als Bestätigung zu werten. Die verknüpfte API-Operation erklärt Berechtigungen und Wiederholungsregeln.
Erforderlich bedeutet innerhalb des übergeordneten Objekts und gewählten Zweigs erforderlich. Ein erforderliches Kind macht kein optionales Elternobjekt erforderlich. Regeln und Feldnamen unten stammen aus dem Vertrag.
| Feld / Variante | Typ / erforderlich | Einschränkungen |
|---|---|---|
$ | objectIm Elternobjekt erforderlich |
|
contract_version | stringIm Elternobjekt erforderlich |
|
action | objectIm Elternobjekt erforderlich |
|
action.id | stringIm Elternobjekt erforderlich |
|
action.workspace_id | stringIm Elternobjekt erforderlich |
|
action.advertising_account_id | stringIm Elternobjekt erforderlich |
|
action.mutation_id | stringIm Elternobjekt erforderlich |
|
action.status | stringIm Elternobjekt erforderlich |
|
action.command | objectIm Elternobjekt erforderlich | — |
action.commandoneOf 1 | objectIm Elternobjekt erforderlich |
|
action.command.operationoneOf 1 | stringIm Elternobjekt erforderlich |
|
action.command.nameoneOf 1 | stringIm Elternobjekt erforderlich |
|
action.command.budgetoneOf 1 | objectOptional / Element |
|
action.command.budget.kindoneOf 1 | stringIm Elternobjekt erforderlich |
|
action.command.budget.amount_minoroneOf 1 | stringIm Elternobjekt erforderlich |
|
action.command.objectiveoneOf 1 | stringIm Elternobjekt erforderlich |
|
action.command.special_ad_categoriesoneOf 1 | arrayIm Elternobjekt erforderlich |
|
action.command.special_ad_categories[]oneOf 1 | stringOptional / Element |
|
action.command.statusoneOf 1 | stringIm Elternobjekt erforderlich |
|
action.commandoneOf 2 | objectIm Elternobjekt erforderlich |
|
action.command.operationoneOf 2 | stringIm Elternobjekt erforderlich |
|
action.command.object_idoneOf 2 | stringIm Elternobjekt erforderlich |
|
action.command.nameoneOf 2 | stringOptional / Element |
|
action.command.budgetoneOf 2 | objectOptional / Element |
|
action.command.budget.kindoneOf 2 | stringIm Elternobjekt erforderlich |
|
action.command.budget.amount_minoroneOf 2 | stringIm Elternobjekt erforderlich |
|
action.command.statusoneOf 2 | stringOptional / Element |
|
action.commandoneOf 3 | objectIm Elternobjekt erforderlich |
|
action.command.operationoneOf 3 | stringIm Elternobjekt erforderlich |
|
action.command.campaign_idoneOf 3 | stringIm Elternobjekt erforderlich |
|
action.command.nameoneOf 3 | stringIm Elternobjekt erforderlich |
|
action.command.budgetoneOf 3 | objectOptional / Element |
|
action.command.budget.kindoneOf 3 | stringIm Elternobjekt erforderlich |
|
action.command.budget.amount_minoroneOf 3 | stringIm Elternobjekt erforderlich |
|
action.command.targetingoneOf 3 | objectIm Elternobjekt erforderlich |
|
action.command.targeting.geo_locationsoneOf 3 | objectIm Elternobjekt erforderlich |
|
action.command.targeting.geo_locations.countriesoneOf 3 | arrayIm Elternobjekt erforderlich |
|
action.command.targeting.geo_locations.countries[]oneOf 3 | stringOptional / Element |
|
action.command.targeting.age_minoneOf 3 | integerIm Elternobjekt erforderlich |
|
action.command.targeting.age_maxoneOf 3 | integerIm Elternobjekt erforderlich |
|
action.command.targeting.gendersoneOf 3 | arrayOptional / Element |
|
action.command.targeting.genders[]oneOf 3 | numberOptional / Element | — |
action.command.targeting.genders[]oneOf 3 / anyOf 1 | numberOptional / Element |
|
action.command.targeting.genders[]oneOf 3 / anyOf 2 | numberOptional / Element |
|
action.command.targeting.localesoneOf 3 | arrayOptional / Element |
|
action.command.targeting.locales[]oneOf 3 | integerOptional / Element |
|
action.command.targeting.publisher_platformsoneOf 3 | arrayIm Elternobjekt erforderlich |
|
action.command.targeting.publisher_platforms[]oneOf 3 | stringOptional / Element |
|
action.command.targeting.facebook_positionsoneOf 3 | arrayOptional / Element |
|
action.command.targeting.facebook_positions[]oneOf 3 | stringOptional / Element |
|
action.command.targeting.instagram_positionsoneOf 3 | arrayOptional / Element |
|
action.command.targeting.instagram_positions[]oneOf 3 | stringOptional / Element |
|
action.command.targeting.threads_positionsoneOf 3 | arrayOptional / Element |
|
action.command.targeting.threads_positions[]oneOf 3 | stringOptional / Element |
|
action.command.targeting.custom_audience_idsoneOf 3 | arrayOptional / Element |
|
action.command.targeting.custom_audience_ids[]oneOf 3 | stringOptional / Element |
|
action.command.targeting.excluded_custom_audience_idsoneOf 3 | arrayOptional / Element |
|
action.command.targeting.excluded_custom_audience_ids[]oneOf 3 | stringOptional / Element |
|
action.command.billing_eventoneOf 3 | stringIm Elternobjekt erforderlich |
|
action.command.optimization_goaloneOf 3 | stringIm Elternobjekt erforderlich |
|
action.command.bid_strategyoneOf 3 | stringIm Elternobjekt erforderlich |
|
action.command.start_timeoneOf 3 | stringOptional / Element |
|
action.command.end_timeoneOf 3 | stringOptional / Element |
|
action.command.promoted_objectoneOf 3 | objectOptional / Element |
|
action.command.promoted_object.page_idoneOf 3 | stringOptional / Element |
|
action.command.promoted_object.pixel_idoneOf 3 | stringOptional / Element |
|
action.command.promoted_object.custom_event_typeoneOf 3 | stringOptional / Element |
|
action.command.statusoneOf 3 | stringIm Elternobjekt erforderlich |
|
action.commandoneOf 4 | objectIm Elternobjekt erforderlich |
|
action.command.operationoneOf 4 | stringIm Elternobjekt erforderlich |
|
action.command.object_idoneOf 4 | stringIm Elternobjekt erforderlich |
|
action.command.nameoneOf 4 | stringOptional / Element |
|
action.command.budgetoneOf 4 | objectOptional / Element |
|
action.command.budget.kindoneOf 4 | stringIm Elternobjekt erforderlich |
|
action.command.budget.amount_minoroneOf 4 | stringIm Elternobjekt erforderlich |
|
action.command.statusoneOf 4 | stringOptional / Element |
|
action.command.targetingoneOf 4 | objectOptional / Element |
|
action.command.targeting.geo_locationsoneOf 4 | objectIm Elternobjekt erforderlich |
|
action.command.targeting.geo_locations.countriesoneOf 4 | arrayIm Elternobjekt erforderlich |
|
action.command.targeting.geo_locations.countries[]oneOf 4 | stringOptional / Element |
|
action.command.targeting.age_minoneOf 4 | integerIm Elternobjekt erforderlich |
|
action.command.targeting.age_maxoneOf 4 | integerIm Elternobjekt erforderlich |
|
action.command.targeting.gendersoneOf 4 | arrayOptional / Element |
|
action.command.targeting.genders[]oneOf 4 | numberOptional / Element | — |
action.command.targeting.genders[]oneOf 4 / anyOf 1 | numberOptional / Element |
|
action.command.targeting.genders[]oneOf 4 / anyOf 2 | numberOptional / Element |
|
action.command.targeting.localesoneOf 4 | arrayOptional / Element |
|
action.command.targeting.locales[]oneOf 4 | integerOptional / Element |
|
action.command.targeting.publisher_platformsoneOf 4 | arrayIm Elternobjekt erforderlich |
|
action.command.targeting.publisher_platforms[]oneOf 4 | stringOptional / Element |
|
action.command.targeting.facebook_positionsoneOf 4 | arrayOptional / Element |
|
action.command.targeting.facebook_positions[]oneOf 4 | stringOptional / Element |
|
action.command.targeting.instagram_positionsoneOf 4 | arrayOptional / Element |
|
action.command.targeting.instagram_positions[]oneOf 4 | stringOptional / Element |
|
action.command.targeting.threads_positionsoneOf 4 | arrayOptional / Element |
|
action.command.targeting.threads_positions[]oneOf 4 | stringOptional / Element |
|
action.command.targeting.custom_audience_idsoneOf 4 | arrayOptional / Element |
|
action.command.targeting.custom_audience_ids[]oneOf 4 | stringOptional / Element |
|
action.command.targeting.excluded_custom_audience_idsoneOf 4 | arrayOptional / Element |
|
action.command.targeting.excluded_custom_audience_ids[]oneOf 4 | stringOptional / Element |
|
action.command.start_timeoneOf 4 | stringOptional / Element |
|
action.command.end_timeoneOf 4 | stringOptional / Element |
|
action.commandoneOf 5 | objectIm Elternobjekt erforderlich |
|
action.command.operationoneOf 5 | stringIm Elternobjekt erforderlich |
|
action.command.nameoneOf 5 | stringIm Elternobjekt erforderlich |
|
action.command.adset_idoneOf 5 | stringIm Elternobjekt erforderlich |
|
action.command.creative_idoneOf 5 | stringIm Elternobjekt erforderlich |
|
action.command.statusoneOf 5 | stringIm Elternobjekt erforderlich |
|
action.commandoneOf 6 | objectIm Elternobjekt erforderlich |
|
action.command.operationoneOf 6 | stringIm Elternobjekt erforderlich |
|
action.command.object_idoneOf 6 | stringIm Elternobjekt erforderlich |
|
action.command.nameoneOf 6 | stringOptional / Element |
|
action.command.creative_idoneOf 6 | stringOptional / Element |
|
action.command.statusoneOf 6 | stringOptional / Element |
|
action.commandoneOf 7 | objectIm Elternobjekt erforderlich |
|
action.command.operationoneOf 7 | stringIm Elternobjekt erforderlich |
|
action.command.nameoneOf 7 | stringIm Elternobjekt erforderlich |
|
action.command.object_story_speconeOf 7 | objectOptional / Element |
|
action.command.object_story_spec.page_idoneOf 7 | stringIm Elternobjekt erforderlich |
|
action.command.object_story_spec.instagram_user_idoneOf 7 | stringOptional / Element |
|
action.command.object_story_spec.link_dataoneOf 7 | objectIm Elternobjekt erforderlich |
|
action.command.object_story_spec.link_data.linkoneOf 7 | stringIm Elternobjekt erforderlich |
|
action.command.object_story_spec.link_data.messageoneOf 7 | stringIm Elternobjekt erforderlich |
|
action.command.object_story_spec.link_data.nameoneOf 7 | stringOptional / Element |
|
action.command.object_story_spec.link_data.image_hashoneOf 7 | stringIm Elternobjekt erforderlich |
|
action.command.object_story_spec.link_data.call_to_actiononeOf 7 | stringOptional / Element |
|
action.command.object_story_idoneOf 7 | stringOptional / Element |
|
action.commandoneOf 8 | objectIm Elternobjekt erforderlich |
|
action.command.operationoneOf 8 | stringIm Elternobjekt erforderlich |
|
action.command.nameoneOf 8 | stringIm Elternobjekt erforderlich |
|
action.command.targetingoneOf 8 | objectIm Elternobjekt erforderlich |
|
action.command.targeting.geo_locationsoneOf 8 | objectIm Elternobjekt erforderlich |
|
action.command.targeting.geo_locations.countriesoneOf 8 | arrayIm Elternobjekt erforderlich |
|
action.command.targeting.geo_locations.countries[]oneOf 8 | stringOptional / Element |
|
action.command.targeting.age_minoneOf 8 | integerIm Elternobjekt erforderlich |
|
action.command.targeting.age_maxoneOf 8 | integerIm Elternobjekt erforderlich |
|
action.command.targeting.gendersoneOf 8 | arrayOptional / Element |
|
action.command.targeting.genders[]oneOf 8 | numberOptional / Element | — |
action.command.targeting.genders[]oneOf 8 / anyOf 1 | numberOptional / Element |
|
action.command.targeting.genders[]oneOf 8 / anyOf 2 | numberOptional / Element |
|
action.command.targeting.localesoneOf 8 | arrayOptional / Element |
|
action.command.targeting.locales[]oneOf 8 | integerOptional / Element |
|
action.command.targeting.publisher_platformsoneOf 8 | arrayIm Elternobjekt erforderlich |
|
action.command.targeting.publisher_platforms[]oneOf 8 | stringOptional / Element |
|
action.command.targeting.facebook_positionsoneOf 8 | arrayOptional / Element |
|
action.command.targeting.facebook_positions[]oneOf 8 | stringOptional / Element |
|
action.command.targeting.instagram_positionsoneOf 8 | arrayOptional / Element |
|
action.command.targeting.instagram_positions[]oneOf 8 | stringOptional / Element |
|
action.command.targeting.threads_positionsoneOf 8 | arrayOptional / Element |
|
action.command.targeting.threads_positions[]oneOf 8 | stringOptional / Element |
|
action.command.targeting.custom_audience_idsoneOf 8 | arrayOptional / Element |
|
action.command.targeting.custom_audience_ids[]oneOf 8 | stringOptional / Element |
|
action.command.targeting.excluded_custom_audience_idsoneOf 8 | arrayOptional / Element |
|
action.command.targeting.excluded_custom_audience_ids[]oneOf 8 | stringOptional / Element |
|
action.commandoneOf 9 | objectIm Elternobjekt erforderlich |
|
action.command.operationoneOf 9 | stringIm Elternobjekt erforderlich |
|
action.command.object_idoneOf 9 | stringIm Elternobjekt erforderlich |
|
action.command.nameoneOf 9 | stringOptional / Element |
|
action.command.targetingoneOf 9 | objectOptional / Element |
|
action.command.targeting.geo_locationsoneOf 9 | objectIm Elternobjekt erforderlich |
|
action.command.targeting.geo_locations.countriesoneOf 9 | arrayIm Elternobjekt erforderlich |
|
action.command.targeting.geo_locations.countries[]oneOf 9 | stringOptional / Element |
|
action.command.targeting.age_minoneOf 9 | integerIm Elternobjekt erforderlich |
|
action.command.targeting.age_maxoneOf 9 | integerIm Elternobjekt erforderlich |
|
action.command.targeting.gendersoneOf 9 | arrayOptional / Element |
|
action.command.targeting.genders[]oneOf 9 | numberOptional / Element | — |
action.command.targeting.genders[]oneOf 9 / anyOf 1 | numberOptional / Element |
|
action.command.targeting.genders[]oneOf 9 / anyOf 2 | numberOptional / Element |
|
action.command.targeting.localesoneOf 9 | arrayOptional / Element |
|
action.command.targeting.locales[]oneOf 9 | integerOptional / Element |
|
action.command.targeting.publisher_platformsoneOf 9 | arrayIm Elternobjekt erforderlich |
|
action.command.targeting.publisher_platforms[]oneOf 9 | stringOptional / Element |
|
action.command.targeting.facebook_positionsoneOf 9 | arrayOptional / Element |
|
action.command.targeting.facebook_positions[]oneOf 9 | stringOptional / Element |
|
action.command.targeting.instagram_positionsoneOf 9 | arrayOptional / Element |
|
action.command.targeting.instagram_positions[]oneOf 9 | stringOptional / Element |
|
action.command.targeting.threads_positionsoneOf 9 | arrayOptional / Element |
|
action.command.targeting.threads_positions[]oneOf 9 | stringOptional / Element |
|
action.command.targeting.custom_audience_idsoneOf 9 | arrayOptional / Element |
|
action.command.targeting.custom_audience_ids[]oneOf 9 | stringOptional / Element |
|
action.command.targeting.excluded_custom_audience_idsoneOf 9 | arrayOptional / Element |
|
action.command.targeting.excluded_custom_audience_ids[]oneOf 9 | stringOptional / Element |
|
action.reviewed_digest | stringIm Elternobjekt erforderlich |
|
action.effects | objectIm Elternobjekt erforderlich |
|
action.effects.creates_object | booleanIm Elternobjekt erforderlich | — |
action.effects.initial_status | string | nullIm Elternobjekt erforderlich | — |
action.effects.initial_statusanyOf 1 | stringIm Elternobjekt erforderlich |
|
action.effects.initial_statusanyOf 2 | nullIm Elternobjekt erforderlich | — |
action.effects.activates_delivery | booleanIm Elternobjekt erforderlich | — |
action.effects.changes_budget | booleanIm Elternobjekt erforderlich | — |
action.effects.changes_audience | booleanIm Elternobjekt erforderlich | — |
action.effects.changes_creative | booleanIm Elternobjekt erforderlich | — |
action.effects.currency | stringIm Elternobjekt erforderlich |
|
action.effects.timezone | stringIm Elternobjekt erforderlich |
|
action.effects.budget | object | nullIm Elternobjekt erforderlich | — |
action.effects.budgetanyOf 1 | objectIm Elternobjekt erforderlich |
|
action.effects.budget.kindanyOf 1 | stringIm Elternobjekt erforderlich |
|
action.effects.budget.amount_minoranyOf 1 | stringIm Elternobjekt erforderlich |
|
action.effects.budgetanyOf 2 | nullIm Elternobjekt erforderlich | — |
action.live_approval | objectIm Elternobjekt erforderlich |
|
action.live_approval.required | booleanIm Elternobjekt erforderlich | — |
action.live_approval.state | stringIm Elternobjekt erforderlich |
|
action.live_approval.reason | string | nullIm Elternobjekt erforderlich | — |
action.live_approval.reasonanyOf 1 | stringIm Elternobjekt erforderlich |
|
action.live_approval.reasonanyOf 2 | nullIm Elternobjekt erforderlich | — |
action.live_approval.expires_at | string | nullIm Elternobjekt erforderlich | — |
action.live_approval.expires_atanyOf 1 | stringIm Elternobjekt erforderlich |
|
action.live_approval.expires_atanyOf 2 | nullIm Elternobjekt erforderlich | — |
action.live_approval.approved_by | string | nullIm Elternobjekt erforderlich | — |
action.live_approval.approved_byanyOf 1 | stringIm Elternobjekt erforderlich |
|
action.live_approval.approved_byanyOf 2 | nullIm Elternobjekt erforderlich | — |
action.provider_object_id | string | nullIm Elternobjekt erforderlich | — |
action.provider_object_idanyOf 1 | stringIm Elternobjekt erforderlich |
|
action.provider_object_idanyOf 2 | nullIm Elternobjekt erforderlich | — |
action.failure_code | string | nullIm Elternobjekt erforderlich | — |
action.failure_codeanyOf 1 | stringIm Elternobjekt erforderlich |
|
action.failure_codeanyOf 2 | nullIm Elternobjekt erforderlich | — |
action.created_at | stringIm Elternobjekt erforderlich |
|
action.completed_at | string | nullIm Elternobjekt erforderlich | — |
action.completed_atanyOf 1 | stringIm Elternobjekt erforderlich |
|
action.completed_atanyOf 2 | nullIm Elternobjekt erforderlich | — |
replayed | booleanIm Elternobjekt erforderlich | — |
Vollständiges JSON Schema
{
"type": "object",
"properties": {
"contract_version": {
"type": "string",
"const": "advertising/v1"
},
"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
},
"replayed": {
"type": "boolean"
}
},
"required": [
"contract_version",
"action",
"replayed"
],
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false
}Beispiel eines Tool-Aufrufs
Diese Beispiele nutzen anhand der Schemas geprüfte fiktive Werte. Ersetze IDs durch autorisierte IDs, Medien durch bereite Assets und Daten durch bestätigte Veröffentlichungszeiten. Prüfe Kontoeignung vor Schreibvorgängen. Diese Seite sendet keine API-Anfragen.
{
"name": "sosoapi_ads_actions_status",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111",
"action_id": "11111111-1111-4111-8111-111111111111"
}
}structuredContent
{
"contract_version": "advertising/v1",
"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
},
"replayed": false
}