Publicidad
Preparar acción publicitaria
Inmoviliza un comando campaign/adset/ad/creative/saved-audience exacto y sus efectos revisados. Las creaciones empiezan en PAUSED; la activación o los efectos presupuestarios requieren una autorización independiente para operaciones reales.
POST /advertising-api/actions/prepareContrato revisado: · sha256:9aedef8d43dd4514
Descripción general
Inmoviliza un comando campaign/adset/ad/creative/saved-audience exacto y sus efectos revisados. Las creaciones empiezan en PAUSED; la activación o los efectos presupuestarios requieren una autorización independiente para operaciones reales.
Una respuesta HTTP exitosa puede indicar aceptación, no finalización. Para trabajo en segundo plano, guarda el ID devuelto y consulta la misma operación hasta que termine. Una publicación programada o aceptada solo está publicada cuando la plataforma lo confirma; un tiempo de espera agotado en el cliente no determina el resultado.
Autenticación y permisos
Un token solo puede usar los derechos de su propietario. Cada solicitud comprueba pertenencia al espacio, propiedad del recurso, espacios elegidos y capacidades concedidas. Los perfiles core y full cambian qué herramientas se muestran; no conceden acceso.
Campos de solicitud
Obligatorio significa obligatorio dentro del objeto principal y la rama elegida. Un campo secundario obligatorio no convierte en obligatorio un objeto principal opcional. Las reglas y nombres de campos siguientes se copian del contrato.
| Campo / rama | Tipo / obligatorio | Restricciones |
|---|---|---|
$ | objectObligatorio en el objeto principal |
|
workspace_id | stringObligatorio en el objeto principal |
|
advertising_account_id | stringObligatorio en el objeto principal |
|
mutation_id | stringObligatorio en el objeto principal |
|
command | objectObligatorio en el objeto principal | — |
commandoneOf 1 | objectObligatorio en el objeto principal |
|
command.operationoneOf 1 | stringObligatorio en el objeto principal |
|
command.nameoneOf 1 | stringObligatorio en el objeto principal |
|
command.budgetoneOf 1 | objectOpcional / elemento |
|
command.budget.kindoneOf 1 | stringObligatorio en el objeto principal |
|
command.budget.amount_minoroneOf 1 | stringObligatorio en el objeto principal |
|
command.objectiveoneOf 1 | stringObligatorio en el objeto principal |
|
command.special_ad_categoriesoneOf 1 | arrayOpcional / elemento |
|
command.special_ad_categories[]oneOf 1 | stringOpcional / elemento |
|
command.statusoneOf 1 | stringOpcional / elemento |
|
commandoneOf 2 | objectObligatorio en el objeto principal |
|
command.operationoneOf 2 | stringObligatorio en el objeto principal |
|
command.object_idoneOf 2 | stringObligatorio en el objeto principal |
|
command.nameoneOf 2 | stringOpcional / elemento |
|
command.budgetoneOf 2 | objectOpcional / elemento |
|
command.budget.kindoneOf 2 | stringObligatorio en el objeto principal |
|
command.budget.amount_minoroneOf 2 | stringObligatorio en el objeto principal |
|
command.statusoneOf 2 | stringOpcional / elemento |
|
commandoneOf 3 | objectObligatorio en el objeto principal |
|
command.operationoneOf 3 | stringObligatorio en el objeto principal |
|
command.campaign_idoneOf 3 | stringObligatorio en el objeto principal |
|
command.nameoneOf 3 | stringObligatorio en el objeto principal |
|
command.budgetoneOf 3 | objectOpcional / elemento |
|
command.budget.kindoneOf 3 | stringObligatorio en el objeto principal |
|
command.budget.amount_minoroneOf 3 | stringObligatorio en el objeto principal |
|
command.targetingoneOf 3 | objectObligatorio en el objeto principal |
|
command.targeting.geo_locationsoneOf 3 | objectObligatorio en el objeto principal |
|
command.targeting.geo_locations.countriesoneOf 3 | arrayObligatorio en el objeto principal |
|
command.targeting.geo_locations.countries[]oneOf 3 | stringOpcional / elemento |
|
command.targeting.age_minoneOf 3 | integerOpcional / elemento |
|
command.targeting.age_maxoneOf 3 | integerOpcional / elemento |
|
command.targeting.gendersoneOf 3 | arrayOpcional / elemento |
|
command.targeting.genders[]oneOf 3 | numberOpcional / elemento | — |
command.targeting.genders[]oneOf 3 / anyOf 1 | numberOpcional / elemento |
|
command.targeting.genders[]oneOf 3 / anyOf 2 | numberOpcional / elemento |
|
command.targeting.localesoneOf 3 | arrayOpcional / elemento |
|
command.targeting.locales[]oneOf 3 | integerOpcional / elemento |
|
command.targeting.publisher_platformsoneOf 3 | arrayObligatorio en el objeto principal |
|
command.targeting.publisher_platforms[]oneOf 3 | stringOpcional / elemento |
|
command.targeting.facebook_positionsoneOf 3 | arrayOpcional / elemento |
|
command.targeting.facebook_positions[]oneOf 3 | stringOpcional / elemento |
|
command.targeting.instagram_positionsoneOf 3 | arrayOpcional / elemento |
|
command.targeting.instagram_positions[]oneOf 3 | stringOpcional / elemento |
|
command.targeting.threads_positionsoneOf 3 | arrayOpcional / elemento |
|
command.targeting.threads_positions[]oneOf 3 | stringOpcional / elemento |
|
command.targeting.custom_audience_idsoneOf 3 | arrayOpcional / elemento |
|
command.targeting.custom_audience_ids[]oneOf 3 | stringOpcional / elemento |
|
command.targeting.excluded_custom_audience_idsoneOf 3 | arrayOpcional / elemento |
|
command.targeting.excluded_custom_audience_ids[]oneOf 3 | stringOpcional / elemento |
|
command.billing_eventoneOf 3 | stringObligatorio en el objeto principal |
|
command.optimization_goaloneOf 3 | stringObligatorio en el objeto principal |
|
command.bid_strategyoneOf 3 | stringOpcional / elemento |
|
command.start_timeoneOf 3 | stringOpcional / elemento |
|
command.end_timeoneOf 3 | stringOpcional / elemento |
|
command.promoted_objectoneOf 3 | objectOpcional / elemento |
|
command.promoted_object.page_idoneOf 3 | stringOpcional / elemento |
|
command.promoted_object.pixel_idoneOf 3 | stringOpcional / elemento |
|
command.promoted_object.custom_event_typeoneOf 3 | stringOpcional / elemento |
|
command.statusoneOf 3 | stringOpcional / elemento |
|
commandoneOf 4 | objectObligatorio en el objeto principal |
|
command.operationoneOf 4 | stringObligatorio en el objeto principal |
|
command.object_idoneOf 4 | stringObligatorio en el objeto principal |
|
command.nameoneOf 4 | stringOpcional / elemento |
|
command.budgetoneOf 4 | objectOpcional / elemento |
|
command.budget.kindoneOf 4 | stringObligatorio en el objeto principal |
|
command.budget.amount_minoroneOf 4 | stringObligatorio en el objeto principal |
|
command.statusoneOf 4 | stringOpcional / elemento |
|
command.targetingoneOf 4 | objectOpcional / elemento |
|
command.targeting.geo_locationsoneOf 4 | objectObligatorio en el objeto principal |
|
command.targeting.geo_locations.countriesoneOf 4 | arrayObligatorio en el objeto principal |
|
command.targeting.geo_locations.countries[]oneOf 4 | stringOpcional / elemento |
|
command.targeting.age_minoneOf 4 | integerOpcional / elemento |
|
command.targeting.age_maxoneOf 4 | integerOpcional / elemento |
|
command.targeting.gendersoneOf 4 | arrayOpcional / elemento |
|
command.targeting.genders[]oneOf 4 | numberOpcional / elemento | — |
command.targeting.genders[]oneOf 4 / anyOf 1 | numberOpcional / elemento |
|
command.targeting.genders[]oneOf 4 / anyOf 2 | numberOpcional / elemento |
|
command.targeting.localesoneOf 4 | arrayOpcional / elemento |
|
command.targeting.locales[]oneOf 4 | integerOpcional / elemento |
|
command.targeting.publisher_platformsoneOf 4 | arrayObligatorio en el objeto principal |
|
command.targeting.publisher_platforms[]oneOf 4 | stringOpcional / elemento |
|
command.targeting.facebook_positionsoneOf 4 | arrayOpcional / elemento |
|
command.targeting.facebook_positions[]oneOf 4 | stringOpcional / elemento |
|
command.targeting.instagram_positionsoneOf 4 | arrayOpcional / elemento |
|
command.targeting.instagram_positions[]oneOf 4 | stringOpcional / elemento |
|
command.targeting.threads_positionsoneOf 4 | arrayOpcional / elemento |
|
command.targeting.threads_positions[]oneOf 4 | stringOpcional / elemento |
|
command.targeting.custom_audience_idsoneOf 4 | arrayOpcional / elemento |
|
command.targeting.custom_audience_ids[]oneOf 4 | stringOpcional / elemento |
|
command.targeting.excluded_custom_audience_idsoneOf 4 | arrayOpcional / elemento |
|
command.targeting.excluded_custom_audience_ids[]oneOf 4 | stringOpcional / elemento |
|
command.start_timeoneOf 4 | stringOpcional / elemento |
|
command.end_timeoneOf 4 | stringOpcional / elemento |
|
commandoneOf 5 | objectObligatorio en el objeto principal |
|
command.operationoneOf 5 | stringObligatorio en el objeto principal |
|
command.nameoneOf 5 | stringObligatorio en el objeto principal |
|
command.adset_idoneOf 5 | stringObligatorio en el objeto principal |
|
command.creative_idoneOf 5 | stringObligatorio en el objeto principal |
|
command.statusoneOf 5 | stringOpcional / elemento |
|
commandoneOf 6 | objectObligatorio en el objeto principal |
|
command.operationoneOf 6 | stringObligatorio en el objeto principal |
|
command.object_idoneOf 6 | stringObligatorio en el objeto principal |
|
command.nameoneOf 6 | stringOpcional / elemento |
|
command.creative_idoneOf 6 | stringOpcional / elemento |
|
command.statusoneOf 6 | stringOpcional / elemento |
|
commandoneOf 7 | objectObligatorio en el objeto principal |
|
command.operationoneOf 7 | stringObligatorio en el objeto principal |
|
command.nameoneOf 7 | stringObligatorio en el objeto principal |
|
command.object_story_speconeOf 7 | objectOpcional / elemento |
|
command.object_story_spec.page_idoneOf 7 | stringObligatorio en el objeto principal |
|
command.object_story_spec.instagram_user_idoneOf 7 | stringOpcional / elemento |
|
command.object_story_spec.link_dataoneOf 7 | objectObligatorio en el objeto principal |
|
command.object_story_spec.link_data.linkoneOf 7 | stringObligatorio en el objeto principal |
|
command.object_story_spec.link_data.messageoneOf 7 | stringObligatorio en el objeto principal |
|
command.object_story_spec.link_data.nameoneOf 7 | stringOpcional / elemento |
|
command.object_story_spec.link_data.image_hashoneOf 7 | stringObligatorio en el objeto principal |
|
command.object_story_spec.link_data.call_to_actiononeOf 7 | stringOpcional / elemento |
|
command.object_story_idoneOf 7 | stringOpcional / elemento |
|
commandoneOf 8 | objectObligatorio en el objeto principal |
|
command.operationoneOf 8 | stringObligatorio en el objeto principal |
|
command.nameoneOf 8 | stringObligatorio en el objeto principal |
|
command.targetingoneOf 8 | objectObligatorio en el objeto principal |
|
command.targeting.geo_locationsoneOf 8 | objectObligatorio en el objeto principal |
|
command.targeting.geo_locations.countriesoneOf 8 | arrayObligatorio en el objeto principal |
|
command.targeting.geo_locations.countries[]oneOf 8 | stringOpcional / elemento |
|
command.targeting.age_minoneOf 8 | integerOpcional / elemento |
|
command.targeting.age_maxoneOf 8 | integerOpcional / elemento |
|
command.targeting.gendersoneOf 8 | arrayOpcional / elemento |
|
command.targeting.genders[]oneOf 8 | numberOpcional / elemento | — |
command.targeting.genders[]oneOf 8 / anyOf 1 | numberOpcional / elemento |
|
command.targeting.genders[]oneOf 8 / anyOf 2 | numberOpcional / elemento |
|
command.targeting.localesoneOf 8 | arrayOpcional / elemento |
|
command.targeting.locales[]oneOf 8 | integerOpcional / elemento |
|
command.targeting.publisher_platformsoneOf 8 | arrayObligatorio en el objeto principal |
|
command.targeting.publisher_platforms[]oneOf 8 | stringOpcional / elemento |
|
command.targeting.facebook_positionsoneOf 8 | arrayOpcional / elemento |
|
command.targeting.facebook_positions[]oneOf 8 | stringOpcional / elemento |
|
command.targeting.instagram_positionsoneOf 8 | arrayOpcional / elemento |
|
command.targeting.instagram_positions[]oneOf 8 | stringOpcional / elemento |
|
command.targeting.threads_positionsoneOf 8 | arrayOpcional / elemento |
|
command.targeting.threads_positions[]oneOf 8 | stringOpcional / elemento |
|
command.targeting.custom_audience_idsoneOf 8 | arrayOpcional / elemento |
|
command.targeting.custom_audience_ids[]oneOf 8 | stringOpcional / elemento |
|
command.targeting.excluded_custom_audience_idsoneOf 8 | arrayOpcional / elemento |
|
command.targeting.excluded_custom_audience_ids[]oneOf 8 | stringOpcional / elemento |
|
commandoneOf 9 | objectObligatorio en el objeto principal |
|
command.operationoneOf 9 | stringObligatorio en el objeto principal |
|
command.object_idoneOf 9 | stringObligatorio en el objeto principal |
|
command.nameoneOf 9 | stringOpcional / elemento |
|
command.targetingoneOf 9 | objectOpcional / elemento |
|
command.targeting.geo_locationsoneOf 9 | objectObligatorio en el objeto principal |
|
command.targeting.geo_locations.countriesoneOf 9 | arrayObligatorio en el objeto principal |
|
command.targeting.geo_locations.countries[]oneOf 9 | stringOpcional / elemento |
|
command.targeting.age_minoneOf 9 | integerOpcional / elemento |
|
command.targeting.age_maxoneOf 9 | integerOpcional / elemento |
|
command.targeting.gendersoneOf 9 | arrayOpcional / elemento |
|
command.targeting.genders[]oneOf 9 | numberOpcional / elemento | — |
command.targeting.genders[]oneOf 9 / anyOf 1 | numberOpcional / elemento |
|
command.targeting.genders[]oneOf 9 / anyOf 2 | numberOpcional / elemento |
|
command.targeting.localesoneOf 9 | arrayOpcional / elemento |
|
command.targeting.locales[]oneOf 9 | integerOpcional / elemento |
|
command.targeting.publisher_platformsoneOf 9 | arrayObligatorio en el objeto principal |
|
command.targeting.publisher_platforms[]oneOf 9 | stringOpcional / elemento |
|
command.targeting.facebook_positionsoneOf 9 | arrayOpcional / elemento |
|
command.targeting.facebook_positions[]oneOf 9 | stringOpcional / elemento |
|
command.targeting.instagram_positionsoneOf 9 | arrayOpcional / elemento |
|
command.targeting.instagram_positions[]oneOf 9 | stringOpcional / elemento |
|
command.targeting.threads_positionsoneOf 9 | arrayOpcional / elemento |
|
command.targeting.threads_positions[]oneOf 9 | stringOpcional / elemento |
|
command.targeting.custom_audience_idsoneOf 9 | arrayOpcional / elemento |
|
command.targeting.custom_audience_ids[]oneOf 9 | stringOpcional / elemento |
|
command.targeting.excluded_custom_audience_idsoneOf 9 | arrayOpcional / elemento |
|
command.targeting.excluded_custom_audience_ids[]oneOf 9 | stringOpcional / elemento |
|
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
}Respuesta y finalización
Estados HTTP de éxito: 200. Cuando la operación se completa: synchronous_http_response.
Una respuesta HTTP exitosa puede indicar aceptación, no finalización. Para trabajo en segundo plano, guarda el ID devuelto y consulta la misma operación hasta que termine. Una publicación programada o aceptada solo está publicada cuando la plataforma lo confirma; un tiempo de espera agotado en el cliente no determina el resultado.
Obligatorio significa obligatorio dentro del objeto principal y la rama elegida. Un campo secundario obligatorio no convierte en obligatorio un objeto principal opcional. Las reglas y nombres de campos siguientes se copian del contrato.
| Campo / rama | Tipo / obligatorio | Restricciones |
|---|---|---|
$ | objectObligatorio en el objeto principal | — |
contract_version | stringObligatorio en el objeto principal |
|
prepare_token | stringObligatorio en el objeto principal |
|
expires_at | stringObligatorio en el objeto principal |
|
action | objectObligatorio en el objeto principal | — |
action.id | stringObligatorio en el objeto principal |
|
action.workspace_id | stringObligatorio en el objeto principal |
|
action.advertising_account_id | stringObligatorio en el objeto principal |
|
action.mutation_id | stringObligatorio en el objeto principal |
|
action.status | stringObligatorio en el objeto principal |
|
action.command | objectObligatorio en el objeto principal | — |
action.commandoneOf 1 | objectObligatorio en el objeto principal | — |
action.command.operationoneOf 1 | stringObligatorio en el objeto principal |
|
action.command.nameoneOf 1 | stringObligatorio en el objeto principal |
|
action.command.budgetoneOf 1 | objectOpcional / elemento | — |
action.command.budget.kindoneOf 1 | stringObligatorio en el objeto principal |
|
action.command.budget.amount_minoroneOf 1 | stringObligatorio en el objeto principal |
|
action.command.objectiveoneOf 1 | stringObligatorio en el objeto principal |
|
action.command.special_ad_categoriesoneOf 1 | arrayObligatorio en el objeto principal |
|
action.command.special_ad_categories[]oneOf 1 | stringOpcional / elemento |
|
action.command.statusoneOf 1 | stringObligatorio en el objeto principal |
|
action.commandoneOf 2 | objectObligatorio en el objeto principal | — |
action.command.operationoneOf 2 | stringObligatorio en el objeto principal |
|
action.command.object_idoneOf 2 | stringObligatorio en el objeto principal |
|
action.command.nameoneOf 2 | stringOpcional / elemento |
|
action.command.budgetoneOf 2 | objectOpcional / elemento | — |
action.command.budget.kindoneOf 2 | stringObligatorio en el objeto principal |
|
action.command.budget.amount_minoroneOf 2 | stringObligatorio en el objeto principal |
|
action.command.statusoneOf 2 | stringOpcional / elemento |
|
action.commandoneOf 3 | objectObligatorio en el objeto principal | — |
action.command.operationoneOf 3 | stringObligatorio en el objeto principal |
|
action.command.campaign_idoneOf 3 | stringObligatorio en el objeto principal |
|
action.command.nameoneOf 3 | stringObligatorio en el objeto principal |
|
action.command.budgetoneOf 3 | objectOpcional / elemento | — |
action.command.budget.kindoneOf 3 | stringObligatorio en el objeto principal |
|
action.command.budget.amount_minoroneOf 3 | stringObligatorio en el objeto principal |
|
action.command.targetingoneOf 3 | objectObligatorio en el objeto principal | — |
action.command.targeting.geo_locationsoneOf 3 | objectObligatorio en el objeto principal | — |
action.command.targeting.geo_locations.countriesoneOf 3 | arrayObligatorio en el objeto principal |
|
action.command.targeting.geo_locations.countries[]oneOf 3 | stringOpcional / elemento |
|
action.command.targeting.age_minoneOf 3 | integerObligatorio en el objeto principal |
|
action.command.targeting.age_maxoneOf 3 | integerObligatorio en el objeto principal |
|
action.command.targeting.gendersoneOf 3 | arrayOpcional / elemento |
|
action.command.targeting.genders[]oneOf 3 | numberOpcional / elemento | — |
action.command.targeting.genders[]oneOf 3 / anyOf 1 | numberOpcional / elemento |
|
action.command.targeting.genders[]oneOf 3 / anyOf 2 | numberOpcional / elemento |
|
action.command.targeting.localesoneOf 3 | arrayOpcional / elemento |
|
action.command.targeting.locales[]oneOf 3 | integerOpcional / elemento |
|
action.command.targeting.publisher_platformsoneOf 3 | arrayObligatorio en el objeto principal |
|
action.command.targeting.publisher_platforms[]oneOf 3 | stringOpcional / elemento |
|
action.command.targeting.facebook_positionsoneOf 3 | arrayOpcional / elemento |
|
action.command.targeting.facebook_positions[]oneOf 3 | stringOpcional / elemento |
|
action.command.targeting.instagram_positionsoneOf 3 | arrayOpcional / elemento |
|
action.command.targeting.instagram_positions[]oneOf 3 | stringOpcional / elemento |
|
action.command.targeting.threads_positionsoneOf 3 | arrayOpcional / elemento |
|
action.command.targeting.threads_positions[]oneOf 3 | stringOpcional / elemento |
|
action.command.targeting.custom_audience_idsoneOf 3 | arrayOpcional / elemento |
|
action.command.targeting.custom_audience_ids[]oneOf 3 | stringOpcional / elemento |
|
action.command.targeting.excluded_custom_audience_idsoneOf 3 | arrayOpcional / elemento |
|
action.command.targeting.excluded_custom_audience_ids[]oneOf 3 | stringOpcional / elemento |
|
action.command.billing_eventoneOf 3 | stringObligatorio en el objeto principal |
|
action.command.optimization_goaloneOf 3 | stringObligatorio en el objeto principal |
|
action.command.bid_strategyoneOf 3 | stringObligatorio en el objeto principal |
|
action.command.start_timeoneOf 3 | stringOpcional / elemento |
|
action.command.end_timeoneOf 3 | stringOpcional / elemento |
|
action.command.promoted_objectoneOf 3 | objectOpcional / elemento | — |
action.command.promoted_object.page_idoneOf 3 | stringOpcional / elemento |
|
action.command.promoted_object.pixel_idoneOf 3 | stringOpcional / elemento |
|
action.command.promoted_object.custom_event_typeoneOf 3 | stringOpcional / elemento |
|
action.command.statusoneOf 3 | stringObligatorio en el objeto principal |
|
action.commandoneOf 4 | objectObligatorio en el objeto principal | — |
action.command.operationoneOf 4 | stringObligatorio en el objeto principal |
|
action.command.object_idoneOf 4 | stringObligatorio en el objeto principal |
|
action.command.nameoneOf 4 | stringOpcional / elemento |
|
action.command.budgetoneOf 4 | objectOpcional / elemento | — |
action.command.budget.kindoneOf 4 | stringObligatorio en el objeto principal |
|
action.command.budget.amount_minoroneOf 4 | stringObligatorio en el objeto principal |
|
action.command.statusoneOf 4 | stringOpcional / elemento |
|
action.command.targetingoneOf 4 | objectOpcional / elemento | — |
action.command.targeting.geo_locationsoneOf 4 | objectObligatorio en el objeto principal | — |
action.command.targeting.geo_locations.countriesoneOf 4 | arrayObligatorio en el objeto principal |
|
action.command.targeting.geo_locations.countries[]oneOf 4 | stringOpcional / elemento |
|
action.command.targeting.age_minoneOf 4 | integerObligatorio en el objeto principal |
|
action.command.targeting.age_maxoneOf 4 | integerObligatorio en el objeto principal |
|
action.command.targeting.gendersoneOf 4 | arrayOpcional / elemento |
|
action.command.targeting.genders[]oneOf 4 | numberOpcional / elemento | — |
action.command.targeting.genders[]oneOf 4 / anyOf 1 | numberOpcional / elemento |
|
action.command.targeting.genders[]oneOf 4 / anyOf 2 | numberOpcional / elemento |
|
action.command.targeting.localesoneOf 4 | arrayOpcional / elemento |
|
action.command.targeting.locales[]oneOf 4 | integerOpcional / elemento |
|
action.command.targeting.publisher_platformsoneOf 4 | arrayObligatorio en el objeto principal |
|
action.command.targeting.publisher_platforms[]oneOf 4 | stringOpcional / elemento |
|
action.command.targeting.facebook_positionsoneOf 4 | arrayOpcional / elemento |
|
action.command.targeting.facebook_positions[]oneOf 4 | stringOpcional / elemento |
|
action.command.targeting.instagram_positionsoneOf 4 | arrayOpcional / elemento |
|
action.command.targeting.instagram_positions[]oneOf 4 | stringOpcional / elemento |
|
action.command.targeting.threads_positionsoneOf 4 | arrayOpcional / elemento |
|
action.command.targeting.threads_positions[]oneOf 4 | stringOpcional / elemento |
|
action.command.targeting.custom_audience_idsoneOf 4 | arrayOpcional / elemento |
|
action.command.targeting.custom_audience_ids[]oneOf 4 | stringOpcional / elemento |
|
action.command.targeting.excluded_custom_audience_idsoneOf 4 | arrayOpcional / elemento |
|
action.command.targeting.excluded_custom_audience_ids[]oneOf 4 | stringOpcional / elemento |
|
action.command.start_timeoneOf 4 | stringOpcional / elemento |
|
action.command.end_timeoneOf 4 | stringOpcional / elemento |
|
action.commandoneOf 5 | objectObligatorio en el objeto principal | — |
action.command.operationoneOf 5 | stringObligatorio en el objeto principal |
|
action.command.nameoneOf 5 | stringObligatorio en el objeto principal |
|
action.command.adset_idoneOf 5 | stringObligatorio en el objeto principal |
|
action.command.creative_idoneOf 5 | stringObligatorio en el objeto principal |
|
action.command.statusoneOf 5 | stringObligatorio en el objeto principal |
|
action.commandoneOf 6 | objectObligatorio en el objeto principal | — |
action.command.operationoneOf 6 | stringObligatorio en el objeto principal |
|
action.command.object_idoneOf 6 | stringObligatorio en el objeto principal |
|
action.command.nameoneOf 6 | stringOpcional / elemento |
|
action.command.creative_idoneOf 6 | stringOpcional / elemento |
|
action.command.statusoneOf 6 | stringOpcional / elemento |
|
action.commandoneOf 7 | objectObligatorio en el objeto principal | — |
action.command.operationoneOf 7 | stringObligatorio en el objeto principal |
|
action.command.nameoneOf 7 | stringObligatorio en el objeto principal |
|
action.command.object_story_speconeOf 7 | objectOpcional / elemento | — |
action.command.object_story_spec.page_idoneOf 7 | stringObligatorio en el objeto principal |
|
action.command.object_story_spec.instagram_user_idoneOf 7 | stringOpcional / elemento |
|
action.command.object_story_spec.link_dataoneOf 7 | objectObligatorio en el objeto principal | — |
action.command.object_story_spec.link_data.linkoneOf 7 | stringObligatorio en el objeto principal |
|
action.command.object_story_spec.link_data.messageoneOf 7 | stringObligatorio en el objeto principal |
|
action.command.object_story_spec.link_data.nameoneOf 7 | stringOpcional / elemento |
|
action.command.object_story_spec.link_data.image_hashoneOf 7 | stringObligatorio en el objeto principal |
|
action.command.object_story_spec.link_data.call_to_actiononeOf 7 | stringOpcional / elemento |
|
action.command.object_story_idoneOf 7 | stringOpcional / elemento |
|
action.commandoneOf 8 | objectObligatorio en el objeto principal | — |
action.command.operationoneOf 8 | stringObligatorio en el objeto principal |
|
action.command.nameoneOf 8 | stringObligatorio en el objeto principal |
|
action.command.targetingoneOf 8 | objectObligatorio en el objeto principal | — |
action.command.targeting.geo_locationsoneOf 8 | objectObligatorio en el objeto principal | — |
action.command.targeting.geo_locations.countriesoneOf 8 | arrayObligatorio en el objeto principal |
|
action.command.targeting.geo_locations.countries[]oneOf 8 | stringOpcional / elemento |
|
action.command.targeting.age_minoneOf 8 | integerObligatorio en el objeto principal |
|
action.command.targeting.age_maxoneOf 8 | integerObligatorio en el objeto principal |
|
action.command.targeting.gendersoneOf 8 | arrayOpcional / elemento |
|
action.command.targeting.genders[]oneOf 8 | numberOpcional / elemento | — |
action.command.targeting.genders[]oneOf 8 / anyOf 1 | numberOpcional / elemento |
|
action.command.targeting.genders[]oneOf 8 / anyOf 2 | numberOpcional / elemento |
|
action.command.targeting.localesoneOf 8 | arrayOpcional / elemento |
|
action.command.targeting.locales[]oneOf 8 | integerOpcional / elemento |
|
action.command.targeting.publisher_platformsoneOf 8 | arrayObligatorio en el objeto principal |
|
action.command.targeting.publisher_platforms[]oneOf 8 | stringOpcional / elemento |
|
action.command.targeting.facebook_positionsoneOf 8 | arrayOpcional / elemento |
|
action.command.targeting.facebook_positions[]oneOf 8 | stringOpcional / elemento |
|
action.command.targeting.instagram_positionsoneOf 8 | arrayOpcional / elemento |
|
action.command.targeting.instagram_positions[]oneOf 8 | stringOpcional / elemento |
|
action.command.targeting.threads_positionsoneOf 8 | arrayOpcional / elemento |
|
action.command.targeting.threads_positions[]oneOf 8 | stringOpcional / elemento |
|
action.command.targeting.custom_audience_idsoneOf 8 | arrayOpcional / elemento |
|
action.command.targeting.custom_audience_ids[]oneOf 8 | stringOpcional / elemento |
|
action.command.targeting.excluded_custom_audience_idsoneOf 8 | arrayOpcional / elemento |
|
action.command.targeting.excluded_custom_audience_ids[]oneOf 8 | stringOpcional / elemento |
|
action.commandoneOf 9 | objectObligatorio en el objeto principal | — |
action.command.operationoneOf 9 | stringObligatorio en el objeto principal |
|
action.command.object_idoneOf 9 | stringObligatorio en el objeto principal |
|
action.command.nameoneOf 9 | stringOpcional / elemento |
|
action.command.targetingoneOf 9 | objectOpcional / elemento | — |
action.command.targeting.geo_locationsoneOf 9 | objectObligatorio en el objeto principal | — |
action.command.targeting.geo_locations.countriesoneOf 9 | arrayObligatorio en el objeto principal |
|
action.command.targeting.geo_locations.countries[]oneOf 9 | stringOpcional / elemento |
|
action.command.targeting.age_minoneOf 9 | integerObligatorio en el objeto principal |
|
action.command.targeting.age_maxoneOf 9 | integerObligatorio en el objeto principal |
|
action.command.targeting.gendersoneOf 9 | arrayOpcional / elemento |
|
action.command.targeting.genders[]oneOf 9 | numberOpcional / elemento | — |
action.command.targeting.genders[]oneOf 9 / anyOf 1 | numberOpcional / elemento |
|
action.command.targeting.genders[]oneOf 9 / anyOf 2 | numberOpcional / elemento |
|
action.command.targeting.localesoneOf 9 | arrayOpcional / elemento |
|
action.command.targeting.locales[]oneOf 9 | integerOpcional / elemento |
|
action.command.targeting.publisher_platformsoneOf 9 | arrayObligatorio en el objeto principal |
|
action.command.targeting.publisher_platforms[]oneOf 9 | stringOpcional / elemento |
|
action.command.targeting.facebook_positionsoneOf 9 | arrayOpcional / elemento |
|
action.command.targeting.facebook_positions[]oneOf 9 | stringOpcional / elemento |
|
action.command.targeting.instagram_positionsoneOf 9 | arrayOpcional / elemento |
|
action.command.targeting.instagram_positions[]oneOf 9 | stringOpcional / elemento |
|
action.command.targeting.threads_positionsoneOf 9 | arrayOpcional / elemento |
|
action.command.targeting.threads_positions[]oneOf 9 | stringOpcional / elemento |
|
action.command.targeting.custom_audience_idsoneOf 9 | arrayOpcional / elemento |
|
action.command.targeting.custom_audience_ids[]oneOf 9 | stringOpcional / elemento |
|
action.command.targeting.excluded_custom_audience_idsoneOf 9 | arrayOpcional / elemento |
|
action.command.targeting.excluded_custom_audience_ids[]oneOf 9 | stringOpcional / elemento |
|
action.reviewed_digest | stringObligatorio en el objeto principal |
|
action.effects | objectObligatorio en el objeto principal | — |
action.effects.creates_object | booleanObligatorio en el objeto principal | — |
action.effects.initial_status | string | nullObligatorio en el objeto principal | — |
action.effects.initial_statusanyOf 1 | stringObligatorio en el objeto principal |
|
action.effects.initial_statusanyOf 2 | nullObligatorio en el objeto principal | — |
action.effects.activates_delivery | booleanObligatorio en el objeto principal | — |
action.effects.changes_budget | booleanObligatorio en el objeto principal | — |
action.effects.changes_audience | booleanObligatorio en el objeto principal | — |
action.effects.changes_creative | booleanObligatorio en el objeto principal | — |
action.effects.currency | stringObligatorio en el objeto principal |
|
action.effects.timezone | stringObligatorio en el objeto principal |
|
action.effects.budget | object | nullObligatorio en el objeto principal | — |
action.effects.budgetanyOf 1 | objectObligatorio en el objeto principal | — |
action.effects.budget.kindanyOf 1 | stringObligatorio en el objeto principal |
|
action.effects.budget.amount_minoranyOf 1 | stringObligatorio en el objeto principal |
|
action.effects.budgetanyOf 2 | nullObligatorio en el objeto principal | — |
action.live_approval | objectObligatorio en el objeto principal | — |
action.live_approval.required | booleanObligatorio en el objeto principal | — |
action.live_approval.state | stringObligatorio en el objeto principal |
|
action.live_approval.reason | string | nullObligatorio en el objeto principal | — |
action.live_approval.reasonanyOf 1 | stringObligatorio en el objeto principal |
|
action.live_approval.reasonanyOf 2 | nullObligatorio en el objeto principal | — |
action.live_approval.expires_at | string | nullObligatorio en el objeto principal | — |
action.live_approval.expires_atanyOf 1 | stringObligatorio en el objeto principal |
|
action.live_approval.expires_atanyOf 2 | nullObligatorio en el objeto principal | — |
action.live_approval.approved_by | string | nullObligatorio en el objeto principal | — |
action.live_approval.approved_byanyOf 1 | stringObligatorio en el objeto principal |
|
action.live_approval.approved_byanyOf 2 | nullObligatorio en el objeto principal | — |
action.provider_object_id | string | nullObligatorio en el objeto principal | — |
action.provider_object_idanyOf 1 | stringObligatorio en el objeto principal |
|
action.provider_object_idanyOf 2 | nullObligatorio en el objeto principal | — |
action.failure_code | string | nullObligatorio en el objeto principal | — |
action.failure_codeanyOf 1 | stringObligatorio en el objeto principal |
|
action.failure_codeanyOf 2 | nullObligatorio en el objeto principal | — |
action.created_at | stringObligatorio en el objeto principal |
|
action.completed_at | string | nullObligatorio en el objeto principal | — |
action.completed_atanyOf 1 | stringObligatorio en el objeto principal |
|
action.completed_atanyOf 2 | nullObligatorio en el objeto principal | — |
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"
]
}Errores y reintentos seguros
Comprueba el estado HTTP y el cuerpo de respuesta. Un error de validación 400 puede contener un ZodError; los errores del controlador usan los campos error, message y code. Conserva request_id o x-request-id para el diagnóstico, sin credenciales. Corrige los errores de acceso 401/403 antes de reintentar y respeta Retry-After para 429. Si una escritura es incierta o devuelve 5xx, consulta primero el resultado existente. Reutiliza una clave de idempotencia solo donde se admita; el comportamiento de reintento varía por operación y no garantiza una entrega exactamente una vez.
Guía de solución de problemasEjemplos
Estos ejemplos usan valores ficticios comprobados con los esquemas. Sustituye los IDs por otros autorizados, los archivos multimedia por recursos listos y las fechas por tu hora de publicación confirmada. Comprueba la elegibilidad de la cuenta antes de enviar una escritura. Esta página no envía solicitudes API.
Establece SOSOAPI_ACCESS_TOKEN en tu servidor con una credencial aceptada por esta operación y mantenla fuera del código del navegador. Para un agente de IA, usa sosoapi auth login para iniciar sesión en el navegador y deja a la CLI renovar sus credenciales.
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.jsonEjemplo de respuesta 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
}
}