Update global bid preferences for an Account

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

Update global bid preferences for an Account

Request

Path Parameters

accountId stringrequired

The Account identifier to update global bid preferences for.

application/json

Body

The request received from the client.

accountId stringrequired

The Account identifier to update global bid preferences for.

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

The three-letter currency code defined in ISO 4217.

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.

Responses

200

OK

application/json

Schema

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

The three-letter currency code defined in ISO 4217.

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.

timestamp date-timerequired

An ISO 8601 timestamp

Example (from schema)

{
  "bidPreference": {
    "bidOnMonday": true,
    "bidOnTuesday": true,
    "bidOnWednesday": true,
    "bidOnThursday": true,
    "bidOnFriday": true,
    "bidOnSaturday": true,
    "bidOnSunday": true,
    "bidTimeFrom": {
      "hours": 0,
      "minutes": 0,
      "seconds": 0,
      "nanos": 0
    },
    "bidTimeTo": {
      "hours": 0,
      "minutes": 0,
      "seconds": 0,
      "nanos": 0
    },
    "dailyLimit": 0,
    "dailySpendLimit": {
      "currencyCode": "string",
      "units": "string",
      "nanos": 0
    }
  },
  "timestamp": "2024-07-29T15:51:28.071Z"
}

default

Error

application/json

Schema

Schema

code int32

An error status code describing the response.

Enum Value	Description
0	OK
1	Cancelled
2	Unknown
3	InvalidArgument
4	DeadlineExceeded
5	NotFound
6	AlreadyExists
7	PermissionDenied
8	ResourceExhausted
9	FailedPrecondition
10	Aborted
11	OutOfRange
12	Unimplemented
13	Internal
14	Unavailable
15	DataLoss
16	Unauthenticated

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]

message string

A developer-facing error message

details

object[]

A list of messages containing details about the errors

Array [

@type stringrequired

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...