Campaigns

This SOAP service provides operations for managing your campaigns.
Service endpoint URL (WSDL definition) is https://api.oddbytes.com/?v3=campaigns.wsdl .

Service Operation
Operation	Result Type	Descrition
getCampaignIds	CampaignIdsResult	Returns the list of ID values for your already existing campaigns. Optionally, returned list can also contain ID values of your currently deleted campaigns.
getCampaigns	CampaignsResult	Returns the parameters stored for your already existing campaigns, please see type Campaign for more details.
addCampaign	AddResult	Creates new campaign within your account, please see type CampaignAdd for more details.
updateCampaign	UpdateResult	Performs changes to your already existing campaign, by updating its parameters. Please note that it is required to specify only those campaign parameters you actually want to update, see type CampaignUpdate for more details.
resumeCampaigns	StatusResult	Resumes your already existing and currently paused campaigns.
pauseCampaigns	StatusResult	Pauses your already existing and currently active campaigns.
deleteCampaigns	DeleteResult	Deletes already existing non–deleted campaigns from your account. Please note that deleting your campaigns also deletes all of their creatives and targets — once deleted, they can not be undeleted.

getCampaignIds

Returns the list of ID values for your already existing campaigns. Optionally, returned list can also contain ID values of your currently deleted campaigns.

Property	Type	Null Allowed	Description
filterNames	string[] (1:100)	✔	Optional filter specification for campaigns names
includeDeleted	bool		Option for also fetching ID values of your currently deleted campaigns

CampaignIdsResult

Property	Type	Null Allowed	Description
ids	unsignedInt[] (0:unbound)		List of campaign ID values for non–deleted campaigns
deletedIds	unsignedInt[] (0:unbound)		List of campaign ID values for deleted campaigns

getCampaigns

Returns the parameters stored for your already existing campaigns, please see type Campaign for more details.

Property	Type	Null Allowed	Description
campaignIds	unsignedInt[] (1:300)		List of campaign ID values
fetchStats	bool	✔	Option for also fetching brief stats data for the returned campaigns

CampaignsResult

Property	Type	Null Allowed	Description
campaigns	Campaign[] (0:unbound)		Campaigns data stored for your already existing non–deleted campaigns
deletedIds	unsignedInt[] (0:unbound)		List of campaign ID values for deleted campaigns

addCampaign

Creates new campaign within your account, please see type CampaignAdd for more details.

Property	Type	Null Allowed	Description
campaign	CampaignAdd		Campaign definition data

AddResult

Property	Type	Null Allowed	Description
addedId	unsignedInt		ID value of the successfully added item

updateCampaign

Performs changes to your already existing campaign, by updating its parameters. Please note that it is required to specify only those campaign parameters you actually want to update, see type CampaignUpdate for more details.

Property	Type	Null Allowed	Description
campaignId	unsignedInt		Campaign ID value
campaign	CampaignUpdate		Campaign parameters to be updated

UpdateResult

Property	Type	Null Allowed	Description
updatedIds	unsignedInt[] (0:unbound)		List of ID values for successfully updated items
unchangedIds	unsignedInt[] (0:unbound)		List of ID values for unchanged items
deletedIds	unsignedInt[] (0:unbound)		List of ID values for currently deleted items

resumeCampaigns

Resumes your already existing and currently paused campaigns.

Property	Type	Null Allowed	Description
campaignIds	unsignedInt[] (1:50)		List of campaign ID values

StatusResult

Property	Type	Null Allowed	Description
changedIds	unsignedInt[] (0:unbound)		List of ID values for successfully changed items
unchangedIds	unsignedInt[] (0:unbound)		List of ID values for unchanged items
deletedIds	unsignedInt[] (0:unbound)		List of ID values for currently deleted items

pauseCampaigns

Pauses your already existing and currently active campaigns.

Property	Type	Null Allowed	Description
campaignIds	unsignedInt[] (1:50)		List of campaign ID values

StatusResult

Property	Type	Null Allowed	Description
changedIds	unsignedInt[] (0:unbound)		List of ID values for successfully changed items
unchangedIds	unsignedInt[] (0:unbound)		List of ID values for unchanged items
deletedIds	unsignedInt[] (0:unbound)		List of ID values for currently deleted items

