الإعلانات
إعداد إجراء إعلاني
تثبيت أمر محدد من النوع campaign/adset/ad/creative/saved-audience وآثاره التي تمت مراجعتها. تبدأ العناصر المنشأة بحالة PAUSED؛ ويتطلب التفعيل أو التأثير في الميزانية صلاحية منفصلة للتنفيذ الفعلي.
POST /advertising-api/actions/prepareمراجعة العقد: · sha256:9aedef8d43dd4514
نظرة عامة
تثبيت أمر محدد من النوع campaign/adset/ad/creative/saved-audience وآثاره التي تمت مراجعتها. تبدأ العناصر المنشأة بحالة PAUSED؛ ويتطلب التفعيل أو التأثير في الميزانية صلاحية منفصلة للتنفيذ الفعلي.
قد يعني نجاح HTTP قبول الطلب لا اكتماله. للعمل الخلفي، احفظ المعرّف المُعاد وتابع العملية نفسها حتى تنتهي. لا يُعدّ المنشور المجدول أوالمقبول منشوراً حتى تأكيد المنصة؛ انتهاء مهلة العميل لا يثبت النتيجة.
المصادقة والأذونات
لا يستخدم الرمز إلا حقوق مالكه. يفحص كل طلب عضوية مساحة العمل وملكية المورد والمساحات المحددة والإمكانات الممنوحة. يغيّر core و full الأدوات المعروضة؛ ولا يمنحان وصولاً.
حقول الطلب
تعني «مطلوب» داخل الكائن الأب والفرع المختار. الحقل الابن المطلوب لا يجعل الأب الاختياري مطلوباً. نُسخت القواعد وأسماء الحقول أدناه من العقد.
| الحقل / الفرع | النوع / مطلوب | القيود |
|---|---|---|
$ | objectمطلوب في العنصر الأب |
|
workspace_id | stringمطلوب في العنصر الأب |
|
advertising_account_id | stringمطلوب في العنصر الأب |
|
mutation_id | stringمطلوب في العنصر الأب |
|
command | objectمطلوب في العنصر الأب | — |
commandoneOf 1 | objectمطلوب في العنصر الأب |
|
command.operationoneOf 1 | stringمطلوب في العنصر الأب |
|
command.nameoneOf 1 | stringمطلوب في العنصر الأب |
|
command.budgetoneOf 1 | objectاختياري / عنصر |
|
command.budget.kindoneOf 1 | stringمطلوب في العنصر الأب |
|
command.budget.amount_minoroneOf 1 | stringمطلوب في العنصر الأب |
|
command.objectiveoneOf 1 | stringمطلوب في العنصر الأب |
|
command.special_ad_categoriesoneOf 1 | arrayاختياري / عنصر |
|
command.special_ad_categories[]oneOf 1 | stringاختياري / عنصر |
|
command.statusoneOf 1 | stringاختياري / عنصر |
|
commandoneOf 2 | objectمطلوب في العنصر الأب |
|
command.operationoneOf 2 | stringمطلوب في العنصر الأب |
|
command.object_idoneOf 2 | stringمطلوب في العنصر الأب |
|
command.nameoneOf 2 | stringاختياري / عنصر |
|
command.budgetoneOf 2 | objectاختياري / عنصر |
|
command.budget.kindoneOf 2 | stringمطلوب في العنصر الأب |
|
command.budget.amount_minoroneOf 2 | stringمطلوب في العنصر الأب |
|
command.statusoneOf 2 | stringاختياري / عنصر |
|
commandoneOf 3 | objectمطلوب في العنصر الأب |
|
command.operationoneOf 3 | stringمطلوب في العنصر الأب |
|
command.campaign_idoneOf 3 | stringمطلوب في العنصر الأب |
|
command.nameoneOf 3 | stringمطلوب في العنصر الأب |
|
command.budgetoneOf 3 | objectاختياري / عنصر |
|
command.budget.kindoneOf 3 | stringمطلوب في العنصر الأب |
|
command.budget.amount_minoroneOf 3 | stringمطلوب في العنصر الأب |
|
command.targetingoneOf 3 | objectمطلوب في العنصر الأب |
|
command.targeting.geo_locationsoneOf 3 | objectمطلوب في العنصر الأب |
|
command.targeting.geo_locations.countriesoneOf 3 | arrayمطلوب في العنصر الأب |
|
command.targeting.geo_locations.countries[]oneOf 3 | stringاختياري / عنصر |
|
command.targeting.age_minoneOf 3 | integerاختياري / عنصر |
|
command.targeting.age_maxoneOf 3 | integerاختياري / عنصر |
|
command.targeting.gendersoneOf 3 | arrayاختياري / عنصر |
|
command.targeting.genders[]oneOf 3 | numberاختياري / عنصر | — |
command.targeting.genders[]oneOf 3 / anyOf 1 | numberاختياري / عنصر |
|
command.targeting.genders[]oneOf 3 / anyOf 2 | numberاختياري / عنصر |
|
command.targeting.localesoneOf 3 | arrayاختياري / عنصر |
|
command.targeting.locales[]oneOf 3 | integerاختياري / عنصر |
|
command.targeting.publisher_platformsoneOf 3 | arrayمطلوب في العنصر الأب |
|
command.targeting.publisher_platforms[]oneOf 3 | stringاختياري / عنصر |
|
command.targeting.facebook_positionsoneOf 3 | arrayاختياري / عنصر |
|
command.targeting.facebook_positions[]oneOf 3 | stringاختياري / عنصر |
|
command.targeting.instagram_positionsoneOf 3 | arrayاختياري / عنصر |
|
command.targeting.instagram_positions[]oneOf 3 | stringاختياري / عنصر |
|
command.targeting.threads_positionsoneOf 3 | arrayاختياري / عنصر |
|
command.targeting.threads_positions[]oneOf 3 | stringاختياري / عنصر |
|
command.targeting.custom_audience_idsoneOf 3 | arrayاختياري / عنصر |
|
command.targeting.custom_audience_ids[]oneOf 3 | stringاختياري / عنصر |
|
command.targeting.excluded_custom_audience_idsoneOf 3 | arrayاختياري / عنصر |
|
command.targeting.excluded_custom_audience_ids[]oneOf 3 | stringاختياري / عنصر |
|
command.billing_eventoneOf 3 | stringمطلوب في العنصر الأب |
|
command.optimization_goaloneOf 3 | stringمطلوب في العنصر الأب |
|
command.bid_strategyoneOf 3 | stringاختياري / عنصر |
|
command.start_timeoneOf 3 | stringاختياري / عنصر |
|
command.end_timeoneOf 3 | stringاختياري / عنصر |
|
command.promoted_objectoneOf 3 | objectاختياري / عنصر |
|
command.promoted_object.page_idoneOf 3 | stringاختياري / عنصر |
|
command.promoted_object.pixel_idoneOf 3 | stringاختياري / عنصر |
|
command.promoted_object.custom_event_typeoneOf 3 | stringاختياري / عنصر |
|
command.statusoneOf 3 | stringاختياري / عنصر |
|
commandoneOf 4 | objectمطلوب في العنصر الأب |
|
command.operationoneOf 4 | stringمطلوب في العنصر الأب |
|
command.object_idoneOf 4 | stringمطلوب في العنصر الأب |
|
command.nameoneOf 4 | stringاختياري / عنصر |
|
command.budgetoneOf 4 | objectاختياري / عنصر |
|
command.budget.kindoneOf 4 | stringمطلوب في العنصر الأب |
|
command.budget.amount_minoroneOf 4 | stringمطلوب في العنصر الأب |
|
command.statusoneOf 4 | stringاختياري / عنصر |
|
command.targetingoneOf 4 | objectاختياري / عنصر |
|
command.targeting.geo_locationsoneOf 4 | objectمطلوب في العنصر الأب |
|
command.targeting.geo_locations.countriesoneOf 4 | arrayمطلوب في العنصر الأب |
|
command.targeting.geo_locations.countries[]oneOf 4 | stringاختياري / عنصر |
|
command.targeting.age_minoneOf 4 | integerاختياري / عنصر |
|
command.targeting.age_maxoneOf 4 | integerاختياري / عنصر |
|
command.targeting.gendersoneOf 4 | arrayاختياري / عنصر |
|
command.targeting.genders[]oneOf 4 | numberاختياري / عنصر | — |
command.targeting.genders[]oneOf 4 / anyOf 1 | numberاختياري / عنصر |
|
command.targeting.genders[]oneOf 4 / anyOf 2 | numberاختياري / عنصر |
|
command.targeting.localesoneOf 4 | arrayاختياري / عنصر |
|
command.targeting.locales[]oneOf 4 | integerاختياري / عنصر |
|
command.targeting.publisher_platformsoneOf 4 | arrayمطلوب في العنصر الأب |
|
command.targeting.publisher_platforms[]oneOf 4 | stringاختياري / عنصر |
|
command.targeting.facebook_positionsoneOf 4 | arrayاختياري / عنصر |
|
command.targeting.facebook_positions[]oneOf 4 | stringاختياري / عنصر |
|
command.targeting.instagram_positionsoneOf 4 | arrayاختياري / عنصر |
|
command.targeting.instagram_positions[]oneOf 4 | stringاختياري / عنصر |
|
command.targeting.threads_positionsoneOf 4 | arrayاختياري / عنصر |
|
command.targeting.threads_positions[]oneOf 4 | stringاختياري / عنصر |
|
command.targeting.custom_audience_idsoneOf 4 | arrayاختياري / عنصر |
|
command.targeting.custom_audience_ids[]oneOf 4 | stringاختياري / عنصر |
|
command.targeting.excluded_custom_audience_idsoneOf 4 | arrayاختياري / عنصر |
|
command.targeting.excluded_custom_audience_ids[]oneOf 4 | stringاختياري / عنصر |
|
command.start_timeoneOf 4 | stringاختياري / عنصر |
|
command.end_timeoneOf 4 | stringاختياري / عنصر |
|
commandoneOf 5 | objectمطلوب في العنصر الأب |
|
command.operationoneOf 5 | stringمطلوب في العنصر الأب |
|
command.nameoneOf 5 | stringمطلوب في العنصر الأب |
|
command.adset_idoneOf 5 | stringمطلوب في العنصر الأب |
|
command.creative_idoneOf 5 | stringمطلوب في العنصر الأب |
|
command.statusoneOf 5 | stringاختياري / عنصر |
|
commandoneOf 6 | objectمطلوب في العنصر الأب |
|
command.operationoneOf 6 | stringمطلوب في العنصر الأب |
|
command.object_idoneOf 6 | stringمطلوب في العنصر الأب |
|
command.nameoneOf 6 | stringاختياري / عنصر |
|
command.creative_idoneOf 6 | stringاختياري / عنصر |
|
command.statusoneOf 6 | stringاختياري / عنصر |
|
commandoneOf 7 | objectمطلوب في العنصر الأب |
|
command.operationoneOf 7 | stringمطلوب في العنصر الأب |
|
command.nameoneOf 7 | stringمطلوب في العنصر الأب |
|
command.object_story_speconeOf 7 | objectاختياري / عنصر |
|
command.object_story_spec.page_idoneOf 7 | stringمطلوب في العنصر الأب |
|
command.object_story_spec.instagram_user_idoneOf 7 | stringاختياري / عنصر |
|
command.object_story_spec.link_dataoneOf 7 | objectمطلوب في العنصر الأب |
|
command.object_story_spec.link_data.linkoneOf 7 | stringمطلوب في العنصر الأب |
|
command.object_story_spec.link_data.messageoneOf 7 | stringمطلوب في العنصر الأب |
|
command.object_story_spec.link_data.nameoneOf 7 | stringاختياري / عنصر |
|
command.object_story_spec.link_data.image_hashoneOf 7 | stringمطلوب في العنصر الأب |
|
command.object_story_spec.link_data.call_to_actiononeOf 7 | stringاختياري / عنصر |
|
command.object_story_idoneOf 7 | stringاختياري / عنصر |
|
commandoneOf 8 | objectمطلوب في العنصر الأب |
|
command.operationoneOf 8 | stringمطلوب في العنصر الأب |
|
command.nameoneOf 8 | stringمطلوب في العنصر الأب |
|
command.targetingoneOf 8 | objectمطلوب في العنصر الأب |
|
command.targeting.geo_locationsoneOf 8 | objectمطلوب في العنصر الأب |
|
command.targeting.geo_locations.countriesoneOf 8 | arrayمطلوب في العنصر الأب |
|
command.targeting.geo_locations.countries[]oneOf 8 | stringاختياري / عنصر |
|
command.targeting.age_minoneOf 8 | integerاختياري / عنصر |
|
command.targeting.age_maxoneOf 8 | integerاختياري / عنصر |
|
command.targeting.gendersoneOf 8 | arrayاختياري / عنصر |
|
command.targeting.genders[]oneOf 8 | numberاختياري / عنصر | — |
command.targeting.genders[]oneOf 8 / anyOf 1 | numberاختياري / عنصر |
|
command.targeting.genders[]oneOf 8 / anyOf 2 | numberاختياري / عنصر |
|
command.targeting.localesoneOf 8 | arrayاختياري / عنصر |
|
command.targeting.locales[]oneOf 8 | integerاختياري / عنصر |
|
command.targeting.publisher_platformsoneOf 8 | arrayمطلوب في العنصر الأب |
|
command.targeting.publisher_platforms[]oneOf 8 | stringاختياري / عنصر |
|
command.targeting.facebook_positionsoneOf 8 | arrayاختياري / عنصر |
|
command.targeting.facebook_positions[]oneOf 8 | stringاختياري / عنصر |
|
command.targeting.instagram_positionsoneOf 8 | arrayاختياري / عنصر |
|
command.targeting.instagram_positions[]oneOf 8 | stringاختياري / عنصر |
|
command.targeting.threads_positionsoneOf 8 | arrayاختياري / عنصر |
|
command.targeting.threads_positions[]oneOf 8 | stringاختياري / عنصر |
|
command.targeting.custom_audience_idsoneOf 8 | arrayاختياري / عنصر |
|
command.targeting.custom_audience_ids[]oneOf 8 | stringاختياري / عنصر |
|
command.targeting.excluded_custom_audience_idsoneOf 8 | arrayاختياري / عنصر |
|
command.targeting.excluded_custom_audience_ids[]oneOf 8 | stringاختياري / عنصر |
|
commandoneOf 9 | objectمطلوب في العنصر الأب |
|
command.operationoneOf 9 | stringمطلوب في العنصر الأب |
|
command.object_idoneOf 9 | stringمطلوب في العنصر الأب |
|
command.nameoneOf 9 | stringاختياري / عنصر |
|
command.targetingoneOf 9 | objectاختياري / عنصر |
|
command.targeting.geo_locationsoneOf 9 | objectمطلوب في العنصر الأب |
|
command.targeting.geo_locations.countriesoneOf 9 | arrayمطلوب في العنصر الأب |
|
command.targeting.geo_locations.countries[]oneOf 9 | stringاختياري / عنصر |
|
command.targeting.age_minoneOf 9 | integerاختياري / عنصر |
|
command.targeting.age_maxoneOf 9 | integerاختياري / عنصر |
|
command.targeting.gendersoneOf 9 | arrayاختياري / عنصر |
|
command.targeting.genders[]oneOf 9 | numberاختياري / عنصر | — |
command.targeting.genders[]oneOf 9 / anyOf 1 | numberاختياري / عنصر |
|
command.targeting.genders[]oneOf 9 / anyOf 2 | numberاختياري / عنصر |
|
command.targeting.localesoneOf 9 | arrayاختياري / عنصر |
|
command.targeting.locales[]oneOf 9 | integerاختياري / عنصر |
|
command.targeting.publisher_platformsoneOf 9 | arrayمطلوب في العنصر الأب |
|
command.targeting.publisher_platforms[]oneOf 9 | stringاختياري / عنصر |
|
command.targeting.facebook_positionsoneOf 9 | arrayاختياري / عنصر |
|
command.targeting.facebook_positions[]oneOf 9 | stringاختياري / عنصر |
|
command.targeting.instagram_positionsoneOf 9 | arrayاختياري / عنصر |
|
command.targeting.instagram_positions[]oneOf 9 | stringاختياري / عنصر |
|
command.targeting.threads_positionsoneOf 9 | arrayاختياري / عنصر |
|
command.targeting.threads_positions[]oneOf 9 | stringاختياري / عنصر |
|
command.targeting.custom_audience_idsoneOf 9 | arrayاختياري / عنصر |
|
command.targeting.custom_audience_ids[]oneOf 9 | stringاختياري / عنصر |
|
command.targeting.excluded_custom_audience_idsoneOf 9 | arrayاختياري / عنصر |
|
command.targeting.excluded_custom_audience_ids[]oneOf 9 | stringاختياري / عنصر |
|
مخطط JSON Schema الكامل
{
"$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
}الاستجابة والاكتمال
رموز نجاح HTTP: 200. عندما تكتمل العملية: synchronous_http_response.
قد يعني نجاح HTTP قبول الطلب لا اكتماله. للعمل الخلفي، احفظ المعرّف المُعاد وتابع العملية نفسها حتى تنتهي. لا يُعدّ المنشور المجدول أوالمقبول منشوراً حتى تأكيد المنصة؛ انتهاء مهلة العميل لا يثبت النتيجة.
تعني «مطلوب» داخل الكائن الأب والفرع المختار. الحقل الابن المطلوب لا يجعل الأب الاختياري مطلوباً. نُسخت القواعد وأسماء الحقول أدناه من العقد.
| الحقل / الفرع | النوع / مطلوب | القيود |
|---|---|---|
$ | objectمطلوب في العنصر الأب | — |
contract_version | stringمطلوب في العنصر الأب |
|
prepare_token | stringمطلوب في العنصر الأب |
|
expires_at | stringمطلوب في العنصر الأب |
|
action | objectمطلوب في العنصر الأب | — |
action.id | stringمطلوب في العنصر الأب |
|
action.workspace_id | stringمطلوب في العنصر الأب |
|
action.advertising_account_id | stringمطلوب في العنصر الأب |
|
action.mutation_id | stringمطلوب في العنصر الأب |
|
action.status | stringمطلوب في العنصر الأب |
|
action.command | objectمطلوب في العنصر الأب | — |
action.commandoneOf 1 | objectمطلوب في العنصر الأب | — |
action.command.operationoneOf 1 | stringمطلوب في العنصر الأب |
|
action.command.nameoneOf 1 | stringمطلوب في العنصر الأب |
|
action.command.budgetoneOf 1 | objectاختياري / عنصر | — |
action.command.budget.kindoneOf 1 | stringمطلوب في العنصر الأب |
|
action.command.budget.amount_minoroneOf 1 | stringمطلوب في العنصر الأب |
|
action.command.objectiveoneOf 1 | stringمطلوب في العنصر الأب |
|
action.command.special_ad_categoriesoneOf 1 | arrayمطلوب في العنصر الأب |
|
action.command.special_ad_categories[]oneOf 1 | stringاختياري / عنصر |
|
action.command.statusoneOf 1 | stringمطلوب في العنصر الأب |
|
action.commandoneOf 2 | objectمطلوب في العنصر الأب | — |
action.command.operationoneOf 2 | stringمطلوب في العنصر الأب |
|
action.command.object_idoneOf 2 | stringمطلوب في العنصر الأب |
|
action.command.nameoneOf 2 | stringاختياري / عنصر |
|
action.command.budgetoneOf 2 | objectاختياري / عنصر | — |
action.command.budget.kindoneOf 2 | stringمطلوب في العنصر الأب |
|
action.command.budget.amount_minoroneOf 2 | stringمطلوب في العنصر الأب |
|
action.command.statusoneOf 2 | stringاختياري / عنصر |
|
action.commandoneOf 3 | objectمطلوب في العنصر الأب | — |
action.command.operationoneOf 3 | stringمطلوب في العنصر الأب |
|
action.command.campaign_idoneOf 3 | stringمطلوب في العنصر الأب |
|
action.command.nameoneOf 3 | stringمطلوب في العنصر الأب |
|
action.command.budgetoneOf 3 | objectاختياري / عنصر | — |
action.command.budget.kindoneOf 3 | stringمطلوب في العنصر الأب |
|
action.command.budget.amount_minoroneOf 3 | stringمطلوب في العنصر الأب |
|
action.command.targetingoneOf 3 | objectمطلوب في العنصر الأب | — |
action.command.targeting.geo_locationsoneOf 3 | objectمطلوب في العنصر الأب | — |
action.command.targeting.geo_locations.countriesoneOf 3 | arrayمطلوب في العنصر الأب |
|
action.command.targeting.geo_locations.countries[]oneOf 3 | stringاختياري / عنصر |
|
action.command.targeting.age_minoneOf 3 | integerمطلوب في العنصر الأب |
|
action.command.targeting.age_maxoneOf 3 | integerمطلوب في العنصر الأب |
|
action.command.targeting.gendersoneOf 3 | arrayاختياري / عنصر |
|
action.command.targeting.genders[]oneOf 3 | numberاختياري / عنصر | — |
action.command.targeting.genders[]oneOf 3 / anyOf 1 | numberاختياري / عنصر |
|
action.command.targeting.genders[]oneOf 3 / anyOf 2 | numberاختياري / عنصر |
|
action.command.targeting.localesoneOf 3 | arrayاختياري / عنصر |
|
action.command.targeting.locales[]oneOf 3 | integerاختياري / عنصر |
|
action.command.targeting.publisher_platformsoneOf 3 | arrayمطلوب في العنصر الأب |
|
action.command.targeting.publisher_platforms[]oneOf 3 | stringاختياري / عنصر |
|
action.command.targeting.facebook_positionsoneOf 3 | arrayاختياري / عنصر |
|
action.command.targeting.facebook_positions[]oneOf 3 | stringاختياري / عنصر |
|
action.command.targeting.instagram_positionsoneOf 3 | arrayاختياري / عنصر |
|
action.command.targeting.instagram_positions[]oneOf 3 | stringاختياري / عنصر |
|
action.command.targeting.threads_positionsoneOf 3 | arrayاختياري / عنصر |
|
action.command.targeting.threads_positions[]oneOf 3 | stringاختياري / عنصر |
|
action.command.targeting.custom_audience_idsoneOf 3 | arrayاختياري / عنصر |
|
action.command.targeting.custom_audience_ids[]oneOf 3 | stringاختياري / عنصر |
|
action.command.targeting.excluded_custom_audience_idsoneOf 3 | arrayاختياري / عنصر |
|
action.command.targeting.excluded_custom_audience_ids[]oneOf 3 | stringاختياري / عنصر |
|
action.command.billing_eventoneOf 3 | stringمطلوب في العنصر الأب |
|
action.command.optimization_goaloneOf 3 | stringمطلوب في العنصر الأب |
|
action.command.bid_strategyoneOf 3 | stringمطلوب في العنصر الأب |
|
action.command.start_timeoneOf 3 | stringاختياري / عنصر |
|
action.command.end_timeoneOf 3 | stringاختياري / عنصر |
|
action.command.promoted_objectoneOf 3 | objectاختياري / عنصر | — |
action.command.promoted_object.page_idoneOf 3 | stringاختياري / عنصر |
|
action.command.promoted_object.pixel_idoneOf 3 | stringاختياري / عنصر |
|
action.command.promoted_object.custom_event_typeoneOf 3 | stringاختياري / عنصر |
|
action.command.statusoneOf 3 | stringمطلوب في العنصر الأب |
|
action.commandoneOf 4 | objectمطلوب في العنصر الأب | — |
action.command.operationoneOf 4 | stringمطلوب في العنصر الأب |
|
action.command.object_idoneOf 4 | stringمطلوب في العنصر الأب |
|
action.command.nameoneOf 4 | stringاختياري / عنصر |
|
action.command.budgetoneOf 4 | objectاختياري / عنصر | — |
action.command.budget.kindoneOf 4 | stringمطلوب في العنصر الأب |
|
action.command.budget.amount_minoroneOf 4 | stringمطلوب في العنصر الأب |
|
action.command.statusoneOf 4 | stringاختياري / عنصر |
|
action.command.targetingoneOf 4 | objectاختياري / عنصر | — |
action.command.targeting.geo_locationsoneOf 4 | objectمطلوب في العنصر الأب | — |
action.command.targeting.geo_locations.countriesoneOf 4 | arrayمطلوب في العنصر الأب |
|
action.command.targeting.geo_locations.countries[]oneOf 4 | stringاختياري / عنصر |
|
action.command.targeting.age_minoneOf 4 | integerمطلوب في العنصر الأب |
|
action.command.targeting.age_maxoneOf 4 | integerمطلوب في العنصر الأب |
|
action.command.targeting.gendersoneOf 4 | arrayاختياري / عنصر |
|
action.command.targeting.genders[]oneOf 4 | numberاختياري / عنصر | — |
action.command.targeting.genders[]oneOf 4 / anyOf 1 | numberاختياري / عنصر |
|
action.command.targeting.genders[]oneOf 4 / anyOf 2 | numberاختياري / عنصر |
|
action.command.targeting.localesoneOf 4 | arrayاختياري / عنصر |
|
action.command.targeting.locales[]oneOf 4 | integerاختياري / عنصر |
|
action.command.targeting.publisher_platformsoneOf 4 | arrayمطلوب في العنصر الأب |
|
action.command.targeting.publisher_platforms[]oneOf 4 | stringاختياري / عنصر |
|
action.command.targeting.facebook_positionsoneOf 4 | arrayاختياري / عنصر |
|
action.command.targeting.facebook_positions[]oneOf 4 | stringاختياري / عنصر |
|
action.command.targeting.instagram_positionsoneOf 4 | arrayاختياري / عنصر |
|
action.command.targeting.instagram_positions[]oneOf 4 | stringاختياري / عنصر |
|
action.command.targeting.threads_positionsoneOf 4 | arrayاختياري / عنصر |
|
action.command.targeting.threads_positions[]oneOf 4 | stringاختياري / عنصر |
|
action.command.targeting.custom_audience_idsoneOf 4 | arrayاختياري / عنصر |
|
action.command.targeting.custom_audience_ids[]oneOf 4 | stringاختياري / عنصر |
|
action.command.targeting.excluded_custom_audience_idsoneOf 4 | arrayاختياري / عنصر |
|
action.command.targeting.excluded_custom_audience_ids[]oneOf 4 | stringاختياري / عنصر |
|
action.command.start_timeoneOf 4 | stringاختياري / عنصر |
|
action.command.end_timeoneOf 4 | stringاختياري / عنصر |
|
action.commandoneOf 5 | objectمطلوب في العنصر الأب | — |
action.command.operationoneOf 5 | stringمطلوب في العنصر الأب |
|
action.command.nameoneOf 5 | stringمطلوب في العنصر الأب |
|
action.command.adset_idoneOf 5 | stringمطلوب في العنصر الأب |
|
action.command.creative_idoneOf 5 | stringمطلوب في العنصر الأب |
|
action.command.statusoneOf 5 | stringمطلوب في العنصر الأب |
|
action.commandoneOf 6 | objectمطلوب في العنصر الأب | — |
action.command.operationoneOf 6 | stringمطلوب في العنصر الأب |
|
action.command.object_idoneOf 6 | stringمطلوب في العنصر الأب |
|
action.command.nameoneOf 6 | stringاختياري / عنصر |
|
action.command.creative_idoneOf 6 | stringاختياري / عنصر |
|
action.command.statusoneOf 6 | stringاختياري / عنصر |
|
action.commandoneOf 7 | objectمطلوب في العنصر الأب | — |
action.command.operationoneOf 7 | stringمطلوب في العنصر الأب |
|
action.command.nameoneOf 7 | stringمطلوب في العنصر الأب |
|
action.command.object_story_speconeOf 7 | objectاختياري / عنصر | — |
action.command.object_story_spec.page_idoneOf 7 | stringمطلوب في العنصر الأب |
|
action.command.object_story_spec.instagram_user_idoneOf 7 | stringاختياري / عنصر |
|
action.command.object_story_spec.link_dataoneOf 7 | objectمطلوب في العنصر الأب | — |
action.command.object_story_spec.link_data.linkoneOf 7 | stringمطلوب في العنصر الأب |
|
action.command.object_story_spec.link_data.messageoneOf 7 | stringمطلوب في العنصر الأب |
|
action.command.object_story_spec.link_data.nameoneOf 7 | stringاختياري / عنصر |
|
action.command.object_story_spec.link_data.image_hashoneOf 7 | stringمطلوب في العنصر الأب |
|
action.command.object_story_spec.link_data.call_to_actiononeOf 7 | stringاختياري / عنصر |
|
action.command.object_story_idoneOf 7 | stringاختياري / عنصر |
|
action.commandoneOf 8 | objectمطلوب في العنصر الأب | — |
action.command.operationoneOf 8 | stringمطلوب في العنصر الأب |
|
action.command.nameoneOf 8 | stringمطلوب في العنصر الأب |
|
action.command.targetingoneOf 8 | objectمطلوب في العنصر الأب | — |
action.command.targeting.geo_locationsoneOf 8 | objectمطلوب في العنصر الأب | — |
action.command.targeting.geo_locations.countriesoneOf 8 | arrayمطلوب في العنصر الأب |
|
action.command.targeting.geo_locations.countries[]oneOf 8 | stringاختياري / عنصر |
|
action.command.targeting.age_minoneOf 8 | integerمطلوب في العنصر الأب |
|
action.command.targeting.age_maxoneOf 8 | integerمطلوب في العنصر الأب |
|
action.command.targeting.gendersoneOf 8 | arrayاختياري / عنصر |
|
action.command.targeting.genders[]oneOf 8 | numberاختياري / عنصر | — |
action.command.targeting.genders[]oneOf 8 / anyOf 1 | numberاختياري / عنصر |
|
action.command.targeting.genders[]oneOf 8 / anyOf 2 | numberاختياري / عنصر |
|
action.command.targeting.localesoneOf 8 | arrayاختياري / عنصر |
|
action.command.targeting.locales[]oneOf 8 | integerاختياري / عنصر |
|
action.command.targeting.publisher_platformsoneOf 8 | arrayمطلوب في العنصر الأب |
|
action.command.targeting.publisher_platforms[]oneOf 8 | stringاختياري / عنصر |
|
action.command.targeting.facebook_positionsoneOf 8 | arrayاختياري / عنصر |
|
action.command.targeting.facebook_positions[]oneOf 8 | stringاختياري / عنصر |
|
action.command.targeting.instagram_positionsoneOf 8 | arrayاختياري / عنصر |
|
action.command.targeting.instagram_positions[]oneOf 8 | stringاختياري / عنصر |
|
action.command.targeting.threads_positionsoneOf 8 | arrayاختياري / عنصر |
|
action.command.targeting.threads_positions[]oneOf 8 | stringاختياري / عنصر |
|
action.command.targeting.custom_audience_idsoneOf 8 | arrayاختياري / عنصر |
|
action.command.targeting.custom_audience_ids[]oneOf 8 | stringاختياري / عنصر |
|
action.command.targeting.excluded_custom_audience_idsoneOf 8 | arrayاختياري / عنصر |
|
action.command.targeting.excluded_custom_audience_ids[]oneOf 8 | stringاختياري / عنصر |
|
action.commandoneOf 9 | objectمطلوب في العنصر الأب | — |
action.command.operationoneOf 9 | stringمطلوب في العنصر الأب |
|
action.command.object_idoneOf 9 | stringمطلوب في العنصر الأب |
|
action.command.nameoneOf 9 | stringاختياري / عنصر |
|
action.command.targetingoneOf 9 | objectاختياري / عنصر | — |
action.command.targeting.geo_locationsoneOf 9 | objectمطلوب في العنصر الأب | — |
action.command.targeting.geo_locations.countriesoneOf 9 | arrayمطلوب في العنصر الأب |
|
action.command.targeting.geo_locations.countries[]oneOf 9 | stringاختياري / عنصر |
|
action.command.targeting.age_minoneOf 9 | integerمطلوب في العنصر الأب |
|
action.command.targeting.age_maxoneOf 9 | integerمطلوب في العنصر الأب |
|
action.command.targeting.gendersoneOf 9 | arrayاختياري / عنصر |
|
action.command.targeting.genders[]oneOf 9 | numberاختياري / عنصر | — |
action.command.targeting.genders[]oneOf 9 / anyOf 1 | numberاختياري / عنصر |
|
action.command.targeting.genders[]oneOf 9 / anyOf 2 | numberاختياري / عنصر |
|
action.command.targeting.localesoneOf 9 | arrayاختياري / عنصر |
|
action.command.targeting.locales[]oneOf 9 | integerاختياري / عنصر |
|
action.command.targeting.publisher_platformsoneOf 9 | arrayمطلوب في العنصر الأب |
|
action.command.targeting.publisher_platforms[]oneOf 9 | stringاختياري / عنصر |
|
action.command.targeting.facebook_positionsoneOf 9 | arrayاختياري / عنصر |
|
action.command.targeting.facebook_positions[]oneOf 9 | stringاختياري / عنصر |
|
action.command.targeting.instagram_positionsoneOf 9 | arrayاختياري / عنصر |
|
action.command.targeting.instagram_positions[]oneOf 9 | stringاختياري / عنصر |
|
action.command.targeting.threads_positionsoneOf 9 | arrayاختياري / عنصر |
|
action.command.targeting.threads_positions[]oneOf 9 | stringاختياري / عنصر |
|
action.command.targeting.custom_audience_idsoneOf 9 | arrayاختياري / عنصر |
|
action.command.targeting.custom_audience_ids[]oneOf 9 | stringاختياري / عنصر |
|
action.command.targeting.excluded_custom_audience_idsoneOf 9 | arrayاختياري / عنصر |
|
action.command.targeting.excluded_custom_audience_ids[]oneOf 9 | stringاختياري / عنصر |
|
action.reviewed_digest | stringمطلوب في العنصر الأب |
|
action.effects | objectمطلوب في العنصر الأب | — |
action.effects.creates_object | booleanمطلوب في العنصر الأب | — |
action.effects.initial_status | string | nullمطلوب في العنصر الأب | — |
action.effects.initial_statusanyOf 1 | stringمطلوب في العنصر الأب |
|
action.effects.initial_statusanyOf 2 | nullمطلوب في العنصر الأب | — |
action.effects.activates_delivery | booleanمطلوب في العنصر الأب | — |
action.effects.changes_budget | booleanمطلوب في العنصر الأب | — |
action.effects.changes_audience | booleanمطلوب في العنصر الأب | — |
action.effects.changes_creative | booleanمطلوب في العنصر الأب | — |
action.effects.currency | stringمطلوب في العنصر الأب |
|
action.effects.timezone | stringمطلوب في العنصر الأب |
|
action.effects.budget | object | nullمطلوب في العنصر الأب | — |
action.effects.budgetanyOf 1 | objectمطلوب في العنصر الأب | — |
action.effects.budget.kindanyOf 1 | stringمطلوب في العنصر الأب |
|
action.effects.budget.amount_minoranyOf 1 | stringمطلوب في العنصر الأب |
|
action.effects.budgetanyOf 2 | nullمطلوب في العنصر الأب | — |
action.live_approval | objectمطلوب في العنصر الأب | — |
action.live_approval.required | booleanمطلوب في العنصر الأب | — |
action.live_approval.state | stringمطلوب في العنصر الأب |
|
action.live_approval.reason | string | nullمطلوب في العنصر الأب | — |
action.live_approval.reasonanyOf 1 | stringمطلوب في العنصر الأب |
|
action.live_approval.reasonanyOf 2 | nullمطلوب في العنصر الأب | — |
action.live_approval.expires_at | string | nullمطلوب في العنصر الأب | — |
action.live_approval.expires_atanyOf 1 | stringمطلوب في العنصر الأب |
|
action.live_approval.expires_atanyOf 2 | nullمطلوب في العنصر الأب | — |
action.live_approval.approved_by | string | nullمطلوب في العنصر الأب | — |
action.live_approval.approved_byanyOf 1 | stringمطلوب في العنصر الأب |
|
action.live_approval.approved_byanyOf 2 | nullمطلوب في العنصر الأب | — |
action.provider_object_id | string | nullمطلوب في العنصر الأب | — |
action.provider_object_idanyOf 1 | stringمطلوب في العنصر الأب |
|
action.provider_object_idanyOf 2 | nullمطلوب في العنصر الأب | — |
action.failure_code | string | nullمطلوب في العنصر الأب | — |
action.failure_codeanyOf 1 | stringمطلوب في العنصر الأب |
|
action.failure_codeanyOf 2 | nullمطلوب في العنصر الأب | — |
action.created_at | stringمطلوب في العنصر الأب |
|
action.completed_at | string | nullمطلوب في العنصر الأب | — |
action.completed_atanyOf 1 | stringمطلوب في العنصر الأب |
|
action.completed_atanyOf 2 | nullمطلوب في العنصر الأب | — |
مخطط JSON Schema الكامل
{
"$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"
]
}الأخطاء وإعادة المحاولة بأمان
افحص حالة HTTP والجسم. قد يحوي خطأ التحقق 400 ZodError؛ تستخدم أخطاء المعالج error و message و code. احتفظ بـ request_id أو x-request-id للتشخيص دون اعتماد. أصلح أخطاء وصول 401/403 قبل المحاولة واتّبع Retry-After لـ 429. لكتابة غير مؤكدة أو 5xx، اقرأ الموجود أولاً. أعِد مفتاح منع التكرار حيث يُدعم فقط؛ تختلف المحاولة حسب العملية ولا تضمن التسليم مرة واحدة بالضبط.
دليل استكشاف الأخطاء وإصلاحهاأمثلة
تستخدم الأمثلة قيماً خيالية مفحوصة بالمخططات. استبدل المعرّفات بالمفوّض لك، والوسائط بأصول جاهزة، والتواريخ بوقت نشر مؤكد. افحص أهلية الحساب قبل الكتابة. لا تُرسل الصفحة طلبات API.
اضبط SOSOAPI_ACCESS_TOKEN على خادمك ببيانات اعتماد تقبلها العملية، وأبقِه خارج شيفرة المتصفح. لوكيل الذكاء الاصطناعي، استخدم sosoapi auth login للدخول بالمتصفح ودع CLI يحدّث بيانات اعتماده.
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.jsonمثال استجابة اصطناعية
{
"contract_version": "advertising/v1",
"prepare_token": "exampleaaaaaaaaaaaaaaaaaaaaaaaaa",
"expires_at": "2099-01-15T09:00:00Z",
"action": {
"id": "11111111-1111-4111-8111-111111111111",
"workspace_id": "11111111-1111-4111-8111-111111111111",
"advertising_account_id": "11111111-1111-4111-8111-111111111111",
"mutation_id": "11111111-1111-4111-8111-111111111111",
"status": "prepared",
"command": {
"operation": "create_campaign",
"name": "example",
"objective": "OUTCOME_AWARENESS",
"special_ad_categories": [],
"status": "PAUSED"
},
"reviewed_digest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"effects": {
"creates_object": false,
"initial_status": null,
"activates_delivery": false,
"changes_budget": false,
"changes_audience": false,
"changes_creative": false,
"currency": "USD",
"timezone": "UTC",
"budget": null
},
"live_approval": {
"required": false,
"state": "not_required",
"reason": null,
"expires_at": null,
"approved_by": null
},
"provider_object_id": null,
"failure_code": null,
"created_at": "2099-01-15T09:00:00Z",
"completed_at": null
}
}