Ad Exchange Buyer API . marketplacenotes

Instance Methods

insert(orderId, body)

Add notes to the order

list(orderId)

Get all the notes associated with an order

Method Details

insert(orderId, body)
Add notes to the order

Args:
  orderId: string, The orderId to add notes for. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "notes": [ # The list of notes to add.
      { # An order is associated with a bunch of notes which may optionally be associated with a deal and/or revision number.
        "orderId": "A String", # The order_id that a note is attached to. (readonly)
        "kind": "adexchangebuyer#marketplaceNote", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceNote".
        "orderRevisionNumber": "A String", # If the note is associated with an order revision number, then store that here. (readonly, except on create)
        "dealId": "A String", # Notes can optionally be associated with a deal. (readonly, except on create)
        "note": "A String", # The actual note to attach. (readonly, except on create)
        "creatorRole": "A String", # The role of the person (buyer/seller) creating the note. (readonly)
        "noteId": "A String", # The unique id for the note. (readonly)
        "timestampMs": "A String", # The timestamp (ms since epoch) that this note was created. (readonly)
      },
    ],
  }


Returns:
  An object of the form:

    {
    "notes": [
      { # An order is associated with a bunch of notes which may optionally be associated with a deal and/or revision number.
        "orderId": "A String", # The order_id that a note is attached to. (readonly)
        "kind": "adexchangebuyer#marketplaceNote", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceNote".
        "orderRevisionNumber": "A String", # If the note is associated with an order revision number, then store that here. (readonly, except on create)
        "dealId": "A String", # Notes can optionally be associated with a deal. (readonly, except on create)
        "note": "A String", # The actual note to attach. (readonly, except on create)
        "creatorRole": "A String", # The role of the person (buyer/seller) creating the note. (readonly)
        "noteId": "A String", # The unique id for the note. (readonly)
        "timestampMs": "A String", # The timestamp (ms since epoch) that this note was created. (readonly)
      },
    ],
  }
list(orderId)
Get all the notes associated with an order

Args:
  orderId: string, The orderId to get notes for. (required)

Returns:
  An object of the form:

    {
    "notes": [ # The list of matching notes.
      { # An order is associated with a bunch of notes which may optionally be associated with a deal and/or revision number.
        "orderId": "A String", # The order_id that a note is attached to. (readonly)
        "kind": "adexchangebuyer#marketplaceNote", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceNote".
        "orderRevisionNumber": "A String", # If the note is associated with an order revision number, then store that here. (readonly, except on create)
        "dealId": "A String", # Notes can optionally be associated with a deal. (readonly, except on create)
        "note": "A String", # The actual note to attach. (readonly, except on create)
        "creatorRole": "A String", # The role of the person (buyer/seller) creating the note. (readonly)
        "noteId": "A String", # The unique id for the note. (readonly)
        "timestampMs": "A String", # The timestamp (ms since epoch) that this note was created. (readonly)
      },
    ],
  }