Update a Schedule

The number of times an ad will be shown in a day. Accepts any integer except 0. Defaults to null.

Whether to impose daily limits on the amount of views ("views") or the amount of clicks ("clicks").

Whether to deliver the impressions as quickly as possible ("default") or deliver it evenly ("smooth") over the specified duration (start_date and end_date) and quota (quota_lifetime and quota_type). Default delivery delivers the impressions as quickly as possible. Smooth delivery will evenly serve over the lifetime dates and quotas. Defaults to "default".

NOTE:

• Placements with serve_method set to "auction" will always be delivered using the "default" method regardless of this field's value.

• Only subscribers on the Standard tier and above have access to smooth delivery. If you don't have that feature enabled, you must set this field's value to "default".

• If you change your subscription from Standard tier and above to a lower tier, any placements that have already been set to smooth delivery will remain under that delivery method.

The time and date when an ad should begin serving. Delay serving of ads by setting the start_date to a date in the future. Defaults to midnight of the current date if no value or null given.

The date-time value received is assumed to be in the Haku account's time zone as defined on account creation. You can check your account's time zone in the Haku Settings page.

In the response body, start_date is returned in Haku’s server time zone (America/Los_Angeles). To see the end date in the Haku account's chosen timezone, see start_date_local.

The time and date when an ad should stop serving. The end date can be as far in the future as desired. This allows you to set time-based expiration for your ads, and we guarantee accuracy to the hour. Set the field to null if you want ad serving to run indefinitely.

The date-time value received is assumed to be in the Haku account's time zone as defined on account creation. You can check your account's time zone in the Haku Settings page.

In the response body, end_date is returned in Haku’s server time zone (America/Los_Angeles). To see the end date in the Haku account's chosen timezone, see end_date_local.

The time and date when an ad should begin serving, in ISO-8601 format. Delay serving of ads by setting start_at to a date in the future. Defaults to midnight of the current date if no value or null given.

The timezone given in the ISO formatted date here does not have to match the start_at_timezone field. However, the start date will be converted to the timezone specificed in start_at_timezone when the value is returned.

The timezone of the start_at field. This is primarily for usage in UI interfaces so that the user can set certain timezones for different schedules. This could be useful if a customer has ordered a schedule to run from the first of the month to the 15th, starting at 9am and ending at 5pm, but the timezone is very different from the one the account or user is in. The timezone is in the IANA timezone format, such as America/New_York. A complete list of acceptable timezones by country is given here.

If no timezone is given, the account's default timezone is used.

The time and date when an ad should stop serving, in ISO-8601 format. The end date can be as far in the future as desired. This allows you to set time-based expiration for your ads, and we guarantee accuracy to the hour. Set the field to null if you want ad serving to never end.

The timezone given in the ISO formatted date here does not have to match the end_at_timezone field. However, the end date will be converted to the timezone specificed in end_at_timezone when the value is returned.

The timezone of the end_at field. This is primarily for usage in UI interfaces so that the user can set certain timezones for different schedules. This could be useful if a customer has ordered a schedule to run from the first of the month to the 15th, starting at 9am and ending at 5pm, but the timezone is very different from the one the account or user is in. The timezone is in the IANA timezone format, such as America/New_York. A complete list of acceptable timezones by country is given here.

If no timezone is given, the account's default timezone is used.

The number of times the ad will be shown to a particular user in a time period given by per_user_view_period. An integer value enables frequency capping and must be specified along with per_user_view_period. Both fields default to null, which means frequency capping is disabled.

The number of days after which the per_user_view_limit counter will start over. This field must be specified along with per_user_view_limit. Both fields default to null, which means frequency capping is disabled.

The targeted number of impressions or clicks to deliver for a placement with a quota-based expiration method, where the ad or campaign will stop being served once the quota for "views" or "clicks" is met. Haku will calculate the remaining inventory based on this value.

The type of quota when setting up quota-based expiration for a placement. It can be the number of clicks ("clicks") or the number of views ("views"). When a placement has a quota-based expiration, it will stop being served once it reaches the given clicks or views.

Whether to keep serving ads until the quota is met ("endOnQuota") or stop serving them right away ("endOnDate") once the end date has been reached. Defaults to endOnDate if delivery_method is "smooth". Defaults to null if delivery_method is "default".

The day_parting identifier if dayparting is enabled for this schedule.

NOTE: Subscribers must have the Targeting add-on to enable dayparting. If you don't have this add-on, you must set this field's value to null.

The status of the schedule, determined using the start and end dates and quotas. All possible statuses are: "active", "queued", "expired", and "quota_reached".

The number of times an ad will be shown in a day. Accepts any integer except 0. Defaults to null.

Whether to impose daily limits on the amount of views ("views") or the amount of clicks ("clicks").

