Ad Exchange Buyer API . budget

Instance Methods

get(accountId, billingId)

Returns the budget information for the adgroup specified by the accountId and billingId.

patch(accountId, billingId, body)

Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request. This method supports patch semantics.

update(accountId, billingId, body)

Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request.

Method Details

get(accountId, billingId)
Returns the budget information for the adgroup specified by the accountId and billingId.

Args:
  accountId: string, The account id to get the budget information for. (required)
  billingId: string, The billing id to get the budget information for. (required)

Returns:
  An object of the form:

    { # The configuration data for Ad Exchange RTB - Budget API.
      "kind": "adexchangebuyer#budget", # The kind of the resource, i.e. "adexchangebuyer#budget".
      "budgetAmount": "A String", # The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.
      "currencyCode": "A String", # The currency code for the buyer. This cannot be altered here.
      "billingId": "A String", # The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.
      "id": "A String", # The unique id that describes this item.
      "accountId": "A String", # The id of the account. This is required for get and update requests.
    }
patch(accountId, billingId, body)
Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request. This method supports patch semantics.

Args:
  accountId: string, The account id associated with the budget being updated. (required)
  billingId: string, The billing id associated with the budget being updated. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The configuration data for Ad Exchange RTB - Budget API.
    "kind": "adexchangebuyer#budget", # The kind of the resource, i.e. "adexchangebuyer#budget".
    "budgetAmount": "A String", # The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.
    "currencyCode": "A String", # The currency code for the buyer. This cannot be altered here.
    "billingId": "A String", # The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.
    "id": "A String", # The unique id that describes this item.
    "accountId": "A String", # The id of the account. This is required for get and update requests.
  }


Returns:
  An object of the form:

    { # The configuration data for Ad Exchange RTB - Budget API.
      "kind": "adexchangebuyer#budget", # The kind of the resource, i.e. "adexchangebuyer#budget".
      "budgetAmount": "A String", # The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.
      "currencyCode": "A String", # The currency code for the buyer. This cannot be altered here.
      "billingId": "A String", # The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.
      "id": "A String", # The unique id that describes this item.
      "accountId": "A String", # The id of the account. This is required for get and update requests.
    }
update(accountId, billingId, body)
Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request.

Args:
  accountId: string, The account id associated with the budget being updated. (required)
  billingId: string, The billing id associated with the budget being updated. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The configuration data for Ad Exchange RTB - Budget API.
    "kind": "adexchangebuyer#budget", # The kind of the resource, i.e. "adexchangebuyer#budget".
    "budgetAmount": "A String", # The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.
    "currencyCode": "A String", # The currency code for the buyer. This cannot be altered here.
    "billingId": "A String", # The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.
    "id": "A String", # The unique id that describes this item.
    "accountId": "A String", # The id of the account. This is required for get and update requests.
  }


Returns:
  An object of the form:

    { # The configuration data for Ad Exchange RTB - Budget API.
      "kind": "adexchangebuyer#budget", # The kind of the resource, i.e. "adexchangebuyer#budget".
      "budgetAmount": "A String", # The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.
      "currencyCode": "A String", # The currency code for the buyer. This cannot be altered here.
      "billingId": "A String", # The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.
      "id": "A String", # The unique id that describes this item.
      "accountId": "A String", # The id of the account. This is required for get and update requests.
    }