Export (0) Print
Expand All

Business Data Object

System_CLiX_note Note

Business location targeting is no longer supported. For more information, see Features Being Migrated or Removed.

Defines a business location for business location targeting.


<xs:complexType name="Business">
  <xs:sequence>
    <xs:element minOccurs="0" name="AddressLine1" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="AddressLine2" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="BusinessImageIcon" nillable="true" type="tns:BusinessImageIcon" />
    <xs:element minOccurs="0" name="City" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="CountryOrRegion" nillable="true" type="xs:string" />
    <xs:element name="Description" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="Email" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="GeoCodeStatus" nillable="true" type="tns:BusinessGeoCodeStatus" />
    <xs:element minOccurs="0" name="HrsOfOperation" nillable="true" type="tns:ArrayOfHoursOfOperation" />
    <xs:element minOccurs="0" name="Id" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="IsOpen24Hours" type="xs:boolean" />
    <xs:element minOccurs="0" name="LatitudeDegrees" nillable="true" type="xs:double" />
    <xs:element minOccurs="0" name="LongitudeDegrees" nillable="true" type="xs:double" />
    <xs:element name="Name" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="OtherPaymentTypeDesc" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="Payment" nillable="true" type="tns:ArrayOfPaymentType" />
    <xs:element minOccurs="0" name="Phone" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="StateOrProvince" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="Status" nillable="true" type="tns:BusinessStatus" />
    <xs:element minOccurs="0" name="URL" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="ZipOrPostalCode" nillable="true" type="xs:string" />
  </xs:sequence>
</xs:complexType>

Elements

Element

Description

Data Type

Add

Update

AddressLine1

The first line of the address, which can contain a maximum of 35 characters.

string

Required

Optional

AddressLine2

The second line of the address, which can contain a maximum of 35 characters.

string

Optional

Optional

BusinessImageIcon

The business icon to display in Bing Maps.

This element is for future use.

BusinessImageIcon

Optional

Optional

City

The city where the business is located. The city can contain a maximum of 35 characters.

string

Required

Optional

CountryOrRegion

The country/region where the business is located. The country/region can contain a maximum of two characters.

The following are the possible country codes that you can specify.

  • CA for Canada

  • FR for France

  • GB for United Kingdom

  • IE for Ireland

  • US for United States

string

Required

Optional

Description

The description of the business, which can contain a maximum of 1,024 characters.

string

Optional

Optional

Email

The email address of the business. The email address can contain a maximum of 200 characters.

This element is for future use.

string

Optional

Optional

GeoCodeStatus

A status value that indicates whether the business’ latitude and longitude values have been determined.

BusinessGeoCodeStatus

Read-only

Must be null.

Read-only

Must be null.

HrsOfOperation

The days and hours that the business is open.

The HrsOfOperation array can contain only one entry for a particular day.

This element must be null if the IsOpen24Hours element contains true.

This element is for future use.

HoursOfOperation array

Optional

Optional

Id

A system-generated identifier of the business object.

long

Read-only

Must be null.

Required

Identifies the business to update.

IsOpen24Hours

A value that determines whether the business is open 24 hours a day.

The value is true if the business is open 24 hours; otherwise, the value is false.

If the IsOpen24Hours element contains true, the HrsOfOperation element must be null.

This element is for future use.

boolean

Optional

Optional

LatitudeDegrees

The latitude of the business location.

double

Read-only

Must be null.

Read-only

Must be null.

LongitudeDegrees

The longitude of the business location.

double

Read-only

Must be null.

Read-only

Must be null.

Name

The name of the business, which can contain a maximum of 35 characters.

The name must be unique for the customer.

string

Required

Read-only

OtherPaymentTypeDesc

An additional form of payment that the business accepts that is not included in the Payment element.

This element can contain a maximum of 256 characters.

This element is for future use.

string

Optional

Optional

Payment

The forms of payment that the business accepts. For possible values, see PaymentType.

This element is for future use.

PaymentType array

Optional

Optional

Phone

The phone number of the business. The phone number can contain a maximum of 20 characters.

string

Optional

Optional

StateOrProvince

The state, province, or territory where the business is located. This element can contain a maximum of 50 characters.

string

Required

Optional

Status

The status of the business object.

BusinessStatus

Read-only

Must be null.

Read-only

Must be null.

URL

The URL of the business's website. The URL can contain a maximum of 2,048 characters.

This element is for future use.

string

Optional

Optional

ZipOrPostalCode

The ZIP Code or Postal Code of the business location. This element can contain a maximum of 10 characters.

string

Optional

Optional

When a business is added, or the address of a business is updated, the latitude and longitude of the address are determined and placed in the LatitudeDegrees and LongitudeDegrees elements. The GeoCodeStatus element indicates the status of this process; the business target is not in effect until the process completes. Determining the coordinates can take from seconds to minutes. The AddressLine1, AddressLine2, City, StateOrProvince, and CountryOrRegion elements are used to determine the coordinates.

The phone number and address of the business will be added to text ads when the ads are displayed. The phone number supports click to call if the ads are displayed on a mobile device. If the user clicks the address, the business location is displayed in Bing Maps.

Requirements

CampaignManagementService.svc v8

Namespace: https://adcenter.microsoft.com/v8

Community Additions

Show:
© 2014 Microsoft