Whether to deliver the impressions as quickly as possible ("default") or deliver it evenly ("smooth") over the specified duration (start_date and end_date) and quota (quota_lifetime and quota_type). Default delivery delivers the impressions as quickly as possible. Smooth delivery will evenly serve over the lifetime dates and quotas. Defaults to "default".

NOTE:

• Placements with serve_method set to "auction" will always be delivered using the "default" method regardless of this field's value.

• Only subscribers on the Standard tier and above have access to smooth delivery. If you don't have that feature enabled, you must set this field's value to "default".

• If you change your subscription from Standard tier and above to a lower tier, any placements that have already been set to smooth delivery will remain under that delivery method.

The time and date when an ad should begin serving. Delay serving of ads by setting the start_date to a date in the future. Defaults to midnight of the current date if no value or null given.

The date-time value received is assumed to be in the Haku account's time zone as defined on account creation. You can check your account's time zone in the Haku Settings page.

In the response body, start_date is returned in Haku’s server time zone (America/Los_Angeles). To see the end date in the Haku account's chosen timezone, see start_date_local.

The time and date when an ad should stop serving. The end date can be as far in the future as desired. This allows you to set time-based expiration for your ads, and we guarantee accuracy to the hour. Set the field to null if you want ad serving to run indefinitely.

The date-time value received is assumed to be in the Haku account's time zone as defined on account creation. You can check your account's time zone in the Haku Settings page.

In the response body, end_date is returned in Haku’s server time zone (America/Los_Angeles). To see the end date in the Haku account's chosen timezone, see end_date_local.

The time and date when an ad should begin serving, in ISO-8601 format. Delay serving of ads by setting start_at to a date in the future. Defaults to midnight of the current date if no value or null given.

The timezone given in the ISO formatted date here does not have to match the start_at_timezone field. However, the start date will be converted to the timezone specificed in start_at_timezone when the value is returned.

The timezone of the start_at field. This is primarily for usage in UI interfaces so that the user can set certain timezones for different schedules. This could be useful if a customer has ordered a schedule to run from the first of the month to the 15th, starting at 9am and ending at 5pm, but the timezone is very different from the one the account or user is in. The timezone is in the IANA timezone format, such as America/New_York. A complete list of acceptable timezones by country is given here.

If no timezone is given, the account's default timezone is used.

The time and date when an ad should stop serving, in ISO-8601 format. The end date can be as far in the future as desired. This allows you to set time-based expiration for your ads, and we guarantee accuracy to the hour. Set the field to null if you want ad serving to never end.

The timezone given in the ISO formatted date here does not have to match the end_at_timezone field. However, the end date will be converted to the timezone specificed in end_at_timezone when the value is returned.

The timezone of the end_at field. This is primarily for usage in UI interfaces so that the user can set certain timezones for different schedules. This could be useful if a customer has ordered a schedule to run from the first of the month to the 15th, starting at 9am and ending at 5pm, but the timezone is very different from the one the account or user is in. The timezone is in the IANA timezone format, such as America/New_York. A complete list of acceptable timezones by country is given here.

If no timezone is given, the account's default timezone is used.

The number of times the ad will be shown to a particular user in a time period given by per_user_view_period. An integer value enables frequency capping and must be specified along with per_user_view_period. Both fields default to null, which means frequency capping is disabled.

The number of days after which the per_user_view_limit counter will start over. This field must be specified along with per_user_view_limit. Both fields default to null, which means frequency capping is disabled.

The targeted number of impressions or clicks to deliver for a placement with a quota-based expiration method, where the ad or campaign will stop being served once the quota for "views" or "clicks" is met. Haku will calculate the remaining inventory based on this value.

The type of quota when setting up quota-based expiration for a placement. It can be the number of clicks ("clicks") or the number of views ("views"). When a placement has a quota-based expiration, it will stop being served once it reaches the given clicks or views.

Whether to keep serving ads until the quota is met ("endOnQuota") or stop serving them right away ("endOnDate") once the end date has been reached. Defaults to endOnDate if delivery_method is "smooth". Defaults to null if delivery_method is "default".

The day_parting identifier if dayparting is enabled for this schedule.

NOTE: Subscribers must have the Targeting add-on to enable dayparting. If you don't have this add-on, you must set this field's value to null.

The status of the schedule, determined using the start and end dates and quotas. All possible statuses are: "active", "queued", "expired", and "quota_reached".

The date and time when the schedule was created.

The number of clicks recorded so far.

The number of views recorded so far.

The number of impressions remaining to be served.

A string denoting the current resource being requested or affected.

The relative URL of the current resource being requested or affected.

The current resource identifier (ID).

The end_date value in the Haku account's timezone.

The start_date value in the Haku account's timezone.