Package com.restfb.types.ads

Class ReachFrequencyPrediction

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 Details

  • Method Details

    • 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