Outil MCP
Appliquer une action publicitaire
sosoapi_ads_actions_applyConsommer le jeton publicitaire exact, vérifié et à usage unique. Après une réponse incertaine, réutiliser l’ID d’action renvoyé pour lire l’état ; ne jamais créer de modification de remplacement.
Lire en MarkdownProfils et transports
Profils : full · Transports : stdio, http
Choisissez core ou full pour définir les outils visibles du client ; cela ne change pas ses autorisations. Le téléversement local nécessite stdio et n’est pas disponible sur HTTP. Définissez SOSOAPI_OUTPUT_SCHEMAS=1 pour inclure les schémas de sortie à la découverte. Les outils renvoient des résultats structurés avec ou sans ce réglage.
Autorisations et effets de bord
Les annotations aident les clients à décrire un outil. Chaque appel vérifie toujours l’authentification, le rôle, l’accès aux ressources et les capacités accordées de l’utilisateur.
{
"readOnlyHint": false,
"destructiveHint": false,
"idempotentHint": false,
"openWorldHint": true
}- /advertising-api/actions/apply: agent:advertising_manage · reçu final du fournisseur
Champs d’entrée
Requis signifie requis dans l’objet parent et la branche sélectionnée. Un enfant requis ne rend pas obligatoire un parent facultatif. Les règles et noms de champs ci-dessous proviennent du contrat.
| Champ / branche | Type / requis | Contraintes |
|---|---|---|
$ | objectRequis dans le parent |
|
workspace_id | stringRequis dans le parent |
|
prepare_token | stringRequis dans le parent |
|
reviewed_digest | stringRequis dans le parent |
|
JSON Schema complet
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
},
"prepare_token": {
"type": "string",
"minLength": 32,
"maxLength": 128
},
"reviewed_digest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
},
"required": [
"workspace_id",
"prepare_token",
"reviewed_digest"
],
"additionalProperties": false
}Sortie structurée
Ce schéma décrit structuredContent dans un résultat d’outil réussi. La réponse MCP contient aussi content et peut définir isError en cas d’échec. Pour publier, lisez le résultat final de la publication plutôt que de considérer une requête acceptée ou une réponse texte comme une confirmation. L’opération API liée explique les autorisations et règles de nouvelle tentative.
Requis signifie requis dans l’objet parent et la branche sélectionnée. Un enfant requis ne rend pas obligatoire un parent facultatif. Les règles et noms de champs ci-dessous proviennent du contrat.
| Champ / branche | Type / requis | Contraintes |
|---|---|---|
$ | objectRequis dans le parent |
|
contract_version | stringRequis dans le parent |
|
action | objectRequis dans le parent |
|
action.id | stringRequis dans le parent |
|
action.workspace_id | stringRequis dans le parent |
|
action.advertising_account_id | stringRequis dans le parent |
|
action.mutation_id | stringRequis dans le parent |
|
action.status | stringRequis dans le parent |
|
action.command | objectRequis dans le parent | — |
action.commandoneOf 1 | objectRequis dans le parent |
|
action.command.operationoneOf 1 | stringRequis dans le parent |
|
action.command.nameoneOf 1 | stringRequis dans le parent |
|
action.command.budgetoneOf 1 | objectFacultatif / élément |
|
action.command.budget.kindoneOf 1 | stringRequis dans le parent |
|
action.command.budget.amount_minoroneOf 1 | stringRequis dans le parent |
|
action.command.objectiveoneOf 1 | stringRequis dans le parent |
|
action.command.special_ad_categoriesoneOf 1 | arrayRequis dans le parent |
|
action.command.special_ad_categories[]oneOf 1 | stringFacultatif / élément |
|
action.command.statusoneOf 1 | stringRequis dans le parent |
|
action.commandoneOf 2 | objectRequis dans le parent |
|
action.command.operationoneOf 2 | stringRequis dans le parent |
|
action.command.object_idoneOf 2 | stringRequis dans le parent |
|
action.command.nameoneOf 2 | stringFacultatif / élément |
|
action.command.budgetoneOf 2 | objectFacultatif / élément |
|
action.command.budget.kindoneOf 2 | stringRequis dans le parent |
|
action.command.budget.amount_minoroneOf 2 | stringRequis dans le parent |
|
action.command.statusoneOf 2 | stringFacultatif / élément |
|
action.commandoneOf 3 | objectRequis dans le parent |
|
action.command.operationoneOf 3 | stringRequis dans le parent |
|
action.command.campaign_idoneOf 3 | stringRequis dans le parent |
|
action.command.nameoneOf 3 | stringRequis dans le parent |
|
action.command.budgetoneOf 3 | objectFacultatif / élément |
|
action.command.budget.kindoneOf 3 | stringRequis dans le parent |
|
action.command.budget.amount_minoroneOf 3 | stringRequis dans le parent |
|
action.command.targetingoneOf 3 | objectRequis dans le parent |
|
action.command.targeting.geo_locationsoneOf 3 | objectRequis dans le parent |
|
action.command.targeting.geo_locations.countriesoneOf 3 | arrayRequis dans le parent |
|
action.command.targeting.geo_locations.countries[]oneOf 3 | stringFacultatif / élément |
|
action.command.targeting.age_minoneOf 3 | integerRequis dans le parent |
|
action.command.targeting.age_maxoneOf 3 | integerRequis dans le parent |
|
action.command.targeting.gendersoneOf 3 | arrayFacultatif / élément |
|
action.command.targeting.genders[]oneOf 3 | numberFacultatif / élément | — |
action.command.targeting.genders[]oneOf 3 / anyOf 1 | numberFacultatif / élément |
|
action.command.targeting.genders[]oneOf 3 / anyOf 2 | numberFacultatif / élément |
|
action.command.targeting.localesoneOf 3 | arrayFacultatif / élément |
|
action.command.targeting.locales[]oneOf 3 | integerFacultatif / élément |
|
action.command.targeting.publisher_platformsoneOf 3 | arrayRequis dans le parent |
|
action.command.targeting.publisher_platforms[]oneOf 3 | stringFacultatif / élément |
|
action.command.targeting.facebook_positionsoneOf 3 | arrayFacultatif / élément |
|
action.command.targeting.facebook_positions[]oneOf 3 | stringFacultatif / élément |
|
action.command.targeting.instagram_positionsoneOf 3 | arrayFacultatif / élément |
|
action.command.targeting.instagram_positions[]oneOf 3 | stringFacultatif / élément |
|
action.command.targeting.threads_positionsoneOf 3 | arrayFacultatif / élément |
|
action.command.targeting.threads_positions[]oneOf 3 | stringFacultatif / élément |
|
action.command.targeting.custom_audience_idsoneOf 3 | arrayFacultatif / élément |
|
action.command.targeting.custom_audience_ids[]oneOf 3 | stringFacultatif / élément |
|
action.command.targeting.excluded_custom_audience_idsoneOf 3 | arrayFacultatif / élément |
|
action.command.targeting.excluded_custom_audience_ids[]oneOf 3 | stringFacultatif / élément |
|
action.command.billing_eventoneOf 3 | stringRequis dans le parent |
|
action.command.optimization_goaloneOf 3 | stringRequis dans le parent |
|
action.command.bid_strategyoneOf 3 | stringRequis dans le parent |
|
action.command.start_timeoneOf 3 | stringFacultatif / élément |
|
action.command.end_timeoneOf 3 | stringFacultatif / élément |
|
action.command.promoted_objectoneOf 3 | objectFacultatif / élément |
|
action.command.promoted_object.page_idoneOf 3 | stringFacultatif / élément |
|
action.command.promoted_object.pixel_idoneOf 3 | stringFacultatif / élément |
|
action.command.promoted_object.custom_event_typeoneOf 3 | stringFacultatif / élément |
|
action.command.statusoneOf 3 | stringRequis dans le parent |
|
action.commandoneOf 4 | objectRequis dans le parent |
|
action.command.operationoneOf 4 | stringRequis dans le parent |
|
action.command.object_idoneOf 4 | stringRequis dans le parent |
|
action.command.nameoneOf 4 | stringFacultatif / élément |
|
action.command.budgetoneOf 4 | objectFacultatif / élément |
|
action.command.budget.kindoneOf 4 | stringRequis dans le parent |
|
action.command.budget.amount_minoroneOf 4 | stringRequis dans le parent |
|
action.command.statusoneOf 4 | stringFacultatif / élément |
|
action.command.targetingoneOf 4 | objectFacultatif / élément |
|
action.command.targeting.geo_locationsoneOf 4 | objectRequis dans le parent |
|
action.command.targeting.geo_locations.countriesoneOf 4 | arrayRequis dans le parent |
|
action.command.targeting.geo_locations.countries[]oneOf 4 | stringFacultatif / élément |
|
action.command.targeting.age_minoneOf 4 | integerRequis dans le parent |
|
action.command.targeting.age_maxoneOf 4 | integerRequis dans le parent |
|
action.command.targeting.gendersoneOf 4 | arrayFacultatif / élément |
|
action.command.targeting.genders[]oneOf 4 | numberFacultatif / élément | — |
action.command.targeting.genders[]oneOf 4 / anyOf 1 | numberFacultatif / élément |
|
action.command.targeting.genders[]oneOf 4 / anyOf 2 | numberFacultatif / élément |
|
action.command.targeting.localesoneOf 4 | arrayFacultatif / élément |
|
action.command.targeting.locales[]oneOf 4 | integerFacultatif / élément |
|
action.command.targeting.publisher_platformsoneOf 4 | arrayRequis dans le parent |
|
action.command.targeting.publisher_platforms[]oneOf 4 | stringFacultatif / élément |
|
action.command.targeting.facebook_positionsoneOf 4 | arrayFacultatif / élément |
|
action.command.targeting.facebook_positions[]oneOf 4 | stringFacultatif / élément |
|
action.command.targeting.instagram_positionsoneOf 4 | arrayFacultatif / élément |
|
action.command.targeting.instagram_positions[]oneOf 4 | stringFacultatif / élément |
|
action.command.targeting.threads_positionsoneOf 4 | arrayFacultatif / élément |
|
action.command.targeting.threads_positions[]oneOf 4 | stringFacultatif / élément |
|
action.command.targeting.custom_audience_idsoneOf 4 | arrayFacultatif / élément |
|
action.command.targeting.custom_audience_ids[]oneOf 4 | stringFacultatif / élément |
|
action.command.targeting.excluded_custom_audience_idsoneOf 4 | arrayFacultatif / élément |
|
action.command.targeting.excluded_custom_audience_ids[]oneOf 4 | stringFacultatif / élément |
|
action.command.start_timeoneOf 4 | stringFacultatif / élément |
|
action.command.end_timeoneOf 4 | stringFacultatif / élément |
|
action.commandoneOf 5 | objectRequis dans le parent |
|
action.command.operationoneOf 5 | stringRequis dans le parent |
|
action.command.nameoneOf 5 | stringRequis dans le parent |
|
action.command.adset_idoneOf 5 | stringRequis dans le parent |
|
action.command.creative_idoneOf 5 | stringRequis dans le parent |
|
action.command.statusoneOf 5 | stringRequis dans le parent |
|
action.commandoneOf 6 | objectRequis dans le parent |
|
action.command.operationoneOf 6 | stringRequis dans le parent |
|
action.command.object_idoneOf 6 | stringRequis dans le parent |
|
action.command.nameoneOf 6 | stringFacultatif / élément |
|
action.command.creative_idoneOf 6 | stringFacultatif / élément |
|
action.command.statusoneOf 6 | stringFacultatif / élément |
|
action.commandoneOf 7 | objectRequis dans le parent |
|
action.command.operationoneOf 7 | stringRequis dans le parent |
|
action.command.nameoneOf 7 | stringRequis dans le parent |
|
action.command.object_story_speconeOf 7 | objectFacultatif / élément |
|
action.command.object_story_spec.page_idoneOf 7 | stringRequis dans le parent |
|
action.command.object_story_spec.instagram_user_idoneOf 7 | stringFacultatif / élément |
|
action.command.object_story_spec.link_dataoneOf 7 | objectRequis dans le parent |
|
action.command.object_story_spec.link_data.linkoneOf 7 | stringRequis dans le parent |
|
action.command.object_story_spec.link_data.messageoneOf 7 | stringRequis dans le parent |
|
action.command.object_story_spec.link_data.nameoneOf 7 | stringFacultatif / élément |
|
action.command.object_story_spec.link_data.image_hashoneOf 7 | stringRequis dans le parent |
|
action.command.object_story_spec.link_data.call_to_actiononeOf 7 | stringFacultatif / élément |
|
action.command.object_story_idoneOf 7 | stringFacultatif / élément |
|
action.commandoneOf 8 | objectRequis dans le parent |
|
action.command.operationoneOf 8 | stringRequis dans le parent |
|
action.command.nameoneOf 8 | stringRequis dans le parent |
|
action.command.targetingoneOf 8 | objectRequis dans le parent |
|
action.command.targeting.geo_locationsoneOf 8 | objectRequis dans le parent |
|
action.command.targeting.geo_locations.countriesoneOf 8 | arrayRequis dans le parent |
|
action.command.targeting.geo_locations.countries[]oneOf 8 | stringFacultatif / élément |
|
action.command.targeting.age_minoneOf 8 | integerRequis dans le parent |
|
action.command.targeting.age_maxoneOf 8 | integerRequis dans le parent |
|
action.command.targeting.gendersoneOf 8 | arrayFacultatif / élément |
|
action.command.targeting.genders[]oneOf 8 | numberFacultatif / élément | — |
action.command.targeting.genders[]oneOf 8 / anyOf 1 | numberFacultatif / élément |
|
action.command.targeting.genders[]oneOf 8 / anyOf 2 | numberFacultatif / élément |
|
action.command.targeting.localesoneOf 8 | arrayFacultatif / élément |
|
action.command.targeting.locales[]oneOf 8 | integerFacultatif / élément |
|
action.command.targeting.publisher_platformsoneOf 8 | arrayRequis dans le parent |
|
action.command.targeting.publisher_platforms[]oneOf 8 | stringFacultatif / élément |
|
action.command.targeting.facebook_positionsoneOf 8 | arrayFacultatif / élément |
|
action.command.targeting.facebook_positions[]oneOf 8 | stringFacultatif / élément |
|
action.command.targeting.instagram_positionsoneOf 8 | arrayFacultatif / élément |
|
action.command.targeting.instagram_positions[]oneOf 8 | stringFacultatif / élément |
|
action.command.targeting.threads_positionsoneOf 8 | arrayFacultatif / élément |
|
action.command.targeting.threads_positions[]oneOf 8 | stringFacultatif / élément |
|
action.command.targeting.custom_audience_idsoneOf 8 | arrayFacultatif / élément |
|
action.command.targeting.custom_audience_ids[]oneOf 8 | stringFacultatif / élément |
|
action.command.targeting.excluded_custom_audience_idsoneOf 8 | arrayFacultatif / élément |
|
action.command.targeting.excluded_custom_audience_ids[]oneOf 8 | stringFacultatif / élément |
|
action.commandoneOf 9 | objectRequis dans le parent |
|
action.command.operationoneOf 9 | stringRequis dans le parent |
|
action.command.object_idoneOf 9 | stringRequis dans le parent |
|
action.command.nameoneOf 9 | stringFacultatif / élément |
|
action.command.targetingoneOf 9 | objectFacultatif / élément |
|
action.command.targeting.geo_locationsoneOf 9 | objectRequis dans le parent |
|
action.command.targeting.geo_locations.countriesoneOf 9 | arrayRequis dans le parent |
|
action.command.targeting.geo_locations.countries[]oneOf 9 | stringFacultatif / élément |
|
action.command.targeting.age_minoneOf 9 | integerRequis dans le parent |
|
action.command.targeting.age_maxoneOf 9 | integerRequis dans le parent |
|
action.command.targeting.gendersoneOf 9 | arrayFacultatif / élément |
|
action.command.targeting.genders[]oneOf 9 | numberFacultatif / élément | — |
action.command.targeting.genders[]oneOf 9 / anyOf 1 | numberFacultatif / élément |
|
action.command.targeting.genders[]oneOf 9 / anyOf 2 | numberFacultatif / élément |
|
action.command.targeting.localesoneOf 9 | arrayFacultatif / élément |
|
action.command.targeting.locales[]oneOf 9 | integerFacultatif / élément |
|
action.command.targeting.publisher_platformsoneOf 9 | arrayRequis dans le parent |
|
action.command.targeting.publisher_platforms[]oneOf 9 | stringFacultatif / élément |
|
action.command.targeting.facebook_positionsoneOf 9 | arrayFacultatif / élément |
|
action.command.targeting.facebook_positions[]oneOf 9 | stringFacultatif / élément |
|
action.command.targeting.instagram_positionsoneOf 9 | arrayFacultatif / élément |
|
action.command.targeting.instagram_positions[]oneOf 9 | stringFacultatif / élément |
|
action.command.targeting.threads_positionsoneOf 9 | arrayFacultatif / élément |
|
action.command.targeting.threads_positions[]oneOf 9 | stringFacultatif / élément |
|
action.command.targeting.custom_audience_idsoneOf 9 | arrayFacultatif / élément |
|
action.command.targeting.custom_audience_ids[]oneOf 9 | stringFacultatif / élément |
|
action.command.targeting.excluded_custom_audience_idsoneOf 9 | arrayFacultatif / élément |
|
action.command.targeting.excluded_custom_audience_ids[]oneOf 9 | stringFacultatif / élément |
|
action.reviewed_digest | stringRequis dans le parent |
|
action.effects | objectRequis dans le parent |
|
action.effects.creates_object | booleanRequis dans le parent | — |
action.effects.initial_status | string | nullRequis dans le parent | — |
action.effects.initial_statusanyOf 1 | stringRequis dans le parent |
|
action.effects.initial_statusanyOf 2 | nullRequis dans le parent | — |
action.effects.activates_delivery | booleanRequis dans le parent | — |
action.effects.changes_budget | booleanRequis dans le parent | — |
action.effects.changes_audience | booleanRequis dans le parent | — |
action.effects.changes_creative | booleanRequis dans le parent | — |
action.effects.currency | stringRequis dans le parent |
|
action.effects.timezone | stringRequis dans le parent |
|
action.effects.budget | object | nullRequis dans le parent | — |
action.effects.budgetanyOf 1 | objectRequis dans le parent |
|
action.effects.budget.kindanyOf 1 | stringRequis dans le parent |
|
action.effects.budget.amount_minoranyOf 1 | stringRequis dans le parent |
|
action.effects.budgetanyOf 2 | nullRequis dans le parent | — |
action.live_approval | objectRequis dans le parent |
|
action.live_approval.required | booleanRequis dans le parent | — |
action.live_approval.state | stringRequis dans le parent |
|
action.live_approval.reason | string | nullRequis dans le parent | — |
action.live_approval.reasonanyOf 1 | stringRequis dans le parent |
|
action.live_approval.reasonanyOf 2 | nullRequis dans le parent | — |
action.live_approval.expires_at | string | nullRequis dans le parent | — |
action.live_approval.expires_atanyOf 1 | stringRequis dans le parent |
|
action.live_approval.expires_atanyOf 2 | nullRequis dans le parent | — |
action.live_approval.approved_by | string | nullRequis dans le parent | — |
action.live_approval.approved_byanyOf 1 | stringRequis dans le parent |
|
action.live_approval.approved_byanyOf 2 | nullRequis dans le parent | — |
action.provider_object_id | string | nullRequis dans le parent | — |
action.provider_object_idanyOf 1 | stringRequis dans le parent |
|
action.provider_object_idanyOf 2 | nullRequis dans le parent | — |
action.failure_code | string | nullRequis dans le parent | — |
action.failure_codeanyOf 1 | stringRequis dans le parent |
|
action.failure_codeanyOf 2 | nullRequis dans le parent | — |
action.created_at | stringRequis dans le parent |
|
action.completed_at | string | nullRequis dans le parent | — |
action.completed_atanyOf 1 | stringRequis dans le parent |
|
action.completed_atanyOf 2 | nullRequis dans le parent | — |
replayed | booleanRequis dans le parent | — |
JSON Schema complet
{
"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
}Exemple d’appel d’outil
Ces exemples utilisent des valeurs fictives vérifiées contre les schémas. Remplacez les identifiants par ceux que vous êtes autorisé à utiliser, les médias par des ressources prêtes et les dates par l’heure confirmée. Vérifiez l’éligibilité du compte avant toute écriture. Cette page n’envoie aucune requête API.
{
"name": "sosoapi_ads_actions_apply",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111",
"prepare_token": "exampleaaaaaaaaaaaaaaaaaaaaaaaaa",
"reviewed_digest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
}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
}