Annonsering
Analyser annonseresultater
Analyser en avgrenset betalt annonserapport levert av kunden, med eksplisitt attribusjon og nøyaktig kildehash. Gir ingen leverandørtilgang eller påstand om årsaksbestemt lønnsomhet.
POST /advertising-api/performance/analyzeKontrakt gjennomgått: · sha256:9aedef8d43dd4514
Oversikt
Analyser en avgrenset betalt annonserapport levert av kunden, med eksplisitt attribusjon og nøyaktig kildehash. Gir ingen leverandørtilgang eller påstand om årsaksbestemt lønnsomhet.
Et vellykket HTTP-svar kan bety at en forespørsel er akseptert fremfor fullført. For bakgrunnsarbeid, lagre returnert ID og kontroller samme operasjon til den er ferdig. Et planlagt eller akseptert innlegg er først publisert når plattformen bekrefter det; et klienttidsavbrudd fastslår ikke resultatet.
Autentisering og tillatelser
Et token kan bare bruke rettighetene eieren har. Hver forespørsel kontrollerer arbeidsområdemedlemskap, ressurseierskap, valgte arbeidsområder og gitte funksjoner. Profilene core og full endrer hvilke verktøy som vises; de gir ikke tilgang.
Forespørselsfelter
Påkrevd betyr påkrevd i foreldreobjektet og valgt gren. Et påkrevd underfelt gjør ikke en valgfri forelder påkrevd. Reglene og feltnavnene nedenfor er kopiert fra kontrakten.
| Felt / gren | Type / påkrevd | Begrensninger |
|---|---|---|
$ | objectPåkrevd i forelder |
|
workspace_id | stringPåkrevd i forelder |
|
source_kind | stringPåkrevd i forelder |
|
source_id | stringPåkrevd i forelder |
|
provider_api_version | stringPåkrevd i forelder |
|
provider_account_id | stringPåkrevd i forelder |
|
currency | stringPåkrevd i forelder |
|
timezone | stringPåkrevd i forelder |
|
level | stringPåkrevd i forelder |
|
start_date | stringPåkrevd i forelder |
|
end_date | stringPåkrevd i forelder |
|
action_attribution_windows | arrayPåkrevd i forelder |
|
action_attribution_windows[] | stringValgfritt / element |
|
action_report_time | stringPåkrevd i forelder |
|
conversion_action_type | stringPåkrevd i forelder |
|
revenue_action_type | stringPåkrevd i forelder |
|
complete | booleanPåkrevd i forelder | — |
rows | arrayPåkrevd i forelder |
|
rows[] | objectValgfritt / element |
|
rows[].account_id | stringPåkrevd i forelder |
|
rows[].account_currency | stringPåkrevd i forelder |
|
rows[].campaign_id | stringPåkrevd i forelder |
|
rows[].campaign_name | stringValgfritt / element |
|
rows[].adset_id | stringValgfritt / element |
|
rows[].ad_id | stringValgfritt / element |
|
rows[].date_start | stringPåkrevd i forelder |
|
rows[].date_stop | stringPåkrevd i forelder |
|
rows[].spend | stringValgfritt / element |
|
rows[].clicks | stringValgfritt / element |
|
rows[].actions | arrayValgfritt / element |
|
rows[].actions[] | objectValgfritt / element |
|
rows[].actions[].action_type | stringPåkrevd i forelder |
|
rows[].actions[].value | stringValgfritt / element |
|
rows[].actions[].1d_click | stringValgfritt / element |
|
rows[].actions[].7d_click | stringValgfritt / element |
|
rows[].actions[].1d_view | stringValgfritt / element |
|
rows[].action_values | arrayValgfritt / element |
|
rows[].action_values[] | objectValgfritt / element |
|
rows[].action_values[].action_type | stringPåkrevd i forelder |
|
rows[].action_values[].value | stringValgfritt / element |
|
rows[].action_values[].1d_click | stringValgfritt / element |
|
rows[].action_values[].7d_click | stringValgfritt / element |
|
rows[].action_values[].1d_view | stringValgfritt / element |
|
Fullstendig JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"source_kind": {
"type": "string",
"enum": [
"customer_import",
"official_meta_api"
]
},
"source_id": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"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",
"minLength": 1,
"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",
"pattern": "^[a-z][a-z0-9_.]{0,99}$"
},
"revenue_action_type": {
"type": "string",
"pattern": "^[a-z][a-z0-9_.]{0,99}$"
},
"complete": {
"type": "boolean"
},
"rows": {
"maxItems": 500,
"type": "array",
"items": {
"type": "object",
"properties": {
"account_id": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
},
"account_currency": {
"type": "string",
"pattern": "^[A-Z]{3}$"
},
"campaign_id": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
},
"campaign_name": {
"type": "string",
"maxLength": 200
},
"adset_id": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
},
"ad_id": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
},
"date_start": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"date_stop": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"spend": {
"type": "string",
"pattern": "^\\d{1,12}(?:\\.\\d{1,6})?$"
},
"clicks": {
"type": "string",
"pattern": "^\\d{1,15}$"
},
"actions": {
"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
}
},
"action_values": {
"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
}
}
},
"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
}Svar og fullføring
HTTP-statuser ved suksess: 200. Når operasjonen er fullført: synchronous_http_response.
Et vellykket HTTP-svar kan bety at en forespørsel er akseptert fremfor fullført. For bakgrunnsarbeid, lagre returnert ID og kontroller samme operasjon til den er ferdig. Et planlagt eller akseptert innlegg er først publisert når plattformen bekrefter det; et klienttidsavbrudd fastslår ikke resultatet.
Påkrevd betyr påkrevd i foreldreobjektet og valgt gren. Et påkrevd underfelt gjør ikke en valgfri forelder påkrevd. Reglene og feltnavnene nedenfor er kopiert fra kontrakten.
| Felt / gren | Type / påkrevd | Begrensninger |
|---|---|---|
$ | objectPåkrevd i forelder | — |
contract_version | stringPåkrevd i forelder |
|
source_id | stringPåkrevd i forelder |
|
source_sha256 | stringPåkrevd i forelder |
|
identity_verification | stringPåkrevd i forelder |
|
currency | stringPåkrevd i forelder |
|
timezone | stringPåkrevd i forelder |
|
selection | objectPåkrevd i forelder | — |
selection.provider_api_version | stringPåkrevd i forelder |
|
selection.provider_account_id | stringPåkrevd i forelder |
|
selection.currency | stringPåkrevd i forelder |
|
selection.timezone | stringPåkrevd i forelder |
|
selection.level | stringPåkrevd i forelder |
|
selection.start_date | stringPåkrevd i forelder |
|
selection.end_date | stringPåkrevd i forelder |
|
selection.action_attribution_windows | arrayPåkrevd i forelder |
|
selection.action_attribution_windows[] | stringValgfritt / element |
|
selection.action_report_time | stringPåkrevd i forelder |
|
selection.conversion_action_type | stringPåkrevd i forelder |
|
selection.revenue_action_type | stringPåkrevd i forelder |
|
complete | booleanPåkrevd i forelder | — |
rows | arrayPåkrevd i forelder |
|
rows[] | objectValgfritt / element | — |
rows[].row_id | stringPåkrevd i forelder |
|
rows[].metrics | objectPåkrevd i forelder | — |
rows[].metrics.spend | objectPåkrevd i forelder | — |
rows[].metrics.spend.value | string | nullPåkrevd i forelder | — |
rows[].metrics.spend.valueanyOf 1 | stringPåkrevd i forelder |
|
rows[].metrics.spend.valueanyOf 2 | nullPåkrevd i forelder | — |
rows[].metrics.spend.unit | stringPåkrevd i forelder |
|
rows[].metrics.spend.availability | stringPåkrevd i forelder |
|
rows[].metrics.spend.reason | string | nullPåkrevd i forelder | — |
rows[].metrics.spend.reasonanyOf 1 | stringPåkrevd i forelder |
|
rows[].metrics.spend.reasonanyOf 2 | nullPåkrevd i forelder | — |
rows[].metrics.spend.input_refs | arrayPåkrevd i forelder |
|
rows[].metrics.spend.input_refs[] | stringValgfritt / element |
|
rows[].metrics.clicks | objectPåkrevd i forelder | — |
rows[].metrics.clicks.value | string | nullPåkrevd i forelder | — |
rows[].metrics.clicks.valueanyOf 1 | stringPåkrevd i forelder |
|
rows[].metrics.clicks.valueanyOf 2 | nullPåkrevd i forelder | — |
rows[].metrics.clicks.unit | stringPåkrevd i forelder |
|
rows[].metrics.clicks.availability | stringPåkrevd i forelder |
|
rows[].metrics.clicks.reason | string | nullPåkrevd i forelder | — |
rows[].metrics.clicks.reasonanyOf 1 | stringPåkrevd i forelder |
|
rows[].metrics.clicks.reasonanyOf 2 | nullPåkrevd i forelder | — |
rows[].metrics.clicks.input_refs | arrayPåkrevd i forelder |
|
rows[].metrics.clicks.input_refs[] | stringValgfritt / element |
|
rows[].metrics.conversions | objectPåkrevd i forelder | — |
rows[].metrics.conversions.value | string | nullPåkrevd i forelder | — |
rows[].metrics.conversions.valueanyOf 1 | stringPåkrevd i forelder |
|
rows[].metrics.conversions.valueanyOf 2 | nullPåkrevd i forelder | — |
rows[].metrics.conversions.unit | stringPåkrevd i forelder |
|
rows[].metrics.conversions.availability | stringPåkrevd i forelder |
|
rows[].metrics.conversions.reason | string | nullPåkrevd i forelder | — |
rows[].metrics.conversions.reasonanyOf 1 | stringPåkrevd i forelder |
|
rows[].metrics.conversions.reasonanyOf 2 | nullPåkrevd i forelder | — |
rows[].metrics.conversions.input_refs | arrayPåkrevd i forelder |
|
rows[].metrics.conversions.input_refs[] | stringValgfritt / element |
|
rows[].metrics.attributed_revenue | objectPåkrevd i forelder | — |
rows[].metrics.attributed_revenue.value | string | nullPåkrevd i forelder | — |
rows[].metrics.attributed_revenue.valueanyOf 1 | stringPåkrevd i forelder |
|
rows[].metrics.attributed_revenue.valueanyOf 2 | nullPåkrevd i forelder | — |
rows[].metrics.attributed_revenue.unit | stringPåkrevd i forelder |
|
rows[].metrics.attributed_revenue.availability | stringPåkrevd i forelder |
|
rows[].metrics.attributed_revenue.reason | string | nullPåkrevd i forelder | — |
rows[].metrics.attributed_revenue.reasonanyOf 1 | stringPåkrevd i forelder |
|
rows[].metrics.attributed_revenue.reasonanyOf 2 | nullPåkrevd i forelder | — |
rows[].metrics.attributed_revenue.input_refs | arrayPåkrevd i forelder |
|
rows[].metrics.attributed_revenue.input_refs[] | stringValgfritt / element |
|
rows[].metrics.cpc | objectPåkrevd i forelder | — |
rows[].metrics.cpc.value | string | nullPåkrevd i forelder | — |
rows[].metrics.cpc.valueanyOf 1 | stringPåkrevd i forelder |
|
rows[].metrics.cpc.valueanyOf 2 | nullPåkrevd i forelder | — |
rows[].metrics.cpc.unit | stringPåkrevd i forelder |
|
rows[].metrics.cpc.availability | stringPåkrevd i forelder |
|
rows[].metrics.cpc.reason | string | nullPåkrevd i forelder | — |
rows[].metrics.cpc.reasonanyOf 1 | stringPåkrevd i forelder |
|
rows[].metrics.cpc.reasonanyOf 2 | nullPåkrevd i forelder | — |
rows[].metrics.cpc.input_refs | arrayPåkrevd i forelder |
|
rows[].metrics.cpc.input_refs[] | stringValgfritt / element |
|
rows[].metrics.cpa | objectPåkrevd i forelder | — |
rows[].metrics.cpa.value | string | nullPåkrevd i forelder | — |
rows[].metrics.cpa.valueanyOf 1 | stringPåkrevd i forelder |
|
rows[].metrics.cpa.valueanyOf 2 | nullPåkrevd i forelder | — |
rows[].metrics.cpa.unit | stringPåkrevd i forelder |
|
rows[].metrics.cpa.availability | stringPåkrevd i forelder |
|
rows[].metrics.cpa.reason | string | nullPåkrevd i forelder | — |
rows[].metrics.cpa.reasonanyOf 1 | stringPåkrevd i forelder |
|
rows[].metrics.cpa.reasonanyOf 2 | nullPåkrevd i forelder | — |
rows[].metrics.cpa.input_refs | arrayPåkrevd i forelder |
|
rows[].metrics.cpa.input_refs[] | stringValgfritt / element |
|
rows[].metrics.attributed_roas | objectPåkrevd i forelder | — |
rows[].metrics.attributed_roas.value | string | nullPåkrevd i forelder | — |
rows[].metrics.attributed_roas.valueanyOf 1 | stringPåkrevd i forelder |
|
rows[].metrics.attributed_roas.valueanyOf 2 | nullPåkrevd i forelder | — |
rows[].metrics.attributed_roas.unit | stringPåkrevd i forelder |
|
rows[].metrics.attributed_roas.availability | stringPåkrevd i forelder |
|
rows[].metrics.attributed_roas.reason | string | nullPåkrevd i forelder | — |
rows[].metrics.attributed_roas.reasonanyOf 1 | stringPåkrevd i forelder |
|
rows[].metrics.attributed_roas.reasonanyOf 2 | nullPåkrevd i forelder | — |
rows[].metrics.attributed_roas.input_refs | arrayPåkrevd i forelder |
|
rows[].metrics.attributed_roas.input_refs[] | stringValgfritt / element |
|
totals | objectPåkrevd i forelder | — |
totals.spend | objectPåkrevd i forelder | — |
totals.spend.value | string | nullPåkrevd i forelder | — |
totals.spend.valueanyOf 1 | stringPåkrevd i forelder |
|
totals.spend.valueanyOf 2 | nullPåkrevd i forelder | — |
totals.spend.unit | stringPåkrevd i forelder |
|
totals.spend.availability | stringPåkrevd i forelder |
|
totals.spend.reason | string | nullPåkrevd i forelder | — |
totals.spend.reasonanyOf 1 | stringPåkrevd i forelder |
|
totals.spend.reasonanyOf 2 | nullPåkrevd i forelder | — |
totals.spend.input_refs | arrayPåkrevd i forelder |
|
totals.spend.input_refs[] | stringValgfritt / element |
|
totals.clicks | objectPåkrevd i forelder | — |
totals.clicks.value | string | nullPåkrevd i forelder | — |
totals.clicks.valueanyOf 1 | stringPåkrevd i forelder |
|
totals.clicks.valueanyOf 2 | nullPåkrevd i forelder | — |
totals.clicks.unit | stringPåkrevd i forelder |
|
totals.clicks.availability | stringPåkrevd i forelder |
|
totals.clicks.reason | string | nullPåkrevd i forelder | — |
totals.clicks.reasonanyOf 1 | stringPåkrevd i forelder |
|
totals.clicks.reasonanyOf 2 | nullPåkrevd i forelder | — |
totals.clicks.input_refs | arrayPåkrevd i forelder |
|
totals.clicks.input_refs[] | stringValgfritt / element |
|
totals.conversions | objectPåkrevd i forelder | — |
totals.conversions.value | string | nullPåkrevd i forelder | — |
totals.conversions.valueanyOf 1 | stringPåkrevd i forelder |
|
totals.conversions.valueanyOf 2 | nullPåkrevd i forelder | — |
totals.conversions.unit | stringPåkrevd i forelder |
|
totals.conversions.availability | stringPåkrevd i forelder |
|
totals.conversions.reason | string | nullPåkrevd i forelder | — |
totals.conversions.reasonanyOf 1 | stringPåkrevd i forelder |
|
totals.conversions.reasonanyOf 2 | nullPåkrevd i forelder | — |
totals.conversions.input_refs | arrayPåkrevd i forelder |
|
totals.conversions.input_refs[] | stringValgfritt / element |
|
totals.attributed_revenue | objectPåkrevd i forelder | — |
totals.attributed_revenue.value | string | nullPåkrevd i forelder | — |
totals.attributed_revenue.valueanyOf 1 | stringPåkrevd i forelder |
|
totals.attributed_revenue.valueanyOf 2 | nullPåkrevd i forelder | — |
totals.attributed_revenue.unit | stringPåkrevd i forelder |
|
totals.attributed_revenue.availability | stringPåkrevd i forelder |
|
totals.attributed_revenue.reason | string | nullPåkrevd i forelder | — |
totals.attributed_revenue.reasonanyOf 1 | stringPåkrevd i forelder |
|
totals.attributed_revenue.reasonanyOf 2 | nullPåkrevd i forelder | — |
totals.attributed_revenue.input_refs | arrayPåkrevd i forelder |
|
totals.attributed_revenue.input_refs[] | stringValgfritt / element |
|
totals.cpc | objectPåkrevd i forelder | — |
totals.cpc.value | string | nullPåkrevd i forelder | — |
totals.cpc.valueanyOf 1 | stringPåkrevd i forelder |
|
totals.cpc.valueanyOf 2 | nullPåkrevd i forelder | — |
totals.cpc.unit | stringPåkrevd i forelder |
|
totals.cpc.availability | stringPåkrevd i forelder |
|
totals.cpc.reason | string | nullPåkrevd i forelder | — |
totals.cpc.reasonanyOf 1 | stringPåkrevd i forelder |
|
totals.cpc.reasonanyOf 2 | nullPåkrevd i forelder | — |
totals.cpc.input_refs | arrayPåkrevd i forelder |
|
totals.cpc.input_refs[] | stringValgfritt / element |
|
totals.cpa | objectPåkrevd i forelder | — |
totals.cpa.value | string | nullPåkrevd i forelder | — |
totals.cpa.valueanyOf 1 | stringPåkrevd i forelder |
|
totals.cpa.valueanyOf 2 | nullPåkrevd i forelder | — |
totals.cpa.unit | stringPåkrevd i forelder |
|
totals.cpa.availability | stringPåkrevd i forelder |
|
totals.cpa.reason | string | nullPåkrevd i forelder | — |
totals.cpa.reasonanyOf 1 | stringPåkrevd i forelder |
|
totals.cpa.reasonanyOf 2 | nullPåkrevd i forelder | — |
totals.cpa.input_refs | arrayPåkrevd i forelder |
|
totals.cpa.input_refs[] | stringValgfritt / element |
|
totals.attributed_roas | objectPåkrevd i forelder | — |
totals.attributed_roas.value | string | nullPåkrevd i forelder | — |
totals.attributed_roas.valueanyOf 1 | stringPåkrevd i forelder |
|
totals.attributed_roas.valueanyOf 2 | nullPåkrevd i forelder | — |
totals.attributed_roas.unit | stringPåkrevd i forelder |
|
totals.attributed_roas.availability | stringPåkrevd i forelder |
|
totals.attributed_roas.reason | string | nullPåkrevd i forelder | — |
totals.attributed_roas.reasonanyOf 1 | stringPåkrevd i forelder |
|
totals.attributed_roas.reasonanyOf 2 | nullPåkrevd i forelder | — |
totals.attributed_roas.input_refs | arrayPåkrevd i forelder |
|
totals.attributed_roas.input_refs[] | stringValgfritt / element |
|
gaps | arrayPåkrevd i forelder |
|
gaps[] | stringValgfritt / element |
|
suggestions | arrayPåkrevd i forelder |
|
suggestions[] | objectValgfritt / element | — |
suggestions[].rule_id | stringPåkrevd i forelder |
|
suggestions[].rule_version | numberPåkrevd i forelder |
|
suggestions[].proposal | stringPåkrevd i forelder |
|
suggestions[].input_refs | arrayPåkrevd i forelder |
|
suggestions[].input_refs[] | stringValgfritt / element |
|
suggestions[].limitations | stringPåkrevd i forelder |
|
Fullstendig JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/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"
]
},
"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"
]
},
"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"
]
},
"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"
]
},
"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"
]
},
"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"
]
},
"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"
]
},
"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"
]
}
},
"required": [
"spend",
"clicks",
"conversions",
"attributed_revenue",
"cpc",
"cpa",
"attributed_roas"
]
}
},
"required": [
"row_id",
"metrics"
]
}
},
"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"
]
},
"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"
]
},
"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"
]
},
"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"
]
},
"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"
]
},
"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"
]
},
"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"
]
}
},
"required": [
"spend",
"clicks",
"conversions",
"attributed_revenue",
"cpc",
"cpa",
"attributed_roas"
]
},
"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"
]
}
}
},
"required": [
"contract_version",
"source_id",
"source_sha256",
"identity_verification",
"currency",
"timezone",
"selection",
"complete",
"rows",
"totals",
"gaps",
"suggestions"
]
}Feil og trygge nye forsøk
Kontroller HTTP-status og svarinnhold. En 400-valideringsfeil kan inneholde en ZodError; håndteringsfeil bruker feltene error, message og code. Behold request_id eller x-request-id for feilsøking, uten påloggingsopplysninger. Rett 401/403-tilgangsfeil før nye forsøk, og følg Retry-After ved 429. Hvis en skriveoperasjon er usikker eller returnerer 5xx, les det eksisterende resultatet først. Gjenbruk bare en idempotensnøkkel der det støttes; virkemåten ved nye forsøk varierer mellom operasjoner og garanterer ikke levering nøyaktig én gang.
FeilsøkingsveiledningEksempler
Disse eksemplene bruker fiktive verdier kontrollert mot skjemaene. Erstatt ID-ene med noen du har lov til å bruke, mediene med klare ressurser og datoene med bekreftet publiseringstidspunkt. Kontroller kontoens kvalifikasjon før en skriveoperasjon sendes inn. Siden sender ingen API-forespørsler.
Angi SOSOAPI_ACCESS_TOKEN på serveren din til legitimasjon som operasjonen godtar, og hold den unna nettleserkode. For en KI-agent, bruk sosoapi auth login for innlogging gjennom nettleseren, og la CLI-et fornye legitimasjonen.
request.json
{
"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": []
}cURL
curl --request POST \
"https://gqeshlawtcexsapabaui.supabase.co/functions/v1/advertising-api/performance/analyze" \
-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/performance/analyze", {
method: "POST",
headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
body: JSON.stringify({
"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": []
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.CLI
npx sosoapi api post /advertising-api/performance/analyze < request.jsonSyntetisk svareksempel
{
"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": []
}