Skip to main content

Microsoft Ads Reader

Note

This adapter is in preview and is available on Striim Developer only. See Striim Developer for more information.

Microsoft Advertising (formerly Bing Ads) is an online advertising platform developed by Microsoft, where advertisers bid to display brief ads, service offers, product listings and videos to web users. The Microsoft Ads Reader can connect with the Microsoft Advertising platform and read data from supported objects/tables.

Feature summary

Feature

Supported?

Notes

Objects

Standard objects

✓

Custom objects

✓

Authentication

Basic authentication

Username and password

OAuth authentication

✓

Manual configuration based

Custom authentication methods

Not all methods may be supported

Operations

Automated mode

✓

Initial load

✓

Pull-based incremental load

✓

Push-based incremental load

Automated pipeline

Governance

Connection profile

Sherlock AI

Sentinel AI

Schema handling

Initial schema creation

✓

Works with supported targets

Schema evolution

Setup

Wizard template

Flow Designer

✓

Striim TQL

✓

Runtime

Resilience/recovery

✓

Parallel execution

Metrics

✓

Standard metrics

Supported authentication method

The Microsoft Ads Reader supports OAuth authentication. Creating a connection requires registering an application in the Azure Portal, requesting user consent for your application to manage the user's Microsoft Advertising accounts obtaining access and refresh tokens, and setting the connection properties in Striim.

To configure OAuth authentication:

  1. Go to the Azure Portal and sign in (or create a free account if needed).

  2. Register an application. See Register an application in the Microsoft documentation.

  3. Request user consent for your application to manage their Microsoft Advertising accounts.

  4. Get the access and refresh tokens.

Supported objects

The following are the supported objects for reading from Microsoft Ads:

  • AccountPerformanceReport

  • Accounts

  • AdAssets

  • AdDynamicTextPerformanceReport

  • AdExtensionAssets

  • AdExtensionByAdReport

  • AdExtensionByKeywordReport

  • AdExtensionDetailReport

  • AdExtensions

  • AdGroupPerformanceReport

  • AdGroups

  • AdPerformanceReport

  • Ads

  • AgeGenderAudienceReport

  • AssetGroupAssets

  • AssetGroups

  • AudiencePerformanceReport

  • Audiences

  • BidOpportunities

  • BudgetOpportunities

  • BudgetSummaryReport

  • Budgets

  • CampaignPerformanceReport

  • Campaigns

  • ConversionPerformanceReport

  • DSAAutoTargetPerformanceReport

  • DSACategoryPerformanceReport

  • DSASearchQueryPerformanceReport

  • DataExclusions

  • DestinationUrlPerformanceReport

  • GeographicPerformanceReport

  • GoalsAndFunnelsReport

  • KeywordEstimatedBid

  • KeywordEstimatedPosition

  • KeywordHistoricalSearch

  • KeywordPerformance

  • KeywordPerformanceReport

  • Keywords

  • NegativeKeywordConflictReport

  • ProductDimensionPerformanceReport

  • ProductNegativeKeywordConflictReport

  • ProductPartitionPerformanceReport

  • ProductPartitionUnitPerformanceReport

  • ProductSearchQueryPerformanceReport

  • PublisherUsagePerformanceReport

  • SearchCampaignChangeHistoryReport

  • SearchQueryPerformanceReport

  • SeasonalityAdjustments

  • ShareOfVoiceReport

  • Tags

  • UserLocationPerformanceReport

Microsoft Ads Reader properties

Property

Type

Default value

Notes

Account ID

String

The ID of the account that you want to get data for. If it is not specified the reader will use the first account ID it finds from querying the API.

Customer ID

String

Customer ID of the currently authenticated user.

Access token

Password

The Access token property is used to connect using OAuth. The OAuth access token is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

Client ID

String

Client ID of the OAuth app registered in the Active Directory of the Microsoft platform.

Client secret

Password

Client secret of the OAuth app registered in the Active Directory of the Microsoft platform.

Connection pool size

Integer

20

Specifies the maximum number of active connections.

Exclude tables

String

A list of tables excluded from read operations. Typically used to create a list of exceptions when the Tables property includes wildcards. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors.

Incremental load marker

String

The incremental load marker is a unique incremental column in each object used for incremental load. When no marker is specified, tables are resynced at each polling interval.

Specify the name of the column that contains the start position value. This column must meet the following criteria:

  • It should have an integer or timestamp data type (for example, a creation timestamp or an employee ID).

  • The values must be unique and continuously increasing to ensure proper incremental reading.

Migrate schema

Boolean

False

Only available in Initial Load or Automated mode. Set to True to enable initial schema migration, which propagates the object schema from the source to the target.

Mode

Select list:

  • Automated mode

  • Initial load

  • Incremental load

Automated

Automated mode applies incremental updates to objects that support incremental load and performs full resyncs for objects that do not support incremental load.

Polling interval

Integer

5m

Specifies an interval as an integer followed by a unit. Supported units are days (d), hours (h), minutes (m), or seconds (s). The reader polls the source at the specified interval.

Start Position

String

%=-1

Value of the incremental load marker that defines the initial reading position.

Tables

String

A semicolon-delimited (;) list of objects to read from the source. Supports the % wildcard. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors. Do not modify this property when recovery is enabled for the application.

Thread pool count

Integer

10

The number of parallel running threads. The default value of zero specifies single-threaded operation.

When the value of the thread pool counter is higher than the connection pool size, large data ingestion operations can cause the app to halt. Since best performance is achieved when using one thread for each table being synced, increasing the size of the connection pool to match the number of threads in use is a performance best practice.