# Preparar ação publicitária URL canônica: https://sosoapi.ai/pt-br/docs/mcp/ads-actions-prepare `sosoapi_ads_actions_prepare` Congele um comando campaign/adset/ad/creative/saved-audience exato e seus efeitos revisados. As criações começam em PAUSED; a ativação ou os efeitos no orçamento exigem uma autorização separada para operações reais. ## Perfis e transportes Perfis: full Transportes: stdio, http Escolha core ou full para controlar quais ferramentas seu cliente vê; isso não altera suas permissões. O envio de arquivos locais exige stdio e não está disponível por HTTP. Defina SOSOAPI_OUTPUT_SCHEMAS=1 para incluir schemas de saída na descoberta. As ferramentas retornam resultados estruturados com ou sem essa configuração. ## Permissões e efeitos colaterais As anotações ajudam os clientes a descrever uma ferramenta. Cada chamada ainda verifica autenticação, função, acesso a recursos e concessões de capacidades do usuário. ```json { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } ``` `/advertising-api/actions/prepare` — agent:advertising_manage; synchronous_http_response ## Campos de entrada ```json { "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" ] } } } ``` ## Saída estruturada Este schema descreve structuredContent em um resultado de ferramenta bem-sucedido. A resposta MCP também inclui content e pode definir isError quando uma chamada falha. Para publicações, consulte o resultado final do post em vez de tratar uma requisição aceita ou resposta de texto como confirmação. A operação de API vinculada explica as permissões e regras de repetição. ```json { "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 } ``` ## Exemplo de chamada de ferramenta Estes exemplos usam valores fictícios verificados conforme os schemas. Substitua os IDs por aqueles que você tem autorização para usar, a mídia por ativos prontos e as datas pelo horário de publicação confirmado. Confira a elegibilidade da conta antes de enviar uma gravação. Esta página não envia requisições de API. ```json { "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 ```json { "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 } } ``` ## Operações de API subjacentes - [/advertising-api/actions/prepare](https://sosoapi.ai/pt-br/docs/api/advertising-api-actions-prepare)