Skip to main content

Get global bid preferences for an Account

GET 
/v1/accounts/:accountId/global-preferences

Get global bid preferences for an Account

Request​

Path Parameters

    accountId stringrequired

    The Account identifier to get global preferences for.

Responses​

OK

Schema

    bidPreference

    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.

Loading...