Edit

ImportJob Data Object - Campaign Management

  • Article

Defines the base object of an import job.

Note

  • Upgrade your expanded text ads to responsive search ads by February 1, 2023. After this date, you will no longer be able to create new or edit existing expanded text ads. For more information, see About responsive search ads.
  • Existing expanded text ads will continue to serve, and you'll be able to view reports on their performance.
  • You'll still be able to pause, enable, or remove your expanded text ads.
  • Learn more about this change.

Do not try to instantiate an ImportJob. You can create one or more of the following objects that derive from it.

Syntax

<xs:complexType name="ImportJob" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="CreatedByUserId" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="CreatedByUserName" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="CreatedDateTimeInUTC" nillable="true" type="xs:dateTime" />
    <xs:element minOccurs="0" name="Frequency" nillable="true" type="tns:Frequency" />
    <xs:element minOccurs="0" name="Id" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="ImportOption" nillable="true" type="tns:ImportOption" />
    <xs:element minOccurs="0" name="LastRunTimeInUTC" nillable="true" type="xs:dateTime" />
    <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="NotificationEmail" nillable="true" type="xs:string">
      <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="NotificationType" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="Status" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="Type" nillable="true" type="xs:string" />
  </xs:sequence>
</xs:complexType>

Elements

The ImportJob object has the following elements: CreatedByUserId, CreatedByUserName, CreatedDateTimeInUTC, Frequency, Id, ImportOption, LastRunTimeInUTC, Name, NotificationEmail, NotificationType, Status, Type.

Element Description Data Type
CreatedByUserId The unique identifier of the Microsoft Advertising user who created the import job. long
CreatedByUserName The login user name of the Microsoft Advertising user who created the import job. string
CreatedDateTimeInUTC The date and time when the import job was created.

The date and time is expressed in Coordinated Universal Time (UTC).		 dateTime
Frequency Determines whether the import job should be run once or scheduled on a recurring basis.

To run the import job now, this element should be nil or empty.		 Frequency
Id The unique Microsoft Advertising identifier of the import job. long
ImportOption The import options that are available via API. ImportOption
LastRunTimeInUTC The most recent import date and time for this job.

The date and time is expressed in Coordinated Universal Time (UTC).		 dateTime
Name The name of the import job string
NotificationEmail The email address where import results should be sent.

This element is not returned by default. To get this element, include the NotificationEmail value in the ReturnAdditionalFields element when you call the GetImportJobsByIds and GetImportResults service operations.		 string
NotificationType Determines whether and how often you want to receive email notifications about the import job results. string
Status The status of the import job.

The possible values are Active, Pause and Deleted. Scheduled imports will have an Active status, whether the job is scheduled once or on a recurring basis in the future. Paused import jobs will have a Pause status. The status of import jobs that only run once will be set to Deleted after the import.

Add: Read-only
Update: Optional. If no value is set for the update, this setting is not changed.		 string
Type The type of the import job.

For more information about import job types, see the Remarks.		 string

Remarks

If you generate the SOAP manually, use the type attribute of the <ImportJob> node as shown in the following example to specify the type of import schedule.

<ImportJob i:type="GoogleImportJob" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <Id i:nil="true" />
    <Status i:nil="true" />
      . . .
</ImportJob>

Requirements

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

Used By

AddImportJobs
GetImportJobsByIds
ImportResult
UpdateImportJobs