InMarketAudience Data Object - Campaign Management

Artikkeli
11/13/2024

Defines an in-market audience.

Note

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. The in-market audiences returned via Bing Ads API is a union of all available in-market audiences across all markets e.g., AU, CA, DE, FR, UK, and US. The AudienceNetworkSize and SearchSize are a sum of lists sizes across all supported markets for a given in-market audience in the corresponding network. The Bing Ads API does not provide details of list sizes per market. For example the "Advertising and Marketing" in-market audience size in the search network might be returned as 17070879 (17.1M) via the Bing Ads API. The breakdown per market shown in the Microsoft Advertising web application might be: 2.88M in US; 474K in AU; 13.7M in UK.
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 in Australia, Canada, France, Germany, United Kingdom, and United States.

Tip

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

<xs:complexType name="InMarketAudience" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:Audience">
      <xs:sequence />
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

{
  "AudienceNetworkSize": "LongValueHere",
  "CustomerShare": {
    "CustomerAccountShares": [
      {
        "AccountId": "LongValueHere",
        "Associations": [
          {
            "AssociationCount": "LongValueHere",
            "UsageType": "ValueHere"
          }
        ],
        "CustomerId": "LongValueHere"
      }
    ],
    "OwnerCustomerId": "LongValueHere"
  },
  "Description": "ValueHere",
  "ForwardCompatibilityMap": [
    {
      "key": "ValueHere",
      "value": "ValueHere"
    }
  ],
  "Id": "LongValueHere",
  "MembershipDuration": IntValueHere,
  "Name": "ValueHere",
  "ParentId": "LongValueHere",
  "Scope": "ValueHere",
  "SearchSize": "LongValueHere",
  "SupportedCampaignTypes": [
    "ValueHere"
  ],
  "Type": "InMarket"
}

Elements

The InMarketAudience object has Inherited Elements.

Inherited Elements

Inherited Elements from Audience

The InMarketAudience object derives from the Audience object, and inherits the following elements: AudienceNetworkSize, CustomerShare, Description, ForwardCompatibilityMap, Id, MembershipDuration, Name, ParentId, Scope, SearchSize, SupportedCampaignTypes, Type. The descriptions below are specific to InMarketAudience, and might not apply to other objects that inherit the same elements from the Audience object.

Element	Description	Data Type
AudienceNetworkSize	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. Add: Not supported Update: Not supported	long
CustomerShare	This element is not supported for in-market audiences. Add: Not supported Update: Not supported	CustomerShare
Description	The description of the audience. Use a description to help you remember what audience you are targeting. The description can contain a maximum of 1,024 characters. Add: Not supported Update: Not supported	string
ForwardCompatibilityMap	The list of key and value strings for forward compatibility to avoid otherwise breaking changes when new elements are added in the current API version. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for the Audience object.	KeyValuePairOfstringstring array
Id	The Microsoft Advertising identifier of the audience. Add: Not supported Update: Not supported	long
MembershipDuration	When you create an audience, you can specify how far back in time Microsoft Advertising should look for actions that match your audience definition. The minimum duration is 1 day and the maximum duration allowed is 180 days. Add: Not supported Update: Not supported	int
Name	The name of the audience. The name can contain a maximum of 128 characters. Add: Not supported Update: Not supported	string
ParentId	The Microsoft Advertising identifier of the customer that contains the in-market audience. Add: Not supported Update: Not supported	long
Scope	Scope defines what accounts can use this audience. For an in-market audience the only supported scope is Customer, and the audience can be associated with campaigns and ad groups in all of the customer's accounts. Add: Not supported Update: Not supported	EntityScope
SearchSize	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. Add: Not supported Update: Not supported	long
SupportedCampaignTypes	The list of campaign types that support this 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	string array
Type	The type of the audience. This value is InMarket when you retrieve an in-market audience. For more information about audience types, see the Audience Data Object Remarks. Add: Not supported Update: Not supported	AudienceType

Requirements

Service: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13

Jaa