deleteCampaigns

Deletes already existing non–deleted campaigns from your account. Please note that deleting your campaigns also deletes all of their creatives and targets — once deleted, they can not be undeleted.

Property	Type	Null Allowed	Description
campaignIds	unsignedInt[] (1:50)		List of campaign ID values

DeleteResult

Property	Type	Null Allowed	Description
deletedIds	unsignedInt[] (0:unbound)		List of ID values for successfully deleted items
unchangedIds	unsignedInt[] (0:unbound)		List of ID values for already deleted items

CampaignIdsResult

Return value type used while fetching ID values of your campaigns.

Property	Type	Null Allowed	Description
ids	unsignedInt[] (0:unbound)		List of campaign ID values for non–deleted campaigns
deletedIds	unsignedInt[] (0:unbound)		List of campaign ID values for deleted campaigns

CampaignsResult

Return value type used while fetching stored data for your already existing campaigns.

Property	Type	Null Allowed	Description
campaigns	Campaign[] (0:unbound)		Campaigns data stored for your already existing non–deleted campaigns
deletedIds	unsignedInt[] (0:unbound)		List of campaign ID values for deleted campaigns

Campaign

Return value type used while fetching stored data for your already existing non–deleted campaign.

Property	Type	Null Allowed	Description
id	unsignedInt		Campaign ID value
name	string		Campaign name
status	CampaignStatus		Campaign status Enum Type: string Enum Values: ACTIVE, PAUSED, DELETED, ARCHIVED, COMPLETED
description	string		Campaign description
totalBudget	float		Total budget for the campaign; receiving null means it is unlimited
workHoursSunday	SchedulingHours[] (0:24)	✔	List of hours (24h format) when the campagin will be receiving traffic; specifying empty array, means that campaign is inactive for the day Enum Type: unsignedInt Enum Values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23
workHoursMonday	SchedulingHours[] (0:24)	✔	List of hours (24h format) when the campagin will be receiving traffic; receiving empty array, means that campaign is inactive for the day Enum Type: unsignedInt Enum Values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23
workHoursTuesday	SchedulingHours[] (0:24)	✔	List of hours (24h format) when the campagin will be receiving traffic; receiving empty array, means that campaign is inactive for the day Enum Type: unsignedInt Enum Values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23
workHoursWednesday	SchedulingHours[] (0:24)	✔	List of hours (24h format) when the campagin will be receiving traffic; receiving empty array, means that campaign is inactive for the day Enum Type: unsignedInt Enum Values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23
workHoursThursday	SchedulingHours[] (0:24)	✔	List of hours (24h format) when the campagin will be receiving traffic; receiving empty array, means that campaign is inactive for the day Enum Type: unsignedInt Enum Values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23
workHoursFriday	SchedulingHours[] (0:24)	✔	List of hours (24h format) when the campagin will be receiving traffic; receiving empty array, means that campaign is inactive for the day Enum Type: unsignedInt Enum Values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23
workHoursSaturday	SchedulingHours[] (0:24)	✔	List of hours (24h format) when the campagin will be receiving traffic; receiving empty array, means that campaign is inactive for the day Enum Type: unsignedInt Enum Values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23
dailyBudgetSunday	float		Daily campaign budget for Sunday; receiving zero means it is unlimited
dailyBudgetMonday	float		Daily campaign budget for Monday; receiving zero means it is unlimited
dailyBudgetTuesday	float		Daily campaign budget for Tuesday; receiving zero means it is unlimited
dailyBudgetWednesday	float		Daily campaign budget for Wednesday; receiving zero means it is unlimited
dailyBudgetThursday	float		Daily campaign budget for Thursday; receiving zero means it is unlimited
dailyBudgetFriday	float		Daily campaign budget for Friday; receiving zero means it is unlimited
dailyBudgetSaturday	float		Daily campaign budget for Saturday; receiving zero means it is unlimited
created	dateTime		Date and time of campaign creation
modified	dateTime		Date and time of last campaign modification
stats	CampaignStats	✔	Brief daily, monthly and total stats data for the campaign, returned only if requested; please see operation getCampaigns() for more details

CampaignStats

