Yahoo DSP API Configuration Beta
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": "NORMAL",
"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
},
"proxy_agent_id": "proxy_agent_id",
"private_link_id": "private_link_id",
"networking_method": "Directly",
"hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
"config": {
"sync_mode_advertiser": "ALL_ADVERTISERS | SPECIFIC_ADVERTISERS",
"advertisers_with_seat": "[\"1234578:987\", \"19283411:999\"]",
"timeframe_months": "THREE | SIX | TWELVE | TWENTY_FOUR | ALL_TIME",
"report_configs": [
{
"prebuilt_report_type": "REPORT_BASIC | REPORT_CONVERSIONS | REPORT_LINE_PERFORMANCE | REPORT_CAMPAIGN_PERFORMANCE | REPORT_AD_PERFORMANCE | REPORT_AUDIENCE_SEGMENT | REPORT_SITE_DOMAIN_PERFORMANCE | REPORT_DYNAMIC_PRODUCT_ADS",
"use_advertiser_timezone": true,
"currency": "SEAT | ADVERTISER | CAMPAIGN | USD",
"metrics": [
"IMPRESSIONS | CLICKS | CTR | CONVERSION | START_VIEWS | COMPLETIONS_25 | COMPLETIONS_50 | COMPLETIONS_75 | COMPLETIONS_100 | DROP_RATE_AT_0 | DROP_RATE_AT_25 | DROP_RATE_AT_50 | DROP_RATE_AT_75 | CPC | CNVR | CPA | ADVERTISER_SPENDING | ADVERTISER_ECPM | PUBLISHER_EARNINGS | PUBLISHER_EARNINGS_PERCENTAGE | INVENTORY_ECPM_DEPRECATED | NETWORK_PROFIT | NETWORK_PROFIT_PERCENTAGE | NETWORK_ECPM | AVERAGE_FREQUENCY | COMPLETION_RATE_25 | COMPLETION_RATE_50 | COMPLETION_RATE_75 | COMPLETION_RATE_100 | YAHOO_MEASURABLE_IMPRESSIONS | YAHOO_VIEWABLE_IMPRESSIONS | YAHOO_VIEWABLE_RATE | NON_VIEWABLE_IMPRESSIONS | YAHOO_NON_MEASURABLE_IMPRESSIONS | YAHOO_MEASURABLE_RATE | IMPRESSION_DISTRIBUTION_VIEWABLE | IMPRESSION_DISTRIBUTION_NONVIEWABLE | IMPRESSION_DISTRIBUTION_NONMEASURABLE | VIEW_THROUGH_CONVERSION | CLICK_THROUGH_CONVERSION | VIEW_THROUGH_CONVERSION_RATE | CLICK_THROUGH_CONVERSION_RATE | VIEW_THROUGH_CPA | CLICK_THROUGH_CPA | UNIQUE_VIEWERS | SEAT_TECH_FEE | SEAT_DATA_FEE | SEAT_MANAGEMENT_FEE | FILTERED_IMPRESSIONS | FILTERED_CLICKS | CONVERSION_VALUE | ROAS | MOAT_VIEWABLE_RATE | MOAT_VIEWABLE_IMPRESSIONS | MOAT_MEASURABLE_IMPRESSIONS | VCPM | CPCV | CROSS_DEVICE_CONVERSIONS | QUALIFIED_BID_REQUESTS | YAHOO_DATA_FEES | THIRD_PARTY_DATA_FEES | ORDER_MANAGEMENT_FEE | AD_SERVING_COST | AD_VERIFICATION_COST | AUDIENCE_MEASUREMENT_COST | BRAND_SAFETY_COST | VIEWABIILITY_COST | OTHER_COST | TOTAL_VARIABLE_COST | MOAT_IMPRESSIONS_ANALYZED | MOAT_AVOC | MOAT_AVFH | MOAT_MEASURABILITY_RATE | MOAT_AVOC_RATE | SKIPPED_ADS | BID_RESPONSES | TOTAL_VENDOR_FEE | BID_PRICE_WITHOUT_MULTIPLIER | BID_PRICE_WITHOUT_MULTIPLIER_ORDER_CURRENCY | MULTIPLIED_ECPM | BID_CPM | BID_CPM_ORDER_CURRENCY | DYNAMIC_CONVERSION_VALUE | VERY_FIRST_CONVERSION | UNIQUE_CONVERTERS | UNIQUE_CLICK_THROUGH_CONVERTERS | UNIQUE_VIEW_THROUGH_CONVERTERS | AUDIENCE_IMPRESSIONS | COST_PER_VALID_VIDEO_VIEW_CPV | BID_PRICE_WITHOUT_MULTIPLIER_ADVERTISER_CURRENCY | BID_PRICE_WITHOUT_MULTIPLIER_SEAT_CURRENCY | BID_CPM_ADVERTISER_CURRENCY | BID_CPM_SEAT_CURRENCY | COMPANION_IMPRESSIONS | COMPANION_CLICKS | MAIL_AD_OPENS | MAIL_AD_FORM_SUBMITS | MAIL_AD_SAVES | MAIL_AD_FORWARDS | MAIL_AD_CLICK_OUTS | MAIL_AD_SUBMIT_RATE | MAIL_AD_SAVES_RATE | MAIL_AD_FORWARD_RATE | MAIL_AD_CLICK_OUTS_RATE | FILTERED_COMPANION_IMPRESSIONS | FILTERED_COMPANION_CLICKS | ESTIMATED_BILLABLE_AMOUNT | AVERAGE_FREQUENCY_PER_HOUSEHOLD | AVERAGE_IMPRESSION_MULTIPLIER | ESTIMATED_NUMBER_OF_STORE_VISITS | ESTIMATED_UNIQUE_STORE_VISITORS | ESTIMATED_STORE_VISIT_THROUGH_RATE_VTR | ESTIMATED_COST_PER_STORE_VISIT_CPSV | AVERAGE_PEOPLE_FREQUENCY | VERY_FIRST_VIEW_THROUGH_CONVERSION | VERY_FIRST_CLICK_THROUGH_CONVERSION | VIEW_THROUGH_CONVERSION_VALUE | CLICK_THROUGH_CONVERSION_VALUE | VERY_FIRST_VIEW_THROUGH_CONVERSION_VALUE | VERY_FIRST_CLICK_THROUGH_CONVERSION_VALUE | YAHOO_SEGMENT_FEE | THIRD_PARTY_SEGMENT_FEE | AVAILABLE_BID_REQUESTS | AVERAGE_WIN_RATE | TOTAL_DATA_FEE | PLATFORM_FEE | INVENTORY_ECPM | INVENTORY_COST_PERCENTAGE | INVENTORY_COST"
],
"report_name": "string",
"time_zone": "AMERICA_LOS_ANGELES | AMERICA_DENVER | AMERICA_CHICAGO | AMERICA_EL_SALVADOR | AMERICA_MEXICO_CITY | AMERICA_NEW_YORK | AMERICA_BOGOTA | AMERICA_LIMA | AMERICA_HALIFAX | AMERICA_PUERTO_RICO | AMERICA_ARGENTINA_BUENOS_AIRES | AMERICA_SANTIAGO | AMERICA_SAO_PAULO | ETC_GMT | EUROPE_LONDON | EUROPE_PARIS | ASIA_JERUSALEM | ASIA_DUBAI | ASIA_KARACHI | ASIA_DHAKA | ASIA_JAKARTA | AUSTRALIA_PERTH | ASIA_SHANGHAI | ASIA_TOKYO | AUSTRALIA_SYDNEY | PACIFIC_AUCKLAND",
"config_type": "PREBUILT | CUSTOM",
"interval_type": "CUMULATIVE | DAY | MONTH | WEEK | HOUR",
"dimensions": [
"PUBLISHER | LAYOUT | ADVERTISER | CAMPAIGN | LINE | AD | CREATIVE | DOMAIN | ADVERTISER_CATEGORY_ID | COUNTRY | REGION | CITY | POSTAL_CODE | DEVICE_CATEGORY | BROWSER_TYPE | DESKTOP_OS_DEPRECATED | AGE | GENDER | AD_POSITION | DEVICE_TYPE | ADVERTISER_SUB_CATEGORY | PIXEL | SUBDOMAIN | APP_NAME | SEAT_ID | LINE_TYPE | ADVERTISER_GROUP | MOBILE_CARRIER | GOAL_TYPE | LINE_BILLING_METHOD | PARENT_LINE | MARKET_AREA | FREQUENCY_BUCKET_1D | FREQUENCY_BUCKET_7D | FREQUENCY_BUCKET_30D | PIXEL_PARAMETER | TARGET_AUDIENCE_ID_GROUP_A | INVENTORY_TYPE | BUCKETED_AGE | DEMO_VENDOR | MOBILE_OS | MOBILE_MAKE | MOBILE_MODEL | CONNECTION_TYPE | ISP | CREATIVE_CUSTOM_ID | DAYS_TO_CONVERSION | PACKAGE | EXCHANGE_DEAL_ID | DOT_RULE | CONNECTED_TV_DEVICE | INVENTORY_AUCTION_TYPE | SUPPLY_GROUP | NATIVE_TYPE | BID_REQUEST_AD_SIZE | WEATHER_CONDITION | TARGET_AUDIENCE_ID_GROUP_B | CHANNEL_TYPE | VIDEO_CONTENT_LENGTH | VIDEO_AD_PLACEMENT | ADS_TXT_DECLARATION | CREATIVE_FORMAT | SITE_NAME | VIDEO_PLAYER_SIZE | SITE_GROUP_NAME | DYNAMIC_CREATIVE_VARIATION | DYNAMIC_CREATIVE_SET | LINE_START_DATE | LINE_END_DATE | PACKAGE_END_DATE | CAMPAIGN_CURRENT_SCHEDULE_TOTAL_BUDGET | PACKAGE_SCHEDULE_NAME | PACKAGE_CURRENT_SCHEDULE_TOTAL_BUDGET | LINE_SCHEDULE_NAME | LINE_SCHEDULE_START_DATE | LINE_SCHEDULE_END_DATE | LINE_DAILY_BUDGET_SCHEDULE | LINE_CURRENT_SCHEDULE_TOTAL_BUDGET | LINE_BUDGET_PACING | LINE_PACING_ACCELERATION | CONNECTED_TV_MAKE | CONNECTED_TV_MODEL | LINE_FLIGHT | PACKAGE_BUDGET_SCHEDULE | DEAL_TYPE | VIDEO_CREATIVE_DURATION | CAMPAIGN_SCHEDULE_NAME | CAMPAIGN_SCHEDULE_END_DATE | CAMPAIGN_START_DATE | CAMPAIGN_END_DATE | PACKAGE_SCHEDULE_START_DATE | PACKAGE_SCHEDULE_END_DATE | CAMPAIGN_TOTAL_BUDGET | CAMPAIGN_DAILY_BUDGET | PACKAGE_TOTAL_BUDGET | PACKAGE_DAILY_BUDGET | LINE_TOTAL_BUDGET | LINE_DAILY_BUDGET | CAMPAIGN_DAILY_BUDGET_SCHEDULE | PACKAGE_DAILY_BUDGET_SCHEDULE | PACKAGE_BUDGET_DISTRIBUTOR | AD_SERVING_COST_NAME | AUDIENCE_MEASUREMENT_COST_NAME | OTHER_COST_NAME | CONTENT_SHOW | CONTENT_CHANNEL | CONTENT_NETWORK | CONTENT_TITLE | CONTENT_GENRE | LINE_CHANNEL_TYPE | LINE_GOAL_TYPE | EXCHANGE | DESKTOP_OS | BID_REQUEST_DIMENSIONS | NATIVE_SITE | NATIVE_SITE_GROUP"
]
}
],
"sync_mode_seat": "ALL_SEATS | SPECIFIC_SEATS",
"seats": [
0
],
"schema": "schema_name"
},
"auth": {
"client_secret": "client_secret",
"client_id": "client_id"
}
}Config parameters
| Name | Description |
|---|---|
sync_mode_advertiser | Whether to sync all advertisers or specific advertisers. Default value: ALL_ADVERTISERS. |
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 |
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`. |
report_configs | Specify the reports you want to sync. This is optional. |
report_configs[0].prebuilt_report_type | Specific report type to sync. Must be populated if config_type is set to PREBUILT. |
report_configs[0].use_advertiser_timezone | Use advertiser timezone to request report data. |
report_configs[0].currency | Currency used in a report. Default value: USD. |
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].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].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].interval_type | The granularity of data in a report. Default value: DAY. |
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 |
sync_mode_seat | Whether to sync all seats or specific seats. Default value: ALL_SEATS. |
seats | Specific Seats to sync. Must be populated if sync_mode_seat is set to SPECIFIC_SEATS. |
schema | 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_secretYour Yahoo DSP Client Secret. client_idYour Yahoo DSP Client ID. By using the Connect Card or the Fivetran dashboard.