Alat MCP
Analisis kinerja iklan
sosoapi_ads_performance_analyzeAnalisis laporan iklan berbayar terbatas yang disediakan pelanggan dengan atribusi eksplisit dan hash sumber yang persis. Tidak ada akses penyedia atau klaim profitabilitas secara kausal.
Baca sebagai MarkdownProfil dan transport
Profil: full · Transport: stdio, http
Pilih core atau full untuk mengatur alat yang terlihat oleh klien; ini tidak mengubah izinnya. Unggahan file lokal memerlukan stdio dan tidak tersedia melalui HTTP. Atur SOSOAPI_OUTPUT_SCHEMAS=1 untuk menyertakan skema output saat penemuan. Alat mengembalikan hasil terstruktur dengan atau tanpa pengaturan itu.
Izin dan efek samping
Anotasi membantu klien menjelaskan alat. Setiap panggilan tetap memeriksa autentikasi pengguna, peran, akses sumber daya, dan izin kemampuan.
{
"readOnlyHint": true,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false
}- /advertising-api/performance/analyze: agent:advertising_read · synchronous_http_response
Kolom input
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 |
|
source_kind | stringWajib dalam induk |
|
source_id | stringWajib dalam induk |
|
provider_api_version | stringWajib dalam induk |
|
provider_account_id | stringWajib dalam induk |
|
currency | stringWajib dalam induk |
|
timezone | stringWajib dalam induk |
|
level | stringWajib dalam induk |
|
start_date | stringWajib dalam induk |
|
end_date | stringWajib dalam induk |
|
action_attribution_windows | arrayWajib dalam induk |
|
action_attribution_windows[] | stringOpsional / item |
|
action_report_time | stringWajib dalam induk |
|
conversion_action_type | stringWajib dalam induk |
|
revenue_action_type | stringWajib dalam induk |
|
complete | booleanWajib dalam induk | — |
rows | arrayWajib dalam induk |
|
rows[] | objectOpsional / item |
|
rows[].account_id | stringWajib dalam induk |
|
rows[].account_currency | stringWajib dalam induk |
|
rows[].campaign_id | stringWajib dalam induk |
|
rows[].campaign_name | stringOpsional / item |
|
rows[].adset_id | stringOpsional / item |
|
rows[].ad_id | stringOpsional / item |
|
rows[].date_start | stringWajib dalam induk |
|
rows[].date_stop | stringWajib dalam induk |
|
rows[].spend | stringOpsional / item |
|
rows[].clicks | stringOpsional / item |
|
rows[].actions | arrayOpsional / item |
|
rows[].actions[] | objectOpsional / item |
|
rows[].actions[].action_type | stringWajib dalam induk |
|
rows[].actions[].value | stringOpsional / item |
|
rows[].actions[].1d_click | stringOpsional / item |
|
rows[].actions[].7d_click | stringOpsional / item |
|
rows[].actions[].1d_view | stringOpsional / item |
|
rows[].action_values | arrayOpsional / item |
|
rows[].action_values[] | objectOpsional / item |
|
rows[].action_values[].action_type | stringWajib dalam induk |
|
rows[].action_values[].value | stringOpsional / item |
|
rows[].action_values[].1d_click | stringOpsional / item |
|
rows[].action_values[].7d_click | stringOpsional / item |
|
rows[].action_values[].1d_view | stringOpsional / item |
|
JSON Schema lengkap
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
},
"source_kind": {
"type": "string",
"enum": [
"customer_import",
"official_meta_api"
]
},
"source_id": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"provider_api_version": {
"type": "string",
"enum": [
"v26.0"
]
},
"provider_account_id": {
"$ref": "#/$defs/s1"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$"
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"level": {
"type": "string",
"enum": [
"campaign",
"adset",
"ad"
]
},
"start_date": {
"$ref": "#/$defs/s2"
},
"end_date": {
"$ref": "#/$defs/s2"
},
"action_attribution_windows": {
"minItems": 1,
"maxItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"1d_click",
"7d_click",
"1d_view"
]
}
},
"action_report_time": {
"type": "string",
"enum": [
"impression",
"conversion"
]
},
"conversion_action_type": {
"$ref": "#/$defs/s3"
},
"revenue_action_type": {
"$ref": "#/$defs/s3"
},
"complete": {
"type": "boolean"
},
"rows": {
"maxItems": 500,
"type": "array",
"items": {
"type": "object",
"properties": {
"account_id": {
"$ref": "#/$defs/s1"
},
"account_currency": {
"type": "string",
"pattern": "^[A-Z]{3}$"
},
"campaign_id": {
"$ref": "#/$defs/s1"
},
"campaign_name": {
"type": "string",
"maxLength": 200
},
"adset_id": {
"$ref": "#/$defs/s1"
},
"ad_id": {
"$ref": "#/$defs/s1"
},
"date_start": {
"$ref": "#/$defs/s2"
},
"date_stop": {
"$ref": "#/$defs/s2"
},
"spend": {
"type": "string",
"pattern": "^\\d{1,12}(?:\\.\\d{1,6})?$"
},
"clicks": {
"type": "string",
"pattern": "^\\d{1,15}$"
},
"actions": {
"$ref": "#/$defs/s0"
},
"action_values": {
"$ref": "#/$defs/s0"
}
},
"required": [
"account_id",
"account_currency",
"campaign_id",
"date_start",
"date_stop"
],
"additionalProperties": false
}
}
},
"required": [
"workspace_id",
"source_kind",
"source_id",
"provider_api_version",
"provider_account_id",
"currency",
"timezone",
"level",
"start_date",
"end_date",
"action_attribution_windows",
"action_report_time",
"conversion_action_type",
"revenue_action_type",
"complete",
"rows"
],
"additionalProperties": false,
"$defs": {
"s0": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"action_type": {
"type": "string",
"pattern": "^[a-z][a-z0-9_.]{0,99}$"
},
"value": {
"type": "string",
"pattern": "^\\d{1,12}(?:\\.\\d{1,6})?$"
},
"1d_click": {
"type": "string",
"pattern": "^\\d{1,12}(?:\\.\\d{1,6})?$"
},
"7d_click": {
"type": "string",
"pattern": "^\\d{1,12}(?:\\.\\d{1,6})?$"
},
"1d_view": {
"type": "string",
"pattern": "^\\d{1,12}(?:\\.\\d{1,6})?$"
}
},
"required": [
"action_type"
],
"additionalProperties": false
}
},
"s1": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
},
"s2": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"s3": {
"type": "string",
"pattern": "^[a-z][a-z0-9_.]{0,99}$"
}
}
}Output terstruktur
Skema ini menjelaskan structuredContent dalam hasil alat yang berhasil. Respons MCP juga menyertakan content dan dapat menetapkan isError saat panggilan gagal. Untuk publikasi, baca hasil akhir postingan alih-alih menganggap permintaan diterima atau respons teks sebagai konfirmasi. Operasi API yang ditautkan menjelaskan izin dan aturan percobaan ulang.
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 |
|
source_id | stringWajib dalam induk |
|
source_sha256 | stringWajib dalam induk |
|
identity_verification | stringWajib dalam induk |
|
currency | stringWajib dalam induk |
|
timezone | stringWajib dalam induk |
|
selection | objectWajib dalam induk |
|
selection.provider_api_version | stringWajib dalam induk |
|
selection.provider_account_id | stringWajib dalam induk |
|
selection.currency | stringWajib dalam induk |
|
selection.timezone | stringWajib dalam induk |
|
selection.level | stringWajib dalam induk |
|
selection.start_date | stringWajib dalam induk |
|
selection.end_date | stringWajib dalam induk |
|
selection.action_attribution_windows | arrayWajib dalam induk |
|
selection.action_attribution_windows[] | stringOpsional / item |
|
selection.action_report_time | stringWajib dalam induk |
|
selection.conversion_action_type | stringWajib dalam induk |
|
selection.revenue_action_type | stringWajib dalam induk |
|
complete | booleanWajib dalam induk | — |
rows | arrayWajib dalam induk |
|
rows[] | objectOpsional / item |
|
rows[].row_id | stringWajib dalam induk |
|
rows[].metrics | objectWajib dalam induk |
|
rows[].metrics.spend | objectWajib dalam induk |
|
rows[].metrics.spend.value | string | nullWajib dalam induk | — |
rows[].metrics.spend.valueanyOf 1 | stringWajib dalam induk |
|
rows[].metrics.spend.valueanyOf 2 | nullWajib dalam induk | — |
rows[].metrics.spend.unit | stringWajib dalam induk |
|
rows[].metrics.spend.availability | stringWajib dalam induk |
|
rows[].metrics.spend.reason | string | nullWajib dalam induk | — |
rows[].metrics.spend.reasonanyOf 1 | stringWajib dalam induk |
|
rows[].metrics.spend.reasonanyOf 2 | nullWajib dalam induk | — |
rows[].metrics.spend.input_refs | arrayWajib dalam induk |
|
rows[].metrics.spend.input_refs[] | stringOpsional / item |
|
rows[].metrics.clicks | objectWajib dalam induk |
|
rows[].metrics.clicks.value | string | nullWajib dalam induk | — |
rows[].metrics.clicks.valueanyOf 1 | stringWajib dalam induk |
|
rows[].metrics.clicks.valueanyOf 2 | nullWajib dalam induk | — |
rows[].metrics.clicks.unit | stringWajib dalam induk |
|
rows[].metrics.clicks.availability | stringWajib dalam induk |
|
rows[].metrics.clicks.reason | string | nullWajib dalam induk | — |
rows[].metrics.clicks.reasonanyOf 1 | stringWajib dalam induk |
|
rows[].metrics.clicks.reasonanyOf 2 | nullWajib dalam induk | — |
rows[].metrics.clicks.input_refs | arrayWajib dalam induk |
|
rows[].metrics.clicks.input_refs[] | stringOpsional / item |
|
rows[].metrics.conversions | objectWajib dalam induk |
|
rows[].metrics.conversions.value | string | nullWajib dalam induk | — |
rows[].metrics.conversions.valueanyOf 1 | stringWajib dalam induk |
|
rows[].metrics.conversions.valueanyOf 2 | nullWajib dalam induk | — |
rows[].metrics.conversions.unit | stringWajib dalam induk |
|
rows[].metrics.conversions.availability | stringWajib dalam induk |
|
rows[].metrics.conversions.reason | string | nullWajib dalam induk | — |
rows[].metrics.conversions.reasonanyOf 1 | stringWajib dalam induk |
|
rows[].metrics.conversions.reasonanyOf 2 | nullWajib dalam induk | — |
rows[].metrics.conversions.input_refs | arrayWajib dalam induk |
|
rows[].metrics.conversions.input_refs[] | stringOpsional / item |
|
rows[].metrics.attributed_revenue | objectWajib dalam induk |
|
rows[].metrics.attributed_revenue.value | string | nullWajib dalam induk | — |
rows[].metrics.attributed_revenue.valueanyOf 1 | stringWajib dalam induk |
|
rows[].metrics.attributed_revenue.valueanyOf 2 | nullWajib dalam induk | — |
rows[].metrics.attributed_revenue.unit | stringWajib dalam induk |
|
rows[].metrics.attributed_revenue.availability | stringWajib dalam induk |
|
rows[].metrics.attributed_revenue.reason | string | nullWajib dalam induk | — |
rows[].metrics.attributed_revenue.reasonanyOf 1 | stringWajib dalam induk |
|
rows[].metrics.attributed_revenue.reasonanyOf 2 | nullWajib dalam induk | — |
rows[].metrics.attributed_revenue.input_refs | arrayWajib dalam induk |
|
rows[].metrics.attributed_revenue.input_refs[] | stringOpsional / item |
|
rows[].metrics.cpc | objectWajib dalam induk |
|
rows[].metrics.cpc.value | string | nullWajib dalam induk | — |
rows[].metrics.cpc.valueanyOf 1 | stringWajib dalam induk |
|
rows[].metrics.cpc.valueanyOf 2 | nullWajib dalam induk | — |
rows[].metrics.cpc.unit | stringWajib dalam induk |
|
rows[].metrics.cpc.availability | stringWajib dalam induk |
|
rows[].metrics.cpc.reason | string | nullWajib dalam induk | — |
rows[].metrics.cpc.reasonanyOf 1 | stringWajib dalam induk |
|
rows[].metrics.cpc.reasonanyOf 2 | nullWajib dalam induk | — |
rows[].metrics.cpc.input_refs | arrayWajib dalam induk |
|
rows[].metrics.cpc.input_refs[] | stringOpsional / item |
|
rows[].metrics.cpa | objectWajib dalam induk |
|
rows[].metrics.cpa.value | string | nullWajib dalam induk | — |
rows[].metrics.cpa.valueanyOf 1 | stringWajib dalam induk |
|
rows[].metrics.cpa.valueanyOf 2 | nullWajib dalam induk | — |
rows[].metrics.cpa.unit | stringWajib dalam induk |
|
rows[].metrics.cpa.availability | stringWajib dalam induk |
|
rows[].metrics.cpa.reason | string | nullWajib dalam induk | — |
rows[].metrics.cpa.reasonanyOf 1 | stringWajib dalam induk |
|
rows[].metrics.cpa.reasonanyOf 2 | nullWajib dalam induk | — |
rows[].metrics.cpa.input_refs | arrayWajib dalam induk |
|
rows[].metrics.cpa.input_refs[] | stringOpsional / item |
|
rows[].metrics.attributed_roas | objectWajib dalam induk |
|
rows[].metrics.attributed_roas.value | string | nullWajib dalam induk | — |
rows[].metrics.attributed_roas.valueanyOf 1 | stringWajib dalam induk |
|
rows[].metrics.attributed_roas.valueanyOf 2 | nullWajib dalam induk | — |
rows[].metrics.attributed_roas.unit | stringWajib dalam induk |
|
rows[].metrics.attributed_roas.availability | stringWajib dalam induk |
|
rows[].metrics.attributed_roas.reason | string | nullWajib dalam induk | — |
rows[].metrics.attributed_roas.reasonanyOf 1 | stringWajib dalam induk |
|
rows[].metrics.attributed_roas.reasonanyOf 2 | nullWajib dalam induk | — |
rows[].metrics.attributed_roas.input_refs | arrayWajib dalam induk |
|
rows[].metrics.attributed_roas.input_refs[] | stringOpsional / item |
|
totals | objectWajib dalam induk |
|
totals.spend | objectWajib dalam induk |
|
totals.spend.value | string | nullWajib dalam induk | — |
totals.spend.valueanyOf 1 | stringWajib dalam induk |
|
totals.spend.valueanyOf 2 | nullWajib dalam induk | — |
totals.spend.unit | stringWajib dalam induk |
|
totals.spend.availability | stringWajib dalam induk |
|
totals.spend.reason | string | nullWajib dalam induk | — |
totals.spend.reasonanyOf 1 | stringWajib dalam induk |
|
totals.spend.reasonanyOf 2 | nullWajib dalam induk | — |
totals.spend.input_refs | arrayWajib dalam induk |
|
totals.spend.input_refs[] | stringOpsional / item |
|
totals.clicks | objectWajib dalam induk |
|
totals.clicks.value | string | nullWajib dalam induk | — |
totals.clicks.valueanyOf 1 | stringWajib dalam induk |
|
totals.clicks.valueanyOf 2 | nullWajib dalam induk | — |
totals.clicks.unit | stringWajib dalam induk |
|
totals.clicks.availability | stringWajib dalam induk |
|
totals.clicks.reason | string | nullWajib dalam induk | — |
totals.clicks.reasonanyOf 1 | stringWajib dalam induk |
|
totals.clicks.reasonanyOf 2 | nullWajib dalam induk | — |
totals.clicks.input_refs | arrayWajib dalam induk |
|
totals.clicks.input_refs[] | stringOpsional / item |
|
totals.conversions | objectWajib dalam induk |
|
totals.conversions.value | string | nullWajib dalam induk | — |
totals.conversions.valueanyOf 1 | stringWajib dalam induk |
|
totals.conversions.valueanyOf 2 | nullWajib dalam induk | — |
totals.conversions.unit | stringWajib dalam induk |
|
totals.conversions.availability | stringWajib dalam induk |
|
totals.conversions.reason | string | nullWajib dalam induk | — |
totals.conversions.reasonanyOf 1 | stringWajib dalam induk |
|
totals.conversions.reasonanyOf 2 | nullWajib dalam induk | — |
totals.conversions.input_refs | arrayWajib dalam induk |
|
totals.conversions.input_refs[] | stringOpsional / item |
|
totals.attributed_revenue | objectWajib dalam induk |
|
totals.attributed_revenue.value | string | nullWajib dalam induk | — |
totals.attributed_revenue.valueanyOf 1 | stringWajib dalam induk |
|
totals.attributed_revenue.valueanyOf 2 | nullWajib dalam induk | — |
totals.attributed_revenue.unit | stringWajib dalam induk |
|
totals.attributed_revenue.availability | stringWajib dalam induk |
|
totals.attributed_revenue.reason | string | nullWajib dalam induk | — |
totals.attributed_revenue.reasonanyOf 1 | stringWajib dalam induk |
|
totals.attributed_revenue.reasonanyOf 2 | nullWajib dalam induk | — |
totals.attributed_revenue.input_refs | arrayWajib dalam induk |
|
totals.attributed_revenue.input_refs[] | stringOpsional / item |
|
totals.cpc | objectWajib dalam induk |
|
totals.cpc.value | string | nullWajib dalam induk | — |
totals.cpc.valueanyOf 1 | stringWajib dalam induk |
|
totals.cpc.valueanyOf 2 | nullWajib dalam induk | — |
totals.cpc.unit | stringWajib dalam induk |
|
totals.cpc.availability | stringWajib dalam induk |
|
totals.cpc.reason | string | nullWajib dalam induk | — |
totals.cpc.reasonanyOf 1 | stringWajib dalam induk |
|
totals.cpc.reasonanyOf 2 | nullWajib dalam induk | — |
totals.cpc.input_refs | arrayWajib dalam induk |
|
totals.cpc.input_refs[] | stringOpsional / item |
|
totals.cpa | objectWajib dalam induk |
|
totals.cpa.value | string | nullWajib dalam induk | — |
totals.cpa.valueanyOf 1 | stringWajib dalam induk |
|
totals.cpa.valueanyOf 2 | nullWajib dalam induk | — |
totals.cpa.unit | stringWajib dalam induk |
|
totals.cpa.availability | stringWajib dalam induk |
|
totals.cpa.reason | string | nullWajib dalam induk | — |
totals.cpa.reasonanyOf 1 | stringWajib dalam induk |
|
totals.cpa.reasonanyOf 2 | nullWajib dalam induk | — |
totals.cpa.input_refs | arrayWajib dalam induk |
|
totals.cpa.input_refs[] | stringOpsional / item |
|
totals.attributed_roas | objectWajib dalam induk |
|
totals.attributed_roas.value | string | nullWajib dalam induk | — |
totals.attributed_roas.valueanyOf 1 | stringWajib dalam induk |
|
totals.attributed_roas.valueanyOf 2 | nullWajib dalam induk | — |
totals.attributed_roas.unit | stringWajib dalam induk |
|
totals.attributed_roas.availability | stringWajib dalam induk |
|
totals.attributed_roas.reason | string | nullWajib dalam induk | — |
totals.attributed_roas.reasonanyOf 1 | stringWajib dalam induk |
|
totals.attributed_roas.reasonanyOf 2 | nullWajib dalam induk | — |
totals.attributed_roas.input_refs | arrayWajib dalam induk |
|
totals.attributed_roas.input_refs[] | stringOpsional / item |
|
gaps | arrayWajib dalam induk |
|
gaps[] | stringOpsional / item |
|
suggestions | arrayWajib dalam induk |
|
suggestions[] | objectOpsional / item |
|
suggestions[].rule_id | stringWajib dalam induk |
|
suggestions[].rule_version | numberWajib dalam induk |
|
suggestions[].proposal | stringWajib dalam induk |
|
suggestions[].input_refs | arrayWajib dalam induk |
|
suggestions[].input_refs[] | stringOpsional / item |
|
suggestions[].limitations | stringWajib dalam induk |
|
JSON Schema lengkap
{
"type": "object",
"properties": {
"contract_version": {
"type": "string",
"const": "ad-performance/v1"
},
"source_id": {
"type": "string",
"maxLength": 100
},
"source_sha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"identity_verification": {
"type": "string",
"enum": [
"customer_supplied",
"accepted_provider_grant"
]
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$"
},
"timezone": {
"type": "string",
"maxLength": 100
},
"selection": {
"type": "object",
"properties": {
"provider_api_version": {
"type": "string",
"const": "v26.0"
},
"provider_account_id": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$"
},
"timezone": {
"type": "string",
"maxLength": 100
},
"level": {
"type": "string",
"enum": [
"campaign",
"adset",
"ad"
]
},
"start_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"end_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"action_attribution_windows": {
"minItems": 1,
"maxItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"1d_click",
"7d_click",
"1d_view"
]
}
},
"action_report_time": {
"type": "string",
"enum": [
"impression",
"conversion"
]
},
"conversion_action_type": {
"type": "string",
"maxLength": 100
},
"revenue_action_type": {
"type": "string",
"maxLength": 100
}
},
"required": [
"provider_api_version",
"provider_account_id",
"currency",
"timezone",
"level",
"start_date",
"end_date",
"action_attribution_windows",
"action_report_time",
"conversion_action_type",
"revenue_action_type"
],
"additionalProperties": false
},
"complete": {
"type": "boolean"
},
"rows": {
"maxItems": 500,
"type": "array",
"items": {
"type": "object",
"properties": {
"row_id": {
"type": "string",
"maxLength": 100
},
"metrics": {
"type": "object",
"properties": {
"spend": {
"type": "object",
"properties": {
"value": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$"
},
{
"type": "null"
}
]
},
"unit": {
"type": "string",
"enum": [
"currency",
"count",
"currency_per_click",
"currency_per_conversion",
"ratio"
]
},
"availability": {
"type": "string",
"enum": [
"available",
"missing_input",
"zero_denominator",
"incompatible",
"partial"
]
},
"reason": {
"anyOf": [
{
"type": "string",
"maxLength": 300
},
{
"type": "null"
}
]
},
"input_refs": {
"maxItems": 2000,
"type": "array",
"items": {
"type": "string",
"maxLength": 300
}
}
},
"required": [
"value",
"unit",
"availability",
"reason",
"input_refs"
],
"additionalProperties": false
},
"clicks": {
"type": "object",
"properties": {
"value": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$"
},
{
"type": "null"
}
]
},
"unit": {
"type": "string",
"enum": [
"currency",
"count",
"currency_per_click",
"currency_per_conversion",
"ratio"
]
},
"availability": {
"type": "string",
"enum": [
"available",
"missing_input",
"zero_denominator",
"incompatible",
"partial"
]
},
"reason": {
"anyOf": [
{
"type": "string",
"maxLength": 300
},
{
"type": "null"
}
]
},
"input_refs": {
"maxItems": 2000,
"type": "array",
"items": {
"type": "string",
"maxLength": 300
}
}
},
"required": [
"value",
"unit",
"availability",
"reason",
"input_refs"
],
"additionalProperties": false
},
"conversions": {
"type": "object",
"properties": {
"value": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$"
},
{
"type": "null"
}
]
},
"unit": {
"type": "string",
"enum": [
"currency",
"count",
"currency_per_click",
"currency_per_conversion",
"ratio"
]
},
"availability": {
"type": "string",
"enum": [
"available",
"missing_input",
"zero_denominator",
"incompatible",
"partial"
]
},
"reason": {
"anyOf": [
{
"type": "string",
"maxLength": 300
},
{
"type": "null"
}
]
},
"input_refs": {
"maxItems": 2000,
"type": "array",
"items": {
"type": "string",
"maxLength": 300
}
}
},
"required": [
"value",
"unit",
"availability",
"reason",
"input_refs"
],
"additionalProperties": false
},
"attributed_revenue": {
"type": "object",
"properties": {
"value": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$"
},
{
"type": "null"
}
]
},
"unit": {
"type": "string",
"enum": [
"currency",
"count",
"currency_per_click",
"currency_per_conversion",
"ratio"
]
},
"availability": {
"type": "string",
"enum": [
"available",
"missing_input",
"zero_denominator",
"incompatible",
"partial"
]
},
"reason": {
"anyOf": [
{
"type": "string",
"maxLength": 300
},
{
"type": "null"
}
]
},
"input_refs": {
"maxItems": 2000,
"type": "array",
"items": {
"type": "string",
"maxLength": 300
}
}
},
"required": [
"value",
"unit",
"availability",
"reason",
"input_refs"
],
"additionalProperties": false
},
"cpc": {
"type": "object",
"properties": {
"value": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$"
},
{
"type": "null"
}
]
},
"unit": {
"type": "string",
"enum": [
"currency",
"count",
"currency_per_click",
"currency_per_conversion",
"ratio"
]
},
"availability": {
"type": "string",
"enum": [
"available",
"missing_input",
"zero_denominator",
"incompatible",
"partial"
]
},
"reason": {
"anyOf": [
{
"type": "string",
"maxLength": 300
},
{
"type": "null"
}
]
},
"input_refs": {
"maxItems": 2000,
"type": "array",
"items": {
"type": "string",
"maxLength": 300
}
}
},
"required": [
"value",
"unit",
"availability",
"reason",
"input_refs"
],
"additionalProperties": false
},
"cpa": {
"type": "object",
"properties": {
"value": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$"
},
{
"type": "null"
}
]
},
"unit": {
"type": "string",
"enum": [
"currency",
"count",
"currency_per_click",
"currency_per_conversion",
"ratio"
]
},
"availability": {
"type": "string",
"enum": [
"available",
"missing_input",
"zero_denominator",
"incompatible",
"partial"
]
},
"reason": {
"anyOf": [
{
"type": "string",
"maxLength": 300
},
{
"type": "null"
}
]
},
"input_refs": {
"maxItems": 2000,
"type": "array",
"items": {
"type": "string",
"maxLength": 300
}
}
},
"required": [
"value",
"unit",
"availability",
"reason",
"input_refs"
],
"additionalProperties": false
},
"attributed_roas": {
"type": "object",
"properties": {
"value": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$"
},
{
"type": "null"
}
]
},
"unit": {
"type": "string",
"enum": [
"currency",
"count",
"currency_per_click",
"currency_per_conversion",
"ratio"
]
},
"availability": {
"type": "string",
"enum": [
"available",
"missing_input",
"zero_denominator",
"incompatible",
"partial"
]
},
"reason": {
"anyOf": [
{
"type": "string",
"maxLength": 300
},
{
"type": "null"
}
]
},
"input_refs": {
"maxItems": 2000,
"type": "array",
"items": {
"type": "string",
"maxLength": 300
}
}
},
"required": [
"value",
"unit",
"availability",
"reason",
"input_refs"
],
"additionalProperties": false
}
},
"required": [
"spend",
"clicks",
"conversions",
"attributed_revenue",
"cpc",
"cpa",
"attributed_roas"
],
"additionalProperties": false
}
},
"required": [
"row_id",
"metrics"
],
"additionalProperties": false
}
},
"totals": {
"type": "object",
"properties": {
"spend": {
"type": "object",
"properties": {
"value": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$"
},
{
"type": "null"
}
]
},
"unit": {
"type": "string",
"enum": [
"currency",
"count",
"currency_per_click",
"currency_per_conversion",
"ratio"
]
},
"availability": {
"type": "string",
"enum": [
"available",
"missing_input",
"zero_denominator",
"incompatible",
"partial"
]
},
"reason": {
"anyOf": [
{
"type": "string",
"maxLength": 300
},
{
"type": "null"
}
]
},
"input_refs": {
"maxItems": 2000,
"type": "array",
"items": {
"type": "string",
"maxLength": 300
}
}
},
"required": [
"value",
"unit",
"availability",
"reason",
"input_refs"
],
"additionalProperties": false
},
"clicks": {
"type": "object",
"properties": {
"value": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$"
},
{
"type": "null"
}
]
},
"unit": {
"type": "string",
"enum": [
"currency",
"count",
"currency_per_click",
"currency_per_conversion",
"ratio"
]
},
"availability": {
"type": "string",
"enum": [
"available",
"missing_input",
"zero_denominator",
"incompatible",
"partial"
]
},
"reason": {
"anyOf": [
{
"type": "string",
"maxLength": 300
},
{
"type": "null"
}
]
},
"input_refs": {
"maxItems": 2000,
"type": "array",
"items": {
"type": "string",
"maxLength": 300
}
}
},
"required": [
"value",
"unit",
"availability",
"reason",
"input_refs"
],
"additionalProperties": false
},
"conversions": {
"type": "object",
"properties": {
"value": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$"
},
{
"type": "null"
}
]
},
"unit": {
"type": "string",
"enum": [
"currency",
"count",
"currency_per_click",
"currency_per_conversion",
"ratio"
]
},
"availability": {
"type": "string",
"enum": [
"available",
"missing_input",
"zero_denominator",
"incompatible",
"partial"
]
},
"reason": {
"anyOf": [
{
"type": "string",
"maxLength": 300
},
{
"type": "null"
}
]
},
"input_refs": {
"maxItems": 2000,
"type": "array",
"items": {
"type": "string",
"maxLength": 300
}
}
},
"required": [
"value",
"unit",
"availability",
"reason",
"input_refs"
],
"additionalProperties": false
},
"attributed_revenue": {
"type": "object",
"properties": {
"value": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$"
},
{
"type": "null"
}
]
},
"unit": {
"type": "string",
"enum": [
"currency",
"count",
"currency_per_click",
"currency_per_conversion",
"ratio"
]
},
"availability": {
"type": "string",
"enum": [
"available",
"missing_input",
"zero_denominator",
"incompatible",
"partial"
]
},
"reason": {
"anyOf": [
{
"type": "string",
"maxLength": 300
},
{
"type": "null"
}
]
},
"input_refs": {
"maxItems": 2000,
"type": "array",
"items": {
"type": "string",
"maxLength": 300
}
}
},
"required": [
"value",
"unit",
"availability",
"reason",
"input_refs"
],
"additionalProperties": false
},
"cpc": {
"type": "object",
"properties": {
"value": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$"
},
{
"type": "null"
}
]
},
"unit": {
"type": "string",
"enum": [
"currency",
"count",
"currency_per_click",
"currency_per_conversion",
"ratio"
]
},
"availability": {
"type": "string",
"enum": [
"available",
"missing_input",
"zero_denominator",
"incompatible",
"partial"
]
},
"reason": {
"anyOf": [
{
"type": "string",
"maxLength": 300
},
{
"type": "null"
}
]
},
"input_refs": {
"maxItems": 2000,
"type": "array",
"items": {
"type": "string",
"maxLength": 300
}
}
},
"required": [
"value",
"unit",
"availability",
"reason",
"input_refs"
],
"additionalProperties": false
},
"cpa": {
"type": "object",
"properties": {
"value": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$"
},
{
"type": "null"
}
]
},
"unit": {
"type": "string",
"enum": [
"currency",
"count",
"currency_per_click",
"currency_per_conversion",
"ratio"
]
},
"availability": {
"type": "string",
"enum": [
"available",
"missing_input",
"zero_denominator",
"incompatible",
"partial"
]
},
"reason": {
"anyOf": [
{
"type": "string",
"maxLength": 300
},
{
"type": "null"
}
]
},
"input_refs": {
"maxItems": 2000,
"type": "array",
"items": {
"type": "string",
"maxLength": 300
}
}
},
"required": [
"value",
"unit",
"availability",
"reason",
"input_refs"
],
"additionalProperties": false
},
"attributed_roas": {
"type": "object",
"properties": {
"value": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{1,24}(?:\\.\\d{1,6})?$"
},
{
"type": "null"
}
]
},
"unit": {
"type": "string",
"enum": [
"currency",
"count",
"currency_per_click",
"currency_per_conversion",
"ratio"
]
},
"availability": {
"type": "string",
"enum": [
"available",
"missing_input",
"zero_denominator",
"incompatible",
"partial"
]
},
"reason": {
"anyOf": [
{
"type": "string",
"maxLength": 300
},
{
"type": "null"
}
]
},
"input_refs": {
"maxItems": 2000,
"type": "array",
"items": {
"type": "string",
"maxLength": 300
}
}
},
"required": [
"value",
"unit",
"availability",
"reason",
"input_refs"
],
"additionalProperties": false
}
},
"required": [
"spend",
"clicks",
"conversions",
"attributed_revenue",
"cpc",
"cpa",
"attributed_roas"
],
"additionalProperties": false
},
"gaps": {
"maxItems": 1000,
"type": "array",
"items": {
"type": "string",
"maxLength": 300
}
},
"suggestions": {
"maxItems": 3,
"type": "array",
"items": {
"type": "object",
"properties": {
"rule_id": {
"type": "string",
"enum": [
"supply_revenue",
"review_comparable_creative_test",
"complete_coverage"
]
},
"rule_version": {
"type": "number",
"const": 1
},
"proposal": {
"type": "string",
"maxLength": 600
},
"input_refs": {
"maxItems": 2000,
"type": "array",
"items": {
"type": "string",
"maxLength": 300
}
},
"limitations": {
"type": "string",
"const": "Observational comparison only; no causal uplift or profitability claim. Human review required."
}
},
"required": [
"rule_id",
"rule_version",
"proposal",
"input_refs",
"limitations"
],
"additionalProperties": false
}
}
},
"required": [
"contract_version",
"source_id",
"source_sha256",
"identity_verification",
"currency",
"timezone",
"selection",
"complete",
"rows",
"totals",
"gaps",
"suggestions"
],
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false
}Contoh panggilan alat
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.
{
"name": "sosoapi_ads_performance_analyze",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111",
"source_kind": "customer_import",
"source_id": "example",
"provider_api_version": "v26.0",
"provider_account_id": "12345",
"currency": "USD",
"timezone": "UTC",
"level": "campaign",
"start_date": "2099-01-15",
"end_date": "2099-01-15",
"action_attribution_windows": [
"1d_click"
],
"action_report_time": "impression",
"conversion_action_type": "example",
"revenue_action_type": "example",
"complete": false,
"rows": []
}
}structuredContent
{
"contract_version": "ad-performance/v1",
"source_id": "example",
"source_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"identity_verification": "customer_supplied",
"currency": "USD",
"timezone": "UTC",
"selection": {
"provider_api_version": "v26.0",
"provider_account_id": "12345",
"currency": "USD",
"timezone": "UTC",
"level": "campaign",
"start_date": "2099-01-15",
"end_date": "2099-01-15",
"action_attribution_windows": [
"1d_click"
],
"action_report_time": "impression",
"conversion_action_type": "example",
"revenue_action_type": "example"
},
"complete": false,
"rows": [],
"totals": {
"spend": {
"value": null,
"unit": "currency",
"availability": "available",
"reason": null,
"input_refs": []
},
"clicks": {
"value": null,
"unit": "currency",
"availability": "available",
"reason": null,
"input_refs": []
},
"conversions": {
"value": null,
"unit": "currency",
"availability": "available",
"reason": null,
"input_refs": []
},
"attributed_revenue": {
"value": null,
"unit": "currency",
"availability": "available",
"reason": null,
"input_refs": []
},
"cpc": {
"value": null,
"unit": "currency",
"availability": "available",
"reason": null,
"input_refs": []
},
"cpa": {
"value": null,
"unit": "currency",
"availability": "available",
"reason": null,
"input_refs": []
},
"attributed_roas": {
"value": null,
"unit": "currency",
"availability": "available",
"reason": null,
"input_refs": []
}
},
"gaps": [],
"suggestions": []
}