Class Campaign

    • Method Detail

      • getAccountId

        public String getAccountId()
        Returns:
        ID of the ad account that owns this campaign
      • setAccountId

        public void setAccountId​(String accountId)
        ID of the ad account that owns this campaign
      • setBuyingType

        public void setBuyingType​(String buyingType)
        Buying type, possible values are:
        • AUCTION: default
        • RESERVED: for reach and frequency ads
      • setCanUseSpendCap

        public void setCanUseSpendCap​(Boolean canUseSpendCap)
        Whether the campaign can set the spend cap
      • setConfiguredStatus

        public void setConfiguredStatus​(String configuredStatus)
        If this status is PAUSED, all its active ad sets and ads will be paused and have an effective status CAMPAIGN_PAUSED. Prefer using 'status' instead of this. possible values: ACTIVE, PAUSED, DELETED, ARCHIVED
      • setEffectiveStatus

        public void setEffectiveStatus​(String effectiveStatus)
        The effective status of this campaign. possible values: ACTIVE, PAUSED, DELETED, PENDING_REVIEW, DISAPPROVED, PREAPPROVED, PENDING_BILLING_INFO, CAMPAIGN_PAUSED, ARCHIVED, ADSET_PAUSED
      • getSpendCap

        public String getSpendCap()
        Returns:
        A spend cap for the campaign, such that it will not spend more than this cap.
      • setSpendCap

        public void setSpendCap​(String spendCap)
        A spend cap for the campaign, such that it will not spend more than this cap. Expressed as integer value of the subunit in your currency.
      • setStatus

        public void setStatus​(String status)
        If this status is PAUSED, all its active ad sets and ads will be paused and have an effective status CAMPAIGN_PAUSED. The field returns the same value as 'configured_status', and is the suggested one to use.