ProductAd Data Object - Campaign Management

Artikkeli
11/13/2024

Defines a product ad. A product ad is not used directly for delivered ad copy. Instead, the delivery engine generates product ads from the product details that it finds in the customer's Microsoft Merchant Center store.

Syntax

XML
JSON

<xs:complexType name="ProductAd" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:Ad">
      <xs:sequence>
        <xs:element minOccurs="0" name="PromotionalText" nillable="true" type="xs:string" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

{
  "AdFormatPreference": "ValueHere",
  "DevicePreference": "LongValueHere",
  "EditorialStatus": "ValueHere",
  "FinalAppUrls": [
    {
      "OsType": "ValueHere",
      "Url": "ValueHere"
    }
  ],
  "FinalMobileUrls": [
    "ValueHere"
  ],
  "FinalUrls": [
    "ValueHere"
  ],
  "FinalUrlSuffix": "ValueHere",
  "ForwardCompatibilityMap": [
    {
      "key": "ValueHere",
      "value": "ValueHere"
    }
  ],
  "Id": "LongValueHere",
  "Status": "ValueHere",
  "TrackingUrlTemplate": "ValueHere",
  "Type": "Product",
  "UrlCustomParameters": {
    "Parameters": [
      {
        "Key": "ValueHere",
        "Value": "ValueHere"
      }
    ]
  },
  "PromotionalText": "ValueHere"
}

Elements

The ProductAd object has the following elements: PromotionalText.

Element	Description	Data Type
PromotionalText	This property is reserved for internal use and will be removed from a future version of the API. You can use Merchant Promotions if you want tags to appear at the bottom of your product ad as "special offer" links, helping to increase customer engagement. Add: Optional Update: Optional	string

The ProductAd object has Inherited Elements.

Inherited Elements

Inherited Elements from Ad

The ProductAd object derives from the Ad object, and inherits the following elements: AdFormatPreference, DevicePreference, EditorialStatus, FinalAppUrls, FinalMobileUrls, FinalUrls, FinalUrlSuffix, ForwardCompatibilityMap, Id, Status, TrackingUrlTemplate, Type, UrlCustomParameters. The descriptions below are specific to ProductAd, and might not apply to other objects that inherit the same elements from the Ad object.

Element	Description	Data Type
AdFormatPreference	Not supported for this ad type.	string
DevicePreference	Not supported for this ad type.	long
EditorialStatus	The editorial review status of the ad, which indicates whether the ad is pending review, has been approved, or has been disapproved. Add: Read-only Update: Read-only	AdEditorialStatus
FinalAppUrls	Not supported for this ad type.	AppUrl array
FinalMobileUrls	Not supported for this ad type.	string array
FinalUrls	Not supported for this ad type.	string array
FinalUrlSuffix	Not supported for this ad type.	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. There are currently not any ForwardCompatibilityMap key and value pairs that are applicable for product ads.	KeyValuePairOfstringstring array
Id	The unique Microsoft Advertising identifier for the ad. Add: Read-only Update: Required and Read-only	long
Status	The status of the ad. You can set the ad status to Active or Paused. Add: Optional Update: Optional	AdStatus
TrackingUrlTemplate	Not supported for this ad type.	string
Type	The type of the ad. This value is Product when you retrieve a product ad. For more information about ad types, see the Ad Data Object Remarks. Add: Read-only Update: Read-only	AdType
UrlCustomParameters	Not supported for this ad type.	CustomParameters

Requirements

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

Jaa