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="dfareporting_v2_7.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_7.creativeFields.html">creativeFields</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#delete">delete(profileId, id)</a></code></p> 79 <p class="firstline">Deletes an existing creative field.</p> 80 <p class="toc_element"> 81 <code><a href="#get">get(profileId, id)</a></code></p> 82 <p class="firstline">Gets one creative field by ID.</p> 83 <p class="toc_element"> 84 <code><a href="#insert">insert(profileId, body)</a></code></p> 85 <p class="firstline">Inserts a new creative field.</p> 86 <p class="toc_element"> 87 <code><a href="#list">list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, ids=None, maxResults=None, sortOrder=None)</a></code></p> 88 <p class="firstline">Retrieves a list of creative fields, possibly filtered. This method supports paging.</p> 89 <p class="toc_element"> 90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 91 <p class="firstline">Retrieves the next page of results.</p> 92 <p class="toc_element"> 93 <code><a href="#patch">patch(profileId, id, body)</a></code></p> 94 <p class="firstline">Updates an existing creative field. This method supports patch semantics.</p> 95 <p class="toc_element"> 96 <code><a href="#update">update(profileId, body)</a></code></p> 97 <p class="firstline">Updates an existing creative field.</p> 98 <h3>Method Details</h3> 99 <div class="method"> 100 <code class="details" id="delete">delete(profileId, id)</code> 101 <pre>Deletes an existing creative field. 102 103 Args: 104 profileId: string, User profile ID associated with this request. (required) 105 id: string, Creative Field ID (required) 106 </pre> 107 </div> 108 109 <div class="method"> 110 <code class="details" id="get">get(profileId, id)</code> 111 <pre>Gets one creative field by ID. 112 113 Args: 114 profileId: string, User profile ID associated with this request. (required) 115 id: string, Creative Field ID (required) 116 117 Returns: 118 An object of the form: 119 120 { # Contains properties of a creative field. 121 "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField". 122 "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank. 123 "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser. 124 "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion. 125 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 126 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 127 "value": "A String", # The value of the dimension. 128 "dimensionName": "A String", # The name of the dimension. 129 "etag": "A String", # The eTag of this response for caching purposes. 130 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 131 "id": "A String", # The ID associated with the value if available. 132 }, 133 "id": "A String", # ID of this creative field. This is a read-only, auto-generated field. 134 "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank. 135 }</pre> 136 </div> 137 138 <div class="method"> 139 <code class="details" id="insert">insert(profileId, body)</code> 140 <pre>Inserts a new creative field. 141 142 Args: 143 profileId: string, User profile ID associated with this request. (required) 144 body: object, The request body. (required) 145 The object takes the form of: 146 147 { # Contains properties of a creative field. 148 "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField". 149 "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank. 150 "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser. 151 "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion. 152 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 153 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 154 "value": "A String", # The value of the dimension. 155 "dimensionName": "A String", # The name of the dimension. 156 "etag": "A String", # The eTag of this response for caching purposes. 157 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 158 "id": "A String", # The ID associated with the value if available. 159 }, 160 "id": "A String", # ID of this creative field. This is a read-only, auto-generated field. 161 "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank. 162 } 163 164 165 Returns: 166 An object of the form: 167 168 { # Contains properties of a creative field. 169 "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField". 170 "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank. 171 "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser. 172 "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion. 173 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 174 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 175 "value": "A String", # The value of the dimension. 176 "dimensionName": "A String", # The name of the dimension. 177 "etag": "A String", # The eTag of this response for caching purposes. 178 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 179 "id": "A String", # The ID associated with the value if available. 180 }, 181 "id": "A String", # ID of this creative field. This is a read-only, auto-generated field. 182 "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank. 183 }</pre> 184 </div> 185 186 <div class="method"> 187 <code class="details" id="list">list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, ids=None, maxResults=None, sortOrder=None)</code> 188 <pre>Retrieves a list of creative fields, possibly filtered. This method supports paging. 189 190 Args: 191 profileId: string, User profile ID associated with this request. (required) 192 searchString: string, Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, "creativefield*2015" will return creative fields with names like "creativefield June 2015", "creativefield April 2015", or simply "creativefield 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativefield" will match creative fields with the name "my creativefield", "creativefield 2015", or simply "creativefield". 193 pageToken: string, Value of the nextPageToken from the previous result page. 194 sortField: string, Field by which to sort the list. 195 Allowed values 196 ID - 197 NAME - 198 advertiserIds: string, Select only creative fields that belong to these advertisers. (repeated) 199 ids: string, Select only creative fields with these IDs. (repeated) 200 maxResults: integer, Maximum number of results to return. 201 sortOrder: string, Order of sorted results. 202 Allowed values 203 ASCENDING - 204 DESCENDING - 205 206 Returns: 207 An object of the form: 208 209 { # Creative Field List Response 210 "nextPageToken": "A String", # Pagination token to be used for the next list operation. 211 "creativeFields": [ # Creative field collection. 212 { # Contains properties of a creative field. 213 "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField". 214 "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank. 215 "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser. 216 "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion. 217 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 218 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 219 "value": "A String", # The value of the dimension. 220 "dimensionName": "A String", # The name of the dimension. 221 "etag": "A String", # The eTag of this response for caching purposes. 222 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 223 "id": "A String", # The ID associated with the value if available. 224 }, 225 "id": "A String", # ID of this creative field. This is a read-only, auto-generated field. 226 "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank. 227 }, 228 ], 229 "kind": "dfareporting#creativeFieldsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldsListResponse". 230 }</pre> 231 </div> 232 233 <div class="method"> 234 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 235 <pre>Retrieves the next page of results. 236 237 Args: 238 previous_request: The request for the previous page. (required) 239 previous_response: The response from the request for the previous page. (required) 240 241 Returns: 242 A request object that you can call 'execute()' on to request the next 243 page. Returns None if there are no more items in the collection. 244 </pre> 245 </div> 246 247 <div class="method"> 248 <code class="details" id="patch">patch(profileId, id, body)</code> 249 <pre>Updates an existing creative field. This method supports patch semantics. 250 251 Args: 252 profileId: string, User profile ID associated with this request. (required) 253 id: string, Creative Field ID (required) 254 body: object, The request body. (required) 255 The object takes the form of: 256 257 { # Contains properties of a creative field. 258 "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField". 259 "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank. 260 "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser. 261 "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion. 262 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 263 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 264 "value": "A String", # The value of the dimension. 265 "dimensionName": "A String", # The name of the dimension. 266 "etag": "A String", # The eTag of this response for caching purposes. 267 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 268 "id": "A String", # The ID associated with the value if available. 269 }, 270 "id": "A String", # ID of this creative field. This is a read-only, auto-generated field. 271 "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank. 272 } 273 274 275 Returns: 276 An object of the form: 277 278 { # Contains properties of a creative field. 279 "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField". 280 "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank. 281 "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser. 282 "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion. 283 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 284 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 285 "value": "A String", # The value of the dimension. 286 "dimensionName": "A String", # The name of the dimension. 287 "etag": "A String", # The eTag of this response for caching purposes. 288 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 289 "id": "A String", # The ID associated with the value if available. 290 }, 291 "id": "A String", # ID of this creative field. This is a read-only, auto-generated field. 292 "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank. 293 }</pre> 294 </div> 295 296 <div class="method"> 297 <code class="details" id="update">update(profileId, body)</code> 298 <pre>Updates an existing creative field. 299 300 Args: 301 profileId: string, User profile ID associated with this request. (required) 302 body: object, The request body. (required) 303 The object takes the form of: 304 305 { # Contains properties of a creative field. 306 "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField". 307 "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank. 308 "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser. 309 "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion. 310 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 311 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 312 "value": "A String", # The value of the dimension. 313 "dimensionName": "A String", # The name of the dimension. 314 "etag": "A String", # The eTag of this response for caching purposes. 315 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 316 "id": "A String", # The ID associated with the value if available. 317 }, 318 "id": "A String", # ID of this creative field. This is a read-only, auto-generated field. 319 "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank. 320 } 321 322 323 Returns: 324 An object of the form: 325 326 { # Contains properties of a creative field. 327 "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField". 328 "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank. 329 "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser. 330 "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion. 331 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 332 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 333 "value": "A String", # The value of the dimension. 334 "dimensionName": "A String", # The name of the dimension. 335 "etag": "A String", # The eTag of this response for caching purposes. 336 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 337 "id": "A String", # The ID associated with the value if available. 338 }, 339 "id": "A String", # ID of this creative field. This is a read-only, auto-generated field. 340 "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank. 341 }</pre> 342 </div> 343 344 </body></html>
