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