Create a new campaign
import os
import ttd_workflows
from ttd_workflows import Workflows
from ttd_workflows.utils import parse_datetime
with Workflows(
ttd_auth=os.getenv("WORKFLOWS_TTD_AUTH", ""),
) as workflows:
res = workflows.campaign.create(request=ttd_workflows.CampaignCreateWorkflowInputWithValidation(
primary_input=ttd_workflows.CampaignCreateWorkflowPrimaryInput(
description="woot furthermore mentor",
campaign_group_id=86586,
time_zone="Europe/Ulyanovsk",
custom_cpa_click_weight=2561.01,
custom_cpa_viewthrough_weight=5604.35,
custom_cpa_type=ttd_workflows.CustomCPAType.CLICK_VIEWTHROUGH_WEIGHTING,
custom_roas_type=ttd_workflows.CustomROASType.DISABLED,
impressions_only_budgeting_cpm=1502.33,
end_date_in_utc=None,
seed_id=None,
campaign_conversion_reporting_columns=[
ttd_workflows.CampaignWorkflowCampaignConversionReportingColumnInput(
tracking_tag_id="<id>",
include_in_custom_cpa=False,
reporting_column_id=888649,
roas_config=ttd_workflows.CustomROASConfig(
include_in_custom_roas=False,
custom_roas_weight=4766.9,
custom_roas_click_weight=3310.24,
custom_roas_viewthrough_weight=2919.37,
),
product_list_reporting_type=ttd_workflows.ProductListReportingTypeInput.FEATURED,
weight=5369.43,
cross_device_attribution_model_id="<id>",
),
],
is_managed_by_ttd=None,
secondary_goal=ttd_workflows.CampaignWorkflowROIGoalInput(
maximize_reach=False,
maximize_ltv_incremental_reach=False,
cpc_in_advertiser_currency=4128.35,
ctr_in_percent=4434.91,
nielsen_otp_in_percent=7433.37,
cpa_in_advertiser_currency=None,
return_on_ad_spend_percent=2367.04,
vcr_in_percent=2333.15,
viewability_in_percent=5018.08,
vcpm_in_advertiser_currency=6070.6,
cpcv_in_advertiser_currency=None,
miaozhen_otp_in_percent=4324.01,
iqvia_audience_quality_index=True,
crossix_audience_quality_index=True,
iqvia_audience_quality_index_and_cost_per_target=False,
crossix_cost_per_target=True,
new_buyer_target_value=None,
),
tertiary_goal=ttd_workflows.CampaignWorkflowROIGoalInput(
maximize_reach=False,
maximize_ltv_incremental_reach=False,
cpc_in_advertiser_currency=7814.79,
ctr_in_percent=7849.85,
nielsen_otp_in_percent=None,
cpa_in_advertiser_currency=None,
return_on_ad_spend_percent=9519.81,
vcr_in_percent=6125.66,
viewability_in_percent=4766.9,
vcpm_in_advertiser_currency=3310.24,
cpcv_in_advertiser_currency=2919.37,
miaozhen_otp_in_percent=5369.43,
iqvia_audience_quality_index=False,
crossix_audience_quality_index=False,
iqvia_audience_quality_index_and_cost_per_target=None,
crossix_cost_per_target=False,
new_buyer_target_value=960101,
),
advertiser_id="<id>",
name="<value>",
custom_label_names=[
"<value 1>",
"<value 2>",
],
primary_channel=ttd_workflows.CampaignChannelType.DOOH,
primary_goal=ttd_workflows.CampaignWorkflowROIGoalInput(
maximize_reach=False,
maximize_ltv_incremental_reach=None,
cpc_in_advertiser_currency=6678.34,
ctr_in_percent=5357.4,
nielsen_otp_in_percent=2741.6,
cpa_in_advertiser_currency=4220.63,
return_on_ad_spend_percent=8572.83,
vcr_in_percent=8294.92,
viewability_in_percent=8592.21,
vcpm_in_advertiser_currency=8388.8,
cpcv_in_advertiser_currency=None,
miaozhen_otp_in_percent=3033.14,
iqvia_audience_quality_index=False,
crossix_audience_quality_index=True,
iqvia_audience_quality_index_and_cost_per_target=True,
crossix_cost_per_target=False,
new_buyer_target_value=412835,
),
start_date_in_utc=None,
budget=ttd_workflows.CampaignCreateWorkflowBudgetInput(
pacing_mode=ttd_workflows.CampaignPacingMode.PACE_AS_SOON_AS_POSSIBLE,
budget_in_advertiser_currency=6363.35,
budget_in_impressions=836518,
daily_target_in_advertiser_currency=7814.79,
daily_target_in_impressions=784985,
),
campaign_incremental_reach_setting=ttd_workflows.CampaignCreateWorkflowIncrementalReachCampaignSetting(
i_spot_reach_setting=ttd_workflows.IncrementalReachBrandInput(
id=787894,
name="<value>",
is_active=False,
),
realytics_reach_setting=ttd_workflows.RealyticsReachSettingInput(
id=859221,
name="<value>",
is_active=False,
products=None,
realytics_entertainment_input=ttd_workflows.RealyticsEntertainmentType.TVS,
),
tv_squared_reach_setting=ttd_workflows.IncrementalReachBrandInput(
id=303314,
name=None,
is_active=False,
),
samba_au_reach_setting=ttd_workflows.IncrementalReachBrandInput(
id=505888,
name="<value>",
is_active=True,
),
),
),
advanced_input=ttd_workflows.CampaignCreateWorkflowAdvancedInput(
purchase_order_number=None,
flights=[
ttd_workflows.CampaignWorkflowFlightInput(
start_date_inclusive_utc=parse_datetime("2024-07-08T10:52:56.944Z"),
end_date_exclusive_utc=parse_datetime("2023-05-12T16:41:56.386Z"),
budget_in_advertiser_currency=5904.11,
budget_in_impressions=None,
daily_target_in_advertiser_currency=6112.24,
daily_target_in_impressions=333131,
),
],
include_defaults_from_advertiser=False,
pass_through_fee_card=ttd_workflows.CampaignCreateWorkflowPassThroughFeeCardInput(
start_date_utc=parse_datetime("2023-03-18T04:39:08.387Z"),
pass_through_fees=[
ttd_workflows.CampaignCreatePassThroughFeesInput(
type=ttd_workflows.PassThroughFeeType.FEE_CPM,
description="fairly gah mortally freight since",
amount=2122.11,
),
],
),
caller_source="<value>",
frequency_configs=[
ttd_workflows.FrequencyConfig(
counter_name="<value>",
frequency_cap=743337,
frequency_goal=None,
reset_interval_in_minutes=520097,
),
],
),
ad_groups=[
ttd_workflows.CampaignCreateWorkflowAdGroupInput(
primary_input=ttd_workflows.AdGroupCreateWorkflowPrimaryInput(
is_enabled=False,
description="quash lightly rot bashfully slope",
budget=ttd_workflows.AdGroupWorkflowBudgetInput(
allocation_type=ttd_workflows.AllocationType.MINIMUM,
budget_in_advertiser_currency=4043.98,
budget_in_impressions=907414,
daily_target_in_advertiser_currency=49.95,
daily_target_in_impressions=62363,
),
base_bid_cpm_in_advertiser_currency=1136.89,
max_bid_cpm_in_advertiser_currency=6950.27,
audience_targeting=ttd_workflows.AdGroupWorkflowAudienceTargetingInput(
audience_id="<id>",
audience_accelerator_exclusions_enabled=False,
audience_booster_enabled=True,
audience_excluder_enabled=False,
audience_predictor_enabled=True,
cross_device_vendor_list_for_audience=[
458524,
284141,
],
recency_exclusion_window_in_minutes=982426,
target_trackable_users_enabled=False,
use_mc_id_as_primary=True,
),
roi_goal=ttd_workflows.AdGroupWorkflowROIGoalInput(
maximize_reach=None,
maximize_ltv_incremental_reach=True,
cpc_in_advertiser_currency=8782.74,
ctr_in_percent=None,
nielsen_otp_in_percent=7930.85,
cpa_in_advertiser_currency=4606.89,
return_on_ad_spend_percent=2522.83,
vcr_in_percent=5828.49,
viewability_in_percent=6824.44,
vcpm_in_advertiser_currency=7123.95,
cpcv_in_advertiser_currency=6233.72,
miaozhen_otp_in_percent=8437.22,
),
creative_ids=[
"<value 1>",
],
associated_bid_lists=[
ttd_workflows.AdGroupWorkflowAssociateBidListInput(
bid_list_id="<id>",
is_enabled=True,
is_default_for_dimension=False,
),
],
name="<value>",
channel=ttd_workflows.AdGroupChannel.NATIVE_VIDEO,
funnel_location=ttd_workflows.AdGroupFunnelLocation.NONE,
market_type=ttd_workflows.MarketTypeInput.OPEN_MARKET,
programmatic_guaranteed_private_contract_id="<id>",
include_defaults_from_campaign=True,
),
advanced_input=ttd_workflows.CampaignCreateWorkflowAdGroupAdvancedInput(
koa_optimization_settings=ttd_workflows.AdGroupWorkflowKoaOptimizationSettingsInput(
are_future_koa_features_enabled=True,
predictive_clearing_enabled=True,
),
comscore_settings=ttd_workflows.AdGroupWorkflowComscoreSettingsInput(
is_enabled=False,
population_id=523753,
demographic_member_ids=None,
mobile_demographic_member_ids=None,
),
contract_targeting=ttd_workflows.AdGroupWorkflowContractTargetingInput(
allow_open_market_bidding_when_targeting_contracts=True,
),
dimensional_bidding_auto_optimization_settings=[
[
ttd_workflows.DimensionalBiddingDimensions.HAS_FULL_REFERRER_URL,
],
[
ttd_workflows.DimensionalBiddingDimensions.HAS_PUBLISHER_ID,
],
],
is_use_clicks_as_conversions_enabled=None,
is_use_secondary_conversions_enabled=True,
nielsen_tracking_attributes=ttd_workflows.AdGroupWorkflowNielsenTrackingAttributesInput(
enhanced_reporting_option=ttd_workflows.EnhancedNielsenReportingOptionsInput.SITE,
gender=ttd_workflows.TargetingGenderInput.FEMALE,
start_age=ttd_workflows.TargetingStartAgeInput.THIRTY_FIVE,
end_age=ttd_workflows.TargetingEndAgeInput.FORTY_NINE,
countries=[],
),
new_frequency_configs=[
ttd_workflows.AdGroupWorkflowNewFrequencyConfigInput(
counter_name="<value>",
frequency_cap=391231,
frequency_goal=499235,
reset_interval_in_minutes=587736,
),
],
inventory_targeting=ttd_workflows.AdGroupWorkflowInventoryTargetingInput(
deal_group_ids_to_include=[
"<value 1>",
],
deal_group_ids_to_exclude=[
"<value 1>",
"<value 2>",
],
deal_ids_to_exclude=[
607060,
],
deal_ids_to_include=None,
include_default_on_deals=True,
),
is_non_decisioned=True,
include_defaults_from_campaign=False,
flights=[
ttd_workflows.CampaignCreateWorkflowAdGroupFlightInput(
allocation_type=ttd_workflows.AllocationType.FIXED,
budget_in_advertiser_currency=5340.32,
budget_in_impressions=492382,
daily_target_in_advertiser_currency=5622.5,
daily_target_in_impressions=398919,
),
],
),
),
],
validate_input_only=False,
))
assert res.campaign_payload is not None
# Handle response
print(res.campaign_payload)models.CreateCampaignResponse
| Error Type |
Status Code |
Content Type |
| models.ProblemDetailsError |
400, 403 |
application/json |
| models.APIError |
4XX, 5XX |
*/* |
Submit a job to create multiple new campaigns
import os
import ttd_workflows
from ttd_workflows import Workflows
from ttd_workflows.utils import parse_datetime
with Workflows(
ttd_auth=os.getenv("WORKFLOWS_TTD_AUTH", ""),
) as workflows:
res = workflows.campaign.create_campaigns_job(request={
"input": [
ttd_workflows.CampaignCreateWorkflowInput(
primary_input=ttd_workflows.CampaignCreateWorkflowPrimaryInput(
description=None,
campaign_group_id=657704,
time_zone="America/North_Dakota/Center",
custom_cpa_click_weight=9662.9,
custom_cpa_viewthrough_weight=3558.78,
custom_cpa_type=ttd_workflows.CustomCPAType.CLICK_VIEWTHROUGH_WEIGHTING,
custom_roas_type=ttd_workflows.CustomROASType.COMPOSITE_WEIGHTING,
impressions_only_budgeting_cpm=4427.56,
end_date_in_utc=parse_datetime("2023-12-21T01:12:20.772Z"),
seed_id="<id>",
campaign_conversion_reporting_columns=[
ttd_workflows.CampaignWorkflowCampaignConversionReportingColumnInput(
tracking_tag_id="<id>",
include_in_custom_cpa=False,
reporting_column_id=356532,
roas_config=ttd_workflows.CustomROASConfig(
include_in_custom_roas=False,
custom_roas_weight=1483.03,
custom_roas_click_weight=5286.76,
custom_roas_viewthrough_weight=8906.82,
),
product_list_reporting_type=ttd_workflows.ProductListReportingTypeInput.HALO,
weight=None,
cross_device_attribution_model_id="<id>",
),
],
is_managed_by_ttd=True,
secondary_goal=ttd_workflows.CampaignWorkflowROIGoalInput(
maximize_reach=True,
maximize_ltv_incremental_reach=False,
cpc_in_advertiser_currency=3558.78,
ctr_in_percent=2407.01,
nielsen_otp_in_percent=2349.25,
cpa_in_advertiser_currency=7778.32,
return_on_ad_spend_percent=6752.02,
vcr_in_percent=5019.36,
viewability_in_percent=5781.75,
vcpm_in_advertiser_currency=1696.34,
cpcv_in_advertiser_currency=5609.2,
miaozhen_otp_in_percent=5842.09,
iqvia_audience_quality_index=True,
crossix_audience_quality_index=False,
iqvia_audience_quality_index_and_cost_per_target=False,
crossix_cost_per_target=None,
new_buyer_target_value=38368,
),
tertiary_goal=ttd_workflows.CampaignWorkflowROIGoalInput(
maximize_reach=False,
maximize_ltv_incremental_reach=False,
cpc_in_advertiser_currency=6123.61,
ctr_in_percent=25.32,
nielsen_otp_in_percent=4889.32,
cpa_in_advertiser_currency=5258.8,
return_on_ad_spend_percent=2553.01,
vcr_in_percent=1142.91,
viewability_in_percent=1152.77,
vcpm_in_advertiser_currency=6711.38,
cpcv_in_advertiser_currency=4528.37,
miaozhen_otp_in_percent=9833.69,
iqvia_audience_quality_index=True,
crossix_audience_quality_index=False,
iqvia_audience_quality_index_and_cost_per_target=False,
crossix_cost_per_target=True,
new_buyer_target_value=373225,
),
advertiser_id="<id>",
name="<value>",
custom_label_names=[
"<value 1>",
"<value 2>",
"<value 3>",
],
primary_channel=ttd_workflows.CampaignChannelType.NATIVE_VIDEO,
primary_goal=ttd_workflows.CampaignWorkflowROIGoalInput(
maximize_reach=False,
maximize_ltv_incremental_reach=False,
cpc_in_advertiser_currency=25.32,
ctr_in_percent=4889.32,
nielsen_otp_in_percent=5258.8,
cpa_in_advertiser_currency=2553.01,
return_on_ad_spend_percent=1142.91,
vcr_in_percent=1152.77,
viewability_in_percent=6711.38,
vcpm_in_advertiser_currency=4528.37,
cpcv_in_advertiser_currency=9833.69,
miaozhen_otp_in_percent=1951.58,
iqvia_audience_quality_index=True,
crossix_audience_quality_index=None,
iqvia_audience_quality_index_and_cost_per_target=False,
crossix_cost_per_target=True,
new_buyer_target_value=355878,
),
start_date_in_utc=parse_datetime("2025-09-26T21:06:42.946Z"),
budget=ttd_workflows.CampaignCreateWorkflowBudgetInput(
pacing_mode=ttd_workflows.CampaignPacingMode.PACE_AHEAD,
budget_in_advertiser_currency=5501.96,
budget_in_impressions=629784,
daily_target_in_advertiser_currency=2524.41,
daily_target_in_impressions=726807,
),
campaign_incremental_reach_setting=ttd_workflows.CampaignCreateWorkflowIncrementalReachCampaignSetting(
i_spot_reach_setting=ttd_workflows.IncrementalReachBrandInput(
id=178346,
name="<value>",
is_active=True,
),
realytics_reach_setting=ttd_workflows.RealyticsReachSettingInput(
id=268786,
name="<value>",
is_active=False,
products=[
ttd_workflows.IncrementalReachProductInput(
id=106975,
name="<value>",
),
],
realytics_entertainment_input=ttd_workflows.RealyticsEntertainmentType.TVS,
),
tv_squared_reach_setting=ttd_workflows.IncrementalReachBrandInput(
id=772731,
name="<value>",
is_active=False,
),
samba_au_reach_setting=ttd_workflows.IncrementalReachBrandInput(
id=403863,
name=None,
is_active=True,
),
),
),
advanced_input=ttd_workflows.CampaignCreateWorkflowAdvancedInput(
purchase_order_number="<value>",
flights=[
ttd_workflows.CampaignWorkflowFlightInput(
start_date_inclusive_utc=parse_datetime("2024-09-20T06:04:19.345Z"),
end_date_exclusive_utc=parse_datetime("2024-01-18T07:43:56.299Z"),
budget_in_advertiser_currency=8219.9,
budget_in_impressions=76925,
daily_target_in_advertiser_currency=9309.03,
daily_target_in_impressions=152838,
),
],
include_defaults_from_advertiser=False,
pass_through_fee_card=ttd_workflows.CampaignCreateWorkflowPassThroughFeeCardInput(
start_date_utc=parse_datetime("2024-07-24T11:58:59.190Z"),
pass_through_fees=[
ttd_workflows.CampaignCreatePassThroughFeesInput(
type=ttd_workflows.PassThroughFeeType.DATA_COST_PERCENTAGE,
description="sweetly absent fortunately forenenst earnest who solidly wherever step-mother",
amount=2888.48,
),
],
),
caller_source="<value>",
frequency_configs=[
ttd_workflows.FrequencyConfig(
counter_name="<value>",
frequency_cap=234925,
frequency_goal=777832,
reset_interval_in_minutes=629784,
),
],
),
ad_groups=[
ttd_workflows.CampaignCreateWorkflowAdGroupInput(
primary_input=ttd_workflows.AdGroupCreateWorkflowPrimaryInput(
is_enabled=True,
description="scenario dish gracefully through tame yahoo pension husband as atop",
budget=ttd_workflows.AdGroupWorkflowBudgetInput(
allocation_type=ttd_workflows.AllocationType.MAXIMUM,
budget_in_advertiser_currency=2283.06,
budget_in_impressions=301691,
daily_target_in_advertiser_currency=9268.18,
daily_target_in_impressions=851470,
),
base_bid_cpm_in_advertiser_currency=694.78,
max_bid_cpm_in_advertiser_currency=6084.4,
audience_targeting=ttd_workflows.AdGroupWorkflowAudienceTargetingInput(
audience_id="<id>",
audience_accelerator_exclusions_enabled=True,
audience_booster_enabled=False,
audience_excluder_enabled=True,
audience_predictor_enabled=False,
cross_device_vendor_list_for_audience=[
497890,
566253,
],
recency_exclusion_window_in_minutes=742665,
target_trackable_users_enabled=True,
use_mc_id_as_primary=True,
),
roi_goal=ttd_workflows.AdGroupWorkflowROIGoalInput(
maximize_reach=False,
maximize_ltv_incremental_reach=True,
cpc_in_advertiser_currency=9062.02,
ctr_in_percent=7192.99,
nielsen_otp_in_percent=2823.22,
cpa_in_advertiser_currency=3140.25,
return_on_ad_spend_percent=6857.21,
vcr_in_percent=2704.73,
viewability_in_percent=2247.4,
vcpm_in_advertiser_currency=8383.69,
cpcv_in_advertiser_currency=4755.8,
miaozhen_otp_in_percent=4575.86,
),
creative_ids=[
"<value 1>",
"<value 2>",
],
associated_bid_lists=[
ttd_workflows.AdGroupWorkflowAssociateBidListInput(
bid_list_id="<id>",
is_enabled=True,
is_default_for_dimension=False,
),
],
name="<value>",
channel=ttd_workflows.AdGroupChannel.DISPLAY,
funnel_location=ttd_workflows.AdGroupFunnelLocation.AWARENESS,
market_type=ttd_workflows.MarketTypeInput.PRIVATE_MARKET_ONLY,
programmatic_guaranteed_private_contract_id="<id>",
include_defaults_from_campaign=True,
),
advanced_input=ttd_workflows.CampaignCreateWorkflowAdGroupAdvancedInput(
koa_optimization_settings=ttd_workflows.AdGroupWorkflowKoaOptimizationSettingsInput(
are_future_koa_features_enabled=True,
predictive_clearing_enabled=False,
),
comscore_settings=ttd_workflows.AdGroupWorkflowComscoreSettingsInput(
is_enabled=False,
population_id=559587,
demographic_member_ids=[
139340,
129935,
],
mobile_demographic_member_ids=None,
),
contract_targeting=ttd_workflows.AdGroupWorkflowContractTargetingInput(
allow_open_market_bidding_when_targeting_contracts=True,
),
dimensional_bidding_auto_optimization_settings=[
[
ttd_workflows.DimensionalBiddingDimensions.HAS_AUDIENCE_REACH_PERCENTAGE_TIER_ID,
],
[],
],
is_use_clicks_as_conversions_enabled=False,
is_use_secondary_conversions_enabled=True,
nielsen_tracking_attributes=ttd_workflows.AdGroupWorkflowNielsenTrackingAttributesInput(
enhanced_reporting_option=ttd_workflows.EnhancedNielsenReportingOptionsInput.NONE,
gender=ttd_workflows.TargetingGenderInput.FEMALE,
start_age=ttd_workflows.TargetingStartAgeInput.THIRTY_FIVE,
end_age=ttd_workflows.TargetingEndAgeInput.TWENTY_FOUR,
countries=[
"<value 1>",
"<value 2>",
],
),
new_frequency_configs=None,
inventory_targeting=ttd_workflows.AdGroupWorkflowInventoryTargetingInput(
deal_group_ids_to_include=[
"<value 1>",
],
deal_group_ids_to_exclude=[
"<value 1>",
"<value 2>",
"<value 3>",
],
deal_ids_to_exclude=[
169634,
],
deal_ids_to_include=[
356532,
584209,
],
include_default_on_deals=True,
),
is_non_decisioned=False,
include_defaults_from_campaign=True,
flights=[
ttd_workflows.CampaignCreateWorkflowAdGroupFlightInput(
allocation_type=ttd_workflows.AllocationType.MAXIMUM,
budget_in_advertiser_currency=4838.47,
budget_in_impressions=420224,
daily_target_in_advertiser_currency=1513.78,
daily_target_in_impressions=735500,
),
],
),
),
],
),
],
"validate_input_only": True,
"callback_input": {
"callback_url": "https://impeccable-pick.com/",
"callback_headers": {
"key": "<value>",
},
},
})
assert res.standard_job_submit_response is not None
# Handle response
print(res.standard_job_submit_response)models.CreateCampaignsJobResponse
| Error Type |
Status Code |
Content Type |
| models.ProblemDetailsError |
400, 403 |
application/json |
| models.APIError |
4XX, 5XX |
*/* |
Only the fields provided in the request payload for each specific campaign will be updated.
import os
import ttd_workflows
from ttd_workflows import Workflows
from ttd_workflows.utils import parse_datetime
with Workflows(
ttd_auth=os.getenv("WORKFLOWS_TTD_AUTH", ""),
) as workflows:
res = workflows.campaign.update_campaigns_job(request={
"input": [
ttd_workflows.CampaignUpdateWorkflowInput(
id="<id>",
primary_input=ttd_workflows.CampaignUpdateWorkflowPrimaryInput(
description="hmph energetically yet surprisingly swift knight swear multicolored absent",
campaign_group_id=645576,
time_zone="America/Argentina/San_Juan",
custom_cpa_click_weight=None,
custom_cpa_viewthrough_weight=8361.84,
custom_cpa_type=ttd_workflows.CustomCPAType.PIXEL_WEIGHTING,
custom_roas_type=ttd_workflows.CustomROASType.CLICK_VIEWTHROUGH_WEIGHTING,
impressions_only_budgeting_cpm=2706.4,
end_date_in_utc=parse_datetime("2023-11-11T21:39:56.025Z"),
seed_id="<id>",
campaign_conversion_reporting_columns=[
ttd_workflows.CampaignWorkflowCampaignConversionReportingColumnInput(
tracking_tag_id="<id>",
include_in_custom_cpa=True,
reporting_column_id=809247,
roas_config=ttd_workflows.CustomROASConfig(
include_in_custom_roas=False,
custom_roas_weight=None,
custom_roas_click_weight=None,
custom_roas_viewthrough_weight=6784.9,
),
product_list_reporting_type=ttd_workflows.ProductListReportingTypeInput.HALO,
weight=2260.69,
cross_device_attribution_model_id="<id>",
),
],
is_managed_by_ttd=True,
secondary_goal=ttd_workflows.CampaignWorkflowROIGoalInput(
maximize_reach=False,
maximize_ltv_incremental_reach=False,
cpc_in_advertiser_currency=None,
ctr_in_percent=None,
nielsen_otp_in_percent=5546.51,
cpa_in_advertiser_currency=7735.11,
return_on_ad_spend_percent=5459.4,
vcr_in_percent=7724.91,
viewability_in_percent=None,
vcpm_in_advertiser_currency=9927,
cpcv_in_advertiser_currency=1852.41,
miaozhen_otp_in_percent=2827.93,
iqvia_audience_quality_index=False,
crossix_audience_quality_index=None,
iqvia_audience_quality_index_and_cost_per_target=False,
crossix_cost_per_target=True,
new_buyer_target_value=178803,
),
tertiary_goal=ttd_workflows.CampaignWorkflowROIGoalInput(
maximize_reach=False,
maximize_ltv_incremental_reach=False,
cpc_in_advertiser_currency=7329.7,
ctr_in_percent=9103.24,
nielsen_otp_in_percent=2359.55,
cpa_in_advertiser_currency=6489.19,
return_on_ad_spend_percent=8265.87,
vcr_in_percent=None,
viewability_in_percent=6404.44,
vcpm_in_advertiser_currency=1278.49,
cpcv_in_advertiser_currency=9238.19,
miaozhen_otp_in_percent=8948.48,
iqvia_audience_quality_index=True,
crossix_audience_quality_index=False,
iqvia_audience_quality_index_and_cost_per_target=False,
crossix_cost_per_target=True,
new_buyer_target_value=784776,
),
name="<value>",
primary_channel=ttd_workflows.CampaignChannelType.NONE,
primary_goal=ttd_workflows.CampaignWorkflowROIGoalInput(
maximize_reach=True,
maximize_ltv_incremental_reach=False,
cpc_in_advertiser_currency=3354.68,
ctr_in_percent=7716.49,
nielsen_otp_in_percent=None,
cpa_in_advertiser_currency=381.7,
return_on_ad_spend_percent=8461.44,
vcr_in_percent=4170.61,
viewability_in_percent=5364.85,
vcpm_in_advertiser_currency=1107.08,
cpcv_in_advertiser_currency=None,
miaozhen_otp_in_percent=4584.96,
iqvia_audience_quality_index=True,
crossix_audience_quality_index=False,
iqvia_audience_quality_index_and_cost_per_target=True,
crossix_cost_per_target=True,
new_buyer_target_value=785673,
),
start_date_in_utc=parse_datetime("2023-01-13T23:06:05.083Z"),
budget=ttd_workflows.CampaignUpdateWorkflowBudgetInput(
pacing_mode=ttd_workflows.CampaignPacingMode.PACE_AS_SOON_AS_POSSIBLE,
),
),
advanced_input=ttd_workflows.CampaignUpdateWorkflowAdvancedInput(
purchase_order_number="<value>",
),
),
],
"validate_input_only": True,
"callback_input": {
"callback_url": "https://soggy-apparatus.org/",
"callback_headers": {
"key": "<value>",
"key1": "<value>",
"key2": "<value>",
},
},
})
assert res.campaign_payload is not None
# Handle response
print(res.campaign_payload)models.UpdateCampaignsJobResponse
| Error Type |
Status Code |
Content Type |
| models.ProblemDetailsError |
400, 403 |
application/json |
| models.APIError |
4XX, 5XX |
*/* |
Get a campaign's version
import os
from ttd_workflows import Workflows
with Workflows(
ttd_auth=os.getenv("WORKFLOWS_TTD_AUTH", ""),
) as workflows:
res = workflows.campaign.get_version(id="<id>")
assert res.campaign_version_workflow is not None
# Handle response
print(res.campaign_version_workflow)
| Parameter |
Type |
Required |
Description |
id |
str |
✔️ |
N/A |
retries |
Optional[utils.RetryConfig] |
➖ |
Configuration to override the default retry behavior of the client. |
models.GetCampaignVersionResponse
| Error Type |
Status Code |
Content Type |
| models.ProblemDetailsError |
400, 401, 403, 404 |
application/json |
| models.APIError |
4XX, 5XX |
*/* |