Ad Exchange Buyer API . marketplacenotes

insert(proposalId, body)

Add notes to the proposal

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

{
    "notes": [ # The list of notes to add.
      { # A proposal is associated with a bunch of notes which may optionally be associated with a deal and/or revision number.
        "kind": "adexchangebuyer#marketplaceNote", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceNote".
        "proposalRevisionNumber": "A String", # If the note is associated with a proposal 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)
        "proposalId": "A String", # The proposalId that a note is attached to. (readonly)
        "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": [
      { # A proposal is associated with a bunch of notes which may optionally be associated with a deal and/or revision number.
        "kind": "adexchangebuyer#marketplaceNote", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceNote".
        "proposalRevisionNumber": "A String", # If the note is associated with a proposal 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)
        "proposalId": "A String", # The proposalId that a note is attached to. (readonly)
        "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(proposalId, pqlQuery=None)

Get all the notes associated with a proposal

Args:
  proposalId: string, The proposalId to get notes for. To search across all proposals specify order_id = '-' as part of the URL. (required)
  pqlQuery: string, Query string to retrieve specific notes. To search the text contents of notes, please use syntax like "WHERE note.note = "foo" or "WHERE note.note LIKE "%bar%"

Returns:
  An object of the form:

    {
    "notes": [ # The list of matching notes. The notes for a proposal are ordered from oldest to newest. If the notes span multiple proposals, they will be grouped by proposal, with the notes for the most recently modified proposal appearing first.
      { # A proposal is associated with a bunch of notes which may optionally be associated with a deal and/or revision number.
        "kind": "adexchangebuyer#marketplaceNote", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceNote".
        "proposalRevisionNumber": "A String", # If the note is associated with a proposal 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)
        "proposalId": "A String", # The proposalId that a note is attached to. (readonly)
        "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)
      },
    ],
  }