AdRecommendationImageSuggestion Data Object - Campaign Management

Defines a data object for ad recommendation image suggestion.

Note

• Expect the E2E P95 latency to be 2x slower after integrating with Dalle (from ~10s to ~20s).

• Azure Active Directory (AAD) callers will receive an error from the public API after integrating with Dalle.

Syntax

XML

<xs:complexType name="AdRecommendationImageSuggestion" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="AssetLink" nillable="true" type="tns:AssetLink" />
    <xs:element minOccurs="0" name="Image" nillable="true" type="tns:Image" />
    <xs:element minOccurs="0" name="ImageMetadata" nillable="true" type="tns:AdRecommendationImageSuggestionMetadata">
      <xs:annotation>
        <xs:appinfo>
          <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
        </xs:appinfo>
      </xs:annotation>
    </xs:element>
    <xs:element minOccurs="0" name="ImageUrl" nillable="true" type="xs:string" />
  </xs:sequence>
</xs:complexType>

JSON

{
  "AssetLink": {
    "Asset": {
      "Id": "LongValueHere",
      "Name": "ValueHere",
      "Type": "ImageAsset",
      "CropHeight": IntValueHere,
      "CropWidth": IntValueHere,
      "CropX": IntValueHere,
      "CropY": IntValueHere,
      "SubType": "ValueHere",
      "TargetHeight": IntValueHere,
      "TargetWidth": IntValueHere
    },
    "AssetPerformanceLabel": "ValueHere",
    "EditorialStatus": "ValueHere",
    "PinnedField": "ValueHere"
  },
  "Image": {
    "Data": "ValueHere"
  },
  "ImageMetadata": {
    "CustomizedProperties": [
      {
        "AssetTypeName": "ValueHere",
        "PropertyName": "ValueHere",
        "PropertyValue": "ValueHere"
      }
    ],
    "ImageAssetProperties": [
      {
        "CropHeight": IntValueHere,
        "CropWidth": IntValueHere,
        "CropX": IntValueHere,
        "CropY": IntValueHere,
        "ImageField": "ValueHere",
        "ImageUrl": "ValueHere"
      }
    ],
    "TemplateId": "ValueHere",
    "TemplateVersion": "ValueHere",
    "TextAssetProperties": [
      {
        "Text": "ValueHere",
        "TextField": "ValueHere"
      }
    ]
  },
  "ImageUrl": "ValueHere"
}

Elements

The AdRecommendationImageSuggestion object has the following elements: AssetLink, Image, ImageMetadata, ImageUrl.

Element	Description	Data Type
AssetLink	Defines the relationship of an asset to an ad.	AssetLink
Image	The suggsted image.	Image
ImageMetadata	The ad recommendation image suggestion metadata data object.	AdRecommendationImageSuggestionMetadata
ImageUrl	The URL of the suggested image.	string

Requirements

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

Used By

CreateAssetGroupRecommendation
CreateResponsiveAdRecommendation
GetResponsiveAdRecommendationJob
RefineAssetGroupRecommendation
RefineResponsiveAdRecommendation