Publicidade
Preparar ação publicitária
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.
POST /advertising-api/actions/prepareContrato revisado: · sha256:9aedef8d43dd4514
Visão geral
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.
Uma resposta HTTP bem-sucedida pode significar que uma requisição foi aceita, não concluída. Para trabalho em segundo plano, salve o ID retornado e consulte a mesma operação até terminar. Um post agendado ou aceito só está publicado quando a plataforma confirma; um timeout do cliente não comprova o resultado.
Autenticação e permissões
Um token só pode usar os direitos do seu proprietário. Cada requisição verifica participação no workspace, propriedade de recursos, workspaces selecionados e capacidades concedidas. Os perfis core e full mudam as ferramentas exibidas; não concedem acesso.
Campos da requisição
Obrigatório significa obrigatório dentro do objeto pai e da ramificação selecionada. Um filho obrigatório não torna obrigatório um pai opcional. As regras e nomes de campos abaixo são copiados do contrato.
| Campo / ramificação | Tipo / obrigatório | Restrições |
|---|---|---|
$ | objectObrigatório no objeto pai |
|
workspace_id | stringObrigatório no objeto pai |
|
advertising_account_id | stringObrigatório no objeto pai |
|
mutation_id | stringObrigatório no objeto pai |
|
command | objectObrigatório no objeto pai | — |
commandoneOf 1 | objectObrigatório no objeto pai |
|
command.operationoneOf 1 | stringObrigatório no objeto pai |
|
command.nameoneOf 1 | stringObrigatório no objeto pai |
|
command.budgetoneOf 1 | objectOpcional / item |
|
command.budget.kindoneOf 1 | stringObrigatório no objeto pai |
|
command.budget.amount_minoroneOf 1 | stringObrigatório no objeto pai |
|
command.objectiveoneOf 1 | stringObrigatório no objeto pai |
|
command.special_ad_categoriesoneOf 1 | arrayOpcional / item |
|
command.special_ad_categories[]oneOf 1 | stringOpcional / item |
|
command.statusoneOf 1 | stringOpcional / item |
|
commandoneOf 2 | objectObrigatório no objeto pai |
|
command.operationoneOf 2 | stringObrigatório no objeto pai |
|
command.object_idoneOf 2 | stringObrigatório no objeto pai |
|
command.nameoneOf 2 | stringOpcional / item |
|
command.budgetoneOf 2 | objectOpcional / item |
|
command.budget.kindoneOf 2 | stringObrigatório no objeto pai |
|
command.budget.amount_minoroneOf 2 | stringObrigatório no objeto pai |
|
command.statusoneOf 2 | stringOpcional / item |
|
commandoneOf 3 | objectObrigatório no objeto pai |
|
command.operationoneOf 3 | stringObrigatório no objeto pai |
|
command.campaign_idoneOf 3 | stringObrigatório no objeto pai |
|
command.nameoneOf 3 | stringObrigatório no objeto pai |
|
command.budgetoneOf 3 | objectOpcional / item |
|
command.budget.kindoneOf 3 | stringObrigatório no objeto pai |
|
command.budget.amount_minoroneOf 3 | stringObrigatório no objeto pai |
|
command.targetingoneOf 3 | objectObrigatório no objeto pai |
|
command.targeting.geo_locationsoneOf 3 | objectObrigatório no objeto pai |
|
command.targeting.geo_locations.countriesoneOf 3 | arrayObrigatório no objeto pai |
|
command.targeting.geo_locations.countries[]oneOf 3 | stringOpcional / item |
|
command.targeting.age_minoneOf 3 | integerOpcional / item |
|
command.targeting.age_maxoneOf 3 | integerOpcional / item |
|
command.targeting.gendersoneOf 3 | arrayOpcional / item |
|
command.targeting.genders[]oneOf 3 | numberOpcional / item | — |
command.targeting.genders[]oneOf 3 / anyOf 1 | numberOpcional / item |
|
command.targeting.genders[]oneOf 3 / anyOf 2 | numberOpcional / item |
|
command.targeting.localesoneOf 3 | arrayOpcional / item |
|
command.targeting.locales[]oneOf 3 | integerOpcional / item |
|
command.targeting.publisher_platformsoneOf 3 | arrayObrigatório no objeto pai |
|
command.targeting.publisher_platforms[]oneOf 3 | stringOpcional / item |
|
command.targeting.facebook_positionsoneOf 3 | arrayOpcional / item |
|
command.targeting.facebook_positions[]oneOf 3 | stringOpcional / item |
|
command.targeting.instagram_positionsoneOf 3 | arrayOpcional / item |
|
command.targeting.instagram_positions[]oneOf 3 | stringOpcional / item |
|
command.targeting.threads_positionsoneOf 3 | arrayOpcional / item |
|
command.targeting.threads_positions[]oneOf 3 | stringOpcional / item |
|
command.targeting.custom_audience_idsoneOf 3 | arrayOpcional / item |
|
command.targeting.custom_audience_ids[]oneOf 3 | stringOpcional / item |
|
command.targeting.excluded_custom_audience_idsoneOf 3 | arrayOpcional / item |
|
command.targeting.excluded_custom_audience_ids[]oneOf 3 | stringOpcional / item |
|
command.billing_eventoneOf 3 | stringObrigatório no objeto pai |
|
command.optimization_goaloneOf 3 | stringObrigatório no objeto pai |
|
command.bid_strategyoneOf 3 | stringOpcional / item |
|
command.start_timeoneOf 3 | stringOpcional / item |
|
command.end_timeoneOf 3 | stringOpcional / item |
|
command.promoted_objectoneOf 3 | objectOpcional / item |
|
command.promoted_object.page_idoneOf 3 | stringOpcional / item |
|
command.promoted_object.pixel_idoneOf 3 | stringOpcional / item |
|
command.promoted_object.custom_event_typeoneOf 3 | stringOpcional / item |
|
command.statusoneOf 3 | stringOpcional / item |
|
commandoneOf 4 | objectObrigatório no objeto pai |
|
command.operationoneOf 4 | stringObrigatório no objeto pai |
|
command.object_idoneOf 4 | stringObrigatório no objeto pai |
|
command.nameoneOf 4 | stringOpcional / item |
|
command.budgetoneOf 4 | objectOpcional / item |
|
command.budget.kindoneOf 4 | stringObrigatório no objeto pai |
|
command.budget.amount_minoroneOf 4 | stringObrigatório no objeto pai |
|
command.statusoneOf 4 | stringOpcional / item |
|
command.targetingoneOf 4 | objectOpcional / item |
|
command.targeting.geo_locationsoneOf 4 | objectObrigatório no objeto pai |
|
command.targeting.geo_locations.countriesoneOf 4 | arrayObrigatório no objeto pai |
|
command.targeting.geo_locations.countries[]oneOf 4 | stringOpcional / item |
|
command.targeting.age_minoneOf 4 | integerOpcional / item |
|
command.targeting.age_maxoneOf 4 | integerOpcional / item |
|
command.targeting.gendersoneOf 4 | arrayOpcional / item |
|
command.targeting.genders[]oneOf 4 | numberOpcional / item | — |
command.targeting.genders[]oneOf 4 / anyOf 1 | numberOpcional / item |
|
command.targeting.genders[]oneOf 4 / anyOf 2 | numberOpcional / item |
|
command.targeting.localesoneOf 4 | arrayOpcional / item |
|
command.targeting.locales[]oneOf 4 | integerOpcional / item |
|
command.targeting.publisher_platformsoneOf 4 | arrayObrigatório no objeto pai |
|
command.targeting.publisher_platforms[]oneOf 4 | stringOpcional / item |
|
command.targeting.facebook_positionsoneOf 4 | arrayOpcional / item |
|
command.targeting.facebook_positions[]oneOf 4 | stringOpcional / item |
|
command.targeting.instagram_positionsoneOf 4 | arrayOpcional / item |
|
command.targeting.instagram_positions[]oneOf 4 | stringOpcional / item |
|
command.targeting.threads_positionsoneOf 4 | arrayOpcional / item |
|
command.targeting.threads_positions[]oneOf 4 | stringOpcional / item |
|
command.targeting.custom_audience_idsoneOf 4 | arrayOpcional / item |
|
command.targeting.custom_audience_ids[]oneOf 4 | stringOpcional / item |
|
command.targeting.excluded_custom_audience_idsoneOf 4 | arrayOpcional / item |
|
command.targeting.excluded_custom_audience_ids[]oneOf 4 | stringOpcional / item |
|
command.start_timeoneOf 4 | stringOpcional / item |
|
command.end_timeoneOf 4 | stringOpcional / item |
|
commandoneOf 5 | objectObrigatório no objeto pai |
|
command.operationoneOf 5 | stringObrigatório no objeto pai |
|
command.nameoneOf 5 | stringObrigatório no objeto pai |
|
command.adset_idoneOf 5 | stringObrigatório no objeto pai |
|
command.creative_idoneOf 5 | stringObrigatório no objeto pai |
|
command.statusoneOf 5 | stringOpcional / item |
|
commandoneOf 6 | objectObrigatório no objeto pai |
|
command.operationoneOf 6 | stringObrigatório no objeto pai |
|
command.object_idoneOf 6 | stringObrigatório no objeto pai |
|
command.nameoneOf 6 | stringOpcional / item |
|
command.creative_idoneOf 6 | stringOpcional / item |
|
command.statusoneOf 6 | stringOpcional / item |
|
commandoneOf 7 | objectObrigatório no objeto pai |
|
command.operationoneOf 7 | stringObrigatório no objeto pai |
|
command.nameoneOf 7 | stringObrigatório no objeto pai |
|
command.object_story_speconeOf 7 | objectOpcional / item |
|
command.object_story_spec.page_idoneOf 7 | stringObrigatório no objeto pai |
|
command.object_story_spec.instagram_user_idoneOf 7 | stringOpcional / item |
|
command.object_story_spec.link_dataoneOf 7 | objectObrigatório no objeto pai |
|
command.object_story_spec.link_data.linkoneOf 7 | stringObrigatório no objeto pai |
|
command.object_story_spec.link_data.messageoneOf 7 | stringObrigatório no objeto pai |
|
command.object_story_spec.link_data.nameoneOf 7 | stringOpcional / item |
|
command.object_story_spec.link_data.image_hashoneOf 7 | stringObrigatório no objeto pai |
|
command.object_story_spec.link_data.call_to_actiononeOf 7 | stringOpcional / item |
|
command.object_story_idoneOf 7 | stringOpcional / item |
|
commandoneOf 8 | objectObrigatório no objeto pai |
|
command.operationoneOf 8 | stringObrigatório no objeto pai |
|
command.nameoneOf 8 | stringObrigatório no objeto pai |
|
command.targetingoneOf 8 | objectObrigatório no objeto pai |
|
command.targeting.geo_locationsoneOf 8 | objectObrigatório no objeto pai |
|
command.targeting.geo_locations.countriesoneOf 8 | arrayObrigatório no objeto pai |
|
command.targeting.geo_locations.countries[]oneOf 8 | stringOpcional / item |
|
command.targeting.age_minoneOf 8 | integerOpcional / item |
|
command.targeting.age_maxoneOf 8 | integerOpcional / item |
|
command.targeting.gendersoneOf 8 | arrayOpcional / item |
|
command.targeting.genders[]oneOf 8 | numberOpcional / item | — |
command.targeting.genders[]oneOf 8 / anyOf 1 | numberOpcional / item |
|
command.targeting.genders[]oneOf 8 / anyOf 2 | numberOpcional / item |
|
command.targeting.localesoneOf 8 | arrayOpcional / item |
|
command.targeting.locales[]oneOf 8 | integerOpcional / item |
|
command.targeting.publisher_platformsoneOf 8 | arrayObrigatório no objeto pai |
|
command.targeting.publisher_platforms[]oneOf 8 | stringOpcional / item |
|
command.targeting.facebook_positionsoneOf 8 | arrayOpcional / item |
|
command.targeting.facebook_positions[]oneOf 8 | stringOpcional / item |
|
command.targeting.instagram_positionsoneOf 8 | arrayOpcional / item |
|
command.targeting.instagram_positions[]oneOf 8 | stringOpcional / item |
|
command.targeting.threads_positionsoneOf 8 | arrayOpcional / item |
|
command.targeting.threads_positions[]oneOf 8 | stringOpcional / item |
|
command.targeting.custom_audience_idsoneOf 8 | arrayOpcional / item |
|
command.targeting.custom_audience_ids[]oneOf 8 | stringOpcional / item |
|
command.targeting.excluded_custom_audience_idsoneOf 8 | arrayOpcional / item |
|
command.targeting.excluded_custom_audience_ids[]oneOf 8 | stringOpcional / item |
|
commandoneOf 9 | objectObrigatório no objeto pai |
|
command.operationoneOf 9 | stringObrigatório no objeto pai |
|
command.object_idoneOf 9 | stringObrigatório no objeto pai |
|
command.nameoneOf 9 | stringOpcional / item |
|
command.targetingoneOf 9 | objectOpcional / item |
|
command.targeting.geo_locationsoneOf 9 | objectObrigatório no objeto pai |
|
command.targeting.geo_locations.countriesoneOf 9 | arrayObrigatório no objeto pai |
|
command.targeting.geo_locations.countries[]oneOf 9 | stringOpcional / item |
|
command.targeting.age_minoneOf 9 | integerOpcional / item |
|
command.targeting.age_maxoneOf 9 | integerOpcional / item |
|
command.targeting.gendersoneOf 9 | arrayOpcional / item |
|
command.targeting.genders[]oneOf 9 | numberOpcional / item | — |
command.targeting.genders[]oneOf 9 / anyOf 1 | numberOpcional / item |
|
command.targeting.genders[]oneOf 9 / anyOf 2 | numberOpcional / item |
|
command.targeting.localesoneOf 9 | arrayOpcional / item |
|
command.targeting.locales[]oneOf 9 | integerOpcional / item |
|
command.targeting.publisher_platformsoneOf 9 | arrayObrigatório no objeto pai |
|
command.targeting.publisher_platforms[]oneOf 9 | stringOpcional / item |
|
command.targeting.facebook_positionsoneOf 9 | arrayOpcional / item |
|
command.targeting.facebook_positions[]oneOf 9 | stringOpcional / item |
|
command.targeting.instagram_positionsoneOf 9 | arrayOpcional / item |
|
command.targeting.instagram_positions[]oneOf 9 | stringOpcional / item |
|
command.targeting.threads_positionsoneOf 9 | arrayOpcional / item |
|
command.targeting.threads_positions[]oneOf 9 | stringOpcional / item |
|
command.targeting.custom_audience_idsoneOf 9 | arrayOpcional / item |
|
command.targeting.custom_audience_ids[]oneOf 9 | stringOpcional / item |
|
command.targeting.excluded_custom_audience_idsoneOf 9 | arrayOpcional / item |
|
command.targeting.excluded_custom_audience_ids[]oneOf 9 | stringOpcional / item |
|
JSON Schema completo
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"advertising_account_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"mutation_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"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"
],
"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",
"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"
],
"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",
"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"
],
"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",
"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",
"publisher_platforms"
],
"additionalProperties": false
}
},
"required": [
"operation",
"object_id"
],
"additionalProperties": false
}
]
}
},
"required": [
"workspace_id",
"advertising_account_id",
"mutation_id",
"command"
],
"additionalProperties": false
}Resposta e conclusão
Códigos HTTP de sucesso: 200. Quando a operação estiver concluída: synchronous_http_response.
Uma resposta HTTP bem-sucedida pode significar que uma requisição foi aceita, não concluída. Para trabalho em segundo plano, salve o ID retornado e consulte a mesma operação até terminar. Um post agendado ou aceito só está publicado quando a plataforma confirma; um timeout do cliente não comprova o resultado.
Obrigatório significa obrigatório dentro do objeto pai e da ramificação selecionada. Um filho obrigatório não torna obrigatório um pai opcional. As regras e nomes de campos abaixo são copiados do contrato.
| Campo / ramificação | Tipo / obrigatório | Restrições |
|---|---|---|
$ | objectObrigatório no objeto pai | — |
contract_version | stringObrigatório no objeto pai |
|
prepare_token | stringObrigatório no objeto pai |
|
expires_at | stringObrigatório no objeto pai |
|
action | objectObrigatório no objeto pai | — |
action.id | stringObrigatório no objeto pai |
|
action.workspace_id | stringObrigatório no objeto pai |
|
action.advertising_account_id | stringObrigatório no objeto pai |
|
action.mutation_id | stringObrigatório no objeto pai |
|
action.status | stringObrigatório no objeto pai |
|
action.command | objectObrigatório no objeto pai | — |
action.commandoneOf 1 | objectObrigatório no objeto pai | — |
action.command.operationoneOf 1 | stringObrigatório no objeto pai |
|
action.command.nameoneOf 1 | stringObrigatório no objeto pai |
|
action.command.budgetoneOf 1 | objectOpcional / item | — |
action.command.budget.kindoneOf 1 | stringObrigatório no objeto pai |
|
action.command.budget.amount_minoroneOf 1 | stringObrigatório no objeto pai |
|
action.command.objectiveoneOf 1 | stringObrigatório no objeto pai |
|
action.command.special_ad_categoriesoneOf 1 | arrayObrigatório no objeto pai |
|
action.command.special_ad_categories[]oneOf 1 | stringOpcional / item |
|
action.command.statusoneOf 1 | stringObrigatório no objeto pai |
|
action.commandoneOf 2 | objectObrigatório no objeto pai | — |
action.command.operationoneOf 2 | stringObrigatório no objeto pai |
|
action.command.object_idoneOf 2 | stringObrigatório no objeto pai |
|
action.command.nameoneOf 2 | stringOpcional / item |
|
action.command.budgetoneOf 2 | objectOpcional / item | — |
action.command.budget.kindoneOf 2 | stringObrigatório no objeto pai |
|
action.command.budget.amount_minoroneOf 2 | stringObrigatório no objeto pai |
|
action.command.statusoneOf 2 | stringOpcional / item |
|
action.commandoneOf 3 | objectObrigatório no objeto pai | — |
action.command.operationoneOf 3 | stringObrigatório no objeto pai |
|
action.command.campaign_idoneOf 3 | stringObrigatório no objeto pai |
|
action.command.nameoneOf 3 | stringObrigatório no objeto pai |
|
action.command.budgetoneOf 3 | objectOpcional / item | — |
action.command.budget.kindoneOf 3 | stringObrigatório no objeto pai |
|
action.command.budget.amount_minoroneOf 3 | stringObrigatório no objeto pai |
|
action.command.targetingoneOf 3 | objectObrigatório no objeto pai | — |
action.command.targeting.geo_locationsoneOf 3 | objectObrigatório no objeto pai | — |
action.command.targeting.geo_locations.countriesoneOf 3 | arrayObrigatório no objeto pai |
|
action.command.targeting.geo_locations.countries[]oneOf 3 | stringOpcional / item |
|
action.command.targeting.age_minoneOf 3 | integerObrigatório no objeto pai |
|
action.command.targeting.age_maxoneOf 3 | integerObrigatório no objeto pai |
|
action.command.targeting.gendersoneOf 3 | arrayOpcional / item |
|
action.command.targeting.genders[]oneOf 3 | numberOpcional / item | — |
action.command.targeting.genders[]oneOf 3 / anyOf 1 | numberOpcional / item |
|
action.command.targeting.genders[]oneOf 3 / anyOf 2 | numberOpcional / item |
|
action.command.targeting.localesoneOf 3 | arrayOpcional / item |
|
action.command.targeting.locales[]oneOf 3 | integerOpcional / item |
|
action.command.targeting.publisher_platformsoneOf 3 | arrayObrigatório no objeto pai |
|
action.command.targeting.publisher_platforms[]oneOf 3 | stringOpcional / item |
|
action.command.targeting.facebook_positionsoneOf 3 | arrayOpcional / item |
|
action.command.targeting.facebook_positions[]oneOf 3 | stringOpcional / item |
|
action.command.targeting.instagram_positionsoneOf 3 | arrayOpcional / item |
|
action.command.targeting.instagram_positions[]oneOf 3 | stringOpcional / item |
|
action.command.targeting.threads_positionsoneOf 3 | arrayOpcional / item |
|
action.command.targeting.threads_positions[]oneOf 3 | stringOpcional / item |
|
action.command.targeting.custom_audience_idsoneOf 3 | arrayOpcional / item |
|
action.command.targeting.custom_audience_ids[]oneOf 3 | stringOpcional / item |
|
action.command.targeting.excluded_custom_audience_idsoneOf 3 | arrayOpcional / item |
|
action.command.targeting.excluded_custom_audience_ids[]oneOf 3 | stringOpcional / item |
|
action.command.billing_eventoneOf 3 | stringObrigatório no objeto pai |
|
action.command.optimization_goaloneOf 3 | stringObrigatório no objeto pai |
|
action.command.bid_strategyoneOf 3 | stringObrigatório no objeto pai |
|
action.command.start_timeoneOf 3 | stringOpcional / item |
|
action.command.end_timeoneOf 3 | stringOpcional / item |
|
action.command.promoted_objectoneOf 3 | objectOpcional / item | — |
action.command.promoted_object.page_idoneOf 3 | stringOpcional / item |
|
action.command.promoted_object.pixel_idoneOf 3 | stringOpcional / item |
|
action.command.promoted_object.custom_event_typeoneOf 3 | stringOpcional / item |
|
action.command.statusoneOf 3 | stringObrigatório no objeto pai |
|
action.commandoneOf 4 | objectObrigatório no objeto pai | — |
action.command.operationoneOf 4 | stringObrigatório no objeto pai |
|
action.command.object_idoneOf 4 | stringObrigatório no objeto pai |
|
action.command.nameoneOf 4 | stringOpcional / item |
|
action.command.budgetoneOf 4 | objectOpcional / item | — |
action.command.budget.kindoneOf 4 | stringObrigatório no objeto pai |
|
action.command.budget.amount_minoroneOf 4 | stringObrigatório no objeto pai |
|
action.command.statusoneOf 4 | stringOpcional / item |
|
action.command.targetingoneOf 4 | objectOpcional / item | — |
action.command.targeting.geo_locationsoneOf 4 | objectObrigatório no objeto pai | — |
action.command.targeting.geo_locations.countriesoneOf 4 | arrayObrigatório no objeto pai |
|
action.command.targeting.geo_locations.countries[]oneOf 4 | stringOpcional / item |
|
action.command.targeting.age_minoneOf 4 | integerObrigatório no objeto pai |
|
action.command.targeting.age_maxoneOf 4 | integerObrigatório no objeto pai |
|
action.command.targeting.gendersoneOf 4 | arrayOpcional / item |
|
action.command.targeting.genders[]oneOf 4 | numberOpcional / item | — |
action.command.targeting.genders[]oneOf 4 / anyOf 1 | numberOpcional / item |
|
action.command.targeting.genders[]oneOf 4 / anyOf 2 | numberOpcional / item |
|
action.command.targeting.localesoneOf 4 | arrayOpcional / item |
|
action.command.targeting.locales[]oneOf 4 | integerOpcional / item |
|
action.command.targeting.publisher_platformsoneOf 4 | arrayObrigatório no objeto pai |
|
action.command.targeting.publisher_platforms[]oneOf 4 | stringOpcional / item |
|
action.command.targeting.facebook_positionsoneOf 4 | arrayOpcional / item |
|
action.command.targeting.facebook_positions[]oneOf 4 | stringOpcional / item |
|
action.command.targeting.instagram_positionsoneOf 4 | arrayOpcional / item |
|
action.command.targeting.instagram_positions[]oneOf 4 | stringOpcional / item |
|
action.command.targeting.threads_positionsoneOf 4 | arrayOpcional / item |
|
action.command.targeting.threads_positions[]oneOf 4 | stringOpcional / item |
|
action.command.targeting.custom_audience_idsoneOf 4 | arrayOpcional / item |
|
action.command.targeting.custom_audience_ids[]oneOf 4 | stringOpcional / item |
|
action.command.targeting.excluded_custom_audience_idsoneOf 4 | arrayOpcional / item |
|
action.command.targeting.excluded_custom_audience_ids[]oneOf 4 | stringOpcional / item |
|
action.command.start_timeoneOf 4 | stringOpcional / item |
|
action.command.end_timeoneOf 4 | stringOpcional / item |
|
action.commandoneOf 5 | objectObrigatório no objeto pai | — |
action.command.operationoneOf 5 | stringObrigatório no objeto pai |
|
action.command.nameoneOf 5 | stringObrigatório no objeto pai |
|
action.command.adset_idoneOf 5 | stringObrigatório no objeto pai |
|
action.command.creative_idoneOf 5 | stringObrigatório no objeto pai |
|
action.command.statusoneOf 5 | stringObrigatório no objeto pai |
|
action.commandoneOf 6 | objectObrigatório no objeto pai | — |
action.command.operationoneOf 6 | stringObrigatório no objeto pai |
|
action.command.object_idoneOf 6 | stringObrigatório no objeto pai |
|
action.command.nameoneOf 6 | stringOpcional / item |
|
action.command.creative_idoneOf 6 | stringOpcional / item |
|
action.command.statusoneOf 6 | stringOpcional / item |
|
action.commandoneOf 7 | objectObrigatório no objeto pai | — |
action.command.operationoneOf 7 | stringObrigatório no objeto pai |
|
action.command.nameoneOf 7 | stringObrigatório no objeto pai |
|
action.command.object_story_speconeOf 7 | objectOpcional / item | — |
action.command.object_story_spec.page_idoneOf 7 | stringObrigatório no objeto pai |
|
action.command.object_story_spec.instagram_user_idoneOf 7 | stringOpcional / item |
|
action.command.object_story_spec.link_dataoneOf 7 | objectObrigatório no objeto pai | — |
action.command.object_story_spec.link_data.linkoneOf 7 | stringObrigatório no objeto pai |
|
action.command.object_story_spec.link_data.messageoneOf 7 | stringObrigatório no objeto pai |
|
action.command.object_story_spec.link_data.nameoneOf 7 | stringOpcional / item |
|
action.command.object_story_spec.link_data.image_hashoneOf 7 | stringObrigatório no objeto pai |
|
action.command.object_story_spec.link_data.call_to_actiononeOf 7 | stringOpcional / item |
|
action.command.object_story_idoneOf 7 | stringOpcional / item |
|
action.commandoneOf 8 | objectObrigatório no objeto pai | — |
action.command.operationoneOf 8 | stringObrigatório no objeto pai |
|
action.command.nameoneOf 8 | stringObrigatório no objeto pai |
|
action.command.targetingoneOf 8 | objectObrigatório no objeto pai | — |
action.command.targeting.geo_locationsoneOf 8 | objectObrigatório no objeto pai | — |
action.command.targeting.geo_locations.countriesoneOf 8 | arrayObrigatório no objeto pai |
|
action.command.targeting.geo_locations.countries[]oneOf 8 | stringOpcional / item |
|
action.command.targeting.age_minoneOf 8 | integerObrigatório no objeto pai |
|
action.command.targeting.age_maxoneOf 8 | integerObrigatório no objeto pai |
|
action.command.targeting.gendersoneOf 8 | arrayOpcional / item |
|
action.command.targeting.genders[]oneOf 8 | numberOpcional / item | — |
action.command.targeting.genders[]oneOf 8 / anyOf 1 | numberOpcional / item |
|
action.command.targeting.genders[]oneOf 8 / anyOf 2 | numberOpcional / item |
|
action.command.targeting.localesoneOf 8 | arrayOpcional / item |
|
action.command.targeting.locales[]oneOf 8 | integerOpcional / item |
|
action.command.targeting.publisher_platformsoneOf 8 | arrayObrigatório no objeto pai |
|
action.command.targeting.publisher_platforms[]oneOf 8 | stringOpcional / item |
|
action.command.targeting.facebook_positionsoneOf 8 | arrayOpcional / item |
|
action.command.targeting.facebook_positions[]oneOf 8 | stringOpcional / item |
|
action.command.targeting.instagram_positionsoneOf 8 | arrayOpcional / item |
|
action.command.targeting.instagram_positions[]oneOf 8 | stringOpcional / item |
|
action.command.targeting.threads_positionsoneOf 8 | arrayOpcional / item |
|
action.command.targeting.threads_positions[]oneOf 8 | stringOpcional / item |
|
action.command.targeting.custom_audience_idsoneOf 8 | arrayOpcional / item |
|
action.command.targeting.custom_audience_ids[]oneOf 8 | stringOpcional / item |
|
action.command.targeting.excluded_custom_audience_idsoneOf 8 | arrayOpcional / item |
|
action.command.targeting.excluded_custom_audience_ids[]oneOf 8 | stringOpcional / item |
|
action.commandoneOf 9 | objectObrigatório no objeto pai | — |
action.command.operationoneOf 9 | stringObrigatório no objeto pai |
|
action.command.object_idoneOf 9 | stringObrigatório no objeto pai |
|
action.command.nameoneOf 9 | stringOpcional / item |
|
action.command.targetingoneOf 9 | objectOpcional / item | — |
action.command.targeting.geo_locationsoneOf 9 | objectObrigatório no objeto pai | — |
action.command.targeting.geo_locations.countriesoneOf 9 | arrayObrigatório no objeto pai |
|
action.command.targeting.geo_locations.countries[]oneOf 9 | stringOpcional / item |
|
action.command.targeting.age_minoneOf 9 | integerObrigatório no objeto pai |
|
action.command.targeting.age_maxoneOf 9 | integerObrigatório no objeto pai |
|
action.command.targeting.gendersoneOf 9 | arrayOpcional / item |
|
action.command.targeting.genders[]oneOf 9 | numberOpcional / item | — |
action.command.targeting.genders[]oneOf 9 / anyOf 1 | numberOpcional / item |
|
action.command.targeting.genders[]oneOf 9 / anyOf 2 | numberOpcional / item |
|
action.command.targeting.localesoneOf 9 | arrayOpcional / item |
|
action.command.targeting.locales[]oneOf 9 | integerOpcional / item |
|
action.command.targeting.publisher_platformsoneOf 9 | arrayObrigatório no objeto pai |
|
action.command.targeting.publisher_platforms[]oneOf 9 | stringOpcional / item |
|
action.command.targeting.facebook_positionsoneOf 9 | arrayOpcional / item |
|
action.command.targeting.facebook_positions[]oneOf 9 | stringOpcional / item |
|
action.command.targeting.instagram_positionsoneOf 9 | arrayOpcional / item |
|
action.command.targeting.instagram_positions[]oneOf 9 | stringOpcional / item |
|
action.command.targeting.threads_positionsoneOf 9 | arrayOpcional / item |
|
action.command.targeting.threads_positions[]oneOf 9 | stringOpcional / item |
|
action.command.targeting.custom_audience_idsoneOf 9 | arrayOpcional / item |
|
action.command.targeting.custom_audience_ids[]oneOf 9 | stringOpcional / item |
|
action.command.targeting.excluded_custom_audience_idsoneOf 9 | arrayOpcional / item |
|
action.command.targeting.excluded_custom_audience_ids[]oneOf 9 | stringOpcional / item |
|
action.reviewed_digest | stringObrigatório no objeto pai |
|
action.effects | objectObrigatório no objeto pai | — |
action.effects.creates_object | booleanObrigatório no objeto pai | — |
action.effects.initial_status | string | nullObrigatório no objeto pai | — |
action.effects.initial_statusanyOf 1 | stringObrigatório no objeto pai |
|
action.effects.initial_statusanyOf 2 | nullObrigatório no objeto pai | — |
action.effects.activates_delivery | booleanObrigatório no objeto pai | — |
action.effects.changes_budget | booleanObrigatório no objeto pai | — |
action.effects.changes_audience | booleanObrigatório no objeto pai | — |
action.effects.changes_creative | booleanObrigatório no objeto pai | — |
action.effects.currency | stringObrigatório no objeto pai |
|
action.effects.timezone | stringObrigatório no objeto pai |
|
action.effects.budget | object | nullObrigatório no objeto pai | — |
action.effects.budgetanyOf 1 | objectObrigatório no objeto pai | — |
action.effects.budget.kindanyOf 1 | stringObrigatório no objeto pai |
|
action.effects.budget.amount_minoranyOf 1 | stringObrigatório no objeto pai |
|
action.effects.budgetanyOf 2 | nullObrigatório no objeto pai | — |
action.live_approval | objectObrigatório no objeto pai | — |
action.live_approval.required | booleanObrigatório no objeto pai | — |
action.live_approval.state | stringObrigatório no objeto pai |
|
action.live_approval.reason | string | nullObrigatório no objeto pai | — |
action.live_approval.reasonanyOf 1 | stringObrigatório no objeto pai |
|
action.live_approval.reasonanyOf 2 | nullObrigatório no objeto pai | — |
action.live_approval.expires_at | string | nullObrigatório no objeto pai | — |
action.live_approval.expires_atanyOf 1 | stringObrigatório no objeto pai |
|
action.live_approval.expires_atanyOf 2 | nullObrigatório no objeto pai | — |
action.live_approval.approved_by | string | nullObrigatório no objeto pai | — |
action.live_approval.approved_byanyOf 1 | stringObrigatório no objeto pai |
|
action.live_approval.approved_byanyOf 2 | nullObrigatório no objeto pai | — |
action.provider_object_id | string | nullObrigatório no objeto pai | — |
action.provider_object_idanyOf 1 | stringObrigatório no objeto pai |
|
action.provider_object_idanyOf 2 | nullObrigatório no objeto pai | — |
action.failure_code | string | nullObrigatório no objeto pai | — |
action.failure_codeanyOf 1 | stringObrigatório no objeto pai |
|
action.failure_codeanyOf 2 | nullObrigatório no objeto pai | — |
action.created_at | stringObrigatório no objeto pai |
|
action.completed_at | string | nullObrigatório no objeto pai | — |
action.completed_atanyOf 1 | stringObrigatório no objeto pai |
|
action.completed_atanyOf 2 | nullObrigatório no objeto pai | — |
JSON Schema completo
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"contract_version": {
"type": "string",
"const": "advertising/v1"
},
"prepare_token": {
"type": "string",
"minLength": 32,
"maxLength": 128
},
"expires_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"action": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"workspace_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"advertising_account_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"mutation_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"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"
]
},
"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"
]
},
{
"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"
]
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"PAUSED",
"ARCHIVED"
]
}
},
"required": [
"operation",
"object_id"
]
},
{
"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"
]
},
"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"
]
},
"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"
]
},
"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"
]
}
}
},
"status": {
"default": "PAUSED",
"type": "string",
"const": "PAUSED"
}
},
"required": [
"operation",
"campaign_id",
"name",
"targeting",
"billing_event",
"optimization_goal",
"bid_strategy",
"status"
]
},
{
"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"
]
},
"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"
]
},
"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"
]
},
"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"
]
},
{
"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"
]
},
{
"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"
]
},
{
"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"
]
}
},
"required": [
"page_id",
"link_data"
]
},
"object_story_id": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}_[1-9]\\d{1,24}$"
}
},
"required": [
"operation",
"name"
]
},
{
"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"
]
},
"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"
]
}
},
"required": [
"operation",
"name",
"targeting"
]
},
{
"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"
]
},
"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"
]
}
},
"required": [
"operation",
"object_id"
]
}
]
},
"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"
]
},
{
"type": "null"
}
]
}
},
"required": [
"creates_object",
"initial_status",
"activates_delivery",
"changes_budget",
"changes_audience",
"changes_creative",
"currency",
"timezone",
"budget"
]
},
"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",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
}
},
"required": [
"required",
"state",
"reason",
"expires_at",
"approved_by"
]
},
"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"
]
}
},
"required": [
"contract_version",
"prepare_token",
"expires_at",
"action"
]
}Erros e repetições seguras
Confira o status HTTP e o corpo da resposta. Um erro de validação 400 pode conter ZodError; erros do handler usam os campos error, message e code. Guarde request_id ou x-request-id para diagnóstico, sem credenciais. Corrija erros de acesso 401/403 antes de tentar novamente e siga Retry-After para 429. Se uma gravação for incerta ou retornar 5xx, consulte primeiro o resultado existente. Reutilize uma chave de idempotência somente quando houver suporte; o comportamento de repetição varia por operação e não garante entrega exatamente uma vez.
Guia de solução de problemasExemplos
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.
Defina SOSOAPI_ACCESS_TOKEN no servidor como uma credencial aceita por esta operação e mantenha-a fora do código do navegador. Para agentes de IA, use sosoapi auth login para entrar pelo navegador e deixe a CLI renovar suas credenciais.
request.json
{
"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"
}
}cURL
curl --request POST \
"https://gqeshlawtcexsapabaui.supabase.co/functions/v1/advertising-api/actions/prepare" \
-H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
--data-binary @request.jsonJavaScript
// Server-side JavaScript. Do not print tokens or credential-bearing responses.
const token = process.env.SOSOAPI_ACCESS_TOKEN;
if (!token) throw new Error("Set an accepted credential for this operation");
const response = await fetch("https://gqeshlawtcexsapabaui.supabase.co/functions/v1/advertising-api/actions/prepare", {
method: "POST",
headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
body: JSON.stringify({
"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"
}
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.CLI
npx sosoapi api post /advertising-api/actions/prepare < request.jsonExemplo de resposta sintética
{
"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
}
}