Brand Kit Record - Bulk

Defines a brand kit that can be downloaded and uploaded in a bulk file.

You can download all Brand Kit records in the account by including the DownloadEntity value of BrandKits 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.

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

For a Brand Kit record, the following attribute fields are available in the Bulk File Schema.

• Brand Voice
• Business Name
• Fonts
• Id
• Images
• Landscape Logos
• Name
• Palettes
• Status
• SquareLogos

Brand Voice

The brand's personality and tone.

{ 
    "personality": "This is a brand voice personality that describes the tone and personality of the brand's communications.", 
    "tones":  ["professional", "trustworthy", "reliable" ] 
} 

See BrandVoice for more information about the BrandVoice elements.

Add: Optional
Update: Optional. If no value is set for the update, this setting is not changed.
Delete: Read-only

Business Name

The name of the business.

Add: Optional
Update: Optional. If no value is set for the update, this setting is not changed.
Delete: Read-only

Fonts

The brand kit's fonts.

[{ 
    "typeface": "Arial", 
    "weight": "Normal", 
    "textAssetType": "ShortHeadline", 
}] 

See BrandKitFont for more information about the BrandKitFont elements.

Add: Optional
Update: Optional. If no value is set for the update, this setting is not changed.
Delete: Read-only

Id

The identifier of the brand kit.

Add: Optional
Update: Read-only and Required
Delete: Read-only and Required

Images

The brand kit's images.

[{
    "id": 1234567890000,
    "cropX": 286,
    "cropY": 0,
    "cropWidth": 628,
    "cropHeight": 628
},
{
    "id": 1234567890000,
    "cropX": 70,
    "cropY": 0,
    "cropWidth": 1061,
    "cropHeight": 628
}]

See BrandKitImage for more information about the BrandKitImage elements.

Add: Optional
Update: Optional. If no value is set for the update, this setting is not changed.
Delete: Read-only

Landscape Logos

The brand kit's landscape logos.

[{
    "id": 1234567890000,
    "cropX": 0,
    "cropY": 0,
    "cropWidth": 628,
    "cropHeight": 300
},
{
    "id": 1234567890000,
    "cropX": 0,
    "cropY": 0,
    "cropWidth": 1061,
    "cropHeight": 628
}]

See BrandKitImage for more information about the BrandKitImage elements.

Add: Optional
Update: Optional. If no value is set for the update, this setting is not changed.
Delete: Read-only

Name

The brand kit's name.

Add: Required
Update: Optional. If no value is set for the update, this setting is not changed.
Delete: Read-only

Palettes

The brand kit's palettes.

[{
    "colorType": "Primary",
    "colors":
    [
        {
            "name": "TestBrandKitColor",
            "hexCode": "#FFFFFF"
        }
    ]
}]

See BrandKitPalette for more information about the BrandKitImage elements.

Status

The status of the brand kit.

Possible values are Active or Deleted.

Add: Optional. The default value is Active.
Update: Optional. If no value is set for the update, this setting is not changed.
Delete: Required. The status must be set to Deleted.

Square Logos

The brand kit's square logos.

[{ 
  "id": 1234567890000, 
  "cropX": 0, 
  "cropY": 0, 
  "cropWidth": 628, 
  "cropHeight": 628 
}, 

{ 
  "id": 1234567890000, 
  "cropX": 0, 
  "cropY": 0, 
  "cropWidth": 1061, 
  "cropHeight": 1061 
}] 

See BrandKitImage for more information about the BrandKitImage elements.

Add: Optional
Update: Optional. If no value is set for the update, this setting is not changed. The start date cannot be updated after the brand kit is submitted i.e., once the start date has arrived.
Delete: Read-only