Skip to main content

Get a Campaign

GET 
/v1/campaigns/:campaignId

Get a Campaign

Request​

Path Parameters

    campaignId stringrequired

    The Campaign identifier to retrieve

Responses​

OK

Schema

    campaign

    object

    required

    A Campaign to bid on Data Instances.

    campaignId stringrequired

    The Campaign identifier.

    accountId stringrequired

    The Account identifier in which the Campaign has been created.

    dataSpecificationId stringrequired

    The Data Specification identifier that the Campaign targets.

    name stringrequired

    The name of the Campaign.

    bidAmount

    object

    required

    Represents an amount of money with its currency type.

    currencyCode stringrequired
    units int64required

    The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

    nanos int32required

    Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

    query

    object

    required

    A query containing conditions that all need to match against a Data Instance.

    conditions

    object[]

    required

    The query conditions.

  • Array [

    • propertyName stringrequired

    The name of the property on the Data Instance as defined in the Data Specification.

    condition stringrequired
    matchMissingValue boolean

    (Optional) If a given Data Instance is missing a value for the property that this condition targets, should this condition be considered a match. This value can only be specified for properties that are not required on the Data Specification.

  • ]

    • onWin

    object

    required

    Preferences for being notified.

    email stringrequired

    The email address to which to send notifications.

    mobileNumber stringrequired

    The phone number to which to send notifications.

    notifyByEmail booleanrequired

    Whether to notify by email to the given email address.

    notifyByTextMessage booleanrequired

    Whether to notify by text message to the given phone number.

    onWinMetadata stringrequired

    Metadata provided if the Campaign wins a Data Instance.

    onLose

    object

    required

    Preferences for being notified.

    email stringrequired

    The email address to which to send notifications.

    mobileNumber stringrequired

    The phone number to which to send notifications.

    notifyByEmail booleanrequired

    Whether to notify by email to the given email address.

    notifyByTextMessage booleanrequired

    Whether to notify by text message to the given phone number.

    useGlobalBidPreferences booleanrequired

    Whether the Campaign should use global bid preferences defined at the Organization level.

    bidPreferences

    object

    required

    Preferences for when to bid and limits on bidding.

    bidOnMonday booleanrequired

    Whether bids should be placed on Mondays.

    bidOnTuesday booleanrequired

    Whether bids should be placed on Tuesdays.

    bidOnWednesday booleanrequired

    Whether bids should be placed on Wednesdays.

    bidOnThursday booleanrequired

    Whether bids should be placed on Thursdays.

    bidOnFriday booleanrequired

    Whether bids should be placed on Fridays.

    bidOnSaturday booleanrequired

    Whether bids should be placed on Saturdays.

    bidOnSunday booleanrequired

    Whether bids should be placed on Sundays.

    bidTimeFrom

    object

    Represents a time of day. The date and time zone are not significant

    hours int32

    Hours of day in 24 hour format. Must be from 0 to 23

    minutes int32

    Minutes of hour of day. Must be from 0 to 59.

    seconds int32

    Seconds of minutes of the time. Must be from 0 to 59

    nanos int32

    Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

    bidTimeTo

    object

    Represents a time of day. The date and time zone are not significant

    hours int32

    Hours of day in 24 hour format. Must be from 0 to 23

    minutes int32

    Minutes of hour of day. Must be from 0 to 59.

    seconds int32

    Seconds of minutes of the time. Must be from 0 to 59

    nanos int32

    Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

    dailyLimit int32

    (Optional) A limit for the number of bids that can be placed daily.

    dailySpendLimit

    object

    Represents an amount of money with its currency type.

    currencyCode stringrequired
    units int64required

    The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

    nanos int32required

    Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

    status CampaignStatus (string)required

    The status of a Campaign.

    Possible values: [RUNNING, STOPPED]

    created date-timerequired

    The date time at which the Campaign was created.

Loading...