Workflows Service: This service provides operations for commonly used workflows on The Trade Desk's platform. In addition, this service provides generic operations for submitting:
- GraphQL API requests
- REST API requests
For further explanation on the entities encountered in this documentation (e.g., campaigns and ad groups), visit the Partner Portal.
Note
Python version upgrade policy
Once a Python version reaches its official end of life date, a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.
The SDK can be installed with uv, pip, or poetry package managers.
uv is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities.
uv add ttd-workflowsPIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.
pip install ttd-workflowsPoetry is a modern tool that simplifies dependency management and package publishing by using a single pyproject.toml file to handle project metadata and dependencies.
poetry add ttd-workflowsYou can use this SDK in a Python shell with uv and the uvx command that comes with it like so:
uvx --from ttd-workflows pythonIt's also possible to write a standalone Python script without needing to set up a whole project like so:
#!/usr/bin/env -S uv run --script # /// script # requires-python = ">=3.9" # dependencies = [ # "ttd-workflows", # ] # /// from ttd_workflows import Workflows sdk = Workflows( # SDK arguments ) # Rest of script here...Once that is saved to a file, you can run it with uv run script.py where script.py can be replaced with the actual file name.
Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.
import os from ttd_workflows import Workflows with Workflows( server="sandbox", ttd_auth=os.getenv("WORKFLOWS_TTD_AUTH", ""), ) as workflows: res = workflows.dmp.get_third_party_data_job(request={ "partner_id": "<id>", "query_shape": "nodes {id name}" }) assert res.standard_job_submit_response is not None print(res.standard_job_submit_response)import os from ttd_workflows import Workflows with Workflows( server="sandbox", ttd_auth=os.getenv("WORKFLOWS_TTD_AUTH", ""), ) as workflows: res = workflows.job_status.get_job_status(id=<id>) assert res.standard_job_status_response is not None print(res.standard_job_status_response)import pprint import os import ttd_workflows from ttd_workflows import Workflows from ttd_workflows.utils import parse_datetime with Workflows( server="sandbox", ttd_auth=os.getenv("WORKFLOWS_TTD_AUTH", ""), ) as workflows: res = workflows.campaign.create(request={ "primary_input": { "name": "<value>", "advertiser_id": "<id>", "seed_id": "<id>", # required, unless the advertiser has a default seed defined "start_date_in_utc": parse_datetime("2026-07-08T10:52:56.944Z"), "primary_channel": ttd_workflows.CampaignChannelType.DOOH, "primary_goal": { "maximize_reach": True } }}) assert res.campaign_payload is not None pprint.pprint(vars(res.campaign_payload.campaign))import pprint import os from ttd_workflows import Workflows with Workflows( server="sandbox", ttd_auth=os.getenv("WORKFLOWS_TTD_AUTH", ""), ) as workflows: query = """ query Advertiser($id: ID!) { advertiser(id: $id) { name totalCampaignChannelCount totalFunnelLocationCount useImpressionsOnlyBudgeting vettingStatus suggestedMeasurementProviderCategories } } """ res = workflows.graph_ql_request.submit_graph_ql_request(request={ "request": query, "variables": { "id": "<id>" } }) assert res.object is not None print(pprint.pprint(res.object))Note: If you submit a GraphQL bulk query job (instead of a standard GraphQL request as shown above), any paginated and nested data is fully iterated and returned in a single output file.
import os import time from ttd_workflows import Workflows with Workflows( server="sandbox", ttd_auth=os.getenv("WORKFLOWS_TTD_AUTH", ""), ) as workflows: query = """ query AudiencesAcrossAdvertisers { partner(id: "<id>") { id name advertisers { nodes { id name adGroups { nodes { id name audience { id name activeUniques { householdCount idsConnectedTvCount idsCount idsInAppCount idsWebCount lastUpdated personsCount } } } } } } } } """ res = workflows.graph_ql_request.submit_graph_ql_query_job(request={ "query": query, }) assert res.graph_ql_query_job_response is not None print(res.graph_ql_query_job_response.payload.data.id)import os from ttd_workflows import Workflows with Workflows( server="sandbox", ttd_auth=os.getenv("WORKFLOWS_TTD_AUTH", ""), ) as workflows: res = workflows.job_status.get_graph_ql_query_job_status(id="<id>") assert res.graph_ql_query_job_retrieval_response is not None print(f"Job completion: {res.graph_ql_query_job_retrieval_response.job.completion_percentage}%\n") if int(res.graph_ql_query_job_retrieval_response.job.completion_percentage) == 100: print(f"Result URL: {res.graph_ql_query_job_retrieval_response.job.url}\n") print(f"Raw result: {res.graph_ql_query_job_retrieval_response.job.raw_result}\n")import os import ttd_workflows from ttd_workflows import Workflows with Workflows( server="sandbox", ttd_auth=os.getenv("WORKFLOWS_TTD_AUTH", ""), ) as workflows: res = workflows.rest_request.submit_rest_request(request={ "method_type": ttd_workflows.RestAPIMethodType.GET, "endpoint": "campaign/<id>", }) assert res.object is not None print(res.object)NOTE: PUT/POST syntax is equivalent to GET, with the additional dataBody field.
import json import os from datetime import datetime, timezone import ttd_workflows from ttd_workflows import Workflows with Workflows( server="sandbox", ttd_auth=os.getenv("WORKFLOWS_TTD_AUTH", ""), ) as workflows: now = datetime.now().isoformat(timespec="milliseconds") res = workflows.rest_request.submit_rest_request(request={ "method_type": ttd_workflows.RestAPIMethodType.PUT, "endpoint": "adgroup", "dataBody": json.dumps({ "adGroupId": "<id>", "description": f"updated by Python SDK: {now}" }) }) assert res.object is not None print(res.object)This SDK supports the following security scheme globally:
| Name | Type | Scheme | Environment Variable |
|---|---|---|---|
ttd_auth | apiKey | API key | WORKFLOWS_TTD_AUTH |
To authenticate with the API the ttd_auth parameter must be set when initializing the SDK client instance. For example:
import os import ttd_workflows from ttd_workflows import Workflows with Workflows( ttd_auth=os.getenv("WORKFLOWS_TTD_AUTH", ""), ) as workflows: res = workflows.ad_groups.create(request={ "primary_input": { "is_enabled": False, "description": "twine from gosh poor safely editor astride vice lost and", "budget": { "allocation_type": ttd_workflows.AllocationType.MAXIMUM, "budget_in_advertiser_currency": 3786.02, "budget_in_impressions": 783190, "daily_target_in_advertiser_currency": 9747.02, "daily_target_in_impressions": 985999, }, "base_bid_cpm_in_advertiser_currency": 3785.04, "max_bid_cpm_in_advertiser_currency": 7447.3, "audience_targeting": { "audience_id": "<id>", "audience_accelerator_exclusions_enabled": True, "audience_booster_enabled": True, "audience_excluder_enabled": True, "audience_predictor_enabled": False, "cross_device_vendor_list_for_audience": [ 107263, ], "recency_exclusion_window_in_minutes": 90062, "target_trackable_users_enabled": True, "use_mc_id_as_primary": True, }, "roi_goal": { "maximize_reach": True, "maximize_ltv_incremental_reach": False, "cpc_in_advertiser_currency": 2280.31, "ctr_in_percent": None, "nielsen_otp_in_percent": 5175.21, "cpa_in_advertiser_currency": 2544.37, "return_on_ad_spend_percent": 8201.47, "vcr_in_percent": 4846.08, "viewability_in_percent": None, "vcpm_in_advertiser_currency": 4649.53, "cpcv_in_advertiser_currency": 313.95, "miaozhen_otp_in_percent": 4704.1, }, "creative_ids": None, "associated_bid_lists": [ { "bid_list_id": "<id>", "is_enabled": False, "is_default_for_dimension": True, }, ], "name": "<value>", "channel": ttd_workflows.AdGroupChannel.DISPLAY, "funnel_location": ttd_workflows.AdGroupFunnelLocation.CONSIDERATION, "market_type": ttd_workflows.MarketType.PRIVATE_MARKET_ONLY, "programmatic_guaranteed_private_contract_id": "<id>", "include_defaults_from_campaign": False, }, "campaign_id": "<id>", "advanced_input": { "koa_optimization_settings": { "are_future_koa_features_enabled": False, "predictive_clearing_enabled": False, }, "comscore_settings": { "is_enabled": False, "population_id": None, "demographic_member_ids": [ 959580, 236376, ], "mobile_demographic_member_ids": [ 664689, 827980, 21321, ], }, "contract_targeting": { "allow_open_market_bidding_when_targeting_contracts": True, }, "dimensional_bidding_auto_optimization_settings": [ [], [], ], "is_use_clicks_as_conversions_enabled": False, "is_use_secondary_conversions_enabled": False, "nielsen_tracking_attributes": { "enhanced_reporting_option": ttd_workflows.EnhancedNielsenReportingOptionsInput.SITE, "gender": ttd_workflows.TargetingGenderInput.MALE, "start_age": ttd_workflows.TargetingStartAgeInput.TWENTY_FIVE, "end_age": ttd_workflows.TargetingEndAgeInput.SEVENTEEN, "countries": [ "<value 1>", "<value 2>", "<value 3>", ], }, "new_frequency_configs": [ { "counter_name": None, "frequency_cap": 375286, "frequency_goal": 534735, "reset_interval_in_minutes": 788122, }, ], "flights": [ { "allocation_type": ttd_workflows.AllocationType.MAXIMUM, "budget_in_advertiser_currency": 4070.96, "budget_in_impressions": 901477, "daily_target_in_advertiser_currency": 5847.35, "daily_target_in_impressions": 257517, "campaign_flight_id": 874887, }, ], "caller_source": "<value>", }, "validate_input_only": True, }) assert res.ad_group_payload is not None # Handle response print(res.ad_group_payload)Available methods
- create_ad_groups_job - Submit a job to create multiple new ad groups
- update_ad_groups_job - Submit a job to update multiple ad groups
- create - Create a new campaign
- create_campaigns_job - Submit a job to create multiple new campaigns
- update_campaigns_job - Submit a job to update multiple campaigns
- get_version - Get a campaign's version
- get_first_party_data_job - Submit a job for first-party data retrieval for an advertiser
- get_third_party_data_job - Submit a job for third-party data retrieval for a partner
- submit_graph_ql_request - Submit a valid GraphQL query or mutation
- submit_graph_ql_bulk_query_job - Submit a valid bulk GraphQL query job
- get_graph_ql_bulk_job_status - Get the status of a previously submitted GraphQL bulk job
- get_job_status - Get the status of a previously submitted job
- submit_rest_request - Submit a valid REST request
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a RetryConfig object to the call:
import os import ttd_workflows from ttd_workflows import Workflows from ttd_workflows.utils import BackoffStrategy, RetryConfig with Workflows( ttd_auth=os.getenv("WORKFLOWS_TTD_AUTH", ""), ) as workflows: res = workflows.ad_groups.create(request={ "primary_input": { "is_enabled": False, "description": "twine from gosh poor safely editor astride vice lost and", "budget": { "allocation_type": ttd_workflows.AllocationType.MAXIMUM, "budget_in_advertiser_currency": 3786.02, "budget_in_impressions": 783190, "daily_target_in_advertiser_currency": 9747.02, "daily_target_in_impressions": 985999, }, "base_bid_cpm_in_advertiser_currency": 3785.04, "max_bid_cpm_in_advertiser_currency": 7447.3, "audience_targeting": { "audience_id": "<id>", "audience_accelerator_exclusions_enabled": True, "audience_booster_enabled": True, "audience_excluder_enabled": True, "audience_predictor_enabled": False, "cross_device_vendor_list_for_audience": [ 107263, ], "recency_exclusion_window_in_minutes": 90062, "target_trackable_users_enabled": True, "use_mc_id_as_primary": True, }, "roi_goal": { "maximize_reach": True, "maximize_ltv_incremental_reach": False, "cpc_in_advertiser_currency": 2280.31, "ctr_in_percent": None, "nielsen_otp_in_percent": 5175.21, "cpa_in_advertiser_currency": 2544.37, "return_on_ad_spend_percent": 8201.47, "vcr_in_percent": 4846.08, "viewability_in_percent": None, "vcpm_in_advertiser_currency": 4649.53, "cpcv_in_advertiser_currency": 313.95, "miaozhen_otp_in_percent": 4704.1, }, "creative_ids": None, "associated_bid_lists": [ { "bid_list_id": "<id>", "is_enabled": False, "is_default_for_dimension": True, }, ], "name": "<value>", "channel": ttd_workflows.AdGroupChannel.DISPLAY, "funnel_location": ttd_workflows.AdGroupFunnelLocation.CONSIDERATION, "market_type": ttd_workflows.MarketType.PRIVATE_MARKET_ONLY, "programmatic_guaranteed_private_contract_id": "<id>", "include_defaults_from_campaign": False, }, "campaign_id": "<id>", "advanced_input": { "koa_optimization_settings": { "are_future_koa_features_enabled": False, "predictive_clearing_enabled": False, }, "comscore_settings": { "is_enabled": False, "population_id": None, "demographic_member_ids": [ 959580, 236376, ], "mobile_demographic_member_ids": [ 664689, 827980, 21321, ], }, "contract_targeting": { "allow_open_market_bidding_when_targeting_contracts": True, }, "dimensional_bidding_auto_optimization_settings": [ [], [], ], "is_use_clicks_as_conversions_enabled": False, "is_use_secondary_conversions_enabled": False, "nielsen_tracking_attributes": { "enhanced_reporting_option": ttd_workflows.EnhancedNielsenReportingOptionsInput.SITE, "gender": ttd_workflows.TargetingGenderInput.MALE, "start_age": ttd_workflows.TargetingStartAgeInput.TWENTY_FIVE, "end_age": ttd_workflows.TargetingEndAgeInput.SEVENTEEN, "countries": [ "<value 1>", "<value 2>", "<value 3>", ], }, "new_frequency_configs": [ { "counter_name": None, "frequency_cap": 375286, "frequency_goal": 534735, "reset_interval_in_minutes": 788122, }, ], "flights": [ { "allocation_type": ttd_workflows.AllocationType.MAXIMUM, "budget_in_advertiser_currency": 4070.96, "budget_in_impressions": 901477, "daily_target_in_advertiser_currency": 5847.35, "daily_target_in_impressions": 257517, "campaign_flight_id": 874887, }, ], "caller_source": "<value>", }, "validate_input_only": True, }, RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False)) assert res.ad_group_payload is not None # Handle response print(res.ad_group_payload)If you'd like to override the default retry strategy for all operations that support retries, you can use the retry_config optional parameter when initializing the SDK:
import os import ttd_workflows from ttd_workflows import Workflows from ttd_workflows.utils import BackoffStrategy, RetryConfig with Workflows( retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False), ttd_auth=os.getenv("WORKFLOWS_TTD_AUTH", ""), ) as workflows: res = workflows.ad_groups.create(request={ "primary_input": { "is_enabled": False, "description": "twine from gosh poor safely editor astride vice lost and", "budget": { "allocation_type": ttd_workflows.AllocationType.MAXIMUM, "budget_in_advertiser_currency": 3786.02, "budget_in_impressions": 783190, "daily_target_in_advertiser_currency": 9747.02, "daily_target_in_impressions": 985999, }, "base_bid_cpm_in_advertiser_currency": 3785.04, "max_bid_cpm_in_advertiser_currency": 7447.3, "audience_targeting": { "audience_id": "<id>", "audience_accelerator_exclusions_enabled": True, "audience_booster_enabled": True, "audience_excluder_enabled": True, "audience_predictor_enabled": False, "cross_device_vendor_list_for_audience": [ 107263, ], "recency_exclusion_window_in_minutes": 90062, "target_trackable_users_enabled": True, "use_mc_id_as_primary": True, }, "roi_goal": { "maximize_reach": True, "maximize_ltv_incremental_reach": False, "cpc_in_advertiser_currency": 2280.31, "ctr_in_percent": None, "nielsen_otp_in_percent": 5175.21, "cpa_in_advertiser_currency": 2544.37, "return_on_ad_spend_percent": 8201.47, "vcr_in_percent": 4846.08, "viewability_in_percent": None, "vcpm_in_advertiser_currency": 4649.53, "cpcv_in_advertiser_currency": 313.95, "miaozhen_otp_in_percent": 4704.1, }, "creative_ids": None, "associated_bid_lists": [ { "bid_list_id": "<id>", "is_enabled": False, "is_default_for_dimension": True, }, ], "name": "<value>", "channel": ttd_workflows.AdGroupChannel.DISPLAY, "funnel_location": ttd_workflows.AdGroupFunnelLocation.CONSIDERATION, "market_type": ttd_workflows.MarketType.PRIVATE_MARKET_ONLY, "programmatic_guaranteed_private_contract_id": "<id>", "include_defaults_from_campaign": False, }, "campaign_id": "<id>", "advanced_input": { "koa_optimization_settings": { "are_future_koa_features_enabled": False, "predictive_clearing_enabled": False, }, "comscore_settings": { "is_enabled": False, "population_id": None, "demographic_member_ids": [ 959580, 236376, ], "mobile_demographic_member_ids": [ 664689, 827980, 21321, ], }, "contract_targeting": { "allow_open_market_bidding_when_targeting_contracts": True, }, "dimensional_bidding_auto_optimization_settings": [ [], [], ], "is_use_clicks_as_conversions_enabled": False, "is_use_secondary_conversions_enabled": False, "nielsen_tracking_attributes": { "enhanced_reporting_option": ttd_workflows.EnhancedNielsenReportingOptionsInput.SITE, "gender": ttd_workflows.TargetingGenderInput.MALE, "start_age": ttd_workflows.TargetingStartAgeInput.TWENTY_FIVE, "end_age": ttd_workflows.TargetingEndAgeInput.SEVENTEEN, "countries": [ "<value 1>", "<value 2>", "<value 3>", ], }, "new_frequency_configs": [ { "counter_name": None, "frequency_cap": 375286, "frequency_goal": 534735, "reset_interval_in_minutes": 788122, }, ], "flights": [ { "allocation_type": ttd_workflows.AllocationType.MAXIMUM, "budget_in_advertiser_currency": 4070.96, "budget_in_impressions": 901477, "daily_target_in_advertiser_currency": 5847.35, "daily_target_in_impressions": 257517, "campaign_flight_id": 874887, }, ], "caller_source": "<value>", }, "validate_input_only": True, }) assert res.ad_group_payload is not None # Handle response print(res.ad_group_payload)WorkflowsError is the base class for all HTTP error responses. It has the following properties:
| Property | Type | Description |
|---|---|---|
err.message | str | Error message |
err.status_code | int | HTTP response status code eg 404 |
err.headers | httpx.Headers | HTTP response headers |
err.body | str | HTTP body. Can be empty string if no body is returned. |
err.raw_response | httpx.Response | Raw HTTP response |
err.data | Optional. Some errors may contain structured data. See Error Classes. |
import os import ttd_workflows from ttd_workflows import Workflows, models with Workflows( ttd_auth=os.getenv("WORKFLOWS_TTD_AUTH", ""), ) as workflows: res = None try: res = workflows.ad_groups.create(request={ "primary_input": { "is_enabled": False, "description": "twine from gosh poor safely editor astride vice lost and", "budget": { "allocation_type": ttd_workflows.AllocationType.MAXIMUM, "budget_in_advertiser_currency": 3786.02, "budget_in_impressions": 783190, "daily_target_in_advertiser_currency": 9747.02, "daily_target_in_impressions": 985999, }, "base_bid_cpm_in_advertiser_currency": 3785.04, "max_bid_cpm_in_advertiser_currency": 7447.3, "audience_targeting": { "audience_id": "<id>", "audience_accelerator_exclusions_enabled": True, "audience_booster_enabled": True, "audience_excluder_enabled": True, "audience_predictor_enabled": False, "cross_device_vendor_list_for_audience": [ 107263, ], "recency_exclusion_window_in_minutes": 90062, "target_trackable_users_enabled": True, "use_mc_id_as_primary": True, }, "roi_goal": { "maximize_reach": True, "maximize_ltv_incremental_reach": False, "cpc_in_advertiser_currency": 2280.31, "ctr_in_percent": None, "nielsen_otp_in_percent": 5175.21, "cpa_in_advertiser_currency": 2544.37, "return_on_ad_spend_percent": 8201.47, "vcr_in_percent": 4846.08, "viewability_in_percent": None, "vcpm_in_advertiser_currency": 4649.53, "cpcv_in_advertiser_currency": 313.95, "miaozhen_otp_in_percent": 4704.1, }, "creative_ids": None, "associated_bid_lists": [ { "bid_list_id": "<id>", "is_enabled": False, "is_default_for_dimension": True, }, ], "name": "<value>", "channel": ttd_workflows.AdGroupChannel.DISPLAY, "funnel_location": ttd_workflows.AdGroupFunnelLocation.CONSIDERATION, "market_type": ttd_workflows.MarketType.PRIVATE_MARKET_ONLY, "programmatic_guaranteed_private_contract_id": "<id>", "include_defaults_from_campaign": False, }, "campaign_id": "<id>", "advanced_input": { "koa_optimization_settings": { "are_future_koa_features_enabled": False, "predictive_clearing_enabled": False, }, "comscore_settings": { "is_enabled": False, "population_id": None, "demographic_member_ids": [ 959580, 236376, ], "mobile_demographic_member_ids": [ 664689, 827980, 21321, ], }, "contract_targeting": { "allow_open_market_bidding_when_targeting_contracts": True, }, "dimensional_bidding_auto_optimization_settings": [ [], [], ], "is_use_clicks_as_conversions_enabled": False, "is_use_secondary_conversions_enabled": False, "nielsen_tracking_attributes": { "enhanced_reporting_option": ttd_workflows.EnhancedNielsenReportingOptionsInput.SITE, "gender": ttd_workflows.TargetingGenderInput.MALE, "start_age": ttd_workflows.TargetingStartAgeInput.TWENTY_FIVE, "end_age": ttd_workflows.TargetingEndAgeInput.SEVENTEEN, "countries": [ "<value 1>", "<value 2>", "<value 3>", ], }, "new_frequency_configs": [ { "counter_name": None, "frequency_cap": 375286, "frequency_goal": 534735, "reset_interval_in_minutes": 788122, }, ], "flights": [ { "allocation_type": ttd_workflows.AllocationType.MAXIMUM, "budget_in_advertiser_currency": 4070.96, "budget_in_impressions": 901477, "daily_target_in_advertiser_currency": 5847.35, "daily_target_in_impressions": 257517, "campaign_flight_id": 874887, }, ], "caller_source": "<value>", }, "validate_input_only": True, }) assert res.ad_group_payload is not None # Handle response print(res.ad_group_payload) except models.WorkflowsError as e: # The base class for HTTP error responses print(e.message) print(e.status_code) print(e.body) print(e.headers) print(e.raw_response) # Depending on the method different errors may be thrown if isinstance(e, models.ProblemDetailsError): print(e.data.type) # OptionalNullable[str] print(e.data.title) # OptionalNullable[str] print(e.data.status) # OptionalNullable[int] print(e.data.detail) # OptionalNullable[str] print(e.data.instance) # OptionalNullable[str]Primary errors:
WorkflowsError: The base class for HTTP error responses.ProblemDetailsError: Bad Request.
Less common errors (5)
Network errors:
httpx.RequestError: Base class for request errors.httpx.ConnectError: HTTP client was unable to make a request to a server.httpx.TimeoutException: HTTP request timed out.
Inherit from WorkflowsError:
ResponseValidationError: Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via thecauseattribute.
You can override the default server globally by passing a server name to the server: str optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:
| Name | Server | Description |
|---|---|---|
prod | https://api.thetradedesk.com/workflows | The production environment. |
sandbox | https://ext-api.sb.thetradedesk.com/workflows | The sandbox environment for testing. |
import os import ttd_workflows from ttd_workflows import Workflows with Workflows( server="prod", ttd_auth=os.getenv("WORKFLOWS_TTD_AUTH", ""), ) as workflows: res = workflows.ad_groups.create(request={ "primary_input": { "is_enabled": False, "description": "twine from gosh poor safely editor astride vice lost and", "budget": { "allocation_type": ttd_workflows.AllocationType.MAXIMUM, "budget_in_advertiser_currency": 3786.02, "budget_in_impressions": 783190, "daily_target_in_advertiser_currency": 9747.02, "daily_target_in_impressions": 985999, }, "base_bid_cpm_in_advertiser_currency": 3785.04, "max_bid_cpm_in_advertiser_currency": 7447.3, "audience_targeting": { "audience_id": "<id>", "audience_accelerator_exclusions_enabled": True, "audience_booster_enabled": True, "audience_excluder_enabled": True, "audience_predictor_enabled": False, "cross_device_vendor_list_for_audience": [ 107263, ], "recency_exclusion_window_in_minutes": 90062, "target_trackable_users_enabled": True, "use_mc_id_as_primary": True, }, "roi_goal": { "maximize_reach": True, "maximize_ltv_incremental_reach": False, "cpc_in_advertiser_currency": 2280.31, "ctr_in_percent": None, "nielsen_otp_in_percent": 5175.21, "cpa_in_advertiser_currency": 2544.37, "return_on_ad_spend_percent": 8201.47, "vcr_in_percent": 4846.08, "viewability_in_percent": None, "vcpm_in_advertiser_currency": 4649.53, "cpcv_in_advertiser_currency": 313.95, "miaozhen_otp_in_percent": 4704.1, }, "creative_ids": None, "associated_bid_lists": [ { "bid_list_id": "<id>", "is_enabled": False, "is_default_for_dimension": True, }, ], "name": "<value>", "channel": ttd_workflows.AdGroupChannel.DISPLAY, "funnel_location": ttd_workflows.AdGroupFunnelLocation.CONSIDERATION, "market_type": ttd_workflows.MarketType.PRIVATE_MARKET_ONLY, "programmatic_guaranteed_private_contract_id": "<id>", "include_defaults_from_campaign": False, }, "campaign_id": "<id>", "advanced_input": { "koa_optimization_settings": { "are_future_koa_features_enabled": False, "predictive_clearing_enabled": False, }, "comscore_settings": { "is_enabled": False, "population_id": None, "demographic_member_ids": [ 959580, 236376, ], "mobile_demographic_member_ids": [ 664689, 827980, 21321, ], }, "contract_targeting": { "allow_open_market_bidding_when_targeting_contracts": True, }, "dimensional_bidding_auto_optimization_settings": [ [], [], ], "is_use_clicks_as_conversions_enabled": False, "is_use_secondary_conversions_enabled": False, "nielsen_tracking_attributes": { "enhanced_reporting_option": ttd_workflows.EnhancedNielsenReportingOptionsInput.SITE, "gender": ttd_workflows.TargetingGenderInput.MALE, "start_age": ttd_workflows.TargetingStartAgeInput.TWENTY_FIVE, "end_age": ttd_workflows.TargetingEndAgeInput.SEVENTEEN, "countries": [ "<value 1>", "<value 2>", "<value 3>", ], }, "new_frequency_configs": [ { "counter_name": None, "frequency_cap": 375286, "frequency_goal": 534735, "reset_interval_in_minutes": 788122, }, ], "flights": [ { "allocation_type": ttd_workflows.AllocationType.MAXIMUM, "budget_in_advertiser_currency": 4070.96, "budget_in_impressions": 901477, "daily_target_in_advertiser_currency": 5847.35, "daily_target_in_impressions": 257517, "campaign_flight_id": 874887, }, ], "caller_source": "<value>", }, "validate_input_only": True, }) assert res.ad_group_payload is not None # Handle response print(res.ad_group_payload)The default server can also be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:
import os import ttd_workflows from ttd_workflows import Workflows with Workflows( server_url="https://api.thetradedesk.com/workflows", ttd_auth=os.getenv("WORKFLOWS_TTD_AUTH", ""), ) as workflows: res = workflows.ad_groups.create(request={ "primary_input": { "is_enabled": False, "description": "twine from gosh poor safely editor astride vice lost and", "budget": { "allocation_type": ttd_workflows.AllocationType.MAXIMUM, "budget_in_advertiser_currency": 3786.02, "budget_in_impressions": 783190, "daily_target_in_advertiser_currency": 9747.02, "daily_target_in_impressions": 985999, }, "base_bid_cpm_in_advertiser_currency": 3785.04, "max_bid_cpm_in_advertiser_currency": 7447.3, "audience_targeting": { "audience_id": "<id>", "audience_accelerator_exclusions_enabled": True, "audience_booster_enabled": True, "audience_excluder_enabled": True, "audience_predictor_enabled": False, "cross_device_vendor_list_for_audience": [ 107263, ], "recency_exclusion_window_in_minutes": 90062, "target_trackable_users_enabled": True, "use_mc_id_as_primary": True, }, "roi_goal": { "maximize_reach": True, "maximize_ltv_incremental_reach": False, "cpc_in_advertiser_currency": 2280.31, "ctr_in_percent": None, "nielsen_otp_in_percent": 5175.21, "cpa_in_advertiser_currency": 2544.37, "return_on_ad_spend_percent": 8201.47, "vcr_in_percent": 4846.08, "viewability_in_percent": None, "vcpm_in_advertiser_currency": 4649.53, "cpcv_in_advertiser_currency": 313.95, "miaozhen_otp_in_percent": 4704.1, }, "creative_ids": None, "associated_bid_lists": [ { "bid_list_id": "<id>", "is_enabled": False, "is_default_for_dimension": True, }, ], "name": "<value>", "channel": ttd_workflows.AdGroupChannel.DISPLAY, "funnel_location": ttd_workflows.AdGroupFunnelLocation.CONSIDERATION, "market_type": ttd_workflows.MarketType.PRIVATE_MARKET_ONLY, "programmatic_guaranteed_private_contract_id": "<id>", "include_defaults_from_campaign": False, }, "campaign_id": "<id>", "advanced_input": { "koa_optimization_settings": { "are_future_koa_features_enabled": False, "predictive_clearing_enabled": False, }, "comscore_settings": { "is_enabled": False, "population_id": None, "demographic_member_ids": [ 959580, 236376, ], "mobile_demographic_member_ids": [ 664689, 827980, 21321, ], }, "contract_targeting": { "allow_open_market_bidding_when_targeting_contracts": True, }, "dimensional_bidding_auto_optimization_settings": [ [], [], ], "is_use_clicks_as_conversions_enabled": False, "is_use_secondary_conversions_enabled": False, "nielsen_tracking_attributes": { "enhanced_reporting_option": ttd_workflows.EnhancedNielsenReportingOptionsInput.SITE, "gender": ttd_workflows.TargetingGenderInput.MALE, "start_age": ttd_workflows.TargetingStartAgeInput.TWENTY_FIVE, "end_age": ttd_workflows.TargetingEndAgeInput.SEVENTEEN, "countries": [ "<value 1>", "<value 2>", "<value 3>", ], }, "new_frequency_configs": [ { "counter_name": None, "frequency_cap": 375286, "frequency_goal": 534735, "reset_interval_in_minutes": 788122, }, ], "flights": [ { "allocation_type": ttd_workflows.AllocationType.MAXIMUM, "budget_in_advertiser_currency": 4070.96, "budget_in_impressions": 901477, "daily_target_in_advertiser_currency": 5847.35, "daily_target_in_impressions": 257517, "campaign_flight_id": 874887, }, ], "caller_source": "<value>", }, "validate_input_only": True, }) assert res.ad_group_payload is not None # Handle response print(res.ad_group_payload)The Python SDK makes API calls using the httpx HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance. Depending on whether you are using the sync or async version of the SDK, you can pass an instance of HttpClient or AsyncHttpClient respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls. This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of httpx.Client or httpx.AsyncClient directly.
For example, you could specify a header for every request that this sdk makes as follows:
from ttd_workflows import Workflows import httpx http_client = httpx.Client(headers={"x-custom-header": "someValue"}) s = Workflows(client=http_client)or you could wrap the client with your own custom logic:
from ttd_workflows import Workflows from ttd_workflows.httpclient import AsyncHttpClient import httpx class CustomClient(AsyncHttpClient): client: AsyncHttpClient def __init__(self, client: AsyncHttpClient): self.client = client async def send( self, request: httpx.Request, *, stream: bool = False, auth: Union[ httpx._types.AuthTypes, httpx._client.UseClientDefault, None ] = httpx.USE_CLIENT_DEFAULT, follow_redirects: Union[ bool, httpx._client.UseClientDefault ] = httpx.USE_CLIENT_DEFAULT, ) -> httpx.Response: request.headers["Client-Level-Header"] = "added by client" return await self.client.send( request, stream=stream, auth=auth, follow_redirects=follow_redirects ) def build_request( self, method: str, url: httpx._types.URLTypes, *, content: Optional[httpx._types.RequestContent] = None, data: Optional[httpx._types.RequestData] = None, files: Optional[httpx._types.RequestFiles] = None, json: Optional[Any] = None, params: Optional[httpx._types.QueryParamTypes] = None, headers: Optional[httpx._types.HeaderTypes] = None, cookies: Optional[httpx._types.CookieTypes] = None, timeout: Union[ httpx._types.TimeoutTypes, httpx._client.UseClientDefault ] = httpx.USE_CLIENT_DEFAULT, extensions: Optional[httpx._types.RequestExtensions] = None, ) -> httpx.Request: return self.client.build_request( method, url, content=content, data=data, files=files, json=json, params=params, headers=headers, cookies=cookies, timeout=timeout, extensions=extensions, ) s = Workflows(async_client=CustomClient(httpx.AsyncClient()))The Workflows class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a context manager and reuse it across the application.
import os from ttd_workflows import Workflows def main(): with Workflows( ttd_auth=os.getenv("WORKFLOWS_TTD_AUTH", ""), ) as workflows: # Rest of application here... # Or when using async: async def amain(): async with Workflows( ttd_auth=os.getenv("WORKFLOWS_TTD_AUTH", ""), ) as workflows: # Rest of application here...You can setup your SDK to emit debug logs for SDK requests and responses.
You can pass your own logger class directly into your SDK.
from ttd_workflows import Workflows import logging logging.basicConfig(level=logging.DEBUG) s = Workflows(debug_logger=logging.getLogger("ttd_workflows"))You can also enable a default debug logger by setting an environment variable WORKFLOWS_DEBUG to true.