MCP-verktyg
Analysera annonsresultat
sosoapi_ads_performance_analyzeAnalysera en avgränsad rapport om betald annonsering från kunden, med uttrycklig attribuering och exakt källhash. Ger ingen leverantörsåtkomst eller något påstående om kausal lönsamhet.
Läs som MarkdownProfiler och transporter
Profiler: full · Transporter: stdio, http
Välj core eller full för att styra vilka verktyg klienten ser; detta ändrar inte dess behörigheter. Lokal filuppladdning kräver stdio och är inte tillgänglig via HTTP. Ange SOSOAPI_OUTPUT_SCHEMAS=1 för att inkludera utdatascheman vid identifiering. Verktygen returnerar strukturerade resultat med eller utan inställningen.
Behörigheter och sidoeffekter
Annoteringar hjälper klienter att beskriva ett verktyg. Varje anrop kontrollerar fortfarande användarens autentisering, roll, resursåtkomst och tilldelade funktionsbehörigheter.
{
"readOnlyHint": true,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false
}- /advertising-api/performance/analyze: agent:advertising_read · synchronous_http_response
Indatafält
Obligatoriskt betyder obligatoriskt inom sitt överordnade objekt och vald gren. Ett obligatoriskt underfält gör inte ett valfritt överordnat objekt obligatoriskt. Regler och fältnamn nedan kopieras från kontraktet.
| Fält / gren | Typ / obligatoriskt | Begränsningar |
|---|---|---|
$ | objectObligatoriskt i överordnat objekt |
|
workspace_id | stringObligatoriskt i överordnat objekt |
|
source_kind | stringObligatoriskt i överordnat objekt |
|
source_id | stringObligatoriskt i överordnat objekt |
|
provider_api_version | stringObligatoriskt i överordnat objekt |
|
provider_account_id | stringObligatoriskt i överordnat objekt |
|
currency | stringObligatoriskt i överordnat objekt |
|
timezone | stringObligatoriskt i överordnat objekt |
|
level | stringObligatoriskt i överordnat objekt |
|
start_date | stringObligatoriskt i överordnat objekt |
|
end_date | stringObligatoriskt i överordnat objekt |
|
action_attribution_windows | arrayObligatoriskt i överordnat objekt |
|
action_attribution_windows[] | stringValfritt / objekt |
|
action_report_time | stringObligatoriskt i överordnat objekt |
|
conversion_action_type | stringObligatoriskt i överordnat objekt |
|
revenue_action_type | stringObligatoriskt i överordnat objekt |
|
complete | booleanObligatoriskt i överordnat objekt | — |
rows | arrayObligatoriskt i överordnat objekt |
|
rows[] | objectValfritt / objekt |
|
rows[].account_id | stringObligatoriskt i överordnat objekt |
|
rows[].account_currency | stringObligatoriskt i överordnat objekt |
|
rows[].campaign_id | stringObligatoriskt i överordnat objekt |
|
rows[].campaign_name | stringValfritt / objekt |
|
rows[].adset_id | stringValfritt / objekt |
|
rows[].ad_id | stringValfritt / objekt |
|
rows[].date_start | stringObligatoriskt i överordnat objekt |
|
rows[].date_stop | stringObligatoriskt i överordnat objekt |
|
rows[].spend | stringValfritt / objekt |
|
rows[].clicks | stringValfritt / objekt |
|
rows[].actions | arrayValfritt / objekt |
|
rows[].actions[] | objectValfritt / objekt |
|
rows[].actions[].action_type | stringObligatoriskt i överordnat objekt |
|
rows[].actions[].value | stringValfritt / objekt |
|
rows[].actions[].1d_click | stringValfritt / objekt |
|
rows[].actions[].7d_click | stringValfritt / objekt |
|
rows[].actions[].1d_view | stringValfritt / objekt |
|
rows[].action_values | arrayValfritt / objekt |
|
rows[].action_values[] | objectValfritt / objekt |
|
rows[].action_values[].action_type | stringObligatoriskt i överordnat objekt |
|
rows[].action_values[].value | stringValfritt / objekt |
|
rows[].action_values[].1d_click | stringValfritt / objekt |
|
rows[].action_values[].7d_click | stringValfritt / objekt |
|
rows[].action_values[].1d_view | stringValfritt / objekt |
|
Fullständigt JSON Schema
{
"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}$"
}
}
}Strukturerat resultat
Detta schema beskriver structuredContent i ett lyckat verktygsresultat. MCP-svaret innehåller även content och kan ange isError när ett anrop misslyckas. För publicering ska du läsa inläggets slutresultat i stället för att tolka en accepterad begäran eller ett textsvar som bekräftelse. Den länkade API-åtgärden förklarar behörigheter och regler för nya försök.
Obligatoriskt betyder obligatoriskt inom sitt överordnade objekt och vald gren. Ett obligatoriskt underfält gör inte ett valfritt överordnat objekt obligatoriskt. Regler och fältnamn nedan kopieras från kontraktet.
| Fält / gren | Typ / obligatoriskt | Begränsningar |
|---|---|---|
$ | objectObligatoriskt i överordnat objekt |
|
contract_version | stringObligatoriskt i överordnat objekt |
|
source_id | stringObligatoriskt i överordnat objekt |
|
source_sha256 | stringObligatoriskt i överordnat objekt |
|
identity_verification | stringObligatoriskt i överordnat objekt |
|
currency | stringObligatoriskt i överordnat objekt |
|
timezone | stringObligatoriskt i överordnat objekt |
|
selection | objectObligatoriskt i överordnat objekt |
|
selection.provider_api_version | stringObligatoriskt i överordnat objekt |
|
selection.provider_account_id | stringObligatoriskt i överordnat objekt |
|
selection.currency | stringObligatoriskt i överordnat objekt |
|
selection.timezone | stringObligatoriskt i överordnat objekt |
|
selection.level | stringObligatoriskt i överordnat objekt |
|
selection.start_date | stringObligatoriskt i överordnat objekt |
|
selection.end_date | stringObligatoriskt i överordnat objekt |
|
selection.action_attribution_windows | arrayObligatoriskt i överordnat objekt |
|
selection.action_attribution_windows[] | stringValfritt / objekt |
|
selection.action_report_time | stringObligatoriskt i överordnat objekt |
|
selection.conversion_action_type | stringObligatoriskt i överordnat objekt |
|
selection.revenue_action_type | stringObligatoriskt i överordnat objekt |
|
complete | booleanObligatoriskt i överordnat objekt | — |
rows | arrayObligatoriskt i överordnat objekt |
|
rows[] | objectValfritt / objekt |
|
rows[].row_id | stringObligatoriskt i överordnat objekt |
|
rows[].metrics | objectObligatoriskt i överordnat objekt |
|
rows[].metrics.spend | objectObligatoriskt i överordnat objekt |
|
rows[].metrics.spend.value | string | nullObligatoriskt i överordnat objekt | — |
rows[].metrics.spend.valueanyOf 1 | stringObligatoriskt i överordnat objekt |
|
rows[].metrics.spend.valueanyOf 2 | nullObligatoriskt i överordnat objekt | — |
rows[].metrics.spend.unit | stringObligatoriskt i överordnat objekt |
|
rows[].metrics.spend.availability | stringObligatoriskt i överordnat objekt |
|
rows[].metrics.spend.reason | string | nullObligatoriskt i överordnat objekt | — |
rows[].metrics.spend.reasonanyOf 1 | stringObligatoriskt i överordnat objekt |
|
rows[].metrics.spend.reasonanyOf 2 | nullObligatoriskt i överordnat objekt | — |
rows[].metrics.spend.input_refs | arrayObligatoriskt i överordnat objekt |
|
rows[].metrics.spend.input_refs[] | stringValfritt / objekt |
|
rows[].metrics.clicks | objectObligatoriskt i överordnat objekt |
|
rows[].metrics.clicks.value | string | nullObligatoriskt i överordnat objekt | — |
rows[].metrics.clicks.valueanyOf 1 | stringObligatoriskt i överordnat objekt |
|
rows[].metrics.clicks.valueanyOf 2 | nullObligatoriskt i överordnat objekt | — |
rows[].metrics.clicks.unit | stringObligatoriskt i överordnat objekt |
|
rows[].metrics.clicks.availability | stringObligatoriskt i överordnat objekt |
|
rows[].metrics.clicks.reason | string | nullObligatoriskt i överordnat objekt | — |
rows[].metrics.clicks.reasonanyOf 1 | stringObligatoriskt i överordnat objekt |
|
rows[].metrics.clicks.reasonanyOf 2 | nullObligatoriskt i överordnat objekt | — |
rows[].metrics.clicks.input_refs | arrayObligatoriskt i överordnat objekt |
|
rows[].metrics.clicks.input_refs[] | stringValfritt / objekt |
|
rows[].metrics.conversions | objectObligatoriskt i överordnat objekt |
|
rows[].metrics.conversions.value | string | nullObligatoriskt i överordnat objekt | — |
rows[].metrics.conversions.valueanyOf 1 | stringObligatoriskt i överordnat objekt |
|
rows[].metrics.conversions.valueanyOf 2 | nullObligatoriskt i överordnat objekt | — |
rows[].metrics.conversions.unit | stringObligatoriskt i överordnat objekt |
|
rows[].metrics.conversions.availability | stringObligatoriskt i överordnat objekt |
|
rows[].metrics.conversions.reason | string | nullObligatoriskt i överordnat objekt | — |
rows[].metrics.conversions.reasonanyOf 1 | stringObligatoriskt i överordnat objekt |
|
rows[].metrics.conversions.reasonanyOf 2 | nullObligatoriskt i överordnat objekt | — |
rows[].metrics.conversions.input_refs | arrayObligatoriskt i överordnat objekt |
|
rows[].metrics.conversions.input_refs[] | stringValfritt / objekt |
|
rows[].metrics.attributed_revenue | objectObligatoriskt i överordnat objekt |
|
rows[].metrics.attributed_revenue.value | string | nullObligatoriskt i överordnat objekt | — |
rows[].metrics.attributed_revenue.valueanyOf 1 | stringObligatoriskt i överordnat objekt |
|
rows[].metrics.attributed_revenue.valueanyOf 2 | nullObligatoriskt i överordnat objekt | — |
rows[].metrics.attributed_revenue.unit | stringObligatoriskt i överordnat objekt |
|
rows[].metrics.attributed_revenue.availability | stringObligatoriskt i överordnat objekt |
|
rows[].metrics.attributed_revenue.reason | string | nullObligatoriskt i överordnat objekt | — |
rows[].metrics.attributed_revenue.reasonanyOf 1 | stringObligatoriskt i överordnat objekt |
|
rows[].metrics.attributed_revenue.reasonanyOf 2 | nullObligatoriskt i överordnat objekt | — |
rows[].metrics.attributed_revenue.input_refs | arrayObligatoriskt i överordnat objekt |
|
rows[].metrics.attributed_revenue.input_refs[] | stringValfritt / objekt |
|
rows[].metrics.cpc | objectObligatoriskt i överordnat objekt |
|
rows[].metrics.cpc.value | string | nullObligatoriskt i överordnat objekt | — |
rows[].metrics.cpc.valueanyOf 1 | stringObligatoriskt i överordnat objekt |
|
rows[].metrics.cpc.valueanyOf 2 | nullObligatoriskt i överordnat objekt | — |
rows[].metrics.cpc.unit | stringObligatoriskt i överordnat objekt |
|
rows[].metrics.cpc.availability | stringObligatoriskt i överordnat objekt |
|
rows[].metrics.cpc.reason | string | nullObligatoriskt i överordnat objekt | — |
rows[].metrics.cpc.reasonanyOf 1 | stringObligatoriskt i överordnat objekt |
|
rows[].metrics.cpc.reasonanyOf 2 | nullObligatoriskt i överordnat objekt | — |
rows[].metrics.cpc.input_refs | arrayObligatoriskt i överordnat objekt |
|
rows[].metrics.cpc.input_refs[] | stringValfritt / objekt |
|
rows[].metrics.cpa | objectObligatoriskt i överordnat objekt |
|
rows[].metrics.cpa.value | string | nullObligatoriskt i överordnat objekt | — |
rows[].metrics.cpa.valueanyOf 1 | stringObligatoriskt i överordnat objekt |
|
rows[].metrics.cpa.valueanyOf 2 | nullObligatoriskt i överordnat objekt | — |
rows[].metrics.cpa.unit | stringObligatoriskt i överordnat objekt |
|
rows[].metrics.cpa.availability | stringObligatoriskt i överordnat objekt |
|
rows[].metrics.cpa.reason | string | nullObligatoriskt i överordnat objekt | — |
rows[].metrics.cpa.reasonanyOf 1 | stringObligatoriskt i överordnat objekt |
|
rows[].metrics.cpa.reasonanyOf 2 | nullObligatoriskt i överordnat objekt | — |
rows[].metrics.cpa.input_refs | arrayObligatoriskt i överordnat objekt |
|
rows[].metrics.cpa.input_refs[] | stringValfritt / objekt |
|
rows[].metrics.attributed_roas | objectObligatoriskt i överordnat objekt |
|
rows[].metrics.attributed_roas.value | string | nullObligatoriskt i överordnat objekt | — |
rows[].metrics.attributed_roas.valueanyOf 1 | stringObligatoriskt i överordnat objekt |
|
rows[].metrics.attributed_roas.valueanyOf 2 | nullObligatoriskt i överordnat objekt | — |
rows[].metrics.attributed_roas.unit | stringObligatoriskt i överordnat objekt |
|
rows[].metrics.attributed_roas.availability | stringObligatoriskt i överordnat objekt |
|
rows[].metrics.attributed_roas.reason | string | nullObligatoriskt i överordnat objekt | — |
rows[].metrics.attributed_roas.reasonanyOf 1 | stringObligatoriskt i överordnat objekt |
|
rows[].metrics.attributed_roas.reasonanyOf 2 | nullObligatoriskt i överordnat objekt | — |
rows[].metrics.attributed_roas.input_refs | arrayObligatoriskt i överordnat objekt |
|
rows[].metrics.attributed_roas.input_refs[] | stringValfritt / objekt |
|
totals | objectObligatoriskt i överordnat objekt |
|
totals.spend | objectObligatoriskt i överordnat objekt |
|
totals.spend.value | string | nullObligatoriskt i överordnat objekt | — |
totals.spend.valueanyOf 1 | stringObligatoriskt i överordnat objekt |
|
totals.spend.valueanyOf 2 | nullObligatoriskt i överordnat objekt | — |
totals.spend.unit | stringObligatoriskt i överordnat objekt |
|
totals.spend.availability | stringObligatoriskt i överordnat objekt |
|
totals.spend.reason | string | nullObligatoriskt i överordnat objekt | — |
totals.spend.reasonanyOf 1 | stringObligatoriskt i överordnat objekt |
|
totals.spend.reasonanyOf 2 | nullObligatoriskt i överordnat objekt | — |
totals.spend.input_refs | arrayObligatoriskt i överordnat objekt |
|
totals.spend.input_refs[] | stringValfritt / objekt |
|
totals.clicks | objectObligatoriskt i överordnat objekt |
|
totals.clicks.value | string | nullObligatoriskt i överordnat objekt | — |
totals.clicks.valueanyOf 1 | stringObligatoriskt i överordnat objekt |
|
totals.clicks.valueanyOf 2 | nullObligatoriskt i överordnat objekt | — |
totals.clicks.unit | stringObligatoriskt i överordnat objekt |
|
totals.clicks.availability | stringObligatoriskt i överordnat objekt |
|
totals.clicks.reason | string | nullObligatoriskt i överordnat objekt | — |
totals.clicks.reasonanyOf 1 | stringObligatoriskt i överordnat objekt |
|
totals.clicks.reasonanyOf 2 | nullObligatoriskt i överordnat objekt | — |
totals.clicks.input_refs | arrayObligatoriskt i överordnat objekt |
|
totals.clicks.input_refs[] | stringValfritt / objekt |
|
totals.conversions | objectObligatoriskt i överordnat objekt |
|
totals.conversions.value | string | nullObligatoriskt i överordnat objekt | — |
totals.conversions.valueanyOf 1 | stringObligatoriskt i överordnat objekt |
|
totals.conversions.valueanyOf 2 | nullObligatoriskt i överordnat objekt | — |
totals.conversions.unit | stringObligatoriskt i överordnat objekt |
|
totals.conversions.availability | stringObligatoriskt i överordnat objekt |
|
totals.conversions.reason | string | nullObligatoriskt i överordnat objekt | — |
totals.conversions.reasonanyOf 1 | stringObligatoriskt i överordnat objekt |
|
totals.conversions.reasonanyOf 2 | nullObligatoriskt i överordnat objekt | — |
totals.conversions.input_refs | arrayObligatoriskt i överordnat objekt |
|
totals.conversions.input_refs[] | stringValfritt / objekt |
|
totals.attributed_revenue | objectObligatoriskt i överordnat objekt |
|
totals.attributed_revenue.value | string | nullObligatoriskt i överordnat objekt | — |
totals.attributed_revenue.valueanyOf 1 | stringObligatoriskt i överordnat objekt |
|
totals.attributed_revenue.valueanyOf 2 | nullObligatoriskt i överordnat objekt | — |
totals.attributed_revenue.unit | stringObligatoriskt i överordnat objekt |
|
totals.attributed_revenue.availability | stringObligatoriskt i överordnat objekt |
|
totals.attributed_revenue.reason | string | nullObligatoriskt i överordnat objekt | — |
totals.attributed_revenue.reasonanyOf 1 | stringObligatoriskt i överordnat objekt |
|
totals.attributed_revenue.reasonanyOf 2 | nullObligatoriskt i överordnat objekt | — |
totals.attributed_revenue.input_refs | arrayObligatoriskt i överordnat objekt |
|
totals.attributed_revenue.input_refs[] | stringValfritt / objekt |
|
totals.cpc | objectObligatoriskt i överordnat objekt |
|
totals.cpc.value | string | nullObligatoriskt i överordnat objekt | — |
totals.cpc.valueanyOf 1 | stringObligatoriskt i överordnat objekt |
|
totals.cpc.valueanyOf 2 | nullObligatoriskt i överordnat objekt | — |
totals.cpc.unit | stringObligatoriskt i överordnat objekt |
|
totals.cpc.availability | stringObligatoriskt i överordnat objekt |
|
totals.cpc.reason | string | nullObligatoriskt i överordnat objekt | — |
totals.cpc.reasonanyOf 1 | stringObligatoriskt i överordnat objekt |
|
totals.cpc.reasonanyOf 2 | nullObligatoriskt i överordnat objekt | — |
totals.cpc.input_refs | arrayObligatoriskt i överordnat objekt |
|
totals.cpc.input_refs[] | stringValfritt / objekt |
|
totals.cpa | objectObligatoriskt i överordnat objekt |
|
totals.cpa.value | string | nullObligatoriskt i överordnat objekt | — |
totals.cpa.valueanyOf 1 | stringObligatoriskt i överordnat objekt |
|
totals.cpa.valueanyOf 2 | nullObligatoriskt i överordnat objekt | — |
totals.cpa.unit | stringObligatoriskt i överordnat objekt |
|
totals.cpa.availability | stringObligatoriskt i överordnat objekt |
|
totals.cpa.reason | string | nullObligatoriskt i överordnat objekt | — |
totals.cpa.reasonanyOf 1 | stringObligatoriskt i överordnat objekt |
|
totals.cpa.reasonanyOf 2 | nullObligatoriskt i överordnat objekt | — |
totals.cpa.input_refs | arrayObligatoriskt i överordnat objekt |
|
totals.cpa.input_refs[] | stringValfritt / objekt |
|
totals.attributed_roas | objectObligatoriskt i överordnat objekt |
|
totals.attributed_roas.value | string | nullObligatoriskt i överordnat objekt | — |
totals.attributed_roas.valueanyOf 1 | stringObligatoriskt i överordnat objekt |
|
totals.attributed_roas.valueanyOf 2 | nullObligatoriskt i överordnat objekt | — |
totals.attributed_roas.unit | stringObligatoriskt i överordnat objekt |
|
totals.attributed_roas.availability | stringObligatoriskt i överordnat objekt |
|
totals.attributed_roas.reason | string | nullObligatoriskt i överordnat objekt | — |
totals.attributed_roas.reasonanyOf 1 | stringObligatoriskt i överordnat objekt |
|
totals.attributed_roas.reasonanyOf 2 | nullObligatoriskt i överordnat objekt | — |
totals.attributed_roas.input_refs | arrayObligatoriskt i överordnat objekt |
|
totals.attributed_roas.input_refs[] | stringValfritt / objekt |
|
gaps | arrayObligatoriskt i överordnat objekt |
|
gaps[] | stringValfritt / objekt |
|
suggestions | arrayObligatoriskt i överordnat objekt |
|
suggestions[] | objectValfritt / objekt |
|
suggestions[].rule_id | stringObligatoriskt i överordnat objekt |
|
suggestions[].rule_version | numberObligatoriskt i överordnat objekt |
|
suggestions[].proposal | stringObligatoriskt i överordnat objekt |
|
suggestions[].input_refs | arrayObligatoriskt i överordnat objekt |
|
suggestions[].input_refs[] | stringValfritt / objekt |
|
suggestions[].limitations | stringObligatoriskt i överordnat objekt |
|
Fullständigt JSON Schema
{
"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
}Exempel på verktygsanrop
Exemplen använder fiktiva värden som kontrollerats mot schemana. Ersätt ID:n med sådana du får använda, medier med färdiga mediefiler och datum med din bekräftade publiceringstid. Kontrollera kontots behörighet före en skrivning. Denna sida skickar inga API-anrop.
{
"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": []
}