MarketplaceNotes: list

This is an invitation-only beta feature.

Get all the notes associated with a proposal Try it now.

Request

HTTP request

GET https://www.googleapis.com/adexchangebuyer/v1.4/proposals/proposalId/notes

Parameters

Parameter name	Value	Description
Path parameters
`proposalId`	`string`	The proposalId to get notes for. To search across all proposals specify order_id = '-' as part of the URL.
Optional query parameters
`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%"

Authorization

This request requires authorization with the following scope:

Scope
`https://www.googleapis.com/auth/adexchange.buyer`

For more information, see the authentication and authorization page.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{
  "notes": [
    {
      "kind": "adexchangebuyer#marketplaceNote",
      "timestampMs": long,
      "creatorRole": string,
      "note": string,
      "proposalRevisionNumber": long,
      "proposalId": string,
      "dealId": string,
      "noteId": string
    }
  ]
}

Property name	Value	Description
`notes[]`	`list`	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.
`notes[].kind`	`string`	Identifies what kind of resource this is. Value: the fixed string `"adexchangebuyer#marketplaceNote"`.
`notes[].timestampMs`	`long`	The timestamp (ms since epoch) that this note was created. (readonly)
`notes[].creatorRole`	`string`	The role of the person (buyer/seller) creating the note. (readonly) Acceptable values are: "`buyer`" "`seller`" "`unknownBuyerSellerRole`"
`notes[].note`	`string`	The actual note to attach. (readonly, except on create)
`notes[].dealId`	`string`	Notes can optionally be associated with a deal. (readonly, except on create)
`notes[].noteId`	`string`	The unique id for the note. (readonly)
`notes[].proposalRevisionNumber`	`long`	If the note is associated with a proposal revision number, then store that here. (readonly, except on create)
`notes[].proposalId`	`string`	The proposalId that a note is attached to. (readonly)

Try it!

Use the APIs Explorer below to call this method on live data and see the response.