| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 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="adexchangebuyer2_v2beta1.html">Ad Exchange Buyer API II</a> . <a href="adexchangebuyer2_v2beta1.accounts.html">accounts</a> . <a href="adexchangebuyer2_v2beta1.accounts.creatives.html">creatives</a> . <a href="adexchangebuyer2_v2beta1.accounts.creatives.dealAssociations.html">dealAssociations</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#add">add(accountId, creativeId, body, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Associate an existing deal with a creative.</p> |
| 80 | <p class="toc_element"> |
| Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 81 | <code><a href="#list">list(accountId, creativeId, pageSize=None, pageToken=None, x__xgafv=None, query=None)</a></code></p> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 82 | <p class="firstline">List all creative-deal associations.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 85 | <p class="firstline">Retrieves the next page of results.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#remove">remove(accountId, creativeId, body, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Remove the association between a deal and a creative.</p> |
| 89 | <h3>Method Details</h3> |
| 90 | <div class="method"> |
| 91 | <code class="details" id="add">add(accountId, creativeId, body, x__xgafv=None)</code> |
| 92 | <pre>Associate an existing deal with a creative. |
| 93 | |
| 94 | Args: |
| 95 | accountId: string, The account the creative belongs to. (required) |
| 96 | creativeId: string, The ID of the creative associated with the deal. (required) |
| 97 | body: object, The request body. (required) |
| 98 | The object takes the form of: |
| 99 | |
| 100 | { # A request for associating a deal and a creative. |
| 101 | "association": { # The association between a creative and a deal. # The association between a creative and a deal that should be added. |
| 102 | "dealsId": "A String", # The externalDealId for the deal associated with the creative. |
| 103 | "creativeId": "A String", # The ID of the creative associated with the deal. |
| 104 | "accountId": "A String", # The account the creative belongs to. |
| 105 | }, |
| 106 | } |
| 107 | |
| 108 | x__xgafv: string, V1 error format. |
| 109 | Allowed values |
| 110 | 1 - v1 error format |
| 111 | 2 - v2 error format |
| 112 | |
| 113 | Returns: |
| 114 | An object of the form: |
| 115 | |
| 116 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 117 | # empty messages in your APIs. A typical example is to use it as the request |
| 118 | # or the response type of an API method. For instance: |
| 119 | # |
| 120 | # service Foo { |
| 121 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 122 | # } |
| 123 | # |
| 124 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 125 | }</pre> |
| 126 | </div> |
| 127 | |
| 128 | <div class="method"> |
| Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 129 | <code class="details" id="list">list(accountId, creativeId, pageSize=None, pageToken=None, x__xgafv=None, query=None)</code> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 130 | <pre>List all creative-deal associations. |
| 131 | |
| 132 | Args: |
| 133 | accountId: string, The account to list the associations from. |
| 134 | Specify "-" to list all creatives the current user has access to. (required) |
| 135 | creativeId: string, The creative ID to list the associations from. |
| 136 | Specify "-" to list all creatives under the above account. (required) |
| 137 | pageSize: integer, Requested page size. Server may return fewer associations than requested. |
| 138 | If unspecified, server will pick an appropriate default. |
| 139 | pageToken: string, A token identifying a page of results the server should return. |
| 140 | Typically, this is the value of |
| 141 | ListDealAssociationsResponse.next_page_token |
| 142 | returned from the previous call to 'ListDealAssociations' method. |
| 143 | x__xgafv: string, V1 error format. |
| 144 | Allowed values |
| 145 | 1 - v1 error format |
| 146 | 2 - v2 error format |
| 147 | query: string, An optional query string to filter deal associations. If no filter is |
| 148 | specified, all associations will be returned. |
| 149 | Supported queries are: |
| 150 | <ul> |
| 151 | <li>accountId=<i>account_id_string</i> |
| 152 | <li>creativeId=<i>creative_id_string</i> |
| 153 | <li>dealsId=<i>deals_id_string</i> |
| 154 | <li>dealsStatus:{approved, conditionally_approved, disapproved, |
| 155 | not_checked} |
| 156 | <li>openAuctionStatus:{approved, conditionally_approved, disapproved, |
| 157 | not_checked} |
| 158 | </ul> |
| 159 | Example: 'dealsId=12345 AND dealsStatus:disapproved' |
| 160 | |
| 161 | Returns: |
| 162 | An object of the form: |
| 163 | |
| 164 | { # A response for listing creative and deal associations |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 165 | "associations": [ # The list of associations. |
| 166 | { # The association between a creative and a deal. |
| 167 | "dealsId": "A String", # The externalDealId for the deal associated with the creative. |
| 168 | "creativeId": "A String", # The ID of the creative associated with the deal. |
| 169 | "accountId": "A String", # The account the creative belongs to. |
| 170 | }, |
| 171 | ], |
| Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 172 | "nextPageToken": "A String", # A token to retrieve the next page of results. |
| 173 | # Pass this value in the |
| 174 | # ListDealAssociationsRequest.page_token |
| 175 | # field in the subsequent call to 'ListDealAssociation' method to retrieve |
| 176 | # the next page of results. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 177 | }</pre> |
| 178 | </div> |
| 179 | |
| 180 | <div class="method"> |
| 181 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 182 | <pre>Retrieves the next page of results. |
| 183 | |
| 184 | Args: |
| 185 | previous_request: The request for the previous page. (required) |
| 186 | previous_response: The response from the request for the previous page. (required) |
| 187 | |
| 188 | Returns: |
| 189 | A request object that you can call 'execute()' on to request the next |
| 190 | page. Returns None if there are no more items in the collection. |
| 191 | </pre> |
| 192 | </div> |
| 193 | |
| 194 | <div class="method"> |
| 195 | <code class="details" id="remove">remove(accountId, creativeId, body, x__xgafv=None)</code> |
| 196 | <pre>Remove the association between a deal and a creative. |
| 197 | |
| 198 | Args: |
| 199 | accountId: string, The account the creative belongs to. (required) |
| 200 | creativeId: string, The ID of the creative associated with the deal. (required) |
| 201 | body: object, The request body. (required) |
| 202 | The object takes the form of: |
| 203 | |
| 204 | { # A request for removing the association between a deal and a creative. |
| 205 | "association": { # The association between a creative and a deal. # The association between a creative and a deal that should be removed. |
| 206 | "dealsId": "A String", # The externalDealId for the deal associated with the creative. |
| 207 | "creativeId": "A String", # The ID of the creative associated with the deal. |
| 208 | "accountId": "A String", # The account the creative belongs to. |
| 209 | }, |
| 210 | } |
| 211 | |
| 212 | x__xgafv: string, V1 error format. |
| 213 | Allowed values |
| 214 | 1 - v1 error format |
| 215 | 2 - v2 error format |
| 216 | |
| 217 | Returns: |
| 218 | An object of the form: |
| 219 | |
| 220 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 221 | # empty messages in your APIs. A typical example is to use it as the request |
| 222 | # or the response type of an API method. For instance: |
| 223 | # |
| 224 | # service Foo { |
| 225 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 226 | # } |
| 227 | # |
| 228 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 229 | }</pre> |
| 230 | </div> |
| 231 | |
| 232 | </body></html> |