Edit

Frequency Data Object - Campaign Management

  • Article

Determines whether an import job should be run once or scheduled on a recurring basis.

You can schedule a recurring import e.g., "Every Sunday at 4:00 PM" or you can run the import once.

  • Auto: Microsoft Advertising will run imports on a varying schedule that will best optimize your campaigns.
  • Now: Import once as soon as you call the AddImportJobs operation.
  • Once: Import once at the time you specify.
  • Daily: Import once per day at the time you specify.
  • Weekly: Import once per week at the time you specify.
  • Monthly: Import once per month at the time you specify.

To run the import "now", you can leave the Google import job Frequency element nil or empty. For all other scheduling options, set the frequency Type and Cron values. For details about supported frequency values, see the Remarks below.

Syntax

<xs:complexType name="Frequency" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="Cron" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="TimeZone" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="Type" nillable="true" type="xs:string" />
  </xs:sequence>
</xs:complexType>

Elements

The Frequency object has the following elements: Cron, TimeZone, Type.

Element Description Data Type
Cron Represents a simplified implementation of Cron frequency.

For example, set the string to "0 16 * * 3 *" if you want the import to run weekly, every Wednesday at 4:00 PM.

For details about supported frequency values, see the Remarks.

Add: Required if the Type is set to "Scheduling", and otherwise the cron value is ignored.		 string
TimeZone The time zone used for the import schedule.

For possible values, see Time Zones.

Add: Optional. If you do not set this element, then "GreenwichMeanTimeDublinEdinburghLisbonLondon" (UTC+0) will be used by default.		 string
Type The scheduling frequency type.

Set this element to "Scheduling" if you want to choose a specific Cron value, whether the import job should run once or on a recurring basis.

Set this element to "Auto" if you want Microsoft Advertising to run imports on a varying schedule that will best optimize your campaigns.

If you want the import to run now, you can either set this element to "RunNow" or do not set the Google import job Frequency element at all.

Add: Required		 string

Remarks

Scheduled imports support a simplified implementation of Cron with up to six ordered components.

* * * * * *
- - - - - -
| | | | | | 
| | | | | +----- year (1 - 9999) 
| | | | +----- day of week (0 - 6) (Sunday=0)
| | | +------- month (1 - 12)
| | +--------- day of month (1 - 31)
| +----------- hour (0 - 23)
+------------- min (0)

Here are some valid examples.

Cron string Import frequency
"0 2 15 09 * 2020" Run once on September 15, 2020 at 2:00AM
"0 16 * * * *" Run daily at 4:00 PM
"0 16 * * 3 *" Run weekly, every Wednesday at 4:00 PM
"0 16 1 * * *" Run monthly, the 1st day of every month at 4:00 PM

Requirements

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

Used By

ImportJob