Skip to main content

Yahoo Ads

info

API Documentation:

High-Level Information:

The Yahoo JAPAN Ads API allows you to access data from both Search Ads and Display Ads campaigns on the Yahoo! JAPAN advertising platform. This connector supports syncing:

  1. Search Ads: Campaign structure (campaigns, ad groups, ads, keywords, etc.) and performance reporting.
  2. Display Ads: Campaign structure (campaigns, ad groups, ads, audiences, assets, etc.) and performance reporting.

Source Setup Guide​

This is an OAuth-based setup:

  1. Click the Connect button
  2. Authenticate with your Yahoo JAPAN Business ID credentials
  3. Grant Extract the necessary permissions to access your advertising data
  4. Verify that your account is visible and the source status shows Connected

Connection Setup Guide​

Once you connected Yahoo Ads to a destination, you will also need to configure:

  • Connection Pull Schedule: Determines how frequently data is extracted from the source.
  • Backfill (Days): Specifies the duration for which historical data will be retrieved during each connection run.
  • Accounts Whitelist: Select specific accounts to sync, or all of them.
  • Destination specific settings: different settings such as "Dataset Name" or "Target Schema" (depending on your destination)
  • Schema Migration Policy: Controls how Extract will handle schema changes from the source.

Connector Information​

info

API Overview​

Yahoo Ads provides two separate APIs:

Search Ads API (https://ads-search.yahooapis.jp/api/v18/)

  • Campaign, Ad Group, Ad, and Keyword management
  • Bidding strategies and conversion tracking
  • Retargeting lists and audience management
  • Performance reports by account, campaign, ad group, keyword, and search query

Display Ads API (https://ads-display.yahooapis.jp/api/v18/)

  • Campaign and Ad Group management
  • Audience lists and placement targeting
  • Media and video asset management
  • Performance reports including reach, audience targeting, and conversion paths

Authentication​

This connector uses OAuth 2.0. During setup, Extract obtains and stores a refresh token and uses it to mint access tokens as needed.

Account scoping​

Yahoo Ads APIs require a base account ID header (x-z-base-account-id) on requests. The connector automatically discovers the base account ID and available accounts during login, and then syncs either:

  • all discovered accounts, or
  • only the accounts selected in Accounts Whitelist.

Important Notes​

  • Empty Data Exclusion: Resources without actual performance metrics may not be included in report outputs.
  • Timezone: Data is pulled in the original timezone configured in your Yahoo Ads account.
  • Rate limiting & concurrency: The connector throttles requests and processes multiple accounts concurrently to balance throughput and API limits.

Configuration Reference​

The following source/connection settings are used by the connector:

  • Backfill (Days) (backfill)
    • Number of days of historical report data to fetch on each run.
  • Accounts Whitelist (account_ids)
    • Optional list of Yahoo Ads account IDs to sync. If unset, all accessible accounts are synced.

OAuth fields (for example client_id, client_secret, and the OAuth token/refresh token) are managed during the UI-based OAuth flow and typically do not need to be entered manually.

Schema ERD​

Explore the interactive entity relationship diagram for Yahoo Ads.

Open page

Data Streams​