Periklanan
Status tindakan iklan
Baca status operasi iklan yang tidak dapat diubah beserta perintah aslinya. Penerimaan bukan keberhasilan penyedia; tindakan dengan dampak yang tidak diketahui tidak boleh dikirim ulang.
POST /advertising-api/actions/statusKontrak ditinjau: · sha256:9aedef8d43dd4514
Ringkasan
Baca status operasi iklan yang tidak dapat diubah beserta perintah aslinya. Penerimaan bukan keberhasilan penyedia; tindakan dengan dampak yang tidak diketahui tidak boleh dikirim ulang.
Respons HTTP berhasil dapat berarti permintaan diterima, bukan selesai. Untuk pekerjaan latar belakang, simpan ID yang dikembalikan dan periksa operasi yang sama sampai selesai. Postingan terjadwal atau diterima baru dipublikasikan setelah platform mengonfirmasi; timeout klien tidak membuktikan hasilnya.
Autentikasi dan izin
Token hanya dapat menggunakan hak pemiliknya. Setiap permintaan memeriksa keanggotaan ruang kerja, kepemilikan sumber daya, ruang kerja terpilih, dan kemampuan yang diberikan. Profil core dan full mengubah alat yang ditampilkan; tidak memberikan akses.
Kolom permintaan
Wajib berarti wajib dalam objek induk dan cabang yang dipilih. Anak wajib tidak membuat induk opsional menjadi wajib. Aturan dan nama kolom di bawah disalin dari kontrak.
| Kolom / cabang | Jenis / wajib | Batasan |
|---|---|---|
$ | objectWajib dalam induk |
|
workspace_id | stringWajib dalam induk |
|
action_id | stringWajib dalam induk |
|
JSON Schema lengkap
{
"$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)$"
},
"action_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)$"
}
},
"required": [
"workspace_id",
"action_id"
],
"additionalProperties": false
}Respons dan penyelesaian
Status HTTP berhasil: 200. Saat operasi selesai: synchronous_http_response.
Respons HTTP berhasil dapat berarti permintaan diterima, bukan selesai. Untuk pekerjaan latar belakang, simpan ID yang dikembalikan dan periksa operasi yang sama sampai selesai. Postingan terjadwal atau diterima baru dipublikasikan setelah platform mengonfirmasi; timeout klien tidak membuktikan hasilnya.
Wajib berarti wajib dalam objek induk dan cabang yang dipilih. Anak wajib tidak membuat induk opsional menjadi wajib. Aturan dan nama kolom di bawah disalin dari kontrak.
| Kolom / cabang | Jenis / wajib | Batasan |
|---|---|---|
$ | objectWajib dalam induk | — |
contract_version | stringWajib dalam induk |
|
action | objectWajib dalam induk | — |
action.id | stringWajib dalam induk |
|
action.workspace_id | stringWajib dalam induk |
|
action.advertising_account_id | stringWajib dalam induk |
|
action.mutation_id | stringWajib dalam induk |
|
action.status | stringWajib dalam induk |
|
action.command | objectWajib dalam induk | — |
action.commandoneOf 1 | objectWajib dalam induk | — |
action.command.operationoneOf 1 | stringWajib dalam induk |
|
action.command.nameoneOf 1 | stringWajib dalam induk |
|
action.command.budgetoneOf 1 | objectOpsional / item | — |
action.command.budget.kindoneOf 1 | stringWajib dalam induk |
|
action.command.budget.amount_minoroneOf 1 | stringWajib dalam induk |
|
action.command.objectiveoneOf 1 | stringWajib dalam induk |
|
action.command.special_ad_categoriesoneOf 1 | arrayWajib dalam induk |
|
action.command.special_ad_categories[]oneOf 1 | stringOpsional / item |
|
action.command.statusoneOf 1 | stringWajib dalam induk |
|
action.commandoneOf 2 | objectWajib dalam induk | — |
action.command.operationoneOf 2 | stringWajib dalam induk |
|
action.command.object_idoneOf 2 | stringWajib dalam induk |
|
action.command.nameoneOf 2 | stringOpsional / item |
|
action.command.budgetoneOf 2 | objectOpsional / item | — |
action.command.budget.kindoneOf 2 | stringWajib dalam induk |
|
action.command.budget.amount_minoroneOf 2 | stringWajib dalam induk |
|
action.command.statusoneOf 2 | stringOpsional / item |
|
action.commandoneOf 3 | objectWajib dalam induk | — |
action.command.operationoneOf 3 | stringWajib dalam induk |
|
action.command.campaign_idoneOf 3 | stringWajib dalam induk |
|
action.command.nameoneOf 3 | stringWajib dalam induk |
|
action.command.budgetoneOf 3 | objectOpsional / item | — |
action.command.budget.kindoneOf 3 | stringWajib dalam induk |
|
action.command.budget.amount_minoroneOf 3 | stringWajib dalam induk |
|
action.command.targetingoneOf 3 | objectWajib dalam induk | — |
action.command.targeting.geo_locationsoneOf 3 | objectWajib dalam induk | — |
action.command.targeting.geo_locations.countriesoneOf 3 | arrayWajib dalam induk |
|
action.command.targeting.geo_locations.countries[]oneOf 3 | stringOpsional / item |
|
action.command.targeting.age_minoneOf 3 | integerWajib dalam induk |
|
action.command.targeting.age_maxoneOf 3 | integerWajib dalam induk |
|
action.command.targeting.gendersoneOf 3 | arrayOpsional / item |
|
action.command.targeting.genders[]oneOf 3 | numberOpsional / item | — |
action.command.targeting.genders[]oneOf 3 / anyOf 1 | numberOpsional / item |
|
action.command.targeting.genders[]oneOf 3 / anyOf 2 | numberOpsional / item |
|
action.command.targeting.localesoneOf 3 | arrayOpsional / item |
|
action.command.targeting.locales[]oneOf 3 | integerOpsional / item |
|
action.command.targeting.publisher_platformsoneOf 3 | arrayWajib dalam induk |
|
action.command.targeting.publisher_platforms[]oneOf 3 | stringOpsional / item |
|
action.command.targeting.facebook_positionsoneOf 3 | arrayOpsional / item |
|
action.command.targeting.facebook_positions[]oneOf 3 | stringOpsional / item |
|
action.command.targeting.instagram_positionsoneOf 3 | arrayOpsional / item |
|
action.command.targeting.instagram_positions[]oneOf 3 | stringOpsional / item |
|
action.command.targeting.threads_positionsoneOf 3 | arrayOpsional / item |
|
action.command.targeting.threads_positions[]oneOf 3 | stringOpsional / item |
|
action.command.targeting.custom_audience_idsoneOf 3 | arrayOpsional / item |
|
action.command.targeting.custom_audience_ids[]oneOf 3 | stringOpsional / item |
|
action.command.targeting.excluded_custom_audience_idsoneOf 3 | arrayOpsional / item |
|
action.command.targeting.excluded_custom_audience_ids[]oneOf 3 | stringOpsional / item |
|
action.command.billing_eventoneOf 3 | stringWajib dalam induk |
|
action.command.optimization_goaloneOf 3 | stringWajib dalam induk |
|
action.command.bid_strategyoneOf 3 | stringWajib dalam induk |
|
action.command.start_timeoneOf 3 | stringOpsional / item |
|
action.command.end_timeoneOf 3 | stringOpsional / item |
|
action.command.promoted_objectoneOf 3 | objectOpsional / item | — |
action.command.promoted_object.page_idoneOf 3 | stringOpsional / item |
|
action.command.promoted_object.pixel_idoneOf 3 | stringOpsional / item |
|
action.command.promoted_object.custom_event_typeoneOf 3 | stringOpsional / item |
|
action.command.statusoneOf 3 | stringWajib dalam induk |
|
action.commandoneOf 4 | objectWajib dalam induk | — |
action.command.operationoneOf 4 | stringWajib dalam induk |
|
action.command.object_idoneOf 4 | stringWajib dalam induk |
|
action.command.nameoneOf 4 | stringOpsional / item |
|
action.command.budgetoneOf 4 | objectOpsional / item | — |
action.command.budget.kindoneOf 4 | stringWajib dalam induk |
|
action.command.budget.amount_minoroneOf 4 | stringWajib dalam induk |
|
action.command.statusoneOf 4 | stringOpsional / item |
|
action.command.targetingoneOf 4 | objectOpsional / item | — |
action.command.targeting.geo_locationsoneOf 4 | objectWajib dalam induk | — |
action.command.targeting.geo_locations.countriesoneOf 4 | arrayWajib dalam induk |
|
action.command.targeting.geo_locations.countries[]oneOf 4 | stringOpsional / item |
|
action.command.targeting.age_minoneOf 4 | integerWajib dalam induk |
|
action.command.targeting.age_maxoneOf 4 | integerWajib dalam induk |
|
action.command.targeting.gendersoneOf 4 | arrayOpsional / item |
|
action.command.targeting.genders[]oneOf 4 | numberOpsional / item | — |
action.command.targeting.genders[]oneOf 4 / anyOf 1 | numberOpsional / item |
|
action.command.targeting.genders[]oneOf 4 / anyOf 2 | numberOpsional / item |
|
action.command.targeting.localesoneOf 4 | arrayOpsional / item |
|
action.command.targeting.locales[]oneOf 4 | integerOpsional / item |
|
action.command.targeting.publisher_platformsoneOf 4 | arrayWajib dalam induk |
|
action.command.targeting.publisher_platforms[]oneOf 4 | stringOpsional / item |
|
action.command.targeting.facebook_positionsoneOf 4 | arrayOpsional / item |
|
action.command.targeting.facebook_positions[]oneOf 4 | stringOpsional / item |
|
action.command.targeting.instagram_positionsoneOf 4 | arrayOpsional / item |
|
action.command.targeting.instagram_positions[]oneOf 4 | stringOpsional / item |
|
action.command.targeting.threads_positionsoneOf 4 | arrayOpsional / item |
|
action.command.targeting.threads_positions[]oneOf 4 | stringOpsional / item |
|
action.command.targeting.custom_audience_idsoneOf 4 | arrayOpsional / item |
|
action.command.targeting.custom_audience_ids[]oneOf 4 | stringOpsional / item |
|
action.command.targeting.excluded_custom_audience_idsoneOf 4 | arrayOpsional / item |
|
action.command.targeting.excluded_custom_audience_ids[]oneOf 4 | stringOpsional / item |
|
action.command.start_timeoneOf 4 | stringOpsional / item |
|
action.command.end_timeoneOf 4 | stringOpsional / item |
|
action.commandoneOf 5 | objectWajib dalam induk | — |
action.command.operationoneOf 5 | stringWajib dalam induk |
|
action.command.nameoneOf 5 | stringWajib dalam induk |
|
action.command.adset_idoneOf 5 | stringWajib dalam induk |
|
action.command.creative_idoneOf 5 | stringWajib dalam induk |
|
action.command.statusoneOf 5 | stringWajib dalam induk |
|
action.commandoneOf 6 | objectWajib dalam induk | — |
action.command.operationoneOf 6 | stringWajib dalam induk |
|
action.command.object_idoneOf 6 | stringWajib dalam induk |
|
action.command.nameoneOf 6 | stringOpsional / item |
|
action.command.creative_idoneOf 6 | stringOpsional / item |
|
action.command.statusoneOf 6 | stringOpsional / item |
|
action.commandoneOf 7 | objectWajib dalam induk | — |
action.command.operationoneOf 7 | stringWajib dalam induk |
|
action.command.nameoneOf 7 | stringWajib dalam induk |
|
action.command.object_story_speconeOf 7 | objectOpsional / item | — |
action.command.object_story_spec.page_idoneOf 7 | stringWajib dalam induk |
|
action.command.object_story_spec.instagram_user_idoneOf 7 | stringOpsional / item |
|
action.command.object_story_spec.link_dataoneOf 7 | objectWajib dalam induk | — |
action.command.object_story_spec.link_data.linkoneOf 7 | stringWajib dalam induk |
|
action.command.object_story_spec.link_data.messageoneOf 7 | stringWajib dalam induk |
|
action.command.object_story_spec.link_data.nameoneOf 7 | stringOpsional / item |
|
action.command.object_story_spec.link_data.image_hashoneOf 7 | stringWajib dalam induk |
|
action.command.object_story_spec.link_data.call_to_actiononeOf 7 | stringOpsional / item |
|
action.command.object_story_idoneOf 7 | stringOpsional / item |
|
action.commandoneOf 8 | objectWajib dalam induk | — |
action.command.operationoneOf 8 | stringWajib dalam induk |
|
action.command.nameoneOf 8 | stringWajib dalam induk |
|
action.command.targetingoneOf 8 | objectWajib dalam induk | — |
action.command.targeting.geo_locationsoneOf 8 | objectWajib dalam induk | — |
action.command.targeting.geo_locations.countriesoneOf 8 | arrayWajib dalam induk |
|
action.command.targeting.geo_locations.countries[]oneOf 8 | stringOpsional / item |
|
action.command.targeting.age_minoneOf 8 | integerWajib dalam induk |
|
action.command.targeting.age_maxoneOf 8 | integerWajib dalam induk |
|
action.command.targeting.gendersoneOf 8 | arrayOpsional / item |
|
action.command.targeting.genders[]oneOf 8 | numberOpsional / item | — |
action.command.targeting.genders[]oneOf 8 / anyOf 1 | numberOpsional / item |
|
action.command.targeting.genders[]oneOf 8 / anyOf 2 | numberOpsional / item |
|
action.command.targeting.localesoneOf 8 | arrayOpsional / item |
|
action.command.targeting.locales[]oneOf 8 | integerOpsional / item |
|
action.command.targeting.publisher_platformsoneOf 8 | arrayWajib dalam induk |
|
action.command.targeting.publisher_platforms[]oneOf 8 | stringOpsional / item |
|
action.command.targeting.facebook_positionsoneOf 8 | arrayOpsional / item |
|
action.command.targeting.facebook_positions[]oneOf 8 | stringOpsional / item |
|
action.command.targeting.instagram_positionsoneOf 8 | arrayOpsional / item |
|
action.command.targeting.instagram_positions[]oneOf 8 | stringOpsional / item |
|
action.command.targeting.threads_positionsoneOf 8 | arrayOpsional / item |
|
action.command.targeting.threads_positions[]oneOf 8 | stringOpsional / item |
|
action.command.targeting.custom_audience_idsoneOf 8 | arrayOpsional / item |
|
action.command.targeting.custom_audience_ids[]oneOf 8 | stringOpsional / item |
|
action.command.targeting.excluded_custom_audience_idsoneOf 8 | arrayOpsional / item |
|
action.command.targeting.excluded_custom_audience_ids[]oneOf 8 | stringOpsional / item |
|
action.commandoneOf 9 | objectWajib dalam induk | — |
action.command.operationoneOf 9 | stringWajib dalam induk |
|
action.command.object_idoneOf 9 | stringWajib dalam induk |
|
action.command.nameoneOf 9 | stringOpsional / item |
|
action.command.targetingoneOf 9 | objectOpsional / item | — |
action.command.targeting.geo_locationsoneOf 9 | objectWajib dalam induk | — |
action.command.targeting.geo_locations.countriesoneOf 9 | arrayWajib dalam induk |
|
action.command.targeting.geo_locations.countries[]oneOf 9 | stringOpsional / item |
|
action.command.targeting.age_minoneOf 9 | integerWajib dalam induk |
|
action.command.targeting.age_maxoneOf 9 | integerWajib dalam induk |
|
action.command.targeting.gendersoneOf 9 | arrayOpsional / item |
|
action.command.targeting.genders[]oneOf 9 | numberOpsional / item | — |
action.command.targeting.genders[]oneOf 9 / anyOf 1 | numberOpsional / item |
|
action.command.targeting.genders[]oneOf 9 / anyOf 2 | numberOpsional / item |
|
action.command.targeting.localesoneOf 9 | arrayOpsional / item |
|
action.command.targeting.locales[]oneOf 9 | integerOpsional / item |
|
action.command.targeting.publisher_platformsoneOf 9 | arrayWajib dalam induk |
|
action.command.targeting.publisher_platforms[]oneOf 9 | stringOpsional / item |
|
action.command.targeting.facebook_positionsoneOf 9 | arrayOpsional / item |
|
action.command.targeting.facebook_positions[]oneOf 9 | stringOpsional / item |
|
action.command.targeting.instagram_positionsoneOf 9 | arrayOpsional / item |
|
action.command.targeting.instagram_positions[]oneOf 9 | stringOpsional / item |
|
action.command.targeting.threads_positionsoneOf 9 | arrayOpsional / item |
|
action.command.targeting.threads_positions[]oneOf 9 | stringOpsional / item |
|
action.command.targeting.custom_audience_idsoneOf 9 | arrayOpsional / item |
|
action.command.targeting.custom_audience_ids[]oneOf 9 | stringOpsional / item |
|
action.command.targeting.excluded_custom_audience_idsoneOf 9 | arrayOpsional / item |
|
action.command.targeting.excluded_custom_audience_ids[]oneOf 9 | stringOpsional / item |
|
action.reviewed_digest | stringWajib dalam induk |
|
action.effects | objectWajib dalam induk | — |
action.effects.creates_object | booleanWajib dalam induk | — |
action.effects.initial_status | string | nullWajib dalam induk | — |
action.effects.initial_statusanyOf 1 | stringWajib dalam induk |
|
action.effects.initial_statusanyOf 2 | nullWajib dalam induk | — |
action.effects.activates_delivery | booleanWajib dalam induk | — |
action.effects.changes_budget | booleanWajib dalam induk | — |
action.effects.changes_audience | booleanWajib dalam induk | — |
action.effects.changes_creative | booleanWajib dalam induk | — |
action.effects.currency | stringWajib dalam induk |
|
action.effects.timezone | stringWajib dalam induk |
|
action.effects.budget | object | nullWajib dalam induk | — |
action.effects.budgetanyOf 1 | objectWajib dalam induk | — |
action.effects.budget.kindanyOf 1 | stringWajib dalam induk |
|
action.effects.budget.amount_minoranyOf 1 | stringWajib dalam induk |
|
action.effects.budgetanyOf 2 | nullWajib dalam induk | — |
action.live_approval | objectWajib dalam induk | — |
action.live_approval.required | booleanWajib dalam induk | — |
action.live_approval.state | stringWajib dalam induk |
|
action.live_approval.reason | string | nullWajib dalam induk | — |
action.live_approval.reasonanyOf 1 | stringWajib dalam induk |
|
action.live_approval.reasonanyOf 2 | nullWajib dalam induk | — |
action.live_approval.expires_at | string | nullWajib dalam induk | — |
action.live_approval.expires_atanyOf 1 | stringWajib dalam induk |
|
action.live_approval.expires_atanyOf 2 | nullWajib dalam induk | — |
action.live_approval.approved_by | string | nullWajib dalam induk | — |
action.live_approval.approved_byanyOf 1 | stringWajib dalam induk |
|
action.live_approval.approved_byanyOf 2 | nullWajib dalam induk | — |
action.provider_object_id | string | nullWajib dalam induk | — |
action.provider_object_idanyOf 1 | stringWajib dalam induk |
|
action.provider_object_idanyOf 2 | nullWajib dalam induk | — |
action.failure_code | string | nullWajib dalam induk | — |
action.failure_codeanyOf 1 | stringWajib dalam induk |
|
action.failure_codeanyOf 2 | nullWajib dalam induk | — |
action.created_at | stringWajib dalam induk |
|
action.completed_at | string | nullWajib dalam induk | — |
action.completed_atanyOf 1 | stringWajib dalam induk |
|
action.completed_atanyOf 2 | nullWajib dalam induk | — |
replayed | booleanWajib dalam induk | — |
JSON Schema lengkap
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"contract_version": {
"type": "string",
"const": "advertising/v1"
},
"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"
]
},
"replayed": {
"type": "boolean"
}
},
"required": [
"contract_version",
"action",
"replayed"
]
}Kesalahan dan percobaan ulang aman
Periksa status HTTP dan isi respons. Kesalahan validasi 400 mungkin berisi ZodError; kesalahan handler menggunakan kolom error, message, dan code. Simpan request_id atau x-request-id untuk diagnosis, tanpa kredensial. Atasi kesalahan akses 401/403 sebelum mencoba lagi, dan ikuti Retry-After untuk 429. Jika penulisan belum pasti atau mengembalikan 5xx, baca hasil yang sudah ada terlebih dahulu. Gunakan kembali kunci idempotensi hanya jika didukung; perilaku percobaan ulang berbeda menurut operasi dan tidak menjamin pengiriman tepat satu kali.
Panduan pemecahan masalahContoh
Contoh ini menggunakan nilai fiktif yang diperiksa terhadap skema. Ganti ID dengan yang diizinkan bagi Anda, media dengan aset siap, dan tanggal dengan waktu publikasi yang dikonfirmasi. Periksa kelayakan akun sebelum mengirim penulisan. Halaman ini tidak mengirim permintaan API.
Atur SOSOAPI_ACCESS_TOKEN di server Anda ke kredensial yang diterima operasi ini, dan jauhkan dari kode browser. Untuk agen AI, gunakan sosoapi auth login untuk masuk melalui browser dan biarkan CLI memperbarui kredensialnya.
request.json
{
"workspace_id": "11111111-1111-4111-8111-111111111111",
"action_id": "11111111-1111-4111-8111-111111111111"
}cURL
curl --request POST \
"https://gqeshlawtcexsapabaui.supabase.co/functions/v1/advertising-api/actions/status" \
-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/status", {
method: "POST",
headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
body: JSON.stringify({
"workspace_id": "11111111-1111-4111-8111-111111111111",
"action_id": "11111111-1111-4111-8111-111111111111"
})
});
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/status < request.jsonContoh respons sintetis
{
"contract_version": "advertising/v1",
"action": {
"id": "11111111-1111-4111-8111-111111111111",
"workspace_id": "11111111-1111-4111-8111-111111111111",
"advertising_account_id": "11111111-1111-4111-8111-111111111111",
"mutation_id": "11111111-1111-4111-8111-111111111111",
"status": "prepared",
"command": {
"operation": "create_campaign",
"name": "example",
"objective": "OUTCOME_AWARENESS",
"special_ad_categories": [],
"status": "PAUSED"
},
"reviewed_digest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"effects": {
"creates_object": false,
"initial_status": null,
"activates_delivery": false,
"changes_budget": false,
"changes_audience": false,
"changes_creative": false,
"currency": "USD",
"timezone": "UTC",
"budget": null
},
"live_approval": {
"required": false,
"state": "not_required",
"reason": null,
"expires_at": null,
"approved_by": null
},
"provider_object_id": null,
"failure_code": null,
"created_at": "2099-01-15T09:00:00Z",
"completed_at": null
},
"replayed": false
}