Insertionorder data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
name | string | No | |
organization_id | string | No | |
campaign_id | string | No | |
status | enum | No | Values: UNSPECIFIED, ACTIVE, PAUSED, ARCHIVED, DRAFT, SCHEDULED_FOR_DELETION, PROCESSING, PROCESSING_FAILED |
pacing | object | No | |
pacing.period | enum | No | Values: UNSPECIFIED, DAILY, FLIGHT |
pacing.type | string | No | |
pacing.daily_max_amount | number | No | |
pacing.daily_max_impressions | number | No | |
frequency_cap | object | No | |
frequency_cap.is_unlimited | boolean | No | |
frequency_cap.time_unit | enum | No | Values: UNSPECIFIED, LIFETIME, MONTHS, WEEKS, DAYS, HOURS, MINUTES |
frequency_cap.time_unit_count | number | No | |
frequency_cap.max_impressions | number | No | |
frequency_cap.max_views | number | No | |
kpi | object | No | |
kpi.type | enum | No | Values: UNSPECIFIED, CPM, CPC, CPA, CTR, VIEWABILITY, CPIAVC, CPE, CPV, CLICK_CVR, IMPRESSION_CVR, VCPM, VTR, AUDIO_COMPLETION_RATE, VIDEO_COMPLETION_RATE, CPCL, CPCV, TOS10, MAXIMIZE_PACING, CUSTOM_IMPRESSION_VALUE_OVER_COST, OTHER |
kpi.amount | number | No | |
kpi.percentage | number | No | |
kpi.string_value | string | No | |
kpi.algorithm_id | string | No | |
budget_unit | enum | No | Values: UNSPECIFIED, CURRENCY, IMPRESSIONS |
budget_segments | AdsInsertionorderBudgetSegment[] | No | |
budget_segments[].budget_amount | number | No | |
budget_segments[].description | string | No | |
budget_segments[].start_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
budget_segments[].end_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
bid_strategy | object | No | YOUTUBE_AND_PARTNERS |
bid_strategy.type | enum | No | Values: FIXED_BID, MAXIMIZE_SPEND, PERFORMANCE_GOAL, YOUTUBE_AND_PARTNERS |
bid_strategy.fixed_bid_amount | number | No | |
bid_strategy.performance_goal_type | enum | No | Values: UNSPECIFIED, CPA, CPC, VIEWABLE_CPM, CUSTOM_ALGO, CIVA, IVO_TEN, AV_VIEWED, REACH |
bid_strategy.performance_goal_amount | number | No | |
bid_strategy.max_average_cpm_bid_amount | number | No | |
bid_strategy.custom_bidding_algorithm_id | string | No | |
bid_strategy.raise_bid_for_deals | boolean | No | |
bid_strategy.youtube_and_partners_type | enum | No | Values: UNSPECIFIED, MANUAL_CPV, MANUAL_CPM, TARGET_CPA, TARGET_CPM, RESERVE_CPM, MAXIMIZE_LIFT, MAXIMIZE_CONVERSIONS, TARGET_CPV, TARGET_ROAS, MAXIMIZE_CONVERSION_VALUE |
bid_strategy.youtube_and_partners_value | string | No | |
bid_strategy.target_roas | number | No | Target ROAS e.g. 2.5 = 250% (Google) |
reference | string | No | client's reference ID for the insertion order |
metadata | AdsMetadata[] | No | |
metadata[].id | string | No | |
metadata[].slug | string | No | |
metadata[].value | object | No | |
metadata[].namespace | string | No | |
metadata[].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
metadata[].extra_data | object | No |
Are we missing anything? Let us know
Was this page helpful?