In Market Audience Record - Bulk

Defines an in-market audience that can be downloaded in a bulk file.

Note

Bulk upload is not supported. You cannot add, update, or delete an in-market audience using the Bing Ads API. Having said that, you can add and delete in-market audience associations and exclusions. Bing Ads API will always return all currently active in-market audiences. The service does not return deleted in-market audiences, or any delta download to see what changed. You should not take any dependencies on the sandbox in-market audiences. Some in-market audiences are available in sandbox, but not in production. The in-market audience property values can also differ between sandbox and production e.g., the audience name and size.

Note

This feature is available only in the United States.

Tip

For an overview of in-market audiences see the About in-market audiences help topic.

You can download all In Market Audience records in the account by including the DownloadEntity value of InMarketAudiences in the DownloadCampaignsByAccountIds or DownloadCampaignsByCampaignIds service request. Additionally the download request must include the EntityData scope. For more details about the Bulk service including best practices, see Bulk Download and Upload.

The following is a Bulk CSV example download for in-market audience.

Type,Status,Id,Parent Id,Client Id,Modified Time,Name,Description,Membership Duration,Scope,Audience,Supported Campaign Types
Format Version,,,,,,6.0,,,,,
In Market Audience,Active,IdHere,ParentIdHere,ClientIdGoesHere,,,In Market Audience Description,30,Account,In Market Audience,Search;DynamicSearchAds;Shopping;Audience

If you are using the Bing Ads SDKs for .NET, Java, or Python, you can save time using the BulkServiceManager to download the BulkInMarketAudience object, instead of calling the service operations directly and writing custom code to parse each field in the bulk file.

// Map properties in the Bulk file to the BulkInMarketAudience
var bulkInMarketAudience = new BulkInMarketAudience
{
    // Map properties in the Bulk file to the 
    // InMarketAudience object of the Campaign Management service.
    InMarketAudience = new InMarketAudience
    {
        // 'Audience Network Size' column header in the Bulk file
        AudienceNetworkSize = null,
        // 'Description' column header in the Bulk file
        Description = "In Market Audience Description",
        // 'Id' column header in the Bulk file
        Id = InMarketAudienceIdKey,
        // 'Membership Duration' column header in the Bulk file
        MembershipDuration = 30,
        // 'Audience' column header in the Bulk file
        Name = "In Market Audience",
        // 'Parent Id' column header in the Bulk file
        ParentId = accountIdKey,
        // 'Scope' column header in the Bulk file
        Scope = EntityScope.Account,
        // 'Audience Search Size' column header in the Bulk file
        SearchSize = null,
        // 'Supported Campaign Types' column header in the Bulk file
        SupportedCampaignTypes = null,
    },
                
    // 'Status' column header in the Bulk file
    Status = Status.Active
};

For an In Market Audience record, the following attribute fields are available in the Bulk File Schema.

Audience

The name of the in-market audience.

The name can contain a maximum of 128 characters

Add: Not supported
Update: Not supported
Delete: Not supported

Audience Network Size

The total number of people who are active members of this audience in the Audience network. This gives you an idea of how many Audience network users you can target.

The audience needs to have at least 300 people before Microsoft Advertising will use it for optimizations.

Add: Not supported
Update: Not supported
Delete: Not supported

Audience Search Size

The total number of people who are active members of this audience in the Search network. This gives you an idea of how many search users you can target.

The audience needs to have at least 1,000 people before Microsoft Advertising will use it for optimizations.

Add: Not supported
Update: Not supported
Delete: Not supported

Description

The description of the in-market audience. Use a description to help you remember what audience you are targeting with this in-market audience.

The description can contain a maximum of 1,024 characters.

Add: Not supported
Update: Not supported
Delete: Not supported

Id

The system generated identifier of the in-market audience.

Add: Not supported
Update: Not supported
Delete: Not supported

Membership Duration

When you create an in-market audience in the Microsoft Advertising web application, you can specify how far back in time Microsoft Advertising should look for actions that match your in-market audience definition in order to add people to your list.

The mimimum duration is 1 day and the maximum duration allowed is 180 days.

Add: Not supported
Update: Not supported
Delete: Not supported

Modified Time

The date and time that the entity was last updated. The value is in Coordinated Universal Time (UTC).

Note

The date and time value reflects the date and time at the server, not the client. For information about the format of the date and time, see the dateTime entry in Primitive XML Data Types.

Add: Not supported
Update: Not supported
Delete: Not supported

Parent Id

The Microsoft Advertising identifier of the customer that contains the in-market audience.

Add: Not supported
Update: Not supported
Delete: Not supported

Scope

Scope defines what accounts can use this in-market audience. For an in-market audience the only supported scope is Customer, and the in-market audience can be associated with any ad groups across all of the customer's accounts.

Add: Not supported
Update: Not supported
Delete: Not supported

Status

The in-market audience status.

Possible values are Active or Deleted.

Add: Not supported
Update: Not supported
Delete: Not supported

Supported Campaign Types

The semicolon delimited list of campaign types that support this in-market audience.

Supported values are Audience, DynamicSearchAds, Search, and Shopping. New campaign types might be added in the future, so you should not take any dependency on a fixed set of values.

Add: Not supported
Update: Not supported
Delete: Not supported