Yahoo DSP API Configuration Beta
For more information about authentication, accessing the Fivetran REST API, and request and response formats, see Getting Started with the Fivetran REST API.
Request
POST https://api.fivetran.com/v1/connections
{ "group_id": "group_id", "service": "yahoo_dsp", "trust_certificates": true, "trust_fingerprints": true, "run_setup_tests": true, "paused": false, "pause_after_trial": false, "sync_frequency": 1440, "data_delay_sensitivity": "LOW", "data_delay_threshold": 0, "daily_sync_time": "14:00", "schedule_type": "auto", "connect_card_config": { "redirect_uri": "https://your.site/path", "hide_setup_guide": true, "all_fields": true }, "proxy_agent_id": "proxy_agent_id", "private_link_id": "private_link_id", "networking_method": "Directly", "hybrid_deployment_agent_id": "hybrid_deployment_agent_id", "destination_configuration": { "virtual_warehouse": "virtual_warehouse" }, "destination_schema_names": "FIVETRAN_NAMING", "external_secrets_manager_id": "esm_id", "config": { "advertisers_with_seat": "[\"1234578:987\", \"19283411:999\"]", "report_configs": [ { "config_type": "CUSTOM | PREBUILT", "currency": "SEAT | USD | ADVERTISER | CAMPAIGN", "dimensions": [ "CONNECTION_TYPE | PACKAGE_END_DATE | PACKAGE_BUDGET_DISTRIBUTOR | LINE_DAILY_BUDGET_SCHEDULE | APP_NAME | CONTENT_CHANNEL | LINE_SCHEDULE_NAME | CAMPAIGN_DAILY_BUDGET_SCHEDULE | DYNAMIC_CREATIVE_VARIATION | PACKAGE_SCHEDULE_START_DATE | LINE_BILLING_METHOD | NATIVE_TYPE | DAYS_TO_CONVERSION | GOAL_TYPE | PACKAGE_TOTAL_BUDGET | NATIVE_SITE | CHANNEL_TYPE | PACKAGE_SCHEDULE_NAME | EXCHANGE | CAMPAIGN_SCHEDULE_NAME | ADVERTISER | FREQUENCY_BUCKET_30D | AD | CONNECTED_TV_MODEL | CAMPAIGN_END_DATE | REGION | SUBDOMAIN | LINE_END_DATE | DESKTOP_OS | LINE_BUDGET_PACING | DOMAIN | CAMPAIGN_TOTAL_BUDGET | LAYOUT | LINE_DAILY_BUDGET | LINE_SCHEDULE_END_DATE | BROWSER_TYPE | INVENTORY_AUCTION_TYPE | DEAL_TYPE | ADVERTISER_SUB_CATEGORY | BUCKETED_AGE | ADVERTISER_CATEGORY_ID | PACKAGE_DAILY_BUDGET_SCHEDULE | OTHER_COST_NAME | POSTAL_CODE | CONTENT_SHOW | SITE_GROUP_NAME | LINE_START_DATE | CAMPAIGN | CONTENT_GENRE | CAMPAIGN_START_DATE | LINE_GOAL_TYPE | CREATIVE_CUSTOM_ID | ISP | LINE_TYPE | CITY | CREATIVE_FORMAT | PACKAGE_DAILY_BUDGET | VIDEO_AD_PLACEMENT | CAMPAIGN_DAILY_BUDGET | LINE_TOTAL_BUDGET | PUBLISHER | CAMPAIGN_CURRENT_SCHEDULE_TOTAL_BUDGET | AUDIENCE_MEASUREMENT_COST_NAME | CREATIVE | PIXEL_PARAMETER | PACKAGE_CURRENT_SCHEDULE_TOTAL_BUDGET | CONTENT_TITLE | SEAT_ID | SITE_NAME | LINE_FLIGHT | INVENTORY_TYPE | COUNTRY | PACKAGE | ADVERTISER_GROUP | AD_SERVING_COST_NAME | DEMO_VENDOR | CAMPAIGN_SCHEDULE_END_DATE | MARKET_AREA | LINE_PACING_ACCELERATION | DEVICE_TYPE | MOBILE_MAKE | NATIVE_SITE_GROUP | DESKTOP_OS_DEPRECATED | FREQUENCY_BUCKET_7D | DEVICE_CATEGORY | VIDEO_CREATIVE_DURATION | CONNECTED_TV_DEVICE | DYNAMIC_CREATIVE_SET | DOT_RULE | CONNECTED_TV_MAKE | PACKAGE_BUDGET_SCHEDULE | PACKAGE_SCHEDULE_END_DATE | FREQUENCY_BUCKET_1D | LINE_CHANNEL_TYPE | WEATHER_CONDITION | LINE | EXCHANGE_DEAL_ID | GENDER | VIDEO_CONTENT_LENGTH | AGE | LINE_CURRENT_SCHEDULE_TOTAL_BUDGET | CONTENT_NETWORK | SUPPLY_GROUP | BID_REQUEST_DIMENSIONS | VIDEO_PLAYER_SIZE | TARGET_AUDIENCE_ID_GROUP_B | TARGET_AUDIENCE_ID_GROUP_A | MOBILE_OS | PIXEL | LINE_SCHEDULE_START_DATE | AD_POSITION | BID_REQUEST_AD_SIZE | ADS_TXT_DECLARATION | MOBILE_CARRIER | MOBILE_MODEL | PARENT_LINE" ], "interval_type": "MONTH | HOUR | CUMULATIVE | WEEK | DAY", "metrics": [ "CTR | AD_SERVING_COST | IMPRESSION_DISTRIBUTION_NONMEASURABLE | BID_CPM_ADVERTISER_CURRENCY | SEAT_DATA_FEE | CLICK_THROUGH_CPA | AVAILABLE_BID_REQUESTS | COMPLETION_RATE_75 | ROAS | YAHOO_NON_MEASURABLE_IMPRESSIONS | BID_PRICE_WITHOUT_MULTIPLIER_ADVERTISER_CURRENCY | VIEW_THROUGH_CONVERSION_RATE | COMPLETION_RATE_100 | TOTAL_DATA_FEE | ADVERTISER_ECPM | YAHOO_VIEWABLE_IMPRESSIONS | VIEW_THROUGH_CONVERSION | NETWORK_ECPM | NETWORK_PROFIT_PERCENTAGE | VERY_FIRST_CONVERSION | AUDIENCE_IMPRESSIONS | MOAT_MEASURABLE_IMPRESSIONS | FILTERED_COMPANION_IMPRESSIONS | INVENTORY_COST | VERY_FIRST_CLICK_THROUGH_CONVERSION_VALUE | SEAT_MANAGEMENT_FEE | VCPM | MOAT_AVOC | ORDER_MANAGEMENT_FEE | DROP_RATE_AT_75 | DYNAMIC_CONVERSION_VALUE | COMPLETIONS_75 | ADVERTISER_SPENDING | CLICKS | UNIQUE_CLICK_THROUGH_CONVERTERS | CLICK_THROUGH_CONVERSION_VALUE | START_VIEWS | BID_PRICE_WITHOUT_MULTIPLIER_ORDER_CURRENCY | IMPRESSION_DISTRIBUTION_VIEWABLE | MOAT_AVFH | MAIL_AD_SAVES_RATE | YAHOO_MEASURABLE_IMPRESSIONS | AVERAGE_WIN_RATE | IMPRESSIONS | INVENTORY_ECPM_DEPRECATED | IMPRESSION_DISTRIBUTION_NONVIEWABLE | CONVERSION_VALUE | SEAT_TECH_FEE | MAIL_AD_OPENS | FILTERED_IMPRESSIONS | MAIL_AD_FORWARDS | TOTAL_VENDOR_FEE | OTHER_COST | MAIL_AD_FORM_SUBMITS | CPA | VIEWABIILITY_COST | CPC | MOAT_VIEWABLE_IMPRESSIONS | CNVR | MOAT_AVOC_RATE | ESTIMATED_NUMBER_OF_STORE_VISITS | YAHOO_VIEWABLE_RATE | TOTAL_VARIABLE_COST | NETWORK_PROFIT | BID_CPM_SEAT_CURRENCY | YAHOO_DATA_FEES | COMPLETIONS_50 | DROP_RATE_AT_50 | UNIQUE_CONVERTERS | COMPANION_CLICKS | UNIQUE_VIEW_THROUGH_CONVERTERS | COMPLETIONS_100 | CLICK_THROUGH_CONVERSION | ESTIMATED_UNIQUE_STORE_VISITORS | MOAT_MEASURABILITY_RATE | CONVERSION | AVERAGE_FREQUENCY_PER_HOUSEHOLD | THIRD_PARTY_DATA_FEES | COMPLETION_RATE_25 | ESTIMATED_STORE_VISIT_THROUGH_RATE_VTR | MAIL_AD_CLICK_OUTS_RATE | YAHOO_SEGMENT_FEE | THIRD_PARTY_SEGMENT_FEE | VIEW_THROUGH_CONVERSION_VALUE | VERY_FIRST_VIEW_THROUGH_CONVERSION | BID_CPM_ORDER_CURRENCY | YAHOO_MEASURABLE_RATE | BID_PRICE_WITHOUT_MULTIPLIER | VERY_FIRST_CLICK_THROUGH_CONVERSION | CPCV | BRAND_SAFETY_COST | UNIQUE_VIEWERS | COMPLETION_RATE_50 | SKIPPED_ADS | ESTIMATED_COST_PER_STORE_VISIT_CPSV | BID_CPM | MAIL_AD_CLICK_OUTS | PUBLISHER_EARNINGS | AVERAGE_FREQUENCY | MULTIPLIED_ECPM | DROP_RATE_AT_25 | MAIL_AD_FORWARD_RATE | NON_VIEWABLE_IMPRESSIONS | AVERAGE_IMPRESSION_MULTIPLIER | PUBLISHER_EARNINGS_PERCENTAGE | MAIL_AD_SUBMIT_RATE | FILTERED_COMPANION_CLICKS | AD_VERIFICATION_COST | MOAT_IMPRESSIONS_ANALYZED | COMPLETIONS_25 | CROSS_DEVICE_CONVERSIONS | PLATFORM_FEE | AUDIENCE_MEASUREMENT_COST | BID_RESPONSES | VIEW_THROUGH_CPA | COMPANION_IMPRESSIONS | ESTIMATED_BILLABLE_AMOUNT | INVENTORY_COST_PERCENTAGE | MAIL_AD_SAVES | VERY_FIRST_VIEW_THROUGH_CONVERSION_VALUE | BID_PRICE_WITHOUT_MULTIPLIER_SEAT_CURRENCY | DROP_RATE_AT_0 | AVERAGE_PEOPLE_FREQUENCY | CLICK_THROUGH_CONVERSION_RATE | MOAT_VIEWABLE_RATE | INVENTORY_ECPM | COST_PER_VALID_VIDEO_VIEW_CPV | FILTERED_CLICKS | QUALIFIED_BID_REQUESTS" ], "prebuilt_report_type": "REPORT_CONVERSIONS | REPORT_SITE_DOMAIN_PERFORMANCE | REPORT_BASIC | REPORT_AUDIENCE_SEGMENT | REPORT_CAMPAIGN_PERFORMANCE | REPORT_AD_PERFORMANCE | REPORT_LINE_PERFORMANCE | REPORT_DYNAMIC_PRODUCT_ADS", "report_name": "string", "time_zone": "ASIA_JAKARTA | AMERICA_NEW_YORK | ASIA_DUBAI | ASIA_KARACHI | AMERICA_HALIFAX | ASIA_JERUSALEM | AMERICA_MEXICO_CITY | EUROPE_PARIS | PACIFIC_AUCKLAND | AMERICA_SAO_PAULO | ASIA_SHANGHAI | AMERICA_LIMA | ETC_GMT | ASIA_DHAKA | AMERICA_ARGENTINA_BUENOS_AIRES | AMERICA_EL_SALVADOR | AMERICA_DENVER | AMERICA_SANTIAGO | ASIA_TOKYO | AUSTRALIA_PERTH | AMERICA_LOS_ANGELES | AUSTRALIA_SYDNEY | AMERICA_CHICAGO | EUROPE_LONDON | AMERICA_BOGOTA | AMERICA_PUERTO_RICO", "use_advertiser_timezone": true } ], "seats": [ 0 ], "sync_mode_advertiser": "SPECIFIC_ADVERTISERS | ALL_ADVERTISERS", "sync_mode_seat": "ALL_SEATS | SPECIFIC_SEATS", "timeframe_months": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE", "schema": "schema_name" }, "auth": { "client_id": "client_id", "client_secret": "client_secret" } }
Config parameters
| Name | Description |
|---|---|
advertisers_with_seat | Specific Advertisers to sync. Must be populated if sync_mode_advertiser is set to SPECIFIC_ADVERTISERS. Pay attention to the format: AdvertiserId:SeatId |
report_configs | Specify the reports you want to sync. This is optional. |
report_configs[0].config_type | Set the value to PREBUILT if it's one of the preconfigured reports (see the prebuilt_report_type option). Otherwise, set to CUSTOM. |
report_configs[0].currency | Currency used in a report. Default value: USD. |
report_configs[0].dimensions | Dimensions used in a report. Must be populated if config_type is set to CUSTOM. PUBLISHER, DESKTOP_OS_DEPRECATED, LINE_TYPE, GOAL_TYPE, BID_REQUEST_AD_SIZE, CHANNEL_TYPE, SITE_NAME, and SITE_GROUP_NAME are deprecated dimension, and shouldn't be used anymore |
report_configs[0].interval_type | The granularity of data in a report. Default value: DAY. |
report_configs[0].metrics | Metrics used in a report. Must be populated if config_type is set to CUSTOM. PUBLISHER_EARNINGS, PUBLISHER_EARNINGS_PERCENTAGE, INVENTORY_ECPM_DEPRECATED, SEAT_TECH_FEE, and SEAT_DATA_FEE are deprecated and shouldn't be used anymore |
report_configs[0].prebuilt_report_type | Specific report type to sync. Must be populated if config_type is set to PREBUILT. |
report_configs[0].report_name | Table name in destination. |
report_configs[0].time_zone | Specify the time zone to be used to request report data |
report_configs[0].use_advertiser_timezone | Use advertiser timezone to request report data. |
seats | Specific Seats to sync. Must be populated if sync_mode_seat is set to SPECIFIC_SEATS. |
sync_mode_advertiser | Whether to sync all advertisers or specific advertisers. Default value: ALL_ADVERTISERS. |
sync_mode_seat | Whether to sync all seats or specific seats. Default value: ALL_SEATS. |
timeframe_months | Number of monthsworth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value:THREE`. |
schema (required) | Destination schema name. Schema name is permanent and cannot be changed after connection creation |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the
client_idandclient_secretparameters in theauthsection.POST https://api.fivetran.com/v1/connections{ "service": "yahoo_dsp", "group_id": "group_id", "auth": { "client_id": "client_id", "client_secret": "client_secret" } }Auth Parameters
Name Description client_idYour Yahoo DSP Client ID. client_secretYour Yahoo DSP Client Secret. By using the Connect Card or the Fivetran dashboard.