VanityPharmaSetting Data Object - Campaign Management

Article
10/16/2024

Defines a data object for VanityPharmaSetting. You can set the DisplayUrlMode and WebsiteDescription.

Note

Note: VanityPharmaSetting is available for limited pilot usage (e.g., pharmaceutical customers).

Syntax

<xs:complexType name="VanityPharmaSetting" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:Setting">
      <xs:sequence>
        <xs:element minOccurs="0" name="DisplayUrlMode" nillable="true" type="tns:VanityPharmaDisplayUrlMode">
          <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="WebsiteDescription" nillable="true" type="tns:VanityPharmaWebsiteDescription">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Elements

The VanityPharmaSetting object has the following elements: DisplayUrlMode, WebsiteDescription.

Element	Description	Data Type
DisplayUrlMode	The display mode for vanity pharma URLs for a campaign. Note: VanityPharmaDisplayUrlMode is available for limited pilot usage (e.g., pharmaceutical customers). Add: Optional. If you do not specify this field or leave it empty, the default value of ManufacturerWebsiteUrl will be set. Update: Optional. If no value is set for the update, this setting is not changed. Delete: Read-only.	VanityPharmaDisplayUrlMode
WebsiteDescription	The text that shows in the display URL of a text ad when WebsiteDescription is the selected display mode for vanity pharma URLs for the campaign. Note: VanityPharmaWebsiteDescription is available for limited pilot usage (e.g., pharmaceutical customers). Add: Optional. If you do not specify this field or leave it empty, the default value of Unspecified is set. Update: Optional. If no value is set for the update, this setting is not changed. If no value is set but the value for VanityPharmaDisplayURLMode is set to ManufacturerWebsiteUrl, the value of Unspecified is set. If no value is set but the value for VanityPharmaDisplayURLMode is set to WebsiteDescription, the campaign service will return the TBD error code. If a value other than Unspecified is set but the value for VanityPharmaDisplayURLMode is set to ManufacturerWebsiteUrl, the campaign service will return the TBD error code. Delete: Read-only	VanityPharmaWebsiteDescription

The VanityPharmaSetting object has Inherited Elements.

Inherited Elements

Inherited Elements from Setting

The VanityPharmaSetting object derives from the Setting object, and inherits the following elements: Type. The descriptions below are specific to VanityPharmaSetting, and might not apply to other objects that inherit the same elements from the Setting object.

Element	Description	Data Type
Type	The type of setting. For more information, see Remarks.	string

Requirements

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

Share via