1 <html><body> 2 <style> 3 4 body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13 } 14 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51 } 52 53 .toc_element { 54 margin-top: 0.5em; 55 } 56 57 .firstline { 58 margin-left: 2 em; 59 } 60 61 .method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66 } 67 68 .details { 69 font-weight: bold; 70 font-size: 14px; 71 } 72 73 </style> 74 75 <h1><a href="adexchangebuyer_v1_4.html">Ad Exchange Buyer API</a> . <a href="adexchangebuyer_v1_4.marketplacenotes.html">marketplacenotes</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#insert">insert(proposalId, body)</a></code></p> 79 <p class="firstline">Add notes to the proposal</p> 80 <p class="toc_element"> 81 <code><a href="#list">list(proposalId, pqlQuery=None)</a></code></p> 82 <p class="firstline">Get all the notes associated with a proposal</p> 83 <h3>Method Details</h3> 84 <div class="method"> 85 <code class="details" id="insert">insert(proposalId, body)</code> 86 <pre>Add notes to the proposal 87 88 Args: 89 proposalId: string, The proposalId to add notes for. (required) 90 body: object, The request body. (required) 91 The object takes the form of: 92 93 { 94 "notes": [ # The list of notes to add. 95 { # A proposal is associated with a bunch of notes which may optionally be associated with a deal and/or revision number. 96 "kind": "adexchangebuyer#marketplaceNote", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceNote". 97 "proposalRevisionNumber": "A String", # If the note is associated with a proposal revision number, then store that here. (readonly, except on create) 98 "dealId": "A String", # Notes can optionally be associated with a deal. (readonly, except on create) 99 "note": "A String", # The actual note to attach. (readonly, except on create) 100 "proposalId": "A String", # The proposalId that a note is attached to. (readonly) 101 "creatorRole": "A String", # The role of the person (buyer/seller) creating the note. (readonly) 102 "noteId": "A String", # The unique id for the note. (readonly) 103 "timestampMs": "A String", # The timestamp (ms since epoch) that this note was created. (readonly) 104 }, 105 ], 106 } 107 108 109 Returns: 110 An object of the form: 111 112 { 113 "notes": [ 114 { # A proposal is associated with a bunch of notes which may optionally be associated with a deal and/or revision number. 115 "kind": "adexchangebuyer#marketplaceNote", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceNote". 116 "proposalRevisionNumber": "A String", # If the note is associated with a proposal revision number, then store that here. (readonly, except on create) 117 "dealId": "A String", # Notes can optionally be associated with a deal. (readonly, except on create) 118 "note": "A String", # The actual note to attach. (readonly, except on create) 119 "proposalId": "A String", # The proposalId that a note is attached to. (readonly) 120 "creatorRole": "A String", # The role of the person (buyer/seller) creating the note. (readonly) 121 "noteId": "A String", # The unique id for the note. (readonly) 122 "timestampMs": "A String", # The timestamp (ms since epoch) that this note was created. (readonly) 123 }, 124 ], 125 }</pre> 126 </div> 127 128 <div class="method"> 129 <code class="details" id="list">list(proposalId, pqlQuery=None)</code> 130 <pre>Get all the notes associated with a proposal 131 132 Args: 133 proposalId: string, The proposalId to get notes for. To search across all proposals specify order_id = '-' as part of the URL. (required) 134 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%" 135 136 Returns: 137 An object of the form: 138 139 { 140 "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. 141 { # A proposal is associated with a bunch of notes which may optionally be associated with a deal and/or revision number. 142 "kind": "adexchangebuyer#marketplaceNote", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceNote". 143 "proposalRevisionNumber": "A String", # If the note is associated with a proposal revision number, then store that here. (readonly, except on create) 144 "dealId": "A String", # Notes can optionally be associated with a deal. (readonly, except on create) 145 "note": "A String", # The actual note to attach. (readonly, except on create) 146 "proposalId": "A String", # The proposalId that a note is attached to. (readonly) 147 "creatorRole": "A String", # The role of the person (buyer/seller) creating the note. (readonly) 148 "noteId": "A String", # The unique id for the note. (readonly) 149 "timestampMs": "A String", # The timestamp (ms since epoch) that this note was created. (readonly) 150 }, 151 ], 152 }</pre> 153 </div> 154 155 </body></html>
