Edit

CustomSegment Data Object - Campaign Management

Defines the CustomSegment data object.

Syntax

<xs:complexType name="CustomSegment" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:Audience">
      <xs:sequence>
        <xs:element minOccurs="0" name="CustomSegmentCatalogList" nillable="true" type="tns:ArrayOfCustomSegmentCatalog" />
        <xs:element minOccurs="0" name="EditorialStatus" nillable="true" type="tns:CustomSegmentEditorialStatus" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Elements

The CustomSegment object has the following elements: CustomSegmentCatalogList, EditorialStatus.

Element Description Data Type
CustomSegmentCatalogList A list of custom segment catalogs.

Add: Required
Update: Optional, if no value is set for the update, this setting isn't changed.		 CustomSegmentCatalog array
EditorialStatus The custom segment editorial status.

Add: Read-only
Update: Read-only		 CustomSegmentEditorialStatus

The CustomSegment object has Inherited Elements.

Inherited Elements

Inherited Elements from Audience

The CustomSegment 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 CustomSegment, 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.

Please see more details in documentation for the objects that inherit this element e.g., RemarketingList.		 long
CustomerShare Determines the list of customers and accounts that share the audience. Details include audience association counts.

This element is only supported with a RemarketingList. Audiences of other types cannot be shared in the customer hierarchy.		 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.		 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 this object.		 KeyValuePairOfstringstring array
Id The Microsoft Advertising identifier of the audience. 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.		 int
Name The name of the audience. The name can contain a maximum of 128 characters. string
ParentId The Microsoft Advertising identifier of the account or customer.

If the Scope is set to Account, this is the account ID, and otherwise it is the customer ID.		 long
Scope Scope defines what accounts can use this audience.

If scope is set to Account, the audience can only be associated with campaigns and ad groups in one account i.e., via the ParentId. If scope is set to Customer, the audience can be associated with campaigns and ad groups in all of the customer's accounts.		 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.

Please see more details in documentation for the objects that inherit this element e.g., RemarketingList.		 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.		 string array
Type The type of the segment. AudienceType

Requirements

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

  • Last updated on