CampaignGoalExtensionConfigService Types

CampaignGoalExtensionConfigService WSDL

Manages the goal-based runtime extension config of a campaign.
This service is stateless.

Examples +

  • save
  • get
.

    getGoalExtensionConfigtop

    Description

    Gets the goal-based runtime extension config for a campaign.
    Requires write permissions for the campaign.

    Returns a result with `exists = false` and `active = false` if no config exists.

    CampaignGoalExtensionConfig getGoalExtensionConfig(int $campaign_id)

    Parameters

    int $campaign_id

    Return Values

    CampaignGoalExtensionConfig

    logintop

    Description

    Initializes a new session with given information

    boolean login(string $user, string $pass, int $network)

    Parameters

    string $user Username
    string $pass Password
    int $network $network Network ID

    Return Values

    boolean true on success, false on fail

    logouttop

    Description

    Destroys the active session, logging out the user.

    boolean logout()

    Return Values

    boolean true on success, false on fail

    saveGoalExtensionConfigtop

    Description

    Creates or replaces the goal-based runtime extension config for a campaign.
    Requires write permissions for the campaign.

    CampaignGoalExtensionConfig saveGoalExtensionConfig(CampaignGoalExtensionConfig $config)

    Parameters

    CampaignGoalExtensionConfig $config

    Return Values

    CampaignGoalExtensionConfig

    Faults

    ValidationErrorMessageList

    CampaignGoalExtensionConfigtop

    Definition

    Configures the goal-based runtime extension for a campaign.

    object CampaignGoalExtensionConfig {
    - boolean $exists

    optional

    Whether a goal-based runtime extension config exists for the campaign.
    Response only: always present in responses (true or false).

    - boolean $active

    required

    Whether the config is currently active. Configs are deactivated by the RuntimeExtender
    once their goal-based extension is exhausted (see `message`/`extendedAt`/`extensionCount`),
    or explicitly via `saveGoalExtensionConfig()`.

    - int $campaignId

    required

    - string $endDate

    required

    - int $mainGoalCapping

    required

    - int $mainGoalBump

    required

    - int $runtimeBumpInDays

    optional

    - int $runtimeBumpDayOfMonth

    optional

    - string $type

    required

    Values: days|date

    - string $extendedAt

    optional

    - int $extensionCount

    optional

    - string $message

    optional

    }

    ValidationErrorMessagetop

    Definition

    object ValidationErrorMessage {
    - string $identifier

    required

    - Array <string> $messages

    required

    }

    ValidationErrorMessageListtop

    Definition

    object ValidationErrorMessageList {
    - Array <ValidationErrorMessage> $messages

    optional

    }

    Console