Defines a label object to organize campaigns, ad groups, ads, and keywords into groups. You can then filter and run reports on your labels to get the data that is most meaningful to you.
Syntax
<xs:complexType name="Label" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:sequence>
<xs:element minOccurs="0" name="ColorCode" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Id" nillable="true" type="xs:long" />
<xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
{
"ColorCode": "ValueHere",
"Description": "ValueHere",
"Id": "LongValueHere",
"Name": "ValueHere"
}
Elements
The Label object has the following elements: ColorCode, Description, Id, Name.
| Element |
Description |
Data Type |
| ColorCode |
The label color as a hexadecimal code.
The hexadecimal value must have the '#' prefix. For example you can use the value of #FFFFFF for a white label.
The color can be viewed in the Microsoft Advertising web application. Your application can display the color or utilize the hexadecimal value to categorize a set of labels.
Add: Optional. If you do not specify any color, the value will be assigned at random for each label.
Update: Optional. If no value is set for the update, this setting is not changed. You can update the color code but cannot remove it. |
string |
| Description |
The label description.
The label description can be between 1 to 200 characters in length.
Add: Optional
Update: Optional. If no value is set for the update, this setting is not changed. |
string |
| Id |
The system-generated identifier of the label.
Add: Read-only
Update: Required |
long |
| Name |
The label name.
The case-sensitive label name can be between 1 to 80 characters in length, and must be unique across all labels in the account.
Add: Required
Update: Optional. If no value is set for the update, this setting is not changed. |
string |
Requirements
Service: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13
Used By
AddLabels
GetLabelsByIds
UpdateLabels