1<html><body> 2<style> 3 4body, 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 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, 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="dfareporting_v3_4.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_4.creativeFieldValues.html">creativeFieldValues</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(profileId, creativeFieldId, id, x__xgafv=None)</a></code></p> 82<p class="firstline">Deletes an existing creative field value.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(profileId, creativeFieldId, id, x__xgafv=None)</a></code></p> 85<p class="firstline">Gets one creative field value by ID.</p> 86<p class="toc_element"> 87 <code><a href="#insert">insert(profileId, creativeFieldId, body=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Inserts a new creative field value.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(profileId, creativeFieldId, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Retrieves a list of creative field values, possibly filtered. This method supports paging.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<p class="toc_element"> 96 <code><a href="#patch">patch(profileId, creativeFieldId, id, body=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Updates an existing creative field value. This method supports patch semantics.</p> 98<p class="toc_element"> 99 <code><a href="#update">update(profileId, creativeFieldId, body=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Updates an existing creative field value.</p> 101<h3>Method Details</h3> 102<div class="method"> 103 <code class="details" id="close">close()</code> 104 <pre>Close httplib2 connections.</pre> 105</div> 106 107<div class="method"> 108 <code class="details" id="delete">delete(profileId, creativeFieldId, id, x__xgafv=None)</code> 109 <pre>Deletes an existing creative field value. 110 111Args: 112 profileId: string, User profile ID associated with this request. (required) 113 creativeFieldId: string, Creative field ID for this creative field value. (required) 114 id: string, Creative Field Value ID (required) 115 x__xgafv: string, V1 error format. 116 Allowed values 117 1 - v1 error format 118 2 - v2 error format 119</pre> 120</div> 121 122<div class="method"> 123 <code class="details" id="get">get(profileId, creativeFieldId, id, x__xgafv=None)</code> 124 <pre>Gets one creative field value by ID. 125 126Args: 127 profileId: string, User profile ID associated with this request. (required) 128 creativeFieldId: string, Creative field ID for this creative field value. (required) 129 id: string, Creative Field Value ID (required) 130 x__xgafv: string, V1 error format. 131 Allowed values 132 1 - v1 error format 133 2 - v2 error format 134 135Returns: 136 An object of the form: 137 138 { # Contains properties of a creative field value. 139 "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field. 140 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue". 141 "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field. 142}</pre> 143</div> 144 145<div class="method"> 146 <code class="details" id="insert">insert(profileId, creativeFieldId, body=None, x__xgafv=None)</code> 147 <pre>Inserts a new creative field value. 148 149Args: 150 profileId: string, User profile ID associated with this request. (required) 151 creativeFieldId: string, Creative field ID for this creative field value. (required) 152 body: object, The request body. 153 The object takes the form of: 154 155{ # Contains properties of a creative field value. 156 "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field. 157 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue". 158 "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field. 159} 160 161 x__xgafv: string, V1 error format. 162 Allowed values 163 1 - v1 error format 164 2 - v2 error format 165 166Returns: 167 An object of the form: 168 169 { # Contains properties of a creative field value. 170 "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field. 171 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue". 172 "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field. 173}</pre> 174</div> 175 176<div class="method"> 177 <code class="details" id="list">list(profileId, creativeFieldId, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, x__xgafv=None)</code> 178 <pre>Retrieves a list of creative field values, possibly filtered. This method supports paging. 179 180Args: 181 profileId: string, User profile ID associated with this request. (required) 182 creativeFieldId: string, Creative field ID for this creative field value. (required) 183 ids: string, Select only creative field values with these IDs. (repeated) 184 maxResults: integer, Maximum number of results to return. 185 pageToken: string, Value of the nextPageToken from the previous result page. 186 searchString: string, Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed. 187 sortField: string, Field by which to sort the list. 188 Allowed values 189 ID - 190 VALUE - 191 sortOrder: string, Order of sorted results. 192 Allowed values 193 ASCENDING - 194 DESCENDING - 195 x__xgafv: string, V1 error format. 196 Allowed values 197 1 - v1 error format 198 2 - v2 error format 199 200Returns: 201 An object of the form: 202 203 { # Creative Field Value List Response 204 "creativeFieldValues": [ # Creative field value collection. 205 { # Contains properties of a creative field value. 206 "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field. 207 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue". 208 "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field. 209 }, 210 ], 211 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValuesListResponse". 212 "nextPageToken": "A String", # Pagination token to be used for the next list operation. 213}</pre> 214</div> 215 216<div class="method"> 217 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 218 <pre>Retrieves the next page of results. 219 220Args: 221 previous_request: The request for the previous page. (required) 222 previous_response: The response from the request for the previous page. (required) 223 224Returns: 225 A request object that you can call 'execute()' on to request the next 226 page. Returns None if there are no more items in the collection. 227 </pre> 228</div> 229 230<div class="method"> 231 <code class="details" id="patch">patch(profileId, creativeFieldId, id, body=None, x__xgafv=None)</code> 232 <pre>Updates an existing creative field value. This method supports patch semantics. 233 234Args: 235 profileId: string, User profile ID associated with this request. (required) 236 creativeFieldId: string, CreativeField ID. (required) 237 id: string, CreativeFieldValue ID. (required) 238 body: object, The request body. 239 The object takes the form of: 240 241{ # Contains properties of a creative field value. 242 "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field. 243 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue". 244 "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field. 245} 246 247 x__xgafv: string, V1 error format. 248 Allowed values 249 1 - v1 error format 250 2 - v2 error format 251 252Returns: 253 An object of the form: 254 255 { # Contains properties of a creative field value. 256 "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field. 257 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue". 258 "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field. 259}</pre> 260</div> 261 262<div class="method"> 263 <code class="details" id="update">update(profileId, creativeFieldId, body=None, x__xgafv=None)</code> 264 <pre>Updates an existing creative field value. 265 266Args: 267 profileId: string, User profile ID associated with this request. (required) 268 creativeFieldId: string, Creative field ID for this creative field value. (required) 269 body: object, The request body. 270 The object takes the form of: 271 272{ # Contains properties of a creative field value. 273 "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field. 274 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue". 275 "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field. 276} 277 278 x__xgafv: string, V1 error format. 279 Allowed values 280 1 - v1 error format 281 2 - v2 error format 282 283Returns: 284 An object of the form: 285 286 { # Contains properties of a creative field value. 287 "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field. 288 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue". 289 "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field. 290}</pre> 291</div> 292 293</body></html>