Return value type used while fetching brief daily, monthly and total stats data for your already existing non–deleted campaign.

Property	Type	Null Allowed	Description
costToday	float		Accounted cost for today
costMonth	float		Accounted cost for current month
costTotal	float		Total amount of accounted cost
impressionsToday	unsignedInt		Accounted number of impressions for today
impressionsMonth	unsignedInt		Accounted number of impressions for current month
impressionsTotal	unsignedInt		Total number of accounted impressions
clicksToday	unsignedInt		Accounted number of clicks for today
clicksMonth	unsignedInt		Accounted number of clicks for current month
clicksTotal	unsignedInt		Total number of accounted clicks
lastServed	dateTime	✔	Date and time of last received impression or click; receiving Null means having no impressions or clicks received yet

AddResult

Return value type used while creating one new item.

Property	Type	Null Allowed	Description
addedId	unsignedInt		ID value of the successfully added item

CampaignAdd

Value type used for specifying campaign definition data while adding new campaign.

Characters allowed within campaign name are the following: 0–9 a–z A–Z - _ / # . : ; | &
Characters allowed within campaign description are the following: 0–9 a–z A–Z - _ / \r \n # & $ % @ | ; : , . ( )

Before adding campaign, all leading or trailing whitespace within the campaign name and description is trimmed.
Length for the strings specified as campaign name and description needs to be between one and 250 characters.

Property	Type	Null Allowed	Description
name	string		Campaign name
description	string		Campaign description; specifying empty string means no description
totalBudget	float	✔	Total budget for the campaign; specifying zero or Null means it is unlimited
dailyBudgetSunday	float		Daily campaign budget for Sunday; specifying zero means it is unlimited
dailyBudgetMonday	float		Daily campaign budget for Monday; specifying zero means it is unlimited
dailyBudgetTuesday	float		Daily campaign budget for Tuesday; specifying zero means it is unlimited
dailyBudgetWednesday	float		Daily campaign budget for Wednesday; specifying zero means it is unlimited
dailyBudgetThursday	float		Daily campaign budget for Thursday; specifying zero means it is unlimited
dailyBudgetFriday	float		Daily campaign budget for Friday; specifying zero means it is unlimited
dailyBudgetSaturday	float		Daily campaign budget for Saturday; specifying zero means it is unlimited
workHoursSunday	SchedulingHours[] (0:24)	✔	List of hours (24h format) when the campagin will be receiving traffic; specifying empty array, means that campaign is inactive for the day specifying Null, means that campaign is active all day Enum Type: unsignedInt Enum Values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23
workHoursMonday	SchedulingHours[] (0:24)	✔	List of hours (24h format) when the campagin will be receiving traffic; specifying empty array, means that campaign is inactive for the day specifying Null, means that campaign is active all day Enum Type: unsignedInt Enum Values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23
workHoursTuesday	SchedulingHours[] (0:24)	✔	List of hours (24h format) when the campagin will be receiving traffic; specifying empty array, means that campaign is inactive for the day specifying Null, means that campaign is active all day Enum Type: unsignedInt Enum Values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23
workHoursWednesday	SchedulingHours[] (0:24)	✔	List of hours (24h format) when the campagin will be receiving traffic; specifying empty array, means that campaign is inactive for the day specifying Null, means that campaign is active all day Enum Type: unsignedInt Enum Values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23
workHoursThursday	SchedulingHours[] (0:24)	✔	List of hours (24h format) when the campagin will be receiving traffic; specifying empty array, means that campaign is inactive for the day specifying Null, means that campaign is active all day Enum Type: unsignedInt Enum Values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23
workHoursFriday	SchedulingHours[] (0:24)	✔	List of hours (24h format) when the campagin will be receiving traffic; specifying empty array, means that campaign is inactive for the day specifying Null, means that campaign is active all day Enum Type: unsignedInt Enum Values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23
workHoursSaturday	SchedulingHours[] (0:24)	✔	List of hours (24h format) when the campagin will be receiving traffic; specifying empty array, means that campaign is inactive for the day specifying Null, means that campaign is active all day Enum Type: unsignedInt Enum Values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23

UpdateResult

Return value type used while updating one or more already existing items.

