Configuration

Configuration is controlled through environmental variables. Default values are provided below.

Calculations (adpay.stats.consts)

adpay.stats.consts.CALCULATE_PAYMENTS_PERIODICALLY = True

Enable/disable periodical payment calculation. 1 for enable, 0 for disable.

Environmental variable override: ADPAY_CALCULATE_TASKS

adpay.stats.consts.CALCULATION_METHOD = 'default'

Choose one of two methods of calculation: ‘default’ and ‘user_value’.

Environmental variable override: ADPAY_CALCULATION_METHOD

adpay.stats.consts.EVENT_PAYMENT_ACCEPTED = 0

Event is ok, but payment can still be 0. For example, event_type ‘request’.

adpay.stats.consts.EVENT_PAYMENT_REJECTED_BANNER_NOT_FOUND = 4

Event is rejected, because banner can’t be found in the database.

adpay.stats.consts.EVENT_PAYMENT_REJECTED_CAMPAIGN_NOT_FOUND = 1

Event is rejected, because campaign can’t be found in the database.

adpay.stats.consts.EVENT_PAYMENT_REJECTED_HUMAN_SCORE_TOO_LOW = 2

Event is rejected, because human_score value is too low, probably a bot.

adpay.stats.consts.EVENT_PAYMENT_REJECTED_INVALID_TARGETING = 3

Event is rejected, because event keywords don’t pass campaign filters.

adpay.stats.consts.EVENT_TYPE_CLICK = 'click'

Click event name

Environmental variable override: ADPAY_EVENT_TYPE_CLICK

adpay.stats.consts.EVENT_TYPE_CONVERSION = 'conversion'

Conversion event name

Environmental variable override: ADPAY_EVENT_TYPE_CONVERSION

adpay.stats.consts.EVENT_TYPE_VIEW = 'view'

View/Impression event name

Environmental variable override: ADPAY_EVENT_TYPE_VIEW

adpay.stats.consts.HUMAN_SCORE_THRESHOLD = 0.0

Filter out events by users with threshold value and below. This value should be between [0.0, 1.0].

Environmental variable override: ADPAY_HUMAN_SCORE_THRESHOLD

adpay.stats.consts.MAX_USER_KEYWORDS_IN_PROFILE = 50

Max keywords in a user profile to consider for similarity

Environmental variable override: ADPAY_MAX_USER_KEYWORDS_IN_PROFILE

adpay.stats.consts.PAID_EVENT_TYPES = ['click', 'view', 'conversion']

AdPay will pay only for these event types.

adpay.stats.consts.SECONDS_PER_HOUR = 3600

Seconds per hour (3600). Development use only.

Environmental variable override: ADPAY_SECONDS_PER_HOUR

adpay.stats.consts.VALIDATE_CAMPAIGN_FILTERS = True

Enable/disable checking if event keywords are appropriate for campaign filters. 1 for enable, 0 for disable.

Environmental variable override: ADPAY_VALIDATE_CAMPAIGN_FILTERS

Database (adpay.db.const)

adpay.db.consts.MONGO_DB_HOST = 'localhost'

MongoDB database host, ie. database host for AdPay application.

Environmental variable override: ADPAY_MONGO_DB_HOST

adpay.db.consts.MONGO_DB_NAME = 'adpay'

MongoDB database name, ie. database name for AdPay application.

Environmental variable override: ADPAY_MONGO_DB_NAME

adpay.db.consts.MONGO_DB_PORT = 27017

MongoDB port, ie. database connection port for AdPay application.

Environmental variable override: ADPAY_MONGO_DB_PORT

Interface (adpay.iface.consts)

adpay.iface.consts.DEBUG_ENDPOINT = False

Enable an endpoint, which allows to force payment recalculation. 1 for enable, 0 for disable. For development use only!

Environmental variable override: ADPAY_DEBUG_ENDPOINT

adpay.iface.consts.INVALID_OBJECT = -32010

JSONRPC error code return when receiving invalid JSON objects.

adpay.iface.consts.PAYMENTS_NOT_CALCULATED_YET = -32000

JSONRPC error code returned when payment round is not calculated yet

adpay.iface.consts.SERVER_PORT = 8012

Twisted TCP port number, ie. AdPay server port

Environmental variable override: ADPAY_SERVER_PORT

Utilities (adpay.utils.consts)

adpay.utils.consts.LOG_CONFIG_JSON_FILE = None

Logging config file (optional), overrides default configuration.

Environmental variable override: ADPAY_LOG_CONFIG_JSON_FILE

adpay.utils.consts.LOG_LEVEL = 'DEBUG'

Logging level

Environmental variable override: ADPAY_LOG_LEVEL

Logging

Log messages are by default sent to stdout/stderr.