java.lang.Object
- com.restfb.types.AbstractFacebookType
- - com.restfb.types.ads.BaseAdsObject
  - - com.restfb.types.ads.NamedAdsObject
    - - com.restfb.types.ads.ReachFrequencyPrediction

All Implemented Interfaces:

Serializable
```
public class ReachFrequencyPrediction
extends NamedAdsObject
```
Represents the Reach Frequency Prediction type.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

ReachFrequencyPrediction()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Integer`	`getAccountId()`	The ID of the Ad Account this reach frequency prediction belongs to
`Integer`	`getCampaignGroupId()`	The id of the campaign which this prediction belongs to
`String`	`getCampaignId()`	The ID of the ad set to which this reach frequency prediction is assigned
`Date`	`getCampaignTimeStart()`	Unix timestamp of the ad set start time
`Date`	`getCampaignTimeStop()`	Unix timestamp of the ad set stop time
`String`	`getCurveBudgetReach()`	The curve for budget and reach.
`List<Double>`	`getDailyImpressionCurve()`	Daily Impression field represents a vector of predicted daily impressions for every single day.
`String`	`getDestinationId()`	The ID of the Page or the ID of the app which the ad promotes.
`Date`	`getExpirationTime()`	Unix timestamp of the expiration time of prediction, if applicable
`Integer`	`getExternalBudget()`	Predicted budget in cents for the ad set, relevant if prediction mode is 0
`Long`	`getExternalImpression()`	Predicted impressions for the ad set
`Long`	`getExternalMaximumBudget()`	Maximum budget given the target, in cents
`String`	`getExternalMaximumImpression()`	Maximum number of impressions given the target
`Long`	`getExternalMaximumReach()`	Maximum reach given the target
`Long`	`getExternalMinimumBudget()`	Minimum budget given the target, in cents
`Long`	`getExternalMinimumImpression()`	Minimum impressions given the target
`Long`	`getExternalMinimumReach()`	Minimum reach given the target
`Long`	`getExternalReach()`	Predicted reach for the ad set, relevant if prediction mode is 1
`Long`	`getFrequencyCap()`	Lifetime frequency cap per user, always relevant, 0 means no frequncy cap
`Double`	`getGrpDmasAudienceSize()`	GRP: Audience size within DMAs based on Nielsen definition
`Long`	`getHoldoutPercentage()`	Percent of users in holdout
`String`	`getInstagramDestinationId()`	The Instagram account id if instagramstream placement is used, except in the case of Mobile App Installs ads.
`Long`	`getIntervalFrequencyCap()`	Interval frequency cap which is set for a custom period
`Long`	`getIntervalFrequencyCapResetPeriod()`	Custom reset period (hours) for interval frequency cap
`String`	`getPausePeriods()`	A list of time periods the associated campaign has been paused.
`String`	`getPlacementBreakdown()`	Predicted impression distribution on different placements, including: `msite`: Facebook mobile sites `android`: Facebook android `ios`: Facebook ios `desktop`: Facebook desktop news feed and right hand column `ig_android`: Instagram android `ig_ios`: Instagram ios `ig_others`: Other Instagram placements ## ReachFrequencyEstimatesPlacementBreakdown
`Long`	`getPredictionMode()`	The prediction mode, `0` = given reach, predict budget, `1` = given budget, predict reach
`Long`	`getPredictionProgress()`	Represents percentage value indicating the prediction progress (values 0-100).
`Long`	`getReservationStatus()`	Reservation status.
`Long`	`getStatus()`	Represents the status of the prediction, refer to Response Status
`Long`	`getStoryEventType()`	Used to indicated the prediction is for video ads or not.
`Long`	`getTargetAudienceSize()`	Unique 30-day active users for given targetting specs.
`Targeting`	`getTargetSpec()`	A string in JSON format representing the targeting specs specified on creation.
`Date`	`getTimeCreated()`	The time when this reach frequency prediction was created
`Date`	`getTimeUpdated()`	Unix timestamp when the row is updated
`void`	`setAccountId(Integer accountId)`	The ID of the Ad Account this reach frequency prediction belongs to
`void`	`setCampaignGroupId(Integer campaignGroupId)`	The id of the campaign which this prediction belongs to
`void`	`setCampaignId(String campaignId)`	The ID of the ad set to which this reach frequency prediction is assigned
`void`	`setCampaignTimeStart(Date campaignTimeStart)`	Unix timestamp of the ad set start time
`void`	`setCampaignTimeStop(Date campaignTimeStop)`	Unix timestamp of the ad set stop time
`void`	`setCurveBudgetReach(String curveBudgetReach)`	The curve for budget and reach.
`void`	`setDailyImpressionCurve(List<Double> dailyImpressionCurve)`	Daily Impression field represents a vector of predicted daily impressions for every single day.
`void`	`setDestinationId(String destinationId)`	The ID of the Page or the ID of the app which the ad promotes.
`void`	`setExpirationTime(Date expirationTime)`	Unix timestamp of the expiration time of prediction, if applicable
`void`	`setExternalBudget(Integer externalBudget)`	Predicted budget in cents for the ad set, relevant if prediction mode is 0
`void`	`setExternalImpression(Long externalImpression)`	Predicted impressions for the ad set
`void`	`setExternalMaximumBudget(Long externalMaximumBudget)`	Maximum budget given the target, in cents
`void`	`setExternalMaximumImpression(String externalMaximumImpression)`	Maximum number of impressions given the target
`void`	`setExternalMaximumReach(Long externalMaximumReach)`	Maximum reach given the target
`void`	`setExternalMinimumBudget(Long externalMinimumBudget)`	Minimum budget given the target, in cents
`void`	`setExternalMinimumImpression(Long externalMinimumImpression)`	Minimum impressions given the target
`void`	`setExternalMinimumReach(Long externalMinimumReach)`	Minimum reach given the target
`void`	`setExternalReach(Long externalReach)`	Predicted reach for the ad set, relevant if prediction mode is 1
`void`	`setFrequencyCap(Long frequencyCap)`	Lifetime frequency cap per user, always relevant, 0 means no frequncy cap
`void`	`setGrpDmasAudienceSize(Double grpDmasAudienceSize)`	GRP: Audience size within DMAs based on Nielsen definition
`void`	`setHoldoutPercentage(Long holdoutPercentage)`	Percent of users in holdout
`void`	`setInstagramDestinationId(String instagramDestinationId)`	The Instagram account id if instagramstream placement is used, except in the case of Mobile App Installs ads.
`void`	`setIntervalFrequencyCap(Long intervalFrequencyCap)`	Interval frequency cap which is set for a custom period
`void`	`setIntervalFrequencyCapResetPeriod(Long intervalFrequencyCapResetPeriod)`	Custom reset period (hours) for interval frequency cap
`void`	`setPausePeriods(String pausePeriods)`	A list of time periods the associated campaign has been paused.
`void`	`setPlacementBreakdown(String placementBreakdown)`	Predicted impression distribution on different placements, including: `msite`: Facebook mobile sites `android`: Facebook android `ios`: Facebook ios `desktop`: Facebook desktop news feed and right hand column `ig_android`: Instagram android `ig_ios`: Instagram ios `ig_others`: Other Instagram placements ## ReachFrequencyEstimatesPlacementBreakdown
`void`	`setPredictionMode(Long predictionMode)`	The prediction mode, `0` = given reach, predict budget, `1` = given budget, predict reach
`void`	`setPredictionProgress(Long predictionProgress)`	Represents percentage value indicating the prediction progress (values 0-100).
`void`	`setReservationStatus(Long reservationStatus)`	Reservation status.
`void`	`setStatus(Long status)`	Represents the status of the prediction, refer to Response Status
`void`	`setStoryEventType(Long storyEventType)`	Used to indicated the prediction is for video ads or not.
`void`	`setTargetAudienceSize(Long targetAudienceSize)`	Unique 30-day active users for given targetting specs.
`void`	`setTargetSpec(Targeting targetSpec)`	A string in JSON format representing the targeting specs specified on creation.
`void`	`setTimeCreated(Date timeCreated)`	The time when this reach frequency prediction was created
`void`	`setTimeUpdated(Date timeUpdated)`	Unix timestamp when the row is updated

Methods inherited from class com.restfb.types.ads.NamedAdsObject
getName, setName

Methods inherited from class com.restfb.types.ads.BaseAdsObject
getId, setId

Methods inherited from class com.restfb.types.AbstractFacebookType
equals, hashCode, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ReachFrequencyPrediction
```
public ReachFrequencyPrediction()
```
- Method Detail
  - getAccountId
```
public Integer getAccountId()
```
    The ID of the Ad Account this reach frequency prediction belongs to
  - setAccountId
```
public void setAccountId(Integer accountId)
```
    The ID of the Ad Account this reach frequency prediction belongs to
  - getCampaignGroupId
```
public Integer getCampaignGroupId()
```
    The id of the campaign which this prediction belongs to
  - setCampaignGroupId
```
public void setCampaignGroupId(Integer campaignGroupId)
```
    The id of the campaign which this prediction belongs to
  - getCampaignId
```
public String getCampaignId()
```
    The ID of the ad set to which this reach frequency prediction is assigned
  - setCampaignId
```
public void setCampaignId(String campaignId)
```
    The ID of the ad set to which this reach frequency prediction is assigned
  - getCampaignTimeStart
```
public Date getCampaignTimeStart()
```
    Unix timestamp of the ad set start time
  - setCampaignTimeStart
```
public void setCampaignTimeStart(Date campaignTimeStart)
```
    Unix timestamp of the ad set start time
  - getCampaignTimeStop
```
public Date getCampaignTimeStop()
```
    Unix timestamp of the ad set stop time
  - setCampaignTimeStop
```
public void setCampaignTimeStop(Date campaignTimeStop)
```
    Unix timestamp of the ad set stop time
  - getCurveBudgetReach
```
public String getCurveBudgetReach()
```
    The curve for budget and reach. It is a string in JSON format representing a JSON object with these fields.
    num_points: the number of data points within the object.
    reach: Data contained at corresponding indices of each array form a single data point. The "reach" values are presented in ascending order with the final value containing the maximum available reach.
    budget: Data contained at corresponding indices of each array form a single data point. Cent of accounts currency.
    impression: Data contained at corresponding indices of each array form a single data point. In video view buying, this is the number of view throughs (aka impression by conversion)raw_impression: Data contained at corresponding indices of each array form a single data point. In video view buying,impressions represents view throughs and raw_impressions representstotal number of views
  - setCurveBudgetReach
```
public void setCurveBudgetReach(String curveBudgetReach)
```
    The curve for budget and reach. It is a string in JSON format representing a JSON object with these fields.
    num_points: the number of data points within the object.
    reach: Data contained at corresponding indices of each array form a single data point. The "reach" values are presented in ascending order with the final value containing the maximum available reach.
    budget: Data contained at corresponding indices of each array form a single data point. Cent of accounts currency.
    impression: Data contained at corresponding indices of each array form a single data point. In video view buying, this is the number of view throughs (aka impression by conversion)raw_impression: Data contained at corresponding indices of each array form a single data point. In video view buying,impressions represents view throughs and raw_impressions representstotal number of views
  - getDailyImpressionCurve
```
public List<Double> getDailyImpressionCurve()
```
    Daily Impression field represents a vector of predicted daily impressions for every single day. Measured from midnight to midnight in the advertiser timezone during the campaign duration.
  - setDailyImpressionCurve
```
public void setDailyImpressionCurve(List<Double> dailyImpressionCurve)
```
    Daily Impression field represents a vector of predicted daily impressions for every single day. Measured from midnight to midnight in the advertiser timezone during the campaign duration.
  - getDestinationId
```
public String getDestinationId()
```
    The ID of the Page or the ID of the app which the ad promotes.
  - setDestinationId
```
public void setDestinationId(String destinationId)
```
    The ID of the Page or the ID of the app which the ad promotes.
  - getExpirationTime
```
public Date getExpirationTime()
```
    Unix timestamp of the expiration time of prediction, if applicable
  - setExpirationTime
```
public void setExpirationTime(Date expirationTime)
```
    Unix timestamp of the expiration time of prediction, if applicable
  - getExternalBudget
```
public Integer getExternalBudget()
```
    Predicted budget in cents for the ad set, relevant if prediction mode is 0
  - setExternalBudget
```
public void setExternalBudget(Integer externalBudget)
```
    Predicted budget in cents for the ad set, relevant if prediction mode is 0
  - getExternalImpression
```
public Long getExternalImpression()
```
    Predicted impressions for the ad set
  - setExternalImpression
```
public void setExternalImpression(Long externalImpression)
```
    Predicted impressions for the ad set
  - getExternalMaximumBudget
```
public Long getExternalMaximumBudget()
```
    Maximum budget given the target, in cents
  - setExternalMaximumBudget
```
public void setExternalMaximumBudget(Long externalMaximumBudget)
```
    Maximum budget given the target, in cents
  - getExternalMaximumImpression
```
public String getExternalMaximumImpression()
```
    Maximum number of impressions given the target
  - setExternalMaximumImpression
```
public void setExternalMaximumImpression(String externalMaximumImpression)
```
    Maximum number of impressions given the target
  - getExternalMaximumReach
```
public Long getExternalMaximumReach()
```
    Maximum reach given the target
  - setExternalMaximumReach
```
public void setExternalMaximumReach(Long externalMaximumReach)
```
    Maximum reach given the target
  - getExternalMinimumBudget
```
public Long getExternalMinimumBudget()
```
    Minimum budget given the target, in cents
  - setExternalMinimumBudget
```
public void setExternalMinimumBudget(Long externalMinimumBudget)
```
    Minimum budget given the target, in cents
  - getExternalMinimumImpression
```
public Long getExternalMinimumImpression()
```
    Minimum impressions given the target
  - setExternalMinimumImpression
```
public void setExternalMinimumImpression(Long externalMinimumImpression)
```
    Minimum impressions given the target
  - getExternalMinimumReach
```
public Long getExternalMinimumReach()
```
    Minimum reach given the target
  - setExternalMinimumReach
```
public void setExternalMinimumReach(Long externalMinimumReach)
```
    Minimum reach given the target
  - getExternalReach
```
public Long getExternalReach()
```
    Predicted reach for the ad set, relevant if prediction mode is 1
  - setExternalReach
```
public void setExternalReach(Long externalReach)
```
    Predicted reach for the ad set, relevant if prediction mode is 1
  - getFrequencyCap
```
public Long getFrequencyCap()
```
    Lifetime frequency cap per user, always relevant, 0 means no frequncy cap
  - setFrequencyCap
```
public void setFrequencyCap(Long frequencyCap)
```
    Lifetime frequency cap per user, always relevant, 0 means no frequncy cap
  - getGrpDmasAudienceSize
```
public Double getGrpDmasAudienceSize()
```
    GRP: Audience size within DMAs based on Nielsen definition
  - setGrpDmasAudienceSize
```
public void setGrpDmasAudienceSize(Double grpDmasAudienceSize)
```
    GRP: Audience size within DMAs based on Nielsen definition
  - getHoldoutPercentage
```
public Long getHoldoutPercentage()
```
    Percent of users in holdout
  - setHoldoutPercentage
```
public void setHoldoutPercentage(Long holdoutPercentage)
```
    Percent of users in holdout
  - getInstagramDestinationId
```
public String getInstagramDestinationId()
```
    The Instagram account id if instagramstream placement is used, except in the case of Mobile App Installs ads.
  - setInstagramDestinationId
```
public void setInstagramDestinationId(String instagramDestinationId)
```
    The Instagram account id if instagramstream placement is used, except in the case of Mobile App Installs ads.
  - getIntervalFrequencyCap
```
public Long getIntervalFrequencyCap()
```
    Interval frequency cap which is set for a custom period
  - setIntervalFrequencyCap
```
public void setIntervalFrequencyCap(Long intervalFrequencyCap)
```
    Interval frequency cap which is set for a custom period
  - getIntervalFrequencyCapResetPeriod
```
public Long getIntervalFrequencyCapResetPeriod()
```
    Custom reset period (hours) for interval frequency cap
  - setIntervalFrequencyCapResetPeriod
```
public void setIntervalFrequencyCapResetPeriod(Long intervalFrequencyCapResetPeriod)
```
    Custom reset period (hours) for interval frequency cap
  - getPausePeriods
```
public String getPausePeriods()
```
    A list of time periods the associated campaign has been paused.
  - setPausePeriods
```
public void setPausePeriods(String pausePeriods)
```
    A list of time periods the associated campaign has been paused.
  - getPlacementBreakdown
```
public String getPlacementBreakdown()
```
    Predicted impression distribution on different placements, including: msite: Facebook mobile sites
    android: Facebook android
    ios: Facebook ios
    desktop: Facebook desktop news feed and right hand column
    ig_android: Instagram android
    ig_ios: Instagram ios
    ig_others: Other Instagram placements ## ReachFrequencyEstimatesPlacementBreakdown
  - setPlacementBreakdown
```
public void setPlacementBreakdown(String placementBreakdown)
```
    Predicted impression distribution on different placements, including: msite: Facebook mobile sites
    android: Facebook android
    ios: Facebook ios
    desktop: Facebook desktop news feed and right hand column
    ig_android: Instagram android
    ig_ios: Instagram ios
    ig_others: Other Instagram placements ## ReachFrequencyEstimatesPlacementBreakdown
  - getPredictionMode
```
public Long getPredictionMode()
```
    The prediction mode, 0 = given reach, predict budget,
    1 = given budget, predict reach
  - setPredictionMode
```
public void setPredictionMode(Long predictionMode)
```
    The prediction mode, 0 = given reach, predict budget,
    1 = given budget, predict reach
  - getPredictionProgress
```
public Long getPredictionProgress()
```
    Represents percentage value indicating the prediction progress (values 0-100). When 100 check status to indicate whether the prediction was successful.
  - setPredictionProgress
```
public void setPredictionProgress(Long predictionProgress)
```
    Represents percentage value indicating the prediction progress (values 0-100). When 100 check status to indicate whether the prediction was successful.
  - getReservationStatus
```
public Long getReservationStatus()
```
    Reservation status. 0 = Cancelled prediction,
    1 = Reserved prediction,
    2 = Prediction has been attached to a campaign
  - setReservationStatus
```
public void setReservationStatus(Long reservationStatus)
```
    Reservation status. 0 = Cancelled prediction,
    1 = Reserved prediction,
    2 = Prediction has been attached to a campaign
  - getStatus
```
public Long getStatus()
```
    Represents the status of the prediction, refer to Response Status
  - setStatus
```
public void setStatus(Long status)
```
    Represents the status of the prediction, refer to Response Status
  - getStoryEventType
```
public Long getStoryEventType()
```
    Used to indicated the prediction is for video ads or not. If it is for video, the prediction will not include devices that cannot play video
  - setStoryEventType
```
public void setStoryEventType(Long storyEventType)
```
    Used to indicated the prediction is for video ads or not. If it is for video, the prediction will not include devices that cannot play video
  - getTargetAudienceSize
```
public Long getTargetAudienceSize()
```
    Unique 30-day active users for given targetting specs. Used as tip to indicate the maximum possible audience size if campaign length is increased
  - setTargetAudienceSize
```
public void setTargetAudienceSize(Long targetAudienceSize)
```
    Unique 30-day active users for given targetting specs. Used as tip to indicate the maximum possible audience size if campaign length is increased
  - getTargetSpec
```
public Targeting getTargetSpec()
```
    A string in JSON format representing the targeting specs specified on creation.
  - setTargetSpec
```
public void setTargetSpec(Targeting targetSpec)
```
    A string in JSON format representing the targeting specs specified on creation.
  - getTimeCreated
```
public Date getTimeCreated()
```
    The time when this reach frequency prediction was created
  - setTimeCreated
```
public void setTimeCreated(Date timeCreated)
```
    The time when this reach frequency prediction was created
  - getTimeUpdated
```
public Date getTimeUpdated()
```
    Unix timestamp when the row is updated
  - setTimeUpdated
```
public void setTimeUpdated(Date timeUpdated)
```
    Unix timestamp when the row is updated

Class ReachFrequencyPrediction

Constructor Summary

Method Summary

Methods inherited from class com.restfb.types.ads.NamedAdsObject

Methods inherited from class com.restfb.types.ads.BaseAdsObject

Methods inherited from class com.restfb.types.AbstractFacebookType

Methods inherited from class java.lang.Object

Constructor Detail

ReachFrequencyPrediction

Method Detail

getAccountId

setAccountId

getCampaignGroupId

setCampaignGroupId

getCampaignId

setCampaignId

getCampaignTimeStart

setCampaignTimeStart

getCampaignTimeStop

setCampaignTimeStop

getCurveBudgetReach

setCurveBudgetReach

getDailyImpressionCurve

setDailyImpressionCurve

getDestinationId

setDestinationId

getExpirationTime

setExpirationTime

getExternalBudget

setExternalBudget

getExternalImpression

setExternalImpression

getExternalMaximumBudget

setExternalMaximumBudget

getExternalMaximumImpression

setExternalMaximumImpression

getExternalMaximumReach

setExternalMaximumReach

getExternalMinimumBudget

setExternalMinimumBudget

getExternalMinimumImpression

setExternalMinimumImpression

getExternalMinimumReach

setExternalMinimumReach

getExternalReach

setExternalReach

getFrequencyCap

setFrequencyCap

getGrpDmasAudienceSize

setGrpDmasAudienceSize

getHoldoutPercentage

setHoldoutPercentage

getInstagramDestinationId

setInstagramDestinationId

getIntervalFrequencyCap

setIntervalFrequencyCap

getIntervalFrequencyCapResetPeriod

setIntervalFrequencyCapResetPeriod

getPausePeriods

setPausePeriods

getPlacementBreakdown

setPlacementBreakdown

getPredictionMode

setPredictionMode

getPredictionProgress

setPredictionProgress

getReservationStatus

setReservationStatus

getStatus

setStatus

getStoryEventType

setStoryEventType

getTargetAudienceSize

setTargetAudienceSize

getTargetSpec

setTargetSpec

getTimeCreated

setTimeCreated

getTimeUpdated

setTimeUpdated