Property	Type	Null Allowed	Description
updatedIds	unsignedInt[] (0:unbound)		List of ID values for successfully updated items
unchangedIds	unsignedInt[] (0:unbound)		List of ID values for unchanged items
deletedIds	unsignedInt[] (0:unbound)		List of ID values for currently deleted items

CampaignUpdate

Value type used for specifying campaign parameters while updating already existing non–deleted campaign.

Please note that it is required to specify values only for those parameters you actually want to update, while remaining parameters you want
to leave unchanged need to have their values specified as Null.

Characters allowed within campaign name are the following: 0–9 a–z A–Z - _ / # . : ; | &
Characters allowed within campaign description are the following: 0–9 a–z A–Z - _ / \r \n # & $ % @ | ; : , . ( )

Before updating the campaign, all leading or trailing whitespace within the campaign name and description (if specified as non-Null) is trimmed.
Length for the strings specified as campaign name and description needs to be between one and 250 characters.

Property	Type	Null Allowed	Description
name	string	✔	Campaign name
description	string	✔	Campaign description; specifying empty string means updating campaign to have no description
totalBudget	float	✔	Total budget for the campaign; specifying zero means it is unlimited
dailyBudgetSunday	float	✔	Daily campaign budget for Sunday; specifying zero means updating campaign to have it unlimited
dailyBudgetMonday	float	✔	Daily campaign budget for Monday; specifying zero means updating campaign to have it unlimited
dailyBudgetTuesday	float	✔	Daily campaign budget for Tuesday; specifying zero means updating campaign to have it unlimited
dailyBudgetWednesday	float	✔	Daily campaign budget for Wednesday; specifying zero means updating campaign to have it unlimited
dailyBudgetThursday	float	✔	Daily campaign budget for Thursday; specifying zero means updating campaign to have it unlimited
dailyBudgetFriday	float	✔	Daily campaign budget for Friday; specifying zero means updating campaign to have it unlimited
dailyBudgetSaturday	float	✔	Daily campaign budget for Saturday; specifying zero means updating campaign to have it unlimited
workHoursSunday	SchedulingHours[] (0:24)	✔	List of hours (24h format) when the campagin will be receiving traffic; specifying empty array, means that campaign is inactive for the day Enum Type: unsignedInt Enum Values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23
workHoursMonday	SchedulingHours[] (0:24)	✔	List of hours (24h format) when the campagin will be receiving traffic; specifying empty array, means that campaign is inactive for the day Enum Type: unsignedInt Enum Values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23
workHoursTuesday	SchedulingHours[] (0:24)	✔	List of hours (24h format) when the campagin will be receiving traffic; specifying empty array, means that campaign is inactive for the day Enum Type: unsignedInt Enum Values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23
workHoursWednesday	SchedulingHours[] (0:24)	✔	List of hours (24h format) when the campagin will be receiving traffic; specifying empty array, means that campaign is inactive for the day Enum Type: unsignedInt Enum Values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23
workHoursThursday	SchedulingHours[] (0:24)	✔	List of hours (24h format) when the campagin will be receiving traffic; specifying empty array, means that campaign is inactive for the day Enum Type: unsignedInt Enum Values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23
workHoursFriday	SchedulingHours[] (0:24)	✔	List of hours (24h format) when the campagin will be receiving traffic; specifying empty array, means that campaign is inactive for the day Enum Type: unsignedInt Enum Values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23
workHoursSaturday	SchedulingHours[] (0:24)	✔	List of hours (24h format) when the campagin will be receiving traffic; specifying empty array, means that campaign is inactive for the day Enum Type: unsignedInt Enum Values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23

StatusResult

Return value type used while changing statuses for one or more already existing items.

Property	Type	Null Allowed	Description
changedIds	unsignedInt[] (0:unbound)		List of ID values for successfully changed items
unchangedIds	unsignedInt[] (0:unbound)		List of ID values for unchanged items
deletedIds	unsignedInt[] (0:unbound)		List of ID values for currently deleted items

DeleteResult

Return value type used while deleting one or more already existing items.

Property	Type	Null Allowed	Description
deletedIds	unsignedInt[] (0:unbound)		List of ID values for successfully deleted items
unchangedIds	unsignedInt[] (0:unbound)		List of ID values for already deleted items