Hirdetések
Hirdetési statisztikák lekérdezése
Kifejezett dátumokkal, időzónával, pénznemmel, attribúciós időablakkal és konverziós művelettel kérj le korlátozott hivatalos fizetett hirdetési eredményeket. A hiányzó mérőszámok hiányzók maradnak.
POST /advertising-api/insights/querySzerződés ellenőrizve: · sha256:9aedef8d43dd4514
Áttekintés
Kifejezett dátumokkal, időzónával, pénznemmel, attribúciós időablakkal és konverziós művelettel kérj le korlátozott hivatalos fizetett hirdetési eredményeket. A hiányzó mérőszámok hiányzók maradnak.
A sikeres HTTP-válasz jelentheti a kérés elfogadását, nem a befejezését. Háttérmunkánál mentsd a visszakapott azonosítót, és ugyanazt a műveletet ellenőrizd a befejezésig. Az időzített vagy elfogadott bejegyzés csak platformmegerősítés után közzétett; a kliens időtúllépése nem igazolja az eredményt.
Hitelesítés és engedélyek
A token csak a tulajdonosa jogait használhatja. Minden kérés ellenőrzi a munkaterületi tagságot, erőforrás-tulajdonjogot, kiválasztott munkaterületeket és megadott képességeket. A core és full profil a megjelenített eszközöket változtatja; hozzáférést nem ad.
Kérésmezők
A kötelező jelölés a szülőobjektumon és a kiválasztott ágon belül érvényes. A kötelező gyermek nem teszi kötelezővé az opcionális szülőt. Az alábbi szabályok és mezőnevek a szerződésből származnak.
| Mező / ág | Típus / kötelező | Korlátok |
|---|---|---|
$ | objectA szülőn belül kötelező |
|
workspace_id | stringA szülőn belül kötelező |
|
advertising_account_id | stringA szülőn belül kötelező |
|
level | stringA szülőn belül kötelező |
|
start_date | stringA szülőn belül kötelező |
|
end_date | stringA szülőn belül kötelező |
|
action_attribution_windows | arrayA szülőn belül kötelező |
|
action_attribution_windows[] | stringOpcionális / elem |
|
action_report_time | stringA szülőn belül kötelező |
|
conversion_action_type | stringA szülőn belül kötelező |
|
revenue_action_type | stringA szülőn belül kötelező |
|
after | stringOpcionális / elem |
|
limit | integerOpcionális / elem |
|
Teljes JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"advertising_account_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"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}$"
},
"after": {
"type": "string",
"maxLength": 2048
},
"limit": {
"default": 25,
"type": "integer",
"minimum": 1,
"maximum": 50
}
},
"required": [
"workspace_id",
"advertising_account_id",
"level",
"start_date",
"end_date",
"action_attribution_windows",
"action_report_time",
"conversion_action_type",
"revenue_action_type"
],
"additionalProperties": false
}Válasz és befejezés
Sikeres HTTP-állapotok: 200. A művelet befejezésekor: synchronous_http_response.
A sikeres HTTP-válasz jelentheti a kérés elfogadását, nem a befejezését. Háttérmunkánál mentsd a visszakapott azonosítót, és ugyanazt a műveletet ellenőrizd a befejezésig. Az időzített vagy elfogadott bejegyzés csak platformmegerősítés után közzétett; a kliens időtúllépése nem igazolja az eredményt.
A kötelező jelölés a szülőobjektumon és a kiválasztott ágon belül érvényes. A kötelező gyermek nem teszi kötelezővé az opcionális szülőt. Az alábbi szabályok és mezőnevek a szerződésből származnak.
| Mező / ág | Típus / kötelező | Korlátok |
|---|---|---|
$ | objectA szülőn belül kötelező | — |
contract_version | stringA szülőn belül kötelező |
|
source_id | stringA szülőn belül kötelező |
|
source_sha256 | stringA szülőn belül kötelező |
|
identity_verification | stringA szülőn belül kötelező |
|
currency | stringA szülőn belül kötelező |
|
timezone | stringA szülőn belül kötelező |
|
selection | objectA szülőn belül kötelező | — |
selection.provider_api_version | stringA szülőn belül kötelező |
|
selection.provider_account_id | stringA szülőn belül kötelező |
|
selection.currency | stringA szülőn belül kötelező |
|
selection.timezone | stringA szülőn belül kötelező |
|
selection.level | stringA szülőn belül kötelező |
|
selection.start_date | stringA szülőn belül kötelező |
|
selection.end_date | stringA szülőn belül kötelező |
|
selection.action_attribution_windows | arrayA szülőn belül kötelező |
|
selection.action_attribution_windows[] | stringOpcionális / elem |
|
selection.action_report_time | stringA szülőn belül kötelező |
|
selection.conversion_action_type | stringA szülőn belül kötelező |
|
selection.revenue_action_type | stringA szülőn belül kötelező |
|
complete | booleanA szülőn belül kötelező | — |
rows | arrayA szülőn belül kötelező |
|
rows[] | objectOpcionális / elem | — |
rows[].row_id | stringA szülőn belül kötelező |
|
rows[].metrics | objectA szülőn belül kötelező | — |
rows[].metrics.spend | objectA szülőn belül kötelező | — |
rows[].metrics.spend.value | string | nullA szülőn belül kötelező | — |
rows[].metrics.spend.valueanyOf 1 | stringA szülőn belül kötelező |
|
rows[].metrics.spend.valueanyOf 2 | nullA szülőn belül kötelező | — |
rows[].metrics.spend.unit | stringA szülőn belül kötelező |
|
rows[].metrics.spend.availability | stringA szülőn belül kötelező |
|
rows[].metrics.spend.reason | string | nullA szülőn belül kötelező | — |
rows[].metrics.spend.reasonanyOf 1 | stringA szülőn belül kötelező |
|
rows[].metrics.spend.reasonanyOf 2 | nullA szülőn belül kötelező | — |
rows[].metrics.spend.input_refs | arrayA szülőn belül kötelező |
|
rows[].metrics.spend.input_refs[] | stringOpcionális / elem |
|
rows[].metrics.clicks | objectA szülőn belül kötelező | — |
rows[].metrics.clicks.value | string | nullA szülőn belül kötelező | — |
rows[].metrics.clicks.valueanyOf 1 | stringA szülőn belül kötelező |
|
rows[].metrics.clicks.valueanyOf 2 | nullA szülőn belül kötelező | — |
rows[].metrics.clicks.unit | stringA szülőn belül kötelező |
|
rows[].metrics.clicks.availability | stringA szülőn belül kötelező |
|
rows[].metrics.clicks.reason | string | nullA szülőn belül kötelező | — |
rows[].metrics.clicks.reasonanyOf 1 | stringA szülőn belül kötelező |
|
rows[].metrics.clicks.reasonanyOf 2 | nullA szülőn belül kötelező | — |
rows[].metrics.clicks.input_refs | arrayA szülőn belül kötelező |
|
rows[].metrics.clicks.input_refs[] | stringOpcionális / elem |
|
rows[].metrics.conversions | objectA szülőn belül kötelező | — |
rows[].metrics.conversions.value | string | nullA szülőn belül kötelező | — |
rows[].metrics.conversions.valueanyOf 1 | stringA szülőn belül kötelező |
|
rows[].metrics.conversions.valueanyOf 2 | nullA szülőn belül kötelező | — |
rows[].metrics.conversions.unit | stringA szülőn belül kötelező |
|
rows[].metrics.conversions.availability | stringA szülőn belül kötelező |
|
rows[].metrics.conversions.reason | string | nullA szülőn belül kötelező | — |
rows[].metrics.conversions.reasonanyOf 1 | stringA szülőn belül kötelező |
|
rows[].metrics.conversions.reasonanyOf 2 | nullA szülőn belül kötelező | — |
rows[].metrics.conversions.input_refs | arrayA szülőn belül kötelező |
|
rows[].metrics.conversions.input_refs[] | stringOpcionális / elem |
|
rows[].metrics.attributed_revenue | objectA szülőn belül kötelező | — |
rows[].metrics.attributed_revenue.value | string | nullA szülőn belül kötelező | — |
rows[].metrics.attributed_revenue.valueanyOf 1 | stringA szülőn belül kötelező |
|
rows[].metrics.attributed_revenue.valueanyOf 2 | nullA szülőn belül kötelező | — |
rows[].metrics.attributed_revenue.unit | stringA szülőn belül kötelező |
|
rows[].metrics.attributed_revenue.availability | stringA szülőn belül kötelező |
|
rows[].metrics.attributed_revenue.reason | string | nullA szülőn belül kötelező | — |
rows[].metrics.attributed_revenue.reasonanyOf 1 | stringA szülőn belül kötelező |
|
rows[].metrics.attributed_revenue.reasonanyOf 2 | nullA szülőn belül kötelező | — |
rows[].metrics.attributed_revenue.input_refs | arrayA szülőn belül kötelező |
|
rows[].metrics.attributed_revenue.input_refs[] | stringOpcionális / elem |
|
rows[].metrics.cpc | objectA szülőn belül kötelező | — |
rows[].metrics.cpc.value | string | nullA szülőn belül kötelező | — |
rows[].metrics.cpc.valueanyOf 1 | stringA szülőn belül kötelező |
|
rows[].metrics.cpc.valueanyOf 2 | nullA szülőn belül kötelező | — |
rows[].metrics.cpc.unit | stringA szülőn belül kötelező |
|
rows[].metrics.cpc.availability | stringA szülőn belül kötelező |
|
rows[].metrics.cpc.reason | string | nullA szülőn belül kötelező | — |
rows[].metrics.cpc.reasonanyOf 1 | stringA szülőn belül kötelező |
|
rows[].metrics.cpc.reasonanyOf 2 | nullA szülőn belül kötelező | — |
rows[].metrics.cpc.input_refs | arrayA szülőn belül kötelező |
|
rows[].metrics.cpc.input_refs[] | stringOpcionális / elem |
|
rows[].metrics.cpa | objectA szülőn belül kötelező | — |
rows[].metrics.cpa.value | string | nullA szülőn belül kötelező | — |
rows[].metrics.cpa.valueanyOf 1 | stringA szülőn belül kötelező |
|
rows[].metrics.cpa.valueanyOf 2 | nullA szülőn belül kötelező | — |
rows[].metrics.cpa.unit | stringA szülőn belül kötelező |
|
rows[].metrics.cpa.availability | stringA szülőn belül kötelező |
|
rows[].metrics.cpa.reason | string | nullA szülőn belül kötelező | — |
rows[].metrics.cpa.reasonanyOf 1 | stringA szülőn belül kötelező |
|
rows[].metrics.cpa.reasonanyOf 2 | nullA szülőn belül kötelező | — |
rows[].metrics.cpa.input_refs | arrayA szülőn belül kötelező |
|
rows[].metrics.cpa.input_refs[] | stringOpcionális / elem |
|
rows[].metrics.attributed_roas | objectA szülőn belül kötelező | — |
rows[].metrics.attributed_roas.value | string | nullA szülőn belül kötelező | — |
rows[].metrics.attributed_roas.valueanyOf 1 | stringA szülőn belül kötelező |
|
rows[].metrics.attributed_roas.valueanyOf 2 | nullA szülőn belül kötelező | — |
rows[].metrics.attributed_roas.unit | stringA szülőn belül kötelező |
|
rows[].metrics.attributed_roas.availability | stringA szülőn belül kötelező |
|
rows[].metrics.attributed_roas.reason | string | nullA szülőn belül kötelező | — |
rows[].metrics.attributed_roas.reasonanyOf 1 | stringA szülőn belül kötelező |
|
rows[].metrics.attributed_roas.reasonanyOf 2 | nullA szülőn belül kötelező | — |
rows[].metrics.attributed_roas.input_refs | arrayA szülőn belül kötelező |
|
rows[].metrics.attributed_roas.input_refs[] | stringOpcionális / elem |
|
totals | objectA szülőn belül kötelező | — |
totals.spend | objectA szülőn belül kötelező | — |
totals.spend.value | string | nullA szülőn belül kötelező | — |
totals.spend.valueanyOf 1 | stringA szülőn belül kötelező |
|
totals.spend.valueanyOf 2 | nullA szülőn belül kötelező | — |
totals.spend.unit | stringA szülőn belül kötelező |
|
totals.spend.availability | stringA szülőn belül kötelező |
|
totals.spend.reason | string | nullA szülőn belül kötelező | — |
totals.spend.reasonanyOf 1 | stringA szülőn belül kötelező |
|
totals.spend.reasonanyOf 2 | nullA szülőn belül kötelező | — |
totals.spend.input_refs | arrayA szülőn belül kötelező |
|
totals.spend.input_refs[] | stringOpcionális / elem |
|
totals.clicks | objectA szülőn belül kötelező | — |
totals.clicks.value | string | nullA szülőn belül kötelező | — |
totals.clicks.valueanyOf 1 | stringA szülőn belül kötelező |
|
totals.clicks.valueanyOf 2 | nullA szülőn belül kötelező | — |
totals.clicks.unit | stringA szülőn belül kötelező |
|
totals.clicks.availability | stringA szülőn belül kötelező |
|
totals.clicks.reason | string | nullA szülőn belül kötelező | — |
totals.clicks.reasonanyOf 1 | stringA szülőn belül kötelező |
|
totals.clicks.reasonanyOf 2 | nullA szülőn belül kötelező | — |
totals.clicks.input_refs | arrayA szülőn belül kötelező |
|
totals.clicks.input_refs[] | stringOpcionális / elem |
|
totals.conversions | objectA szülőn belül kötelező | — |
totals.conversions.value | string | nullA szülőn belül kötelező | — |
totals.conversions.valueanyOf 1 | stringA szülőn belül kötelező |
|
totals.conversions.valueanyOf 2 | nullA szülőn belül kötelező | — |
totals.conversions.unit | stringA szülőn belül kötelező |
|
totals.conversions.availability | stringA szülőn belül kötelező |
|
totals.conversions.reason | string | nullA szülőn belül kötelező | — |
totals.conversions.reasonanyOf 1 | stringA szülőn belül kötelező |
|
totals.conversions.reasonanyOf 2 | nullA szülőn belül kötelező | — |
totals.conversions.input_refs | arrayA szülőn belül kötelező |
|
totals.conversions.input_refs[] | stringOpcionális / elem |
|
totals.attributed_revenue | objectA szülőn belül kötelező | — |
totals.attributed_revenue.value | string | nullA szülőn belül kötelező | — |
totals.attributed_revenue.valueanyOf 1 | stringA szülőn belül kötelező |
|
totals.attributed_revenue.valueanyOf 2 | nullA szülőn belül kötelező | — |
totals.attributed_revenue.unit | stringA szülőn belül kötelező |
|
totals.attributed_revenue.availability | stringA szülőn belül kötelező |
|
totals.attributed_revenue.reason | string | nullA szülőn belül kötelező | — |
totals.attributed_revenue.reasonanyOf 1 | stringA szülőn belül kötelező |
|
totals.attributed_revenue.reasonanyOf 2 | nullA szülőn belül kötelező | — |
totals.attributed_revenue.input_refs | arrayA szülőn belül kötelező |
|
totals.attributed_revenue.input_refs[] | stringOpcionális / elem |
|
totals.cpc | objectA szülőn belül kötelező | — |
totals.cpc.value | string | nullA szülőn belül kötelező | — |
totals.cpc.valueanyOf 1 | stringA szülőn belül kötelező |
|
totals.cpc.valueanyOf 2 | nullA szülőn belül kötelező | — |
totals.cpc.unit | stringA szülőn belül kötelező |
|
totals.cpc.availability | stringA szülőn belül kötelező |
|
totals.cpc.reason | string | nullA szülőn belül kötelező | — |
totals.cpc.reasonanyOf 1 | stringA szülőn belül kötelező |
|
totals.cpc.reasonanyOf 2 | nullA szülőn belül kötelező | — |
totals.cpc.input_refs | arrayA szülőn belül kötelező |
|
totals.cpc.input_refs[] | stringOpcionális / elem |
|
totals.cpa | objectA szülőn belül kötelező | — |
totals.cpa.value | string | nullA szülőn belül kötelező | — |
totals.cpa.valueanyOf 1 | stringA szülőn belül kötelező |
|
totals.cpa.valueanyOf 2 | nullA szülőn belül kötelező | — |
totals.cpa.unit | stringA szülőn belül kötelező |
|
totals.cpa.availability | stringA szülőn belül kötelező |
|
totals.cpa.reason | string | nullA szülőn belül kötelező | — |
totals.cpa.reasonanyOf 1 | stringA szülőn belül kötelező |
|
totals.cpa.reasonanyOf 2 | nullA szülőn belül kötelező | — |
totals.cpa.input_refs | arrayA szülőn belül kötelező |
|
totals.cpa.input_refs[] | stringOpcionális / elem |
|
totals.attributed_roas | objectA szülőn belül kötelező | — |
totals.attributed_roas.value | string | nullA szülőn belül kötelező | — |
totals.attributed_roas.valueanyOf 1 | stringA szülőn belül kötelező |
|
totals.attributed_roas.valueanyOf 2 | nullA szülőn belül kötelező | — |
totals.attributed_roas.unit | stringA szülőn belül kötelező |
|
totals.attributed_roas.availability | stringA szülőn belül kötelező |
|
totals.attributed_roas.reason | string | nullA szülőn belül kötelező | — |
totals.attributed_roas.reasonanyOf 1 | stringA szülőn belül kötelező |
|
totals.attributed_roas.reasonanyOf 2 | nullA szülőn belül kötelező | — |
totals.attributed_roas.input_refs | arrayA szülőn belül kötelező |
|
totals.attributed_roas.input_refs[] | stringOpcionális / elem |
|
gaps | arrayA szülőn belül kötelező |
|
gaps[] | stringOpcionális / elem |
|
suggestions | arrayA szülőn belül kötelező |
|
suggestions[] | objectOpcionális / elem | — |
suggestions[].rule_id | stringA szülőn belül kötelező |
|
suggestions[].rule_version | numberA szülőn belül kötelező |
|
suggestions[].proposal | stringA szülőn belül kötelező |
|
suggestions[].input_refs | arrayA szülőn belül kötelező |
|
suggestions[].input_refs[] | stringOpcionális / elem |
|
suggestions[].limitations | stringA szülőn belül kötelező |
|
advertising_account_id | stringA szülőn belül kötelező |
|
next_cursor | string | nullA szülőn belül kötelező | — |
next_cursoranyOf 1 | stringA szülőn belül kötelező |
|
next_cursoranyOf 2 | nullA szülőn belül kötelező | — |
Teljes 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"
]
}
},
"advertising_account_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"next_cursor": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
]
}
},
"required": [
"contract_version",
"source_id",
"source_sha256",
"identity_verification",
"currency",
"timezone",
"selection",
"complete",
"rows",
"totals",
"gaps",
"suggestions",
"advertising_account_id",
"next_cursor"
]
}Hibák és biztonságos újrapróbálás
Ellenőrizd a HTTP-állapotot és a válasz törzsét. A 400 ellenőrzési hiba ZodError értéket tartalmazhat; a kezelőhibák az error, message és code mezőket használják. Őrizd meg a request_id vagy x-request-id értéket a diagnózishoz, hitelesítő adatok nélkül. Újrapróbálás előtt javítsd a 401/403 hozzáférési hibákat; 429 esetén kövesd a Retry-After értékét. Bizonytalan írás vagy 5xx válasz esetén előbb olvasd el a meglévő eredményt. Csak támogatott műveletnél használj újra idempotenciakulcsot; az újrapróbálás műveletenként eltér, és nem garantál pontosan egyszeri kézbesítést.
Hibaelhárítási útmutatóPéldák
A példák sémákkal ellenőrzött képzeletbeli értékeket használnak. Az azonosítókat engedélyezettekre, a médiát kész tartalomelemekre, a dátumokat megerősített közzétételi időpontra cseréld. Írás beküldése előtt ellenőrizd a fiók jogosultságát. Ez az oldal nem küld API-kérést.
A szervereden állítsd a SOSOAPI_ACCESS_TOKEN értékét a művelet által elfogadott hitelesítő adatra, és tartsd távol a böngészőkódtól. AI-ügynökhöz a sosoapi auth login paranccsal jelentkezz be böngészőben, és hagyd, hogy a CLI frissítse a hitelesítő adatokat.
request.json
{
"workspace_id": "11111111-1111-4111-8111-111111111111",
"advertising_account_id": "11111111-1111-4111-8111-111111111111",
"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"
}cURL
curl --request POST \
"https://gqeshlawtcexsapabaui.supabase.co/functions/v1/advertising-api/insights/query" \
-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/insights/query", {
method: "POST",
headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
body: JSON.stringify({
"workspace_id": "11111111-1111-4111-8111-111111111111",
"advertising_account_id": "11111111-1111-4111-8111-111111111111",
"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"
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.CLI
npx sosoapi api post /advertising-api/insights/query < request.jsonSzintetikus válaszpélda
{
"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": [],
"advertising_account_id": "11111111-1111-4111-8111-111111111111",
"next_cursor": null
}