OLD | NEW |
| (Empty) |
1 { | |
2 "auth": { | |
3 "oauth2": { | |
4 "scopes": { | |
5 "https://www.googleapis.com/auth/dfareporting": { | |
6 "description": "View and manage DoubleClick for Advertisers
reports" | |
7 }, | |
8 "https://www.googleapis.com/auth/dfatrafficking": { | |
9 "description": "View and manage your DoubleClick Campaign Ma
nager's (DCM) display ad campaigns" | |
10 } | |
11 } | |
12 } | |
13 }, | |
14 "basePath": "/dfareporting/v2.2/", | |
15 "baseUrl": "https://www.googleapis.com/dfareporting/v2.2/", | |
16 "batchPath": "batch", | |
17 "description": "Manages your DoubleClick Campaign Manager ad campaigns and r
eports.", | |
18 "discoveryVersion": "v1", | |
19 "documentationLink": "https://developers.google.com/doubleclick-advertisers/
reporting/", | |
20 "etag": "\"C5oy1hgQsABtYOYIOXWcR3BgYqU/KW75znc8lX5BhRl351_4B3M8uMo\"", | |
21 "icons": { | |
22 "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif", | |
23 "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif" | |
24 }, | |
25 "id": "dfareporting:v2.2", | |
26 "kind": "discovery#restDescription", | |
27 "name": "dfareporting", | |
28 "ownerDomain": "google.com", | |
29 "ownerName": "Google", | |
30 "parameters": { | |
31 "alt": { | |
32 "default": "json", | |
33 "description": "Data format for the response.", | |
34 "enum": [ | |
35 "json" | |
36 ], | |
37 "enumDescriptions": [ | |
38 "Responses with Content-Type of application/json" | |
39 ], | |
40 "location": "query", | |
41 "type": "string" | |
42 }, | |
43 "fields": { | |
44 "description": "Selector specifying which fields to include in a par
tial response.", | |
45 "location": "query", | |
46 "type": "string" | |
47 }, | |
48 "key": { | |
49 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", | |
50 "location": "query", | |
51 "type": "string" | |
52 }, | |
53 "oauth_token": { | |
54 "description": "OAuth 2.0 token for the current user.", | |
55 "location": "query", | |
56 "type": "string" | |
57 }, | |
58 "prettyPrint": { | |
59 "default": "true", | |
60 "description": "Returns response with indentations and line breaks."
, | |
61 "location": "query", | |
62 "type": "boolean" | |
63 }, | |
64 "quotaUser": { | |
65 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters. Overrides userIp if both are provided.", | |
66 "location": "query", | |
67 "type": "string" | |
68 }, | |
69 "userIp": { | |
70 "description": "IP address of the site where the request originates.
Use this if you want to enforce per-user limits.", | |
71 "location": "query", | |
72 "type": "string" | |
73 } | |
74 }, | |
75 "protocol": "rest", | |
76 "resources": { | |
77 "accountActiveAdSummaries": { | |
78 "methods": { | |
79 "get": { | |
80 "description": "Gets the account's active ad summary by acco
unt ID.", | |
81 "httpMethod": "GET", | |
82 "id": "dfareporting.accountActiveAdSummaries.get", | |
83 "parameterOrder": [ | |
84 "profileId", | |
85 "summaryAccountId" | |
86 ], | |
87 "parameters": { | |
88 "profileId": { | |
89 "description": "User profile ID associated with this
request.", | |
90 "format": "int64", | |
91 "location": "path", | |
92 "required": true, | |
93 "type": "string" | |
94 }, | |
95 "summaryAccountId": { | |
96 "description": "Account ID.", | |
97 "format": "int64", | |
98 "location": "path", | |
99 "required": true, | |
100 "type": "string" | |
101 } | |
102 }, | |
103 "path": "userprofiles/{profileId}/accountActiveAdSummaries/{
summaryAccountId}", | |
104 "response": { | |
105 "$ref": "AccountActiveAdSummary" | |
106 }, | |
107 "scopes": [ | |
108 "https://www.googleapis.com/auth/dfatrafficking" | |
109 ] | |
110 } | |
111 } | |
112 }, | |
113 "accountPermissionGroups": { | |
114 "methods": { | |
115 "get": { | |
116 "description": "Gets one account permission group by ID.", | |
117 "httpMethod": "GET", | |
118 "id": "dfareporting.accountPermissionGroups.get", | |
119 "parameterOrder": [ | |
120 "profileId", | |
121 "id" | |
122 ], | |
123 "parameters": { | |
124 "id": { | |
125 "description": "Account permission group ID.", | |
126 "format": "int64", | |
127 "location": "path", | |
128 "required": true, | |
129 "type": "string" | |
130 }, | |
131 "profileId": { | |
132 "description": "User profile ID associated with this
request.", | |
133 "format": "int64", | |
134 "location": "path", | |
135 "required": true, | |
136 "type": "string" | |
137 } | |
138 }, | |
139 "path": "userprofiles/{profileId}/accountPermissionGroups/{i
d}", | |
140 "response": { | |
141 "$ref": "AccountPermissionGroup" | |
142 }, | |
143 "scopes": [ | |
144 "https://www.googleapis.com/auth/dfatrafficking" | |
145 ] | |
146 }, | |
147 "list": { | |
148 "description": "Retrieves the list of account permission gro
ups.", | |
149 "httpMethod": "GET", | |
150 "id": "dfareporting.accountPermissionGroups.list", | |
151 "parameterOrder": [ | |
152 "profileId" | |
153 ], | |
154 "parameters": { | |
155 "profileId": { | |
156 "description": "User profile ID associated with this
request.", | |
157 "format": "int64", | |
158 "location": "path", | |
159 "required": true, | |
160 "type": "string" | |
161 } | |
162 }, | |
163 "path": "userprofiles/{profileId}/accountPermissionGroups", | |
164 "response": { | |
165 "$ref": "AccountPermissionGroupsListResponse" | |
166 }, | |
167 "scopes": [ | |
168 "https://www.googleapis.com/auth/dfatrafficking" | |
169 ] | |
170 } | |
171 } | |
172 }, | |
173 "accountPermissions": { | |
174 "methods": { | |
175 "get": { | |
176 "description": "Gets one account permission by ID.", | |
177 "httpMethod": "GET", | |
178 "id": "dfareporting.accountPermissions.get", | |
179 "parameterOrder": [ | |
180 "profileId", | |
181 "id" | |
182 ], | |
183 "parameters": { | |
184 "id": { | |
185 "description": "Account permission ID.", | |
186 "format": "int64", | |
187 "location": "path", | |
188 "required": true, | |
189 "type": "string" | |
190 }, | |
191 "profileId": { | |
192 "description": "User profile ID associated with this
request.", | |
193 "format": "int64", | |
194 "location": "path", | |
195 "required": true, | |
196 "type": "string" | |
197 } | |
198 }, | |
199 "path": "userprofiles/{profileId}/accountPermissions/{id}", | |
200 "response": { | |
201 "$ref": "AccountPermission" | |
202 }, | |
203 "scopes": [ | |
204 "https://www.googleapis.com/auth/dfatrafficking" | |
205 ] | |
206 }, | |
207 "list": { | |
208 "description": "Retrieves the list of account permissions.", | |
209 "httpMethod": "GET", | |
210 "id": "dfareporting.accountPermissions.list", | |
211 "parameterOrder": [ | |
212 "profileId" | |
213 ], | |
214 "parameters": { | |
215 "profileId": { | |
216 "description": "User profile ID associated with this
request.", | |
217 "format": "int64", | |
218 "location": "path", | |
219 "required": true, | |
220 "type": "string" | |
221 } | |
222 }, | |
223 "path": "userprofiles/{profileId}/accountPermissions", | |
224 "response": { | |
225 "$ref": "AccountPermissionsListResponse" | |
226 }, | |
227 "scopes": [ | |
228 "https://www.googleapis.com/auth/dfatrafficking" | |
229 ] | |
230 } | |
231 } | |
232 }, | |
233 "accountUserProfiles": { | |
234 "methods": { | |
235 "get": { | |
236 "description": "Gets one account user profile by ID.", | |
237 "httpMethod": "GET", | |
238 "id": "dfareporting.accountUserProfiles.get", | |
239 "parameterOrder": [ | |
240 "profileId", | |
241 "id" | |
242 ], | |
243 "parameters": { | |
244 "id": { | |
245 "description": "User profile ID.", | |
246 "format": "int64", | |
247 "location": "path", | |
248 "required": true, | |
249 "type": "string" | |
250 }, | |
251 "profileId": { | |
252 "description": "User profile ID associated with this
request.", | |
253 "format": "int64", | |
254 "location": "path", | |
255 "required": true, | |
256 "type": "string" | |
257 } | |
258 }, | |
259 "path": "userprofiles/{profileId}/accountUserProfiles/{id}", | |
260 "response": { | |
261 "$ref": "AccountUserProfile" | |
262 }, | |
263 "scopes": [ | |
264 "https://www.googleapis.com/auth/dfatrafficking" | |
265 ] | |
266 }, | |
267 "insert": { | |
268 "description": "Inserts a new account user profile.", | |
269 "httpMethod": "POST", | |
270 "id": "dfareporting.accountUserProfiles.insert", | |
271 "parameterOrder": [ | |
272 "profileId" | |
273 ], | |
274 "parameters": { | |
275 "profileId": { | |
276 "description": "User profile ID associated with this
request.", | |
277 "format": "int64", | |
278 "location": "path", | |
279 "required": true, | |
280 "type": "string" | |
281 } | |
282 }, | |
283 "path": "userprofiles/{profileId}/accountUserProfiles", | |
284 "request": { | |
285 "$ref": "AccountUserProfile" | |
286 }, | |
287 "response": { | |
288 "$ref": "AccountUserProfile" | |
289 }, | |
290 "scopes": [ | |
291 "https://www.googleapis.com/auth/dfatrafficking" | |
292 ] | |
293 }, | |
294 "list": { | |
295 "description": "Retrieves a list of account user profiles, p
ossibly filtered.", | |
296 "httpMethod": "GET", | |
297 "id": "dfareporting.accountUserProfiles.list", | |
298 "parameterOrder": [ | |
299 "profileId" | |
300 ], | |
301 "parameters": { | |
302 "active": { | |
303 "description": "Select only active user profiles.", | |
304 "location": "query", | |
305 "type": "boolean" | |
306 }, | |
307 "ids": { | |
308 "description": "Select only user profiles with these
IDs.", | |
309 "format": "int64", | |
310 "location": "query", | |
311 "repeated": true, | |
312 "type": "string" | |
313 }, | |
314 "maxResults": { | |
315 "description": "Maximum number of results to return.
", | |
316 "format": "int32", | |
317 "location": "query", | |
318 "type": "integer" | |
319 }, | |
320 "pageToken": { | |
321 "description": "Value of the nextPageToken from the
previous result page.", | |
322 "location": "query", | |
323 "type": "string" | |
324 }, | |
325 "profileId": { | |
326 "description": "User profile ID associated with this
request.", | |
327 "format": "int64", | |
328 "location": "path", | |
329 "required": true, | |
330 "type": "string" | |
331 }, | |
332 "searchString": { | |
333 "description": "Allows searching for objects by name
, ID or email. Wildcards (*) are allowed. For example, \"user profile*2015\" wil
l return objects with names like \"user profile June 2015\", \"user profile Apri
l 2015\", or simply \"user profile 2015\". Most of the searches also add wildcar
ds implicitly at the start and the end of the search string. For example, a sear
ch string of \"user profile\" will match objects with name \"my user profile\",
\"user profile 2015\", or simply \"user profile\".", | |
334 "location": "query", | |
335 "type": "string" | |
336 }, | |
337 "sortField": { | |
338 "description": "Field by which to sort the list.", | |
339 "enum": [ | |
340 "ID", | |
341 "NAME" | |
342 ], | |
343 "enumDescriptions": [ | |
344 "", | |
345 "" | |
346 ], | |
347 "location": "query", | |
348 "type": "string" | |
349 }, | |
350 "sortOrder": { | |
351 "description": "Order of sorted results, default is
ASCENDING.", | |
352 "enum": [ | |
353 "ASCENDING", | |
354 "DESCENDING" | |
355 ], | |
356 "enumDescriptions": [ | |
357 "", | |
358 "" | |
359 ], | |
360 "location": "query", | |
361 "type": "string" | |
362 }, | |
363 "subaccountId": { | |
364 "description": "Select only user profiles with the s
pecified subaccount ID.", | |
365 "format": "int64", | |
366 "location": "query", | |
367 "type": "string" | |
368 }, | |
369 "userRoleId": { | |
370 "description": "Select only user profiles with the s
pecified user role ID.", | |
371 "format": "int64", | |
372 "location": "query", | |
373 "type": "string" | |
374 } | |
375 }, | |
376 "path": "userprofiles/{profileId}/accountUserProfiles", | |
377 "response": { | |
378 "$ref": "AccountUserProfilesListResponse" | |
379 }, | |
380 "scopes": [ | |
381 "https://www.googleapis.com/auth/dfatrafficking" | |
382 ] | |
383 }, | |
384 "patch": { | |
385 "description": "Updates an existing account user profile. Th
is method supports patch semantics.", | |
386 "httpMethod": "PATCH", | |
387 "id": "dfareporting.accountUserProfiles.patch", | |
388 "parameterOrder": [ | |
389 "profileId", | |
390 "id" | |
391 ], | |
392 "parameters": { | |
393 "id": { | |
394 "description": "User profile ID.", | |
395 "format": "int64", | |
396 "location": "query", | |
397 "required": true, | |
398 "type": "string" | |
399 }, | |
400 "profileId": { | |
401 "description": "User profile ID associated with this
request.", | |
402 "format": "int64", | |
403 "location": "path", | |
404 "required": true, | |
405 "type": "string" | |
406 } | |
407 }, | |
408 "path": "userprofiles/{profileId}/accountUserProfiles", | |
409 "request": { | |
410 "$ref": "AccountUserProfile" | |
411 }, | |
412 "response": { | |
413 "$ref": "AccountUserProfile" | |
414 }, | |
415 "scopes": [ | |
416 "https://www.googleapis.com/auth/dfatrafficking" | |
417 ] | |
418 }, | |
419 "update": { | |
420 "description": "Updates an existing account user profile.", | |
421 "httpMethod": "PUT", | |
422 "id": "dfareporting.accountUserProfiles.update", | |
423 "parameterOrder": [ | |
424 "profileId" | |
425 ], | |
426 "parameters": { | |
427 "profileId": { | |
428 "description": "User profile ID associated with this
request.", | |
429 "format": "int64", | |
430 "location": "path", | |
431 "required": true, | |
432 "type": "string" | |
433 } | |
434 }, | |
435 "path": "userprofiles/{profileId}/accountUserProfiles", | |
436 "request": { | |
437 "$ref": "AccountUserProfile" | |
438 }, | |
439 "response": { | |
440 "$ref": "AccountUserProfile" | |
441 }, | |
442 "scopes": [ | |
443 "https://www.googleapis.com/auth/dfatrafficking" | |
444 ] | |
445 } | |
446 } | |
447 }, | |
448 "accounts": { | |
449 "methods": { | |
450 "get": { | |
451 "description": "Gets one account by ID.", | |
452 "httpMethod": "GET", | |
453 "id": "dfareporting.accounts.get", | |
454 "parameterOrder": [ | |
455 "profileId", | |
456 "id" | |
457 ], | |
458 "parameters": { | |
459 "id": { | |
460 "description": "Account ID.", | |
461 "format": "int64", | |
462 "location": "path", | |
463 "required": true, | |
464 "type": "string" | |
465 }, | |
466 "profileId": { | |
467 "description": "User profile ID associated with this
request.", | |
468 "format": "int64", | |
469 "location": "path", | |
470 "required": true, | |
471 "type": "string" | |
472 } | |
473 }, | |
474 "path": "userprofiles/{profileId}/accounts/{id}", | |
475 "response": { | |
476 "$ref": "Account" | |
477 }, | |
478 "scopes": [ | |
479 "https://www.googleapis.com/auth/dfatrafficking" | |
480 ] | |
481 }, | |
482 "list": { | |
483 "description": "Retrieves the list of accounts, possibly fil
tered.", | |
484 "httpMethod": "GET", | |
485 "id": "dfareporting.accounts.list", | |
486 "parameterOrder": [ | |
487 "profileId" | |
488 ], | |
489 "parameters": { | |
490 "active": { | |
491 "description": "Select only active accounts. Don't s
et this field to select both active and non-active accounts.", | |
492 "location": "query", | |
493 "type": "boolean" | |
494 }, | |
495 "ids": { | |
496 "description": "Select only accounts with these IDs.
", | |
497 "format": "int64", | |
498 "location": "query", | |
499 "repeated": true, | |
500 "type": "string" | |
501 }, | |
502 "maxResults": { | |
503 "description": "Maximum number of results to return.
", | |
504 "format": "int32", | |
505 "location": "query", | |
506 "type": "integer" | |
507 }, | |
508 "pageToken": { | |
509 "description": "Value of the nextPageToken from the
previous result page.", | |
510 "location": "query", | |
511 "type": "string" | |
512 }, | |
513 "profileId": { | |
514 "description": "User profile ID associated with this
request.", | |
515 "format": "int64", | |
516 "location": "path", | |
517 "required": true, | |
518 "type": "string" | |
519 }, | |
520 "searchString": { | |
521 "description": "Allows searching for objects by name
or ID. Wildcards (*) are allowed. For example, \"account*2015\" will return obj
ects with names like \"account June 2015\", \"account April 2015\", or simply \"
account 2015\". Most of the searches also add wildcards implicitly at the start
and the end of the search string. For example, a search string of \"account\" wi
ll match objects with name \"my account\", \"account 2015\", or simply \"account
\".", | |
522 "location": "query", | |
523 "type": "string" | |
524 }, | |
525 "sortField": { | |
526 "description": "Field by which to sort the list.", | |
527 "enum": [ | |
528 "ID", | |
529 "NAME" | |
530 ], | |
531 "enumDescriptions": [ | |
532 "", | |
533 "" | |
534 ], | |
535 "location": "query", | |
536 "type": "string" | |
537 }, | |
538 "sortOrder": { | |
539 "description": "Order of sorted results, default is
ASCENDING.", | |
540 "enum": [ | |
541 "ASCENDING", | |
542 "DESCENDING" | |
543 ], | |
544 "enumDescriptions": [ | |
545 "", | |
546 "" | |
547 ], | |
548 "location": "query", | |
549 "type": "string" | |
550 } | |
551 }, | |
552 "path": "userprofiles/{profileId}/accounts", | |
553 "response": { | |
554 "$ref": "AccountsListResponse" | |
555 }, | |
556 "scopes": [ | |
557 "https://www.googleapis.com/auth/dfatrafficking" | |
558 ] | |
559 }, | |
560 "patch": { | |
561 "description": "Updates an existing account. This method sup
ports patch semantics.", | |
562 "httpMethod": "PATCH", | |
563 "id": "dfareporting.accounts.patch", | |
564 "parameterOrder": [ | |
565 "profileId", | |
566 "id" | |
567 ], | |
568 "parameters": { | |
569 "id": { | |
570 "description": "Account ID.", | |
571 "format": "int64", | |
572 "location": "query", | |
573 "required": true, | |
574 "type": "string" | |
575 }, | |
576 "profileId": { | |
577 "description": "User profile ID associated with this
request.", | |
578 "format": "int64", | |
579 "location": "path", | |
580 "required": true, | |
581 "type": "string" | |
582 } | |
583 }, | |
584 "path": "userprofiles/{profileId}/accounts", | |
585 "request": { | |
586 "$ref": "Account" | |
587 }, | |
588 "response": { | |
589 "$ref": "Account" | |
590 }, | |
591 "scopes": [ | |
592 "https://www.googleapis.com/auth/dfatrafficking" | |
593 ] | |
594 }, | |
595 "update": { | |
596 "description": "Updates an existing account.", | |
597 "httpMethod": "PUT", | |
598 "id": "dfareporting.accounts.update", | |
599 "parameterOrder": [ | |
600 "profileId" | |
601 ], | |
602 "parameters": { | |
603 "profileId": { | |
604 "description": "User profile ID associated with this
request.", | |
605 "format": "int64", | |
606 "location": "path", | |
607 "required": true, | |
608 "type": "string" | |
609 } | |
610 }, | |
611 "path": "userprofiles/{profileId}/accounts", | |
612 "request": { | |
613 "$ref": "Account" | |
614 }, | |
615 "response": { | |
616 "$ref": "Account" | |
617 }, | |
618 "scopes": [ | |
619 "https://www.googleapis.com/auth/dfatrafficking" | |
620 ] | |
621 } | |
622 } | |
623 }, | |
624 "ads": { | |
625 "methods": { | |
626 "get": { | |
627 "description": "Gets one ad by ID.", | |
628 "httpMethod": "GET", | |
629 "id": "dfareporting.ads.get", | |
630 "parameterOrder": [ | |
631 "profileId", | |
632 "id" | |
633 ], | |
634 "parameters": { | |
635 "id": { | |
636 "description": "Ad ID.", | |
637 "format": "int64", | |
638 "location": "path", | |
639 "required": true, | |
640 "type": "string" | |
641 }, | |
642 "profileId": { | |
643 "description": "User profile ID associated with this
request.", | |
644 "format": "int64", | |
645 "location": "path", | |
646 "required": true, | |
647 "type": "string" | |
648 } | |
649 }, | |
650 "path": "userprofiles/{profileId}/ads/{id}", | |
651 "response": { | |
652 "$ref": "Ad" | |
653 }, | |
654 "scopes": [ | |
655 "https://www.googleapis.com/auth/dfatrafficking" | |
656 ] | |
657 }, | |
658 "insert": { | |
659 "description": "Inserts a new ad.", | |
660 "httpMethod": "POST", | |
661 "id": "dfareporting.ads.insert", | |
662 "parameterOrder": [ | |
663 "profileId" | |
664 ], | |
665 "parameters": { | |
666 "profileId": { | |
667 "description": "User profile ID associated with this
request.", | |
668 "format": "int64", | |
669 "location": "path", | |
670 "required": true, | |
671 "type": "string" | |
672 } | |
673 }, | |
674 "path": "userprofiles/{profileId}/ads", | |
675 "request": { | |
676 "$ref": "Ad" | |
677 }, | |
678 "response": { | |
679 "$ref": "Ad" | |
680 }, | |
681 "scopes": [ | |
682 "https://www.googleapis.com/auth/dfatrafficking" | |
683 ] | |
684 }, | |
685 "list": { | |
686 "description": "Retrieves a list of ads, possibly filtered."
, | |
687 "httpMethod": "GET", | |
688 "id": "dfareporting.ads.list", | |
689 "parameterOrder": [ | |
690 "profileId" | |
691 ], | |
692 "parameters": { | |
693 "active": { | |
694 "description": "Select only active ads.", | |
695 "location": "query", | |
696 "type": "boolean" | |
697 }, | |
698 "advertiserId": { | |
699 "description": "Select only ads with this advertiser
ID.", | |
700 "format": "int64", | |
701 "location": "query", | |
702 "type": "string" | |
703 }, | |
704 "archived": { | |
705 "description": "Select only archived ads.", | |
706 "location": "query", | |
707 "type": "boolean" | |
708 }, | |
709 "audienceSegmentIds": { | |
710 "description": "Select only ads with these audience
segment IDs.", | |
711 "format": "int64", | |
712 "location": "query", | |
713 "repeated": true, | |
714 "type": "string" | |
715 }, | |
716 "campaignIds": { | |
717 "description": "Select only ads with these campaign
IDs.", | |
718 "format": "int64", | |
719 "location": "query", | |
720 "repeated": true, | |
721 "type": "string" | |
722 }, | |
723 "compatibility": { | |
724 "description": "Select default ads with the specifie
d compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and WEB_INTE
RSTITIAL refer to rendering either on desktop or on mobile devices for regular o
r interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in
mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads develope
d with the VAST standard.", | |
725 "enum": [ | |
726 "APP", | |
727 "APP_INTERSTITIAL", | |
728 "IN_STREAM_VIDEO", | |
729 "WEB", | |
730 "WEB_INTERSTITIAL" | |
731 ], | |
732 "enumDescriptions": [ | |
733 "", | |
734 "", | |
735 "", | |
736 "", | |
737 "" | |
738 ], | |
739 "location": "query", | |
740 "type": "string" | |
741 }, | |
742 "creativeIds": { | |
743 "description": "Select only ads with these creative
IDs assigned.", | |
744 "format": "int64", | |
745 "location": "query", | |
746 "repeated": true, | |
747 "type": "string" | |
748 }, | |
749 "creativeOptimizationConfigurationIds": { | |
750 "description": "Select only ads with these creative
optimization configuration IDs.", | |
751 "format": "int64", | |
752 "location": "query", | |
753 "repeated": true, | |
754 "type": "string" | |
755 }, | |
756 "creativeType": { | |
757 "description": "Select only ads with the specified c
reativeType.", | |
758 "enum": [ | |
759 "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO", | |
760 "CUSTOM_INPAGE", | |
761 "CUSTOM_INTERSTITIAL", | |
762 "ENHANCED_BANNER", | |
763 "ENHANCED_IMAGE", | |
764 "FLASH_INPAGE", | |
765 "HTML5_BANNER", | |
766 "IMAGE", | |
767 "INSTREAM_VIDEO", | |
768 "INTERNAL_REDIRECT", | |
769 "INTERSTITIAL_INTERNAL_REDIRECT", | |
770 "REDIRECT", | |
771 "RICH_MEDIA_EXPANDING", | |
772 "RICH_MEDIA_IM_EXPAND", | |
773 "RICH_MEDIA_INPAGE", | |
774 "RICH_MEDIA_INPAGE_FLOATING", | |
775 "RICH_MEDIA_INTERSTITIAL_FLOAT", | |
776 "RICH_MEDIA_MOBILE_IN_APP", | |
777 "RICH_MEDIA_MULTI_FLOATING", | |
778 "RICH_MEDIA_PEEL_DOWN", | |
779 "TRACKING_TEXT", | |
780 "VAST_REDIRECT", | |
781 "VPAID_LINEAR", | |
782 "VPAID_NON_LINEAR" | |
783 ], | |
784 "enumDescriptions": [ | |
785 "", | |
786 "", | |
787 "", | |
788 "", | |
789 "", | |
790 "", | |
791 "", | |
792 "", | |
793 "", | |
794 "", | |
795 "", | |
796 "", | |
797 "", | |
798 "", | |
799 "", | |
800 "", | |
801 "", | |
802 "", | |
803 "", | |
804 "", | |
805 "", | |
806 "", | |
807 "", | |
808 "" | |
809 ], | |
810 "location": "query", | |
811 "type": "string" | |
812 }, | |
813 "dynamicClickTracker": { | |
814 "description": "Select only dynamic click trackers.
Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click
trackers. If false, select static click trackers. Leave unset to select both.", | |
815 "location": "query", | |
816 "type": "boolean" | |
817 }, | |
818 "ids": { | |
819 "description": "Select only ads with these IDs.", | |
820 "format": "int64", | |
821 "location": "query", | |
822 "repeated": true, | |
823 "type": "string" | |
824 }, | |
825 "landingPageIds": { | |
826 "description": "Select only ads with these landing p
age IDs.", | |
827 "format": "int64", | |
828 "location": "query", | |
829 "repeated": true, | |
830 "type": "string" | |
831 }, | |
832 "maxResults": { | |
833 "description": "Maximum number of results to return.
", | |
834 "format": "int32", | |
835 "location": "query", | |
836 "type": "integer" | |
837 }, | |
838 "overriddenEventTagId": { | |
839 "description": "Select only ads with this event tag
override ID.", | |
840 "format": "int64", | |
841 "location": "query", | |
842 "type": "string" | |
843 }, | |
844 "pageToken": { | |
845 "description": "Value of the nextPageToken from the
previous result page.", | |
846 "location": "query", | |
847 "type": "string" | |
848 }, | |
849 "placementIds": { | |
850 "description": "Select only ads with these placement
IDs assigned.", | |
851 "format": "int64", | |
852 "location": "query", | |
853 "repeated": true, | |
854 "type": "string" | |
855 }, | |
856 "profileId": { | |
857 "description": "User profile ID associated with this
request.", | |
858 "format": "int64", | |
859 "location": "path", | |
860 "required": true, | |
861 "type": "string" | |
862 }, | |
863 "remarketingListIds": { | |
864 "description": "Select only ads whose list targeting
expression use these remarketing list IDs.", | |
865 "format": "int64", | |
866 "location": "query", | |
867 "repeated": true, | |
868 "type": "string" | |
869 }, | |
870 "searchString": { | |
871 "description": "Allows searching for objects by name
or ID. Wildcards (*) are allowed. For example, \"ad*2015\" will return objects
with names like \"ad June 2015\", \"ad April 2015\", or simply \"ad 2015\". Most
of the searches also add wildcards implicitly at the start and the end of the s
earch string. For example, a search string of \"ad\" will match objects with nam
e \"my ad\", \"ad 2015\", or simply \"ad\".", | |
872 "location": "query", | |
873 "type": "string" | |
874 }, | |
875 "sizeIds": { | |
876 "description": "Select only ads with these size IDs.
", | |
877 "format": "int64", | |
878 "location": "query", | |
879 "repeated": true, | |
880 "type": "string" | |
881 }, | |
882 "sortField": { | |
883 "description": "Field by which to sort the list.", | |
884 "enum": [ | |
885 "ID", | |
886 "NAME" | |
887 ], | |
888 "enumDescriptions": [ | |
889 "", | |
890 "" | |
891 ], | |
892 "location": "query", | |
893 "type": "string" | |
894 }, | |
895 "sortOrder": { | |
896 "description": "Order of sorted results, default is
ASCENDING.", | |
897 "enum": [ | |
898 "ASCENDING", | |
899 "DESCENDING" | |
900 ], | |
901 "enumDescriptions": [ | |
902 "", | |
903 "" | |
904 ], | |
905 "location": "query", | |
906 "type": "string" | |
907 }, | |
908 "sslCompliant": { | |
909 "description": "Select only ads that are SSL-complia
nt.", | |
910 "location": "query", | |
911 "type": "boolean" | |
912 }, | |
913 "sslRequired": { | |
914 "description": "Select only ads that require SSL.", | |
915 "location": "query", | |
916 "type": "boolean" | |
917 }, | |
918 "type": { | |
919 "description": "Select only ads with these types.", | |
920 "enum": [ | |
921 "AD_SERVING_CLICK_TRACKER", | |
922 "AD_SERVING_DEFAULT_AD", | |
923 "AD_SERVING_STANDARD_AD", | |
924 "AD_SERVING_TRACKING" | |
925 ], | |
926 "enumDescriptions": [ | |
927 "", | |
928 "", | |
929 "", | |
930 "" | |
931 ], | |
932 "location": "query", | |
933 "repeated": true, | |
934 "type": "string" | |
935 } | |
936 }, | |
937 "path": "userprofiles/{profileId}/ads", | |
938 "response": { | |
939 "$ref": "AdsListResponse" | |
940 }, | |
941 "scopes": [ | |
942 "https://www.googleapis.com/auth/dfatrafficking" | |
943 ] | |
944 }, | |
945 "patch": { | |
946 "description": "Updates an existing ad. This method supports
patch semantics.", | |
947 "httpMethod": "PATCH", | |
948 "id": "dfareporting.ads.patch", | |
949 "parameterOrder": [ | |
950 "profileId", | |
951 "id" | |
952 ], | |
953 "parameters": { | |
954 "id": { | |
955 "description": "Ad ID.", | |
956 "format": "int64", | |
957 "location": "query", | |
958 "required": true, | |
959 "type": "string" | |
960 }, | |
961 "profileId": { | |
962 "description": "User profile ID associated with this
request.", | |
963 "format": "int64", | |
964 "location": "path", | |
965 "required": true, | |
966 "type": "string" | |
967 } | |
968 }, | |
969 "path": "userprofiles/{profileId}/ads", | |
970 "request": { | |
971 "$ref": "Ad" | |
972 }, | |
973 "response": { | |
974 "$ref": "Ad" | |
975 }, | |
976 "scopes": [ | |
977 "https://www.googleapis.com/auth/dfatrafficking" | |
978 ] | |
979 }, | |
980 "update": { | |
981 "description": "Updates an existing ad.", | |
982 "httpMethod": "PUT", | |
983 "id": "dfareporting.ads.update", | |
984 "parameterOrder": [ | |
985 "profileId" | |
986 ], | |
987 "parameters": { | |
988 "profileId": { | |
989 "description": "User profile ID associated with this
request.", | |
990 "format": "int64", | |
991 "location": "path", | |
992 "required": true, | |
993 "type": "string" | |
994 } | |
995 }, | |
996 "path": "userprofiles/{profileId}/ads", | |
997 "request": { | |
998 "$ref": "Ad" | |
999 }, | |
1000 "response": { | |
1001 "$ref": "Ad" | |
1002 }, | |
1003 "scopes": [ | |
1004 "https://www.googleapis.com/auth/dfatrafficking" | |
1005 ] | |
1006 } | |
1007 } | |
1008 }, | |
1009 "advertiserGroups": { | |
1010 "methods": { | |
1011 "delete": { | |
1012 "description": "Deletes an existing advertiser group.", | |
1013 "httpMethod": "DELETE", | |
1014 "id": "dfareporting.advertiserGroups.delete", | |
1015 "parameterOrder": [ | |
1016 "profileId", | |
1017 "id" | |
1018 ], | |
1019 "parameters": { | |
1020 "id": { | |
1021 "description": "Advertiser group ID.", | |
1022 "format": "int64", | |
1023 "location": "path", | |
1024 "required": true, | |
1025 "type": "string" | |
1026 }, | |
1027 "profileId": { | |
1028 "description": "User profile ID associated with this
request.", | |
1029 "format": "int64", | |
1030 "location": "path", | |
1031 "required": true, | |
1032 "type": "string" | |
1033 } | |
1034 }, | |
1035 "path": "userprofiles/{profileId}/advertiserGroups/{id}", | |
1036 "scopes": [ | |
1037 "https://www.googleapis.com/auth/dfatrafficking" | |
1038 ] | |
1039 }, | |
1040 "get": { | |
1041 "description": "Gets one advertiser group by ID.", | |
1042 "httpMethod": "GET", | |
1043 "id": "dfareporting.advertiserGroups.get", | |
1044 "parameterOrder": [ | |
1045 "profileId", | |
1046 "id" | |
1047 ], | |
1048 "parameters": { | |
1049 "id": { | |
1050 "description": "Advertiser group ID.", | |
1051 "format": "int64", | |
1052 "location": "path", | |
1053 "required": true, | |
1054 "type": "string" | |
1055 }, | |
1056 "profileId": { | |
1057 "description": "User profile ID associated with this
request.", | |
1058 "format": "int64", | |
1059 "location": "path", | |
1060 "required": true, | |
1061 "type": "string" | |
1062 } | |
1063 }, | |
1064 "path": "userprofiles/{profileId}/advertiserGroups/{id}", | |
1065 "response": { | |
1066 "$ref": "AdvertiserGroup" | |
1067 }, | |
1068 "scopes": [ | |
1069 "https://www.googleapis.com/auth/dfatrafficking" | |
1070 ] | |
1071 }, | |
1072 "insert": { | |
1073 "description": "Inserts a new advertiser group.", | |
1074 "httpMethod": "POST", | |
1075 "id": "dfareporting.advertiserGroups.insert", | |
1076 "parameterOrder": [ | |
1077 "profileId" | |
1078 ], | |
1079 "parameters": { | |
1080 "profileId": { | |
1081 "description": "User profile ID associated with this
request.", | |
1082 "format": "int64", | |
1083 "location": "path", | |
1084 "required": true, | |
1085 "type": "string" | |
1086 } | |
1087 }, | |
1088 "path": "userprofiles/{profileId}/advertiserGroups", | |
1089 "request": { | |
1090 "$ref": "AdvertiserGroup" | |
1091 }, | |
1092 "response": { | |
1093 "$ref": "AdvertiserGroup" | |
1094 }, | |
1095 "scopes": [ | |
1096 "https://www.googleapis.com/auth/dfatrafficking" | |
1097 ] | |
1098 }, | |
1099 "list": { | |
1100 "description": "Retrieves a list of advertiser groups, possi
bly filtered.", | |
1101 "httpMethod": "GET", | |
1102 "id": "dfareporting.advertiserGroups.list", | |
1103 "parameterOrder": [ | |
1104 "profileId" | |
1105 ], | |
1106 "parameters": { | |
1107 "ids": { | |
1108 "description": "Select only advertiser groups with t
hese IDs.", | |
1109 "format": "int64", | |
1110 "location": "query", | |
1111 "repeated": true, | |
1112 "type": "string" | |
1113 }, | |
1114 "maxResults": { | |
1115 "description": "Maximum number of results to return.
", | |
1116 "format": "int32", | |
1117 "location": "query", | |
1118 "type": "integer" | |
1119 }, | |
1120 "pageToken": { | |
1121 "description": "Value of the nextPageToken from the
previous result page.", | |
1122 "location": "query", | |
1123 "type": "string" | |
1124 }, | |
1125 "profileId": { | |
1126 "description": "User profile ID associated with this
request.", | |
1127 "format": "int64", | |
1128 "location": "path", | |
1129 "required": true, | |
1130 "type": "string" | |
1131 }, | |
1132 "searchString": { | |
1133 "description": "Allows searching for objects by name
or ID. Wildcards (*) are allowed. For example, \"advertiser*2015\" will return
objects with names like \"advertiser group June 2015\", \"advertiser group April
2015\", or simply \"advertiser group 2015\". Most of the searches also add wild
cards implicitly at the start and the end of the search string. For example, a s
earch string of \"advertisergroup\" will match objects with name \"my advertiser
group\", \"advertisergroup 2015\", or simply \"advertisergroup\".", | |
1134 "location": "query", | |
1135 "type": "string" | |
1136 }, | |
1137 "sortField": { | |
1138 "description": "Field by which to sort the list.", | |
1139 "enum": [ | |
1140 "ID", | |
1141 "NAME" | |
1142 ], | |
1143 "enumDescriptions": [ | |
1144 "", | |
1145 "" | |
1146 ], | |
1147 "location": "query", | |
1148 "type": "string" | |
1149 }, | |
1150 "sortOrder": { | |
1151 "description": "Order of sorted results, default is
ASCENDING.", | |
1152 "enum": [ | |
1153 "ASCENDING", | |
1154 "DESCENDING" | |
1155 ], | |
1156 "enumDescriptions": [ | |
1157 "", | |
1158 "" | |
1159 ], | |
1160 "location": "query", | |
1161 "type": "string" | |
1162 } | |
1163 }, | |
1164 "path": "userprofiles/{profileId}/advertiserGroups", | |
1165 "response": { | |
1166 "$ref": "AdvertiserGroupsListResponse" | |
1167 }, | |
1168 "scopes": [ | |
1169 "https://www.googleapis.com/auth/dfatrafficking" | |
1170 ] | |
1171 }, | |
1172 "patch": { | |
1173 "description": "Updates an existing advertiser group. This m
ethod supports patch semantics.", | |
1174 "httpMethod": "PATCH", | |
1175 "id": "dfareporting.advertiserGroups.patch", | |
1176 "parameterOrder": [ | |
1177 "profileId", | |
1178 "id" | |
1179 ], | |
1180 "parameters": { | |
1181 "id": { | |
1182 "description": "Advertiser group ID.", | |
1183 "format": "int64", | |
1184 "location": "query", | |
1185 "required": true, | |
1186 "type": "string" | |
1187 }, | |
1188 "profileId": { | |
1189 "description": "User profile ID associated with this
request.", | |
1190 "format": "int64", | |
1191 "location": "path", | |
1192 "required": true, | |
1193 "type": "string" | |
1194 } | |
1195 }, | |
1196 "path": "userprofiles/{profileId}/advertiserGroups", | |
1197 "request": { | |
1198 "$ref": "AdvertiserGroup" | |
1199 }, | |
1200 "response": { | |
1201 "$ref": "AdvertiserGroup" | |
1202 }, | |
1203 "scopes": [ | |
1204 "https://www.googleapis.com/auth/dfatrafficking" | |
1205 ] | |
1206 }, | |
1207 "update": { | |
1208 "description": "Updates an existing advertiser group.", | |
1209 "httpMethod": "PUT", | |
1210 "id": "dfareporting.advertiserGroups.update", | |
1211 "parameterOrder": [ | |
1212 "profileId" | |
1213 ], | |
1214 "parameters": { | |
1215 "profileId": { | |
1216 "description": "User profile ID associated with this
request.", | |
1217 "format": "int64", | |
1218 "location": "path", | |
1219 "required": true, | |
1220 "type": "string" | |
1221 } | |
1222 }, | |
1223 "path": "userprofiles/{profileId}/advertiserGroups", | |
1224 "request": { | |
1225 "$ref": "AdvertiserGroup" | |
1226 }, | |
1227 "response": { | |
1228 "$ref": "AdvertiserGroup" | |
1229 }, | |
1230 "scopes": [ | |
1231 "https://www.googleapis.com/auth/dfatrafficking" | |
1232 ] | |
1233 } | |
1234 } | |
1235 }, | |
1236 "advertisers": { | |
1237 "methods": { | |
1238 "get": { | |
1239 "description": "Gets one advertiser by ID.", | |
1240 "httpMethod": "GET", | |
1241 "id": "dfareporting.advertisers.get", | |
1242 "parameterOrder": [ | |
1243 "profileId", | |
1244 "id" | |
1245 ], | |
1246 "parameters": { | |
1247 "id": { | |
1248 "description": "Advertiser ID.", | |
1249 "format": "int64", | |
1250 "location": "path", | |
1251 "required": true, | |
1252 "type": "string" | |
1253 }, | |
1254 "profileId": { | |
1255 "description": "User profile ID associated with this
request.", | |
1256 "format": "int64", | |
1257 "location": "path", | |
1258 "required": true, | |
1259 "type": "string" | |
1260 } | |
1261 }, | |
1262 "path": "userprofiles/{profileId}/advertisers/{id}", | |
1263 "response": { | |
1264 "$ref": "Advertiser" | |
1265 }, | |
1266 "scopes": [ | |
1267 "https://www.googleapis.com/auth/dfatrafficking" | |
1268 ] | |
1269 }, | |
1270 "insert": { | |
1271 "description": "Inserts a new advertiser.", | |
1272 "httpMethod": "POST", | |
1273 "id": "dfareporting.advertisers.insert", | |
1274 "parameterOrder": [ | |
1275 "profileId" | |
1276 ], | |
1277 "parameters": { | |
1278 "profileId": { | |
1279 "description": "User profile ID associated with this
request.", | |
1280 "format": "int64", | |
1281 "location": "path", | |
1282 "required": true, | |
1283 "type": "string" | |
1284 } | |
1285 }, | |
1286 "path": "userprofiles/{profileId}/advertisers", | |
1287 "request": { | |
1288 "$ref": "Advertiser" | |
1289 }, | |
1290 "response": { | |
1291 "$ref": "Advertiser" | |
1292 }, | |
1293 "scopes": [ | |
1294 "https://www.googleapis.com/auth/dfatrafficking" | |
1295 ] | |
1296 }, | |
1297 "list": { | |
1298 "description": "Retrieves a list of advertisers, possibly fi
ltered.", | |
1299 "httpMethod": "GET", | |
1300 "id": "dfareporting.advertisers.list", | |
1301 "parameterOrder": [ | |
1302 "profileId" | |
1303 ], | |
1304 "parameters": { | |
1305 "advertiserGroupIds": { | |
1306 "description": "Select only advertisers with these a
dvertiser group IDs.", | |
1307 "format": "int64", | |
1308 "location": "query", | |
1309 "repeated": true, | |
1310 "type": "string" | |
1311 }, | |
1312 "floodlightConfigurationIds": { | |
1313 "description": "Select only advertisers with these f
loodlight configuration IDs.", | |
1314 "format": "int64", | |
1315 "location": "query", | |
1316 "repeated": true, | |
1317 "type": "string" | |
1318 }, | |
1319 "ids": { | |
1320 "description": "Select only advertisers with these I
Ds.", | |
1321 "format": "int64", | |
1322 "location": "query", | |
1323 "repeated": true, | |
1324 "type": "string" | |
1325 }, | |
1326 "includeAdvertisersWithoutGroupsOnly": { | |
1327 "description": "Select only advertisers which do not
belong to any advertiser group.", | |
1328 "location": "query", | |
1329 "type": "boolean" | |
1330 }, | |
1331 "maxResults": { | |
1332 "description": "Maximum number of results to return.
", | |
1333 "format": "int32", | |
1334 "location": "query", | |
1335 "type": "integer" | |
1336 }, | |
1337 "onlyParent": { | |
1338 "description": "Select only advertisers which use an
other advertiser's floodlight configuration.", | |
1339 "location": "query", | |
1340 "type": "boolean" | |
1341 }, | |
1342 "pageToken": { | |
1343 "description": "Value of the nextPageToken from the
previous result page.", | |
1344 "location": "query", | |
1345 "type": "string" | |
1346 }, | |
1347 "profileId": { | |
1348 "description": "User profile ID associated with this
request.", | |
1349 "format": "int64", | |
1350 "location": "path", | |
1351 "required": true, | |
1352 "type": "string" | |
1353 }, | |
1354 "searchString": { | |
1355 "description": "Allows searching for objects by name
or ID. Wildcards (*) are allowed. For example, \"advertiser*2015\" will return
objects with names like \"advertiser June 2015\", \"advertiser April 2015\", or
simply \"advertiser 2015\". Most of the searches also add wildcards implicitly a
t the start and the end of the search string. For example, a search string of \"
advertiser\" will match objects with name \"my advertiser\", \"advertiser 2015\"
, or simply \"advertiser\".", | |
1356 "location": "query", | |
1357 "type": "string" | |
1358 }, | |
1359 "sortField": { | |
1360 "description": "Field by which to sort the list.", | |
1361 "enum": [ | |
1362 "ID", | |
1363 "NAME" | |
1364 ], | |
1365 "enumDescriptions": [ | |
1366 "", | |
1367 "" | |
1368 ], | |
1369 "location": "query", | |
1370 "type": "string" | |
1371 }, | |
1372 "sortOrder": { | |
1373 "description": "Order of sorted results, default is
ASCENDING.", | |
1374 "enum": [ | |
1375 "ASCENDING", | |
1376 "DESCENDING" | |
1377 ], | |
1378 "enumDescriptions": [ | |
1379 "", | |
1380 "" | |
1381 ], | |
1382 "location": "query", | |
1383 "type": "string" | |
1384 }, | |
1385 "status": { | |
1386 "description": "Select only advertisers with the spe
cified status.", | |
1387 "enum": [ | |
1388 "APPROVED", | |
1389 "ON_HOLD" | |
1390 ], | |
1391 "enumDescriptions": [ | |
1392 "", | |
1393 "" | |
1394 ], | |
1395 "location": "query", | |
1396 "type": "string" | |
1397 }, | |
1398 "subaccountId": { | |
1399 "description": "Select only advertisers with these s
ubaccount IDs.", | |
1400 "format": "int64", | |
1401 "location": "query", | |
1402 "type": "string" | |
1403 } | |
1404 }, | |
1405 "path": "userprofiles/{profileId}/advertisers", | |
1406 "response": { | |
1407 "$ref": "AdvertisersListResponse" | |
1408 }, | |
1409 "scopes": [ | |
1410 "https://www.googleapis.com/auth/dfatrafficking" | |
1411 ] | |
1412 }, | |
1413 "patch": { | |
1414 "description": "Updates an existing advertiser. This method
supports patch semantics.", | |
1415 "httpMethod": "PATCH", | |
1416 "id": "dfareporting.advertisers.patch", | |
1417 "parameterOrder": [ | |
1418 "profileId", | |
1419 "id" | |
1420 ], | |
1421 "parameters": { | |
1422 "id": { | |
1423 "description": "Advertiser ID.", | |
1424 "format": "int64", | |
1425 "location": "query", | |
1426 "required": true, | |
1427 "type": "string" | |
1428 }, | |
1429 "profileId": { | |
1430 "description": "User profile ID associated with this
request.", | |
1431 "format": "int64", | |
1432 "location": "path", | |
1433 "required": true, | |
1434 "type": "string" | |
1435 } | |
1436 }, | |
1437 "path": "userprofiles/{profileId}/advertisers", | |
1438 "request": { | |
1439 "$ref": "Advertiser" | |
1440 }, | |
1441 "response": { | |
1442 "$ref": "Advertiser" | |
1443 }, | |
1444 "scopes": [ | |
1445 "https://www.googleapis.com/auth/dfatrafficking" | |
1446 ] | |
1447 }, | |
1448 "update": { | |
1449 "description": "Updates an existing advertiser.", | |
1450 "httpMethod": "PUT", | |
1451 "id": "dfareporting.advertisers.update", | |
1452 "parameterOrder": [ | |
1453 "profileId" | |
1454 ], | |
1455 "parameters": { | |
1456 "profileId": { | |
1457 "description": "User profile ID associated with this
request.", | |
1458 "format": "int64", | |
1459 "location": "path", | |
1460 "required": true, | |
1461 "type": "string" | |
1462 } | |
1463 }, | |
1464 "path": "userprofiles/{profileId}/advertisers", | |
1465 "request": { | |
1466 "$ref": "Advertiser" | |
1467 }, | |
1468 "response": { | |
1469 "$ref": "Advertiser" | |
1470 }, | |
1471 "scopes": [ | |
1472 "https://www.googleapis.com/auth/dfatrafficking" | |
1473 ] | |
1474 } | |
1475 } | |
1476 }, | |
1477 "browsers": { | |
1478 "methods": { | |
1479 "list": { | |
1480 "description": "Retrieves a list of browsers.", | |
1481 "httpMethod": "GET", | |
1482 "id": "dfareporting.browsers.list", | |
1483 "parameterOrder": [ | |
1484 "profileId" | |
1485 ], | |
1486 "parameters": { | |
1487 "profileId": { | |
1488 "description": "User profile ID associated with this
request.", | |
1489 "format": "int64", | |
1490 "location": "path", | |
1491 "required": true, | |
1492 "type": "string" | |
1493 } | |
1494 }, | |
1495 "path": "userprofiles/{profileId}/browsers", | |
1496 "response": { | |
1497 "$ref": "BrowsersListResponse" | |
1498 }, | |
1499 "scopes": [ | |
1500 "https://www.googleapis.com/auth/dfatrafficking" | |
1501 ] | |
1502 } | |
1503 } | |
1504 }, | |
1505 "campaignCreativeAssociations": { | |
1506 "methods": { | |
1507 "insert": { | |
1508 "description": "Associates a creative with the specified cam
paign. This method creates a default ad with dimensions matching the creative in
the campaign if such a default ad does not exist already.", | |
1509 "httpMethod": "POST", | |
1510 "id": "dfareporting.campaignCreativeAssociations.insert", | |
1511 "parameterOrder": [ | |
1512 "profileId", | |
1513 "campaignId" | |
1514 ], | |
1515 "parameters": { | |
1516 "campaignId": { | |
1517 "description": "Campaign ID in this association.", | |
1518 "format": "int64", | |
1519 "location": "path", | |
1520 "required": true, | |
1521 "type": "string" | |
1522 }, | |
1523 "profileId": { | |
1524 "description": "User profile ID associated with this
request.", | |
1525 "format": "int64", | |
1526 "location": "path", | |
1527 "required": true, | |
1528 "type": "string" | |
1529 } | |
1530 }, | |
1531 "path": "userprofiles/{profileId}/campaigns/{campaignId}/cam
paignCreativeAssociations", | |
1532 "request": { | |
1533 "$ref": "CampaignCreativeAssociation" | |
1534 }, | |
1535 "response": { | |
1536 "$ref": "CampaignCreativeAssociation" | |
1537 }, | |
1538 "scopes": [ | |
1539 "https://www.googleapis.com/auth/dfatrafficking" | |
1540 ] | |
1541 }, | |
1542 "list": { | |
1543 "description": "Retrieves the list of creative IDs associate
d with the specified campaign.", | |
1544 "httpMethod": "GET", | |
1545 "id": "dfareporting.campaignCreativeAssociations.list", | |
1546 "parameterOrder": [ | |
1547 "profileId", | |
1548 "campaignId" | |
1549 ], | |
1550 "parameters": { | |
1551 "campaignId": { | |
1552 "description": "Campaign ID in this association.", | |
1553 "format": "int64", | |
1554 "location": "path", | |
1555 "required": true, | |
1556 "type": "string" | |
1557 }, | |
1558 "maxResults": { | |
1559 "description": "Maximum number of results to return.
", | |
1560 "format": "int32", | |
1561 "location": "query", | |
1562 "type": "integer" | |
1563 }, | |
1564 "pageToken": { | |
1565 "description": "Value of the nextPageToken from the
previous result page.", | |
1566 "location": "query", | |
1567 "type": "string" | |
1568 }, | |
1569 "profileId": { | |
1570 "description": "User profile ID associated with this
request.", | |
1571 "format": "int64", | |
1572 "location": "path", | |
1573 "required": true, | |
1574 "type": "string" | |
1575 }, | |
1576 "sortOrder": { | |
1577 "description": "Order of sorted results, default is
ASCENDING.", | |
1578 "enum": [ | |
1579 "ASCENDING", | |
1580 "DESCENDING" | |
1581 ], | |
1582 "enumDescriptions": [ | |
1583 "", | |
1584 "" | |
1585 ], | |
1586 "location": "query", | |
1587 "type": "string" | |
1588 } | |
1589 }, | |
1590 "path": "userprofiles/{profileId}/campaigns/{campaignId}/cam
paignCreativeAssociations", | |
1591 "response": { | |
1592 "$ref": "CampaignCreativeAssociationsListResponse" | |
1593 }, | |
1594 "scopes": [ | |
1595 "https://www.googleapis.com/auth/dfatrafficking" | |
1596 ] | |
1597 } | |
1598 } | |
1599 }, | |
1600 "campaigns": { | |
1601 "methods": { | |
1602 "get": { | |
1603 "description": "Gets one campaign by ID.", | |
1604 "httpMethod": "GET", | |
1605 "id": "dfareporting.campaigns.get", | |
1606 "parameterOrder": [ | |
1607 "profileId", | |
1608 "id" | |
1609 ], | |
1610 "parameters": { | |
1611 "id": { | |
1612 "description": "Campaign ID.", | |
1613 "format": "int64", | |
1614 "location": "path", | |
1615 "required": true, | |
1616 "type": "string" | |
1617 }, | |
1618 "profileId": { | |
1619 "description": "User profile ID associated with this
request.", | |
1620 "format": "int64", | |
1621 "location": "path", | |
1622 "required": true, | |
1623 "type": "string" | |
1624 } | |
1625 }, | |
1626 "path": "userprofiles/{profileId}/campaigns/{id}", | |
1627 "response": { | |
1628 "$ref": "Campaign" | |
1629 }, | |
1630 "scopes": [ | |
1631 "https://www.googleapis.com/auth/dfatrafficking" | |
1632 ] | |
1633 }, | |
1634 "insert": { | |
1635 "description": "Inserts a new campaign.", | |
1636 "httpMethod": "POST", | |
1637 "id": "dfareporting.campaigns.insert", | |
1638 "parameterOrder": [ | |
1639 "profileId", | |
1640 "defaultLandingPageName", | |
1641 "defaultLandingPageUrl" | |
1642 ], | |
1643 "parameters": { | |
1644 "defaultLandingPageName": { | |
1645 "description": "Default landing page name for this n
ew campaign. Must be less than 256 characters long.", | |
1646 "location": "query", | |
1647 "required": true, | |
1648 "type": "string" | |
1649 }, | |
1650 "defaultLandingPageUrl": { | |
1651 "description": "Default landing page URL for this ne
w campaign.", | |
1652 "location": "query", | |
1653 "required": true, | |
1654 "type": "string" | |
1655 }, | |
1656 "profileId": { | |
1657 "description": "User profile ID associated with this
request.", | |
1658 "format": "int64", | |
1659 "location": "path", | |
1660 "required": true, | |
1661 "type": "string" | |
1662 } | |
1663 }, | |
1664 "path": "userprofiles/{profileId}/campaigns", | |
1665 "request": { | |
1666 "$ref": "Campaign" | |
1667 }, | |
1668 "response": { | |
1669 "$ref": "Campaign" | |
1670 }, | |
1671 "scopes": [ | |
1672 "https://www.googleapis.com/auth/dfatrafficking" | |
1673 ] | |
1674 }, | |
1675 "list": { | |
1676 "description": "Retrieves a list of campaigns, possibly filt
ered.", | |
1677 "httpMethod": "GET", | |
1678 "id": "dfareporting.campaigns.list", | |
1679 "parameterOrder": [ | |
1680 "profileId" | |
1681 ], | |
1682 "parameters": { | |
1683 "advertiserGroupIds": { | |
1684 "description": "Select only campaigns whose advertis
ers belong to these advertiser groups.", | |
1685 "format": "int64", | |
1686 "location": "query", | |
1687 "repeated": true, | |
1688 "type": "string" | |
1689 }, | |
1690 "advertiserIds": { | |
1691 "description": "Select only campaigns that belong to
these advertisers.", | |
1692 "format": "int64", | |
1693 "location": "query", | |
1694 "repeated": true, | |
1695 "type": "string" | |
1696 }, | |
1697 "archived": { | |
1698 "description": "Select only archived campaigns. Don'
t set this field to select both archived and non-archived campaigns.", | |
1699 "location": "query", | |
1700 "type": "boolean" | |
1701 }, | |
1702 "atLeastOneOptimizationActivity": { | |
1703 "description": "Select only campaigns that have at l
east one optimization activity.", | |
1704 "location": "query", | |
1705 "type": "boolean" | |
1706 }, | |
1707 "excludedIds": { | |
1708 "description": "Exclude campaigns with these IDs.", | |
1709 "format": "int64", | |
1710 "location": "query", | |
1711 "repeated": true, | |
1712 "type": "string" | |
1713 }, | |
1714 "ids": { | |
1715 "description": "Select only campaigns with these IDs
.", | |
1716 "format": "int64", | |
1717 "location": "query", | |
1718 "repeated": true, | |
1719 "type": "string" | |
1720 }, | |
1721 "maxResults": { | |
1722 "description": "Maximum number of results to return.
", | |
1723 "format": "int32", | |
1724 "location": "query", | |
1725 "type": "integer" | |
1726 }, | |
1727 "overriddenEventTagId": { | |
1728 "description": "Select only campaigns that have over
ridden this event tag ID.", | |
1729 "format": "int64", | |
1730 "location": "query", | |
1731 "type": "string" | |
1732 }, | |
1733 "pageToken": { | |
1734 "description": "Value of the nextPageToken from the
previous result page.", | |
1735 "location": "query", | |
1736 "type": "string" | |
1737 }, | |
1738 "profileId": { | |
1739 "description": "User profile ID associated with this
request.", | |
1740 "format": "int64", | |
1741 "location": "path", | |
1742 "required": true, | |
1743 "type": "string" | |
1744 }, | |
1745 "searchString": { | |
1746 "description": "Allows searching for campaigns by na
me or ID. Wildcards (*) are allowed. For example, \"campaign*2015\" will return
campaigns with names like \"campaign June 2015\", \"campaign April 2015\", or si
mply \"campaign 2015\". Most of the searches also add wildcards implicitly at th
e start and the end of the search string. For example, a search string of \"camp
aign\" will match campaigns with name \"my campaign\", \"campaign 2015\", or sim
ply \"campaign\".", | |
1747 "location": "query", | |
1748 "type": "string" | |
1749 }, | |
1750 "sortField": { | |
1751 "description": "Field by which to sort the list.", | |
1752 "enum": [ | |
1753 "ID", | |
1754 "NAME" | |
1755 ], | |
1756 "enumDescriptions": [ | |
1757 "", | |
1758 "" | |
1759 ], | |
1760 "location": "query", | |
1761 "type": "string" | |
1762 }, | |
1763 "sortOrder": { | |
1764 "description": "Order of sorted results, default is
ASCENDING.", | |
1765 "enum": [ | |
1766 "ASCENDING", | |
1767 "DESCENDING" | |
1768 ], | |
1769 "enumDescriptions": [ | |
1770 "", | |
1771 "" | |
1772 ], | |
1773 "location": "query", | |
1774 "type": "string" | |
1775 }, | |
1776 "subaccountId": { | |
1777 "description": "Select only campaigns that belong to
this subaccount.", | |
1778 "format": "int64", | |
1779 "location": "query", | |
1780 "type": "string" | |
1781 } | |
1782 }, | |
1783 "path": "userprofiles/{profileId}/campaigns", | |
1784 "response": { | |
1785 "$ref": "CampaignsListResponse" | |
1786 }, | |
1787 "scopes": [ | |
1788 "https://www.googleapis.com/auth/dfatrafficking" | |
1789 ] | |
1790 }, | |
1791 "patch": { | |
1792 "description": "Updates an existing campaign. This method su
pports patch semantics.", | |
1793 "httpMethod": "PATCH", | |
1794 "id": "dfareporting.campaigns.patch", | |
1795 "parameterOrder": [ | |
1796 "profileId", | |
1797 "id" | |
1798 ], | |
1799 "parameters": { | |
1800 "id": { | |
1801 "description": "Campaign ID.", | |
1802 "format": "int64", | |
1803 "location": "query", | |
1804 "required": true, | |
1805 "type": "string" | |
1806 }, | |
1807 "profileId": { | |
1808 "description": "User profile ID associated with this
request.", | |
1809 "format": "int64", | |
1810 "location": "path", | |
1811 "required": true, | |
1812 "type": "string" | |
1813 } | |
1814 }, | |
1815 "path": "userprofiles/{profileId}/campaigns", | |
1816 "request": { | |
1817 "$ref": "Campaign" | |
1818 }, | |
1819 "response": { | |
1820 "$ref": "Campaign" | |
1821 }, | |
1822 "scopes": [ | |
1823 "https://www.googleapis.com/auth/dfatrafficking" | |
1824 ] | |
1825 }, | |
1826 "update": { | |
1827 "description": "Updates an existing campaign.", | |
1828 "httpMethod": "PUT", | |
1829 "id": "dfareporting.campaigns.update", | |
1830 "parameterOrder": [ | |
1831 "profileId" | |
1832 ], | |
1833 "parameters": { | |
1834 "profileId": { | |
1835 "description": "User profile ID associated with this
request.", | |
1836 "format": "int64", | |
1837 "location": "path", | |
1838 "required": true, | |
1839 "type": "string" | |
1840 } | |
1841 }, | |
1842 "path": "userprofiles/{profileId}/campaigns", | |
1843 "request": { | |
1844 "$ref": "Campaign" | |
1845 }, | |
1846 "response": { | |
1847 "$ref": "Campaign" | |
1848 }, | |
1849 "scopes": [ | |
1850 "https://www.googleapis.com/auth/dfatrafficking" | |
1851 ] | |
1852 } | |
1853 } | |
1854 }, | |
1855 "changeLogs": { | |
1856 "methods": { | |
1857 "get": { | |
1858 "description": "Gets one change log by ID.", | |
1859 "httpMethod": "GET", | |
1860 "id": "dfareporting.changeLogs.get", | |
1861 "parameterOrder": [ | |
1862 "profileId", | |
1863 "id" | |
1864 ], | |
1865 "parameters": { | |
1866 "id": { | |
1867 "description": "Change log ID.", | |
1868 "format": "int64", | |
1869 "location": "path", | |
1870 "required": true, | |
1871 "type": "string" | |
1872 }, | |
1873 "profileId": { | |
1874 "description": "User profile ID associated with this
request.", | |
1875 "format": "int64", | |
1876 "location": "path", | |
1877 "required": true, | |
1878 "type": "string" | |
1879 } | |
1880 }, | |
1881 "path": "userprofiles/{profileId}/changeLogs/{id}", | |
1882 "response": { | |
1883 "$ref": "ChangeLog" | |
1884 }, | |
1885 "scopes": [ | |
1886 "https://www.googleapis.com/auth/dfatrafficking" | |
1887 ] | |
1888 }, | |
1889 "list": { | |
1890 "description": "Retrieves a list of change logs.", | |
1891 "httpMethod": "GET", | |
1892 "id": "dfareporting.changeLogs.list", | |
1893 "parameterOrder": [ | |
1894 "profileId" | |
1895 ], | |
1896 "parameters": { | |
1897 "action": { | |
1898 "description": "Select only change logs with the spe
cified action.", | |
1899 "enum": [ | |
1900 "ACTION_ADD", | |
1901 "ACTION_ASSIGN", | |
1902 "ACTION_ASSOCIATE", | |
1903 "ACTION_CREATE", | |
1904 "ACTION_DELETE", | |
1905 "ACTION_DISABLE", | |
1906 "ACTION_EMAIL_TAGS", | |
1907 "ACTION_ENABLE", | |
1908 "ACTION_LINK", | |
1909 "ACTION_MARK_AS_DEFAULT", | |
1910 "ACTION_PUSH", | |
1911 "ACTION_REMOVE", | |
1912 "ACTION_SEND", | |
1913 "ACTION_SHARE", | |
1914 "ACTION_UNASSIGN", | |
1915 "ACTION_UNLINK", | |
1916 "ACTION_UPDATE" | |
1917 ], | |
1918 "enumDescriptions": [ | |
1919 "", | |
1920 "", | |
1921 "", | |
1922 "", | |
1923 "", | |
1924 "", | |
1925 "", | |
1926 "", | |
1927 "", | |
1928 "", | |
1929 "", | |
1930 "", | |
1931 "", | |
1932 "", | |
1933 "", | |
1934 "", | |
1935 "" | |
1936 ], | |
1937 "location": "query", | |
1938 "type": "string" | |
1939 }, | |
1940 "ids": { | |
1941 "description": "Select only change logs with these I
Ds.", | |
1942 "format": "int64", | |
1943 "location": "query", | |
1944 "repeated": true, | |
1945 "type": "string" | |
1946 }, | |
1947 "maxChangeTime": { | |
1948 "description": "Select only change logs whose change
time is before the specified maxChangeTime.The time should be formatted as an R
FC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the Am
erica/New York time zone, the format is \"2015-07-18T22:54:00-04:00\". In other
words, the year, month, day, the letter T, the hour (24-hour clock system), minu
te, second, and then the time zone offset.", | |
1949 "location": "query", | |
1950 "type": "string" | |
1951 }, | |
1952 "maxResults": { | |
1953 "description": "Maximum number of results to return.
", | |
1954 "format": "int32", | |
1955 "location": "query", | |
1956 "type": "integer" | |
1957 }, | |
1958 "minChangeTime": { | |
1959 "description": "Select only change logs whose change
time is before the specified minChangeTime.The time should be formatted as an R
FC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the Am
erica/New York time zone, the format is \"2015-07-18T22:54:00-04:00\". In other
words, the year, month, day, the letter T, the hour (24-hour clock system), minu
te, second, and then the time zone offset.", | |
1960 "location": "query", | |
1961 "type": "string" | |
1962 }, | |
1963 "objectIds": { | |
1964 "description": "Select only change logs with these o
bject IDs.", | |
1965 "format": "int64", | |
1966 "location": "query", | |
1967 "repeated": true, | |
1968 "type": "string" | |
1969 }, | |
1970 "objectType": { | |
1971 "description": "Select only change logs with the spe
cified object type.", | |
1972 "enum": [ | |
1973 "OBJECT_ACCOUNT", | |
1974 "OBJECT_ACCOUNT_BILLING_FEATURE", | |
1975 "OBJECT_AD", | |
1976 "OBJECT_ADVERTISER", | |
1977 "OBJECT_ADVERTISER_GROUP", | |
1978 "OBJECT_BILLING_ACCOUNT_GROUP", | |
1979 "OBJECT_BILLING_FEATURE", | |
1980 "OBJECT_BILLING_MINIMUM_FEE", | |
1981 "OBJECT_BILLING_PROFILE", | |
1982 "OBJECT_CAMPAIGN", | |
1983 "OBJECT_CONTENT_CATEGORY", | |
1984 "OBJECT_CREATIVE", | |
1985 "OBJECT_CREATIVE_ASSET", | |
1986 "OBJECT_CREATIVE_BUNDLE", | |
1987 "OBJECT_CREATIVE_FIELD", | |
1988 "OBJECT_CREATIVE_GROUP", | |
1989 "OBJECT_DFA_SITE", | |
1990 "OBJECT_EVENT_TAG", | |
1991 "OBJECT_FLOODLIGHT_ACTIVITY_GROUP", | |
1992 "OBJECT_FLOODLIGHT_ACTVITY", | |
1993 "OBJECT_FLOODLIGHT_CONFIGURATION", | |
1994 "OBJECT_INSTREAM_CREATIVE", | |
1995 "OBJECT_LANDING_PAGE", | |
1996 "OBJECT_MEDIA_ORDER", | |
1997 "OBJECT_PLACEMENT", | |
1998 "OBJECT_PLACEMENT_STRATEGY", | |
1999 "OBJECT_PLAYSTORE_LINK", | |
2000 "OBJECT_PROVIDED_LIST_CLIENT", | |
2001 "OBJECT_RATE_CARD", | |
2002 "OBJECT_REMARKETING_LIST", | |
2003 "OBJECT_RICHMEDIA_CREATIVE", | |
2004 "OBJECT_SD_SITE", | |
2005 "OBJECT_SIZE", | |
2006 "OBJECT_SUBACCOUNT", | |
2007 "OBJECT_TARGETING_TEMPLATE", | |
2008 "OBJECT_USER_PROFILE", | |
2009 "OBJECT_USER_PROFILE_FILTER", | |
2010 "OBJECT_USER_ROLE" | |
2011 ], | |
2012 "enumDescriptions": [ | |
2013 "", | |
2014 "", | |
2015 "", | |
2016 "", | |
2017 "", | |
2018 "", | |
2019 "", | |
2020 "", | |
2021 "", | |
2022 "", | |
2023 "", | |
2024 "", | |
2025 "", | |
2026 "", | |
2027 "", | |
2028 "", | |
2029 "", | |
2030 "", | |
2031 "", | |
2032 "", | |
2033 "", | |
2034 "", | |
2035 "", | |
2036 "", | |
2037 "", | |
2038 "", | |
2039 "", | |
2040 "", | |
2041 "", | |
2042 "", | |
2043 "", | |
2044 "", | |
2045 "", | |
2046 "", | |
2047 "", | |
2048 "", | |
2049 "", | |
2050 "" | |
2051 ], | |
2052 "location": "query", | |
2053 "type": "string" | |
2054 }, | |
2055 "pageToken": { | |
2056 "description": "Value of the nextPageToken from the
previous result page.", | |
2057 "location": "query", | |
2058 "type": "string" | |
2059 }, | |
2060 "profileId": { | |
2061 "description": "User profile ID associated with this
request.", | |
2062 "format": "int64", | |
2063 "location": "path", | |
2064 "required": true, | |
2065 "type": "string" | |
2066 }, | |
2067 "searchString": { | |
2068 "description": "Select only change logs whose object
ID, user name, old or new values match the search string.", | |
2069 "location": "query", | |
2070 "type": "string" | |
2071 }, | |
2072 "userProfileIds": { | |
2073 "description": "Select only change logs with these u
ser profile IDs.", | |
2074 "format": "int64", | |
2075 "location": "query", | |
2076 "repeated": true, | |
2077 "type": "string" | |
2078 } | |
2079 }, | |
2080 "path": "userprofiles/{profileId}/changeLogs", | |
2081 "response": { | |
2082 "$ref": "ChangeLogsListResponse" | |
2083 }, | |
2084 "scopes": [ | |
2085 "https://www.googleapis.com/auth/dfatrafficking" | |
2086 ] | |
2087 } | |
2088 } | |
2089 }, | |
2090 "cities": { | |
2091 "methods": { | |
2092 "list": { | |
2093 "description": "Retrieves a list of cities, possibly filtere
d.", | |
2094 "httpMethod": "GET", | |
2095 "id": "dfareporting.cities.list", | |
2096 "parameterOrder": [ | |
2097 "profileId" | |
2098 ], | |
2099 "parameters": { | |
2100 "countryDartIds": { | |
2101 "description": "Select only cities from these countr
ies.", | |
2102 "format": "int64", | |
2103 "location": "query", | |
2104 "repeated": true, | |
2105 "type": "string" | |
2106 }, | |
2107 "dartIds": { | |
2108 "description": "Select only cities with these DART I
Ds.", | |
2109 "format": "int64", | |
2110 "location": "query", | |
2111 "repeated": true, | |
2112 "type": "string" | |
2113 }, | |
2114 "namePrefix": { | |
2115 "description": "Select only cities with names starti
ng with this prefix.", | |
2116 "location": "query", | |
2117 "type": "string" | |
2118 }, | |
2119 "profileId": { | |
2120 "description": "User profile ID associated with this
request.", | |
2121 "format": "int64", | |
2122 "location": "path", | |
2123 "required": true, | |
2124 "type": "string" | |
2125 }, | |
2126 "regionDartIds": { | |
2127 "description": "Select only cities from these region
s.", | |
2128 "format": "int64", | |
2129 "location": "query", | |
2130 "repeated": true, | |
2131 "type": "string" | |
2132 } | |
2133 }, | |
2134 "path": "userprofiles/{profileId}/cities", | |
2135 "response": { | |
2136 "$ref": "CitiesListResponse" | |
2137 }, | |
2138 "scopes": [ | |
2139 "https://www.googleapis.com/auth/dfatrafficking" | |
2140 ] | |
2141 } | |
2142 } | |
2143 }, | |
2144 "connectionTypes": { | |
2145 "methods": { | |
2146 "get": { | |
2147 "description": "Gets one connection type by ID.", | |
2148 "httpMethod": "GET", | |
2149 "id": "dfareporting.connectionTypes.get", | |
2150 "parameterOrder": [ | |
2151 "profileId", | |
2152 "id" | |
2153 ], | |
2154 "parameters": { | |
2155 "id": { | |
2156 "description": "Connection type ID.", | |
2157 "format": "int64", | |
2158 "location": "path", | |
2159 "required": true, | |
2160 "type": "string" | |
2161 }, | |
2162 "profileId": { | |
2163 "description": "User profile ID associated with this
request.", | |
2164 "format": "int64", | |
2165 "location": "path", | |
2166 "required": true, | |
2167 "type": "string" | |
2168 } | |
2169 }, | |
2170 "path": "userprofiles/{profileId}/connectionTypes/{id}", | |
2171 "response": { | |
2172 "$ref": "ConnectionType" | |
2173 }, | |
2174 "scopes": [ | |
2175 "https://www.googleapis.com/auth/dfatrafficking" | |
2176 ] | |
2177 }, | |
2178 "list": { | |
2179 "description": "Retrieves a list of connection types.", | |
2180 "httpMethod": "GET", | |
2181 "id": "dfareporting.connectionTypes.list", | |
2182 "parameterOrder": [ | |
2183 "profileId" | |
2184 ], | |
2185 "parameters": { | |
2186 "profileId": { | |
2187 "description": "User profile ID associated with this
request.", | |
2188 "format": "int64", | |
2189 "location": "path", | |
2190 "required": true, | |
2191 "type": "string" | |
2192 } | |
2193 }, | |
2194 "path": "userprofiles/{profileId}/connectionTypes", | |
2195 "response": { | |
2196 "$ref": "ConnectionTypesListResponse" | |
2197 }, | |
2198 "scopes": [ | |
2199 "https://www.googleapis.com/auth/dfatrafficking" | |
2200 ] | |
2201 } | |
2202 } | |
2203 }, | |
2204 "contentCategories": { | |
2205 "methods": { | |
2206 "delete": { | |
2207 "description": "Deletes an existing content category.", | |
2208 "httpMethod": "DELETE", | |
2209 "id": "dfareporting.contentCategories.delete", | |
2210 "parameterOrder": [ | |
2211 "profileId", | |
2212 "id" | |
2213 ], | |
2214 "parameters": { | |
2215 "id": { | |
2216 "description": "Content category ID.", | |
2217 "format": "int64", | |
2218 "location": "path", | |
2219 "required": true, | |
2220 "type": "string" | |
2221 }, | |
2222 "profileId": { | |
2223 "description": "User profile ID associated with this
request.", | |
2224 "format": "int64", | |
2225 "location": "path", | |
2226 "required": true, | |
2227 "type": "string" | |
2228 } | |
2229 }, | |
2230 "path": "userprofiles/{profileId}/contentCategories/{id}", | |
2231 "scopes": [ | |
2232 "https://www.googleapis.com/auth/dfatrafficking" | |
2233 ] | |
2234 }, | |
2235 "get": { | |
2236 "description": "Gets one content category by ID.", | |
2237 "httpMethod": "GET", | |
2238 "id": "dfareporting.contentCategories.get", | |
2239 "parameterOrder": [ | |
2240 "profileId", | |
2241 "id" | |
2242 ], | |
2243 "parameters": { | |
2244 "id": { | |
2245 "description": "Content category ID.", | |
2246 "format": "int64", | |
2247 "location": "path", | |
2248 "required": true, | |
2249 "type": "string" | |
2250 }, | |
2251 "profileId": { | |
2252 "description": "User profile ID associated with this
request.", | |
2253 "format": "int64", | |
2254 "location": "path", | |
2255 "required": true, | |
2256 "type": "string" | |
2257 } | |
2258 }, | |
2259 "path": "userprofiles/{profileId}/contentCategories/{id}", | |
2260 "response": { | |
2261 "$ref": "ContentCategory" | |
2262 }, | |
2263 "scopes": [ | |
2264 "https://www.googleapis.com/auth/dfatrafficking" | |
2265 ] | |
2266 }, | |
2267 "insert": { | |
2268 "description": "Inserts a new content category.", | |
2269 "httpMethod": "POST", | |
2270 "id": "dfareporting.contentCategories.insert", | |
2271 "parameterOrder": [ | |
2272 "profileId" | |
2273 ], | |
2274 "parameters": { | |
2275 "profileId": { | |
2276 "description": "User profile ID associated with this
request.", | |
2277 "format": "int64", | |
2278 "location": "path", | |
2279 "required": true, | |
2280 "type": "string" | |
2281 } | |
2282 }, | |
2283 "path": "userprofiles/{profileId}/contentCategories", | |
2284 "request": { | |
2285 "$ref": "ContentCategory" | |
2286 }, | |
2287 "response": { | |
2288 "$ref": "ContentCategory" | |
2289 }, | |
2290 "scopes": [ | |
2291 "https://www.googleapis.com/auth/dfatrafficking" | |
2292 ] | |
2293 }, | |
2294 "list": { | |
2295 "description": "Retrieves a list of content categories, poss
ibly filtered.", | |
2296 "httpMethod": "GET", | |
2297 "id": "dfareporting.contentCategories.list", | |
2298 "parameterOrder": [ | |
2299 "profileId" | |
2300 ], | |
2301 "parameters": { | |
2302 "ids": { | |
2303 "description": "Select only content categories with
these IDs.", | |
2304 "format": "int64", | |
2305 "location": "query", | |
2306 "repeated": true, | |
2307 "type": "string" | |
2308 }, | |
2309 "maxResults": { | |
2310 "description": "Maximum number of results to return.
", | |
2311 "format": "int32", | |
2312 "location": "query", | |
2313 "type": "integer" | |
2314 }, | |
2315 "pageToken": { | |
2316 "description": "Value of the nextPageToken from the
previous result page.", | |
2317 "location": "query", | |
2318 "type": "string" | |
2319 }, | |
2320 "profileId": { | |
2321 "description": "User profile ID associated with this
request.", | |
2322 "format": "int64", | |
2323 "location": "path", | |
2324 "required": true, | |
2325 "type": "string" | |
2326 }, | |
2327 "searchString": { | |
2328 "description": "Allows searching for objects by name
or ID. Wildcards (*) are allowed. For example, \"contentcategory*2015\" will re
turn objects with names like \"contentcategory June 2015\", \"contentcategory Ap
ril 2015\", or simply \"contentcategory 2015\". Most of the searches also add wi
ldcards implicitly at the start and the end of the search string. For example, a
search string of \"contentcategory\" will match objects with name \"my contentc
ategory\", \"contentcategory 2015\", or simply \"contentcategory\".", | |
2329 "location": "query", | |
2330 "type": "string" | |
2331 }, | |
2332 "sortField": { | |
2333 "description": "Field by which to sort the list.", | |
2334 "enum": [ | |
2335 "ID", | |
2336 "NAME" | |
2337 ], | |
2338 "enumDescriptions": [ | |
2339 "", | |
2340 "" | |
2341 ], | |
2342 "location": "query", | |
2343 "type": "string" | |
2344 }, | |
2345 "sortOrder": { | |
2346 "description": "Order of sorted results, default is
ASCENDING.", | |
2347 "enum": [ | |
2348 "ASCENDING", | |
2349 "DESCENDING" | |
2350 ], | |
2351 "enumDescriptions": [ | |
2352 "", | |
2353 "" | |
2354 ], | |
2355 "location": "query", | |
2356 "type": "string" | |
2357 } | |
2358 }, | |
2359 "path": "userprofiles/{profileId}/contentCategories", | |
2360 "response": { | |
2361 "$ref": "ContentCategoriesListResponse" | |
2362 }, | |
2363 "scopes": [ | |
2364 "https://www.googleapis.com/auth/dfatrafficking" | |
2365 ] | |
2366 }, | |
2367 "patch": { | |
2368 "description": "Updates an existing content category. This m
ethod supports patch semantics.", | |
2369 "httpMethod": "PATCH", | |
2370 "id": "dfareporting.contentCategories.patch", | |
2371 "parameterOrder": [ | |
2372 "profileId", | |
2373 "id" | |
2374 ], | |
2375 "parameters": { | |
2376 "id": { | |
2377 "description": "Content category ID.", | |
2378 "format": "int64", | |
2379 "location": "query", | |
2380 "required": true, | |
2381 "type": "string" | |
2382 }, | |
2383 "profileId": { | |
2384 "description": "User profile ID associated with this
request.", | |
2385 "format": "int64", | |
2386 "location": "path", | |
2387 "required": true, | |
2388 "type": "string" | |
2389 } | |
2390 }, | |
2391 "path": "userprofiles/{profileId}/contentCategories", | |
2392 "request": { | |
2393 "$ref": "ContentCategory" | |
2394 }, | |
2395 "response": { | |
2396 "$ref": "ContentCategory" | |
2397 }, | |
2398 "scopes": [ | |
2399 "https://www.googleapis.com/auth/dfatrafficking" | |
2400 ] | |
2401 }, | |
2402 "update": { | |
2403 "description": "Updates an existing content category.", | |
2404 "httpMethod": "PUT", | |
2405 "id": "dfareporting.contentCategories.update", | |
2406 "parameterOrder": [ | |
2407 "profileId" | |
2408 ], | |
2409 "parameters": { | |
2410 "profileId": { | |
2411 "description": "User profile ID associated with this
request.", | |
2412 "format": "int64", | |
2413 "location": "path", | |
2414 "required": true, | |
2415 "type": "string" | |
2416 } | |
2417 }, | |
2418 "path": "userprofiles/{profileId}/contentCategories", | |
2419 "request": { | |
2420 "$ref": "ContentCategory" | |
2421 }, | |
2422 "response": { | |
2423 "$ref": "ContentCategory" | |
2424 }, | |
2425 "scopes": [ | |
2426 "https://www.googleapis.com/auth/dfatrafficking" | |
2427 ] | |
2428 } | |
2429 } | |
2430 }, | |
2431 "countries": { | |
2432 "methods": { | |
2433 "get": { | |
2434 "description": "Gets one country by ID.", | |
2435 "httpMethod": "GET", | |
2436 "id": "dfareporting.countries.get", | |
2437 "parameterOrder": [ | |
2438 "profileId", | |
2439 "dartId" | |
2440 ], | |
2441 "parameters": { | |
2442 "dartId": { | |
2443 "description": "Country DART ID.", | |
2444 "format": "int64", | |
2445 "location": "path", | |
2446 "required": true, | |
2447 "type": "string" | |
2448 }, | |
2449 "profileId": { | |
2450 "description": "User profile ID associated with this
request.", | |
2451 "format": "int64", | |
2452 "location": "path", | |
2453 "required": true, | |
2454 "type": "string" | |
2455 } | |
2456 }, | |
2457 "path": "userprofiles/{profileId}/countries/{dartId}", | |
2458 "response": { | |
2459 "$ref": "Country" | |
2460 }, | |
2461 "scopes": [ | |
2462 "https://www.googleapis.com/auth/dfatrafficking" | |
2463 ] | |
2464 }, | |
2465 "list": { | |
2466 "description": "Retrieves a list of countries.", | |
2467 "httpMethod": "GET", | |
2468 "id": "dfareporting.countries.list", | |
2469 "parameterOrder": [ | |
2470 "profileId" | |
2471 ], | |
2472 "parameters": { | |
2473 "profileId": { | |
2474 "description": "User profile ID associated with this
request.", | |
2475 "format": "int64", | |
2476 "location": "path", | |
2477 "required": true, | |
2478 "type": "string" | |
2479 } | |
2480 }, | |
2481 "path": "userprofiles/{profileId}/countries", | |
2482 "response": { | |
2483 "$ref": "CountriesListResponse" | |
2484 }, | |
2485 "scopes": [ | |
2486 "https://www.googleapis.com/auth/dfatrafficking" | |
2487 ] | |
2488 } | |
2489 } | |
2490 }, | |
2491 "creativeAssets": { | |
2492 "methods": { | |
2493 "insert": { | |
2494 "description": "Inserts a new creative asset.", | |
2495 "httpMethod": "POST", | |
2496 "id": "dfareporting.creativeAssets.insert", | |
2497 "mediaUpload": { | |
2498 "accept": [ | |
2499 "*/*" | |
2500 ], | |
2501 "maxSize": "1024MB", | |
2502 "protocols": { | |
2503 "resumable": { | |
2504 "multipart": true, | |
2505 "path": "/resumable/upload/dfareporting/v2.2/use
rprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets" | |
2506 }, | |
2507 "simple": { | |
2508 "multipart": true, | |
2509 "path": "/upload/dfareporting/v2.2/userprofiles/
{profileId}/creativeAssets/{advertiserId}/creativeAssets" | |
2510 } | |
2511 } | |
2512 }, | |
2513 "parameterOrder": [ | |
2514 "profileId", | |
2515 "advertiserId" | |
2516 ], | |
2517 "parameters": { | |
2518 "advertiserId": { | |
2519 "description": "Advertiser ID of this creative. This
is a required field.", | |
2520 "format": "int64", | |
2521 "location": "path", | |
2522 "required": true, | |
2523 "type": "string" | |
2524 }, | |
2525 "profileId": { | |
2526 "description": "User profile ID associated with this
request.", | |
2527 "format": "int64", | |
2528 "location": "path", | |
2529 "required": true, | |
2530 "type": "string" | |
2531 } | |
2532 }, | |
2533 "path": "userprofiles/{profileId}/creativeAssets/{advertiser
Id}/creativeAssets", | |
2534 "request": { | |
2535 "$ref": "CreativeAssetMetadata" | |
2536 }, | |
2537 "response": { | |
2538 "$ref": "CreativeAssetMetadata" | |
2539 }, | |
2540 "scopes": [ | |
2541 "https://www.googleapis.com/auth/dfatrafficking" | |
2542 ], | |
2543 "supportsMediaUpload": true | |
2544 } | |
2545 } | |
2546 }, | |
2547 "creativeFieldValues": { | |
2548 "methods": { | |
2549 "delete": { | |
2550 "description": "Deletes an existing creative field value.", | |
2551 "httpMethod": "DELETE", | |
2552 "id": "dfareporting.creativeFieldValues.delete", | |
2553 "parameterOrder": [ | |
2554 "profileId", | |
2555 "creativeFieldId", | |
2556 "id" | |
2557 ], | |
2558 "parameters": { | |
2559 "creativeFieldId": { | |
2560 "description": "Creative field ID for this creative
field value.", | |
2561 "format": "int64", | |
2562 "location": "path", | |
2563 "required": true, | |
2564 "type": "string" | |
2565 }, | |
2566 "id": { | |
2567 "description": "Creative Field Value ID", | |
2568 "format": "int64", | |
2569 "location": "path", | |
2570 "required": true, | |
2571 "type": "string" | |
2572 }, | |
2573 "profileId": { | |
2574 "description": "User profile ID associated with this
request.", | |
2575 "format": "int64", | |
2576 "location": "path", | |
2577 "required": true, | |
2578 "type": "string" | |
2579 } | |
2580 }, | |
2581 "path": "userprofiles/{profileId}/creativeFields/{creativeFi
eldId}/creativeFieldValues/{id}", | |
2582 "scopes": [ | |
2583 "https://www.googleapis.com/auth/dfatrafficking" | |
2584 ] | |
2585 }, | |
2586 "get": { | |
2587 "description": "Gets one creative field value by ID.", | |
2588 "httpMethod": "GET", | |
2589 "id": "dfareporting.creativeFieldValues.get", | |
2590 "parameterOrder": [ | |
2591 "profileId", | |
2592 "creativeFieldId", | |
2593 "id" | |
2594 ], | |
2595 "parameters": { | |
2596 "creativeFieldId": { | |
2597 "description": "Creative field ID for this creative
field value.", | |
2598 "format": "int64", | |
2599 "location": "path", | |
2600 "required": true, | |
2601 "type": "string" | |
2602 }, | |
2603 "id": { | |
2604 "description": "Creative Field Value ID", | |
2605 "format": "int64", | |
2606 "location": "path", | |
2607 "required": true, | |
2608 "type": "string" | |
2609 }, | |
2610 "profileId": { | |
2611 "description": "User profile ID associated with this
request.", | |
2612 "format": "int64", | |
2613 "location": "path", | |
2614 "required": true, | |
2615 "type": "string" | |
2616 } | |
2617 }, | |
2618 "path": "userprofiles/{profileId}/creativeFields/{creativeFi
eldId}/creativeFieldValues/{id}", | |
2619 "response": { | |
2620 "$ref": "CreativeFieldValue" | |
2621 }, | |
2622 "scopes": [ | |
2623 "https://www.googleapis.com/auth/dfatrafficking" | |
2624 ] | |
2625 }, | |
2626 "insert": { | |
2627 "description": "Inserts a new creative field value.", | |
2628 "httpMethod": "POST", | |
2629 "id": "dfareporting.creativeFieldValues.insert", | |
2630 "parameterOrder": [ | |
2631 "profileId", | |
2632 "creativeFieldId" | |
2633 ], | |
2634 "parameters": { | |
2635 "creativeFieldId": { | |
2636 "description": "Creative field ID for this creative
field value.", | |
2637 "format": "int64", | |
2638 "location": "path", | |
2639 "required": true, | |
2640 "type": "string" | |
2641 }, | |
2642 "profileId": { | |
2643 "description": "User profile ID associated with this
request.", | |
2644 "format": "int64", | |
2645 "location": "path", | |
2646 "required": true, | |
2647 "type": "string" | |
2648 } | |
2649 }, | |
2650 "path": "userprofiles/{profileId}/creativeFields/{creativeFi
eldId}/creativeFieldValues", | |
2651 "request": { | |
2652 "$ref": "CreativeFieldValue" | |
2653 }, | |
2654 "response": { | |
2655 "$ref": "CreativeFieldValue" | |
2656 }, | |
2657 "scopes": [ | |
2658 "https://www.googleapis.com/auth/dfatrafficking" | |
2659 ] | |
2660 }, | |
2661 "list": { | |
2662 "description": "Retrieves a list of creative field values, p
ossibly filtered.", | |
2663 "httpMethod": "GET", | |
2664 "id": "dfareporting.creativeFieldValues.list", | |
2665 "parameterOrder": [ | |
2666 "profileId", | |
2667 "creativeFieldId" | |
2668 ], | |
2669 "parameters": { | |
2670 "creativeFieldId": { | |
2671 "description": "Creative field ID for this creative
field value.", | |
2672 "format": "int64", | |
2673 "location": "path", | |
2674 "required": true, | |
2675 "type": "string" | |
2676 }, | |
2677 "ids": { | |
2678 "description": "Select only creative field values wi
th these IDs.", | |
2679 "format": "int64", | |
2680 "location": "query", | |
2681 "repeated": true, | |
2682 "type": "string" | |
2683 }, | |
2684 "maxResults": { | |
2685 "description": "Maximum number of results to return.
", | |
2686 "format": "int32", | |
2687 "location": "query", | |
2688 "type": "integer" | |
2689 }, | |
2690 "pageToken": { | |
2691 "description": "Value of the nextPageToken from the
previous result page.", | |
2692 "location": "query", | |
2693 "type": "string" | |
2694 }, | |
2695 "profileId": { | |
2696 "description": "User profile ID associated with this
request.", | |
2697 "format": "int64", | |
2698 "location": "path", | |
2699 "required": true, | |
2700 "type": "string" | |
2701 }, | |
2702 "searchString": { | |
2703 "description": "Allows searching for creative field
values by their values. Wildcards (e.g. *) are not allowed.", | |
2704 "location": "query", | |
2705 "type": "string" | |
2706 }, | |
2707 "sortField": { | |
2708 "description": "Field by which to sort the list.", | |
2709 "enum": [ | |
2710 "ID", | |
2711 "VALUE" | |
2712 ], | |
2713 "enumDescriptions": [ | |
2714 "", | |
2715 "" | |
2716 ], | |
2717 "location": "query", | |
2718 "type": "string" | |
2719 }, | |
2720 "sortOrder": { | |
2721 "description": "Order of sorted results, default is
ASCENDING.", | |
2722 "enum": [ | |
2723 "ASCENDING", | |
2724 "DESCENDING" | |
2725 ], | |
2726 "enumDescriptions": [ | |
2727 "", | |
2728 "" | |
2729 ], | |
2730 "location": "query", | |
2731 "type": "string" | |
2732 } | |
2733 }, | |
2734 "path": "userprofiles/{profileId}/creativeFields/{creativeFi
eldId}/creativeFieldValues", | |
2735 "response": { | |
2736 "$ref": "CreativeFieldValuesListResponse" | |
2737 }, | |
2738 "scopes": [ | |
2739 "https://www.googleapis.com/auth/dfatrafficking" | |
2740 ] | |
2741 }, | |
2742 "patch": { | |
2743 "description": "Updates an existing creative field value. Th
is method supports patch semantics.", | |
2744 "httpMethod": "PATCH", | |
2745 "id": "dfareporting.creativeFieldValues.patch", | |
2746 "parameterOrder": [ | |
2747 "profileId", | |
2748 "creativeFieldId", | |
2749 "id" | |
2750 ], | |
2751 "parameters": { | |
2752 "creativeFieldId": { | |
2753 "description": "Creative field ID for this creative
field value.", | |
2754 "format": "int64", | |
2755 "location": "path", | |
2756 "required": true, | |
2757 "type": "string" | |
2758 }, | |
2759 "id": { | |
2760 "description": "Creative Field Value ID", | |
2761 "format": "int64", | |
2762 "location": "query", | |
2763 "required": true, | |
2764 "type": "string" | |
2765 }, | |
2766 "profileId": { | |
2767 "description": "User profile ID associated with this
request.", | |
2768 "format": "int64", | |
2769 "location": "path", | |
2770 "required": true, | |
2771 "type": "string" | |
2772 } | |
2773 }, | |
2774 "path": "userprofiles/{profileId}/creativeFields/{creativeFi
eldId}/creativeFieldValues", | |
2775 "request": { | |
2776 "$ref": "CreativeFieldValue" | |
2777 }, | |
2778 "response": { | |
2779 "$ref": "CreativeFieldValue" | |
2780 }, | |
2781 "scopes": [ | |
2782 "https://www.googleapis.com/auth/dfatrafficking" | |
2783 ] | |
2784 }, | |
2785 "update": { | |
2786 "description": "Updates an existing creative field value.", | |
2787 "httpMethod": "PUT", | |
2788 "id": "dfareporting.creativeFieldValues.update", | |
2789 "parameterOrder": [ | |
2790 "profileId", | |
2791 "creativeFieldId" | |
2792 ], | |
2793 "parameters": { | |
2794 "creativeFieldId": { | |
2795 "description": "Creative field ID for this creative
field value.", | |
2796 "format": "int64", | |
2797 "location": "path", | |
2798 "required": true, | |
2799 "type": "string" | |
2800 }, | |
2801 "profileId": { | |
2802 "description": "User profile ID associated with this
request.", | |
2803 "format": "int64", | |
2804 "location": "path", | |
2805 "required": true, | |
2806 "type": "string" | |
2807 } | |
2808 }, | |
2809 "path": "userprofiles/{profileId}/creativeFields/{creativeFi
eldId}/creativeFieldValues", | |
2810 "request": { | |
2811 "$ref": "CreativeFieldValue" | |
2812 }, | |
2813 "response": { | |
2814 "$ref": "CreativeFieldValue" | |
2815 }, | |
2816 "scopes": [ | |
2817 "https://www.googleapis.com/auth/dfatrafficking" | |
2818 ] | |
2819 } | |
2820 } | |
2821 }, | |
2822 "creativeFields": { | |
2823 "methods": { | |
2824 "delete": { | |
2825 "description": "Deletes an existing creative field.", | |
2826 "httpMethod": "DELETE", | |
2827 "id": "dfareporting.creativeFields.delete", | |
2828 "parameterOrder": [ | |
2829 "profileId", | |
2830 "id" | |
2831 ], | |
2832 "parameters": { | |
2833 "id": { | |
2834 "description": "Creative Field ID", | |
2835 "format": "int64", | |
2836 "location": "path", | |
2837 "required": true, | |
2838 "type": "string" | |
2839 }, | |
2840 "profileId": { | |
2841 "description": "User profile ID associated with this
request.", | |
2842 "format": "int64", | |
2843 "location": "path", | |
2844 "required": true, | |
2845 "type": "string" | |
2846 } | |
2847 }, | |
2848 "path": "userprofiles/{profileId}/creativeFields/{id}", | |
2849 "scopes": [ | |
2850 "https://www.googleapis.com/auth/dfatrafficking" | |
2851 ] | |
2852 }, | |
2853 "get": { | |
2854 "description": "Gets one creative field by ID.", | |
2855 "httpMethod": "GET", | |
2856 "id": "dfareporting.creativeFields.get", | |
2857 "parameterOrder": [ | |
2858 "profileId", | |
2859 "id" | |
2860 ], | |
2861 "parameters": { | |
2862 "id": { | |
2863 "description": "Creative Field ID", | |
2864 "format": "int64", | |
2865 "location": "path", | |
2866 "required": true, | |
2867 "type": "string" | |
2868 }, | |
2869 "profileId": { | |
2870 "description": "User profile ID associated with this
request.", | |
2871 "format": "int64", | |
2872 "location": "path", | |
2873 "required": true, | |
2874 "type": "string" | |
2875 } | |
2876 }, | |
2877 "path": "userprofiles/{profileId}/creativeFields/{id}", | |
2878 "response": { | |
2879 "$ref": "CreativeField" | |
2880 }, | |
2881 "scopes": [ | |
2882 "https://www.googleapis.com/auth/dfatrafficking" | |
2883 ] | |
2884 }, | |
2885 "insert": { | |
2886 "description": "Inserts a new creative field.", | |
2887 "httpMethod": "POST", | |
2888 "id": "dfareporting.creativeFields.insert", | |
2889 "parameterOrder": [ | |
2890 "profileId" | |
2891 ], | |
2892 "parameters": { | |
2893 "profileId": { | |
2894 "description": "User profile ID associated with this
request.", | |
2895 "format": "int64", | |
2896 "location": "path", | |
2897 "required": true, | |
2898 "type": "string" | |
2899 } | |
2900 }, | |
2901 "path": "userprofiles/{profileId}/creativeFields", | |
2902 "request": { | |
2903 "$ref": "CreativeField" | |
2904 }, | |
2905 "response": { | |
2906 "$ref": "CreativeField" | |
2907 }, | |
2908 "scopes": [ | |
2909 "https://www.googleapis.com/auth/dfatrafficking" | |
2910 ] | |
2911 }, | |
2912 "list": { | |
2913 "description": "Retrieves a list of creative fields, possibl
y filtered.", | |
2914 "httpMethod": "GET", | |
2915 "id": "dfareporting.creativeFields.list", | |
2916 "parameterOrder": [ | |
2917 "profileId" | |
2918 ], | |
2919 "parameters": { | |
2920 "advertiserIds": { | |
2921 "description": "Select only creative fields that bel
ong to these advertisers.", | |
2922 "format": "int64", | |
2923 "location": "query", | |
2924 "repeated": true, | |
2925 "type": "string" | |
2926 }, | |
2927 "ids": { | |
2928 "description": "Select only creative fields with the
se IDs.", | |
2929 "format": "int64", | |
2930 "location": "query", | |
2931 "repeated": true, | |
2932 "type": "string" | |
2933 }, | |
2934 "maxResults": { | |
2935 "description": "Maximum number of results to return.
", | |
2936 "format": "int32", | |
2937 "location": "query", | |
2938 "type": "integer" | |
2939 }, | |
2940 "pageToken": { | |
2941 "description": "Value of the nextPageToken from the
previous result page.", | |
2942 "location": "query", | |
2943 "type": "string" | |
2944 }, | |
2945 "profileId": { | |
2946 "description": "User profile ID associated with this
request.", | |
2947 "format": "int64", | |
2948 "location": "path", | |
2949 "required": true, | |
2950 "type": "string" | |
2951 }, | |
2952 "searchString": { | |
2953 "description": "Allows searching for creative fields
by name or ID. Wildcards (*) are allowed. For example, \"creativefield*2015\" w
ill return creative fields with names like \"creativefield June 2015\", \"creati
vefield April 2015\", or simply \"creativefield 2015\". Most of the searches als
o add wild-cards implicitly at the start and the end of the search string. For e
xample, a search string of \"creativefield\" will match creative fields with the
name \"my creativefield\", \"creativefield 2015\", or simply \"creativefield\".
", | |
2954 "location": "query", | |
2955 "type": "string" | |
2956 }, | |
2957 "sortField": { | |
2958 "description": "Field by which to sort the list.", | |
2959 "enum": [ | |
2960 "ID", | |
2961 "NAME" | |
2962 ], | |
2963 "enumDescriptions": [ | |
2964 "", | |
2965 "" | |
2966 ], | |
2967 "location": "query", | |
2968 "type": "string" | |
2969 }, | |
2970 "sortOrder": { | |
2971 "description": "Order of sorted results, default is
ASCENDING.", | |
2972 "enum": [ | |
2973 "ASCENDING", | |
2974 "DESCENDING" | |
2975 ], | |
2976 "enumDescriptions": [ | |
2977 "", | |
2978 "" | |
2979 ], | |
2980 "location": "query", | |
2981 "type": "string" | |
2982 } | |
2983 }, | |
2984 "path": "userprofiles/{profileId}/creativeFields", | |
2985 "response": { | |
2986 "$ref": "CreativeFieldsListResponse" | |
2987 }, | |
2988 "scopes": [ | |
2989 "https://www.googleapis.com/auth/dfatrafficking" | |
2990 ] | |
2991 }, | |
2992 "patch": { | |
2993 "description": "Updates an existing creative field. This met
hod supports patch semantics.", | |
2994 "httpMethod": "PATCH", | |
2995 "id": "dfareporting.creativeFields.patch", | |
2996 "parameterOrder": [ | |
2997 "profileId", | |
2998 "id" | |
2999 ], | |
3000 "parameters": { | |
3001 "id": { | |
3002 "description": "Creative Field ID", | |
3003 "format": "int64", | |
3004 "location": "query", | |
3005 "required": true, | |
3006 "type": "string" | |
3007 }, | |
3008 "profileId": { | |
3009 "description": "User profile ID associated with this
request.", | |
3010 "format": "int64", | |
3011 "location": "path", | |
3012 "required": true, | |
3013 "type": "string" | |
3014 } | |
3015 }, | |
3016 "path": "userprofiles/{profileId}/creativeFields", | |
3017 "request": { | |
3018 "$ref": "CreativeField" | |
3019 }, | |
3020 "response": { | |
3021 "$ref": "CreativeField" | |
3022 }, | |
3023 "scopes": [ | |
3024 "https://www.googleapis.com/auth/dfatrafficking" | |
3025 ] | |
3026 }, | |
3027 "update": { | |
3028 "description": "Updates an existing creative field.", | |
3029 "httpMethod": "PUT", | |
3030 "id": "dfareporting.creativeFields.update", | |
3031 "parameterOrder": [ | |
3032 "profileId" | |
3033 ], | |
3034 "parameters": { | |
3035 "profileId": { | |
3036 "description": "User profile ID associated with this
request.", | |
3037 "format": "int64", | |
3038 "location": "path", | |
3039 "required": true, | |
3040 "type": "string" | |
3041 } | |
3042 }, | |
3043 "path": "userprofiles/{profileId}/creativeFields", | |
3044 "request": { | |
3045 "$ref": "CreativeField" | |
3046 }, | |
3047 "response": { | |
3048 "$ref": "CreativeField" | |
3049 }, | |
3050 "scopes": [ | |
3051 "https://www.googleapis.com/auth/dfatrafficking" | |
3052 ] | |
3053 } | |
3054 } | |
3055 }, | |
3056 "creativeGroups": { | |
3057 "methods": { | |
3058 "get": { | |
3059 "description": "Gets one creative group by ID.", | |
3060 "httpMethod": "GET", | |
3061 "id": "dfareporting.creativeGroups.get", | |
3062 "parameterOrder": [ | |
3063 "profileId", | |
3064 "id" | |
3065 ], | |
3066 "parameters": { | |
3067 "id": { | |
3068 "description": "Creative group ID.", | |
3069 "format": "int64", | |
3070 "location": "path", | |
3071 "required": true, | |
3072 "type": "string" | |
3073 }, | |
3074 "profileId": { | |
3075 "description": "User profile ID associated with this
request.", | |
3076 "format": "int64", | |
3077 "location": "path", | |
3078 "required": true, | |
3079 "type": "string" | |
3080 } | |
3081 }, | |
3082 "path": "userprofiles/{profileId}/creativeGroups/{id}", | |
3083 "response": { | |
3084 "$ref": "CreativeGroup" | |
3085 }, | |
3086 "scopes": [ | |
3087 "https://www.googleapis.com/auth/dfatrafficking" | |
3088 ] | |
3089 }, | |
3090 "insert": { | |
3091 "description": "Inserts a new creative group.", | |
3092 "httpMethod": "POST", | |
3093 "id": "dfareporting.creativeGroups.insert", | |
3094 "parameterOrder": [ | |
3095 "profileId" | |
3096 ], | |
3097 "parameters": { | |
3098 "profileId": { | |
3099 "description": "User profile ID associated with this
request.", | |
3100 "format": "int64", | |
3101 "location": "path", | |
3102 "required": true, | |
3103 "type": "string" | |
3104 } | |
3105 }, | |
3106 "path": "userprofiles/{profileId}/creativeGroups", | |
3107 "request": { | |
3108 "$ref": "CreativeGroup" | |
3109 }, | |
3110 "response": { | |
3111 "$ref": "CreativeGroup" | |
3112 }, | |
3113 "scopes": [ | |
3114 "https://www.googleapis.com/auth/dfatrafficking" | |
3115 ] | |
3116 }, | |
3117 "list": { | |
3118 "description": "Retrieves a list of creative groups, possibl
y filtered.", | |
3119 "httpMethod": "GET", | |
3120 "id": "dfareporting.creativeGroups.list", | |
3121 "parameterOrder": [ | |
3122 "profileId" | |
3123 ], | |
3124 "parameters": { | |
3125 "advertiserIds": { | |
3126 "description": "Select only creative groups that bel
ong to these advertisers.", | |
3127 "format": "int64", | |
3128 "location": "query", | |
3129 "repeated": true, | |
3130 "type": "string" | |
3131 }, | |
3132 "groupNumber": { | |
3133 "description": "Select only creative groups that bel
ong to this subgroup.", | |
3134 "format": "int32", | |
3135 "location": "query", | |
3136 "type": "integer" | |
3137 }, | |
3138 "ids": { | |
3139 "description": "Select only creative groups with the
se IDs.", | |
3140 "format": "int64", | |
3141 "location": "query", | |
3142 "repeated": true, | |
3143 "type": "string" | |
3144 }, | |
3145 "maxResults": { | |
3146 "description": "Maximum number of results to return.
", | |
3147 "format": "int32", | |
3148 "location": "query", | |
3149 "type": "integer" | |
3150 }, | |
3151 "pageToken": { | |
3152 "description": "Value of the nextPageToken from the
previous result page.", | |
3153 "location": "query", | |
3154 "type": "string" | |
3155 }, | |
3156 "profileId": { | |
3157 "description": "User profile ID associated with this
request.", | |
3158 "format": "int64", | |
3159 "location": "path", | |
3160 "required": true, | |
3161 "type": "string" | |
3162 }, | |
3163 "searchString": { | |
3164 "description": "Allows searching for creative groups
by name or ID. Wildcards (*) are allowed. For example, \"creativegroup*2015\" w
ill return creative groups with names like \"creativegroup June 2015\", \"creati
vegroup April 2015\", or simply \"creativegroup 2015\". Most of the searches als
o add wild-cards implicitly at the start and the end of the search string. For e
xample, a search string of \"creativegroup\" will match creative groups with the
name \"my creativegroup\", \"creativegroup 2015\", or simply \"creativegroup\".
", | |
3165 "location": "query", | |
3166 "type": "string" | |
3167 }, | |
3168 "sortField": { | |
3169 "description": "Field by which to sort the list.", | |
3170 "enum": [ | |
3171 "ID", | |
3172 "NAME" | |
3173 ], | |
3174 "enumDescriptions": [ | |
3175 "", | |
3176 "" | |
3177 ], | |
3178 "location": "query", | |
3179 "type": "string" | |
3180 }, | |
3181 "sortOrder": { | |
3182 "description": "Order of sorted results, default is
ASCENDING.", | |
3183 "enum": [ | |
3184 "ASCENDING", | |
3185 "DESCENDING" | |
3186 ], | |
3187 "enumDescriptions": [ | |
3188 "", | |
3189 "" | |
3190 ], | |
3191 "location": "query", | |
3192 "type": "string" | |
3193 } | |
3194 }, | |
3195 "path": "userprofiles/{profileId}/creativeGroups", | |
3196 "response": { | |
3197 "$ref": "CreativeGroupsListResponse" | |
3198 }, | |
3199 "scopes": [ | |
3200 "https://www.googleapis.com/auth/dfatrafficking" | |
3201 ] | |
3202 }, | |
3203 "patch": { | |
3204 "description": "Updates an existing creative group. This met
hod supports patch semantics.", | |
3205 "httpMethod": "PATCH", | |
3206 "id": "dfareporting.creativeGroups.patch", | |
3207 "parameterOrder": [ | |
3208 "profileId", | |
3209 "id" | |
3210 ], | |
3211 "parameters": { | |
3212 "id": { | |
3213 "description": "Creative group ID.", | |
3214 "format": "int64", | |
3215 "location": "query", | |
3216 "required": true, | |
3217 "type": "string" | |
3218 }, | |
3219 "profileId": { | |
3220 "description": "User profile ID associated with this
request.", | |
3221 "format": "int64", | |
3222 "location": "path", | |
3223 "required": true, | |
3224 "type": "string" | |
3225 } | |
3226 }, | |
3227 "path": "userprofiles/{profileId}/creativeGroups", | |
3228 "request": { | |
3229 "$ref": "CreativeGroup" | |
3230 }, | |
3231 "response": { | |
3232 "$ref": "CreativeGroup" | |
3233 }, | |
3234 "scopes": [ | |
3235 "https://www.googleapis.com/auth/dfatrafficking" | |
3236 ] | |
3237 }, | |
3238 "update": { | |
3239 "description": "Updates an existing creative group.", | |
3240 "httpMethod": "PUT", | |
3241 "id": "dfareporting.creativeGroups.update", | |
3242 "parameterOrder": [ | |
3243 "profileId" | |
3244 ], | |
3245 "parameters": { | |
3246 "profileId": { | |
3247 "description": "User profile ID associated with this
request.", | |
3248 "format": "int64", | |
3249 "location": "path", | |
3250 "required": true, | |
3251 "type": "string" | |
3252 } | |
3253 }, | |
3254 "path": "userprofiles/{profileId}/creativeGroups", | |
3255 "request": { | |
3256 "$ref": "CreativeGroup" | |
3257 }, | |
3258 "response": { | |
3259 "$ref": "CreativeGroup" | |
3260 }, | |
3261 "scopes": [ | |
3262 "https://www.googleapis.com/auth/dfatrafficking" | |
3263 ] | |
3264 } | |
3265 } | |
3266 }, | |
3267 "creatives": { | |
3268 "methods": { | |
3269 "get": { | |
3270 "description": "Gets one creative by ID.", | |
3271 "httpMethod": "GET", | |
3272 "id": "dfareporting.creatives.get", | |
3273 "parameterOrder": [ | |
3274 "profileId", | |
3275 "id" | |
3276 ], | |
3277 "parameters": { | |
3278 "id": { | |
3279 "description": "Creative ID.", | |
3280 "format": "int64", | |
3281 "location": "path", | |
3282 "required": true, | |
3283 "type": "string" | |
3284 }, | |
3285 "profileId": { | |
3286 "description": "User profile ID associated with this
request.", | |
3287 "format": "int64", | |
3288 "location": "path", | |
3289 "required": true, | |
3290 "type": "string" | |
3291 } | |
3292 }, | |
3293 "path": "userprofiles/{profileId}/creatives/{id}", | |
3294 "response": { | |
3295 "$ref": "Creative" | |
3296 }, | |
3297 "scopes": [ | |
3298 "https://www.googleapis.com/auth/dfatrafficking" | |
3299 ] | |
3300 }, | |
3301 "insert": { | |
3302 "description": "Inserts a new creative.", | |
3303 "httpMethod": "POST", | |
3304 "id": "dfareporting.creatives.insert", | |
3305 "parameterOrder": [ | |
3306 "profileId" | |
3307 ], | |
3308 "parameters": { | |
3309 "profileId": { | |
3310 "description": "User profile ID associated with this
request.", | |
3311 "format": "int64", | |
3312 "location": "path", | |
3313 "required": true, | |
3314 "type": "string" | |
3315 } | |
3316 }, | |
3317 "path": "userprofiles/{profileId}/creatives", | |
3318 "request": { | |
3319 "$ref": "Creative" | |
3320 }, | |
3321 "response": { | |
3322 "$ref": "Creative" | |
3323 }, | |
3324 "scopes": [ | |
3325 "https://www.googleapis.com/auth/dfatrafficking" | |
3326 ] | |
3327 }, | |
3328 "list": { | |
3329 "description": "Retrieves a list of creatives, possibly filt
ered.", | |
3330 "httpMethod": "GET", | |
3331 "id": "dfareporting.creatives.list", | |
3332 "parameterOrder": [ | |
3333 "profileId" | |
3334 ], | |
3335 "parameters": { | |
3336 "active": { | |
3337 "description": "Select only active creatives. Leave
blank to select active and inactive creatives.", | |
3338 "location": "query", | |
3339 "type": "boolean" | |
3340 }, | |
3341 "advertiserId": { | |
3342 "description": "Select only creatives with this adve
rtiser ID.", | |
3343 "format": "int64", | |
3344 "location": "query", | |
3345 "type": "string" | |
3346 }, | |
3347 "archived": { | |
3348 "description": "Select only archived creatives. Leav
e blank to select archived and unarchived creatives.", | |
3349 "location": "query", | |
3350 "type": "boolean" | |
3351 }, | |
3352 "campaignId": { | |
3353 "description": "Select only creatives with this camp
aign ID.", | |
3354 "format": "int64", | |
3355 "location": "query", | |
3356 "type": "string" | |
3357 }, | |
3358 "companionCreativeIds": { | |
3359 "description": "Select only in-stream video creative
s with these companion IDs.", | |
3360 "format": "int64", | |
3361 "location": "query", | |
3362 "repeated": true, | |
3363 "type": "string" | |
3364 }, | |
3365 "creativeFieldIds": { | |
3366 "description": "Select only creatives with these cre
ative field IDs.", | |
3367 "format": "int64", | |
3368 "location": "query", | |
3369 "repeated": true, | |
3370 "type": "string" | |
3371 }, | |
3372 "ids": { | |
3373 "description": "Select only creatives with these IDs
.", | |
3374 "format": "int64", | |
3375 "location": "query", | |
3376 "repeated": true, | |
3377 "type": "string" | |
3378 }, | |
3379 "maxResults": { | |
3380 "description": "Maximum number of results to return.
", | |
3381 "format": "int32", | |
3382 "location": "query", | |
3383 "type": "integer" | |
3384 }, | |
3385 "pageToken": { | |
3386 "description": "Value of the nextPageToken from the
previous result page.", | |
3387 "location": "query", | |
3388 "type": "string" | |
3389 }, | |
3390 "profileId": { | |
3391 "description": "User profile ID associated with this
request.", | |
3392 "format": "int64", | |
3393 "location": "path", | |
3394 "required": true, | |
3395 "type": "string" | |
3396 }, | |
3397 "renderingIds": { | |
3398 "description": "Select only creatives with these ren
dering IDs.", | |
3399 "format": "int64", | |
3400 "location": "query", | |
3401 "repeated": true, | |
3402 "type": "string" | |
3403 }, | |
3404 "searchString": { | |
3405 "description": "Allows searching for objects by name
or ID. Wildcards (*) are allowed. For example, \"creative*2015\" will return ob
jects with names like \"creative June 2015\", \"creative April 2015\", or simply
\"creative 2015\". Most of the searches also add wildcards implicitly at the st
art and the end of the search string. For example, a search string of \"creative
\" will match objects with name \"my creative\", \"creative 2015\", or simply \"
creative\".", | |
3406 "location": "query", | |
3407 "type": "string" | |
3408 }, | |
3409 "sizeIds": { | |
3410 "description": "Select only creatives with these siz
e IDs.", | |
3411 "format": "int64", | |
3412 "location": "query", | |
3413 "repeated": true, | |
3414 "type": "string" | |
3415 }, | |
3416 "sortField": { | |
3417 "description": "Field by which to sort the list.", | |
3418 "enum": [ | |
3419 "ID", | |
3420 "NAME" | |
3421 ], | |
3422 "enumDescriptions": [ | |
3423 "", | |
3424 "" | |
3425 ], | |
3426 "location": "query", | |
3427 "type": "string" | |
3428 }, | |
3429 "sortOrder": { | |
3430 "description": "Order of sorted results, default is
ASCENDING.", | |
3431 "enum": [ | |
3432 "ASCENDING", | |
3433 "DESCENDING" | |
3434 ], | |
3435 "enumDescriptions": [ | |
3436 "", | |
3437 "" | |
3438 ], | |
3439 "location": "query", | |
3440 "type": "string" | |
3441 }, | |
3442 "studioCreativeId": { | |
3443 "description": "Select only creatives corresponding
to this Studio creative ID.", | |
3444 "format": "int64", | |
3445 "location": "query", | |
3446 "type": "string" | |
3447 }, | |
3448 "types": { | |
3449 "description": "Select only creatives with these cre
ative types.", | |
3450 "enum": [ | |
3451 "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO", | |
3452 "CUSTOM_INPAGE", | |
3453 "CUSTOM_INTERSTITIAL", | |
3454 "ENHANCED_BANNER", | |
3455 "ENHANCED_IMAGE", | |
3456 "FLASH_INPAGE", | |
3457 "HTML5_BANNER", | |
3458 "IMAGE", | |
3459 "INSTREAM_VIDEO", | |
3460 "INTERNAL_REDIRECT", | |
3461 "INTERSTITIAL_INTERNAL_REDIRECT", | |
3462 "REDIRECT", | |
3463 "RICH_MEDIA_EXPANDING", | |
3464 "RICH_MEDIA_IM_EXPAND", | |
3465 "RICH_MEDIA_INPAGE", | |
3466 "RICH_MEDIA_INPAGE_FLOATING", | |
3467 "RICH_MEDIA_INTERSTITIAL_FLOAT", | |
3468 "RICH_MEDIA_MOBILE_IN_APP", | |
3469 "RICH_MEDIA_MULTI_FLOATING", | |
3470 "RICH_MEDIA_PEEL_DOWN", | |
3471 "TRACKING_TEXT", | |
3472 "VAST_REDIRECT", | |
3473 "VPAID_LINEAR", | |
3474 "VPAID_NON_LINEAR" | |
3475 ], | |
3476 "enumDescriptions": [ | |
3477 "", | |
3478 "", | |
3479 "", | |
3480 "", | |
3481 "", | |
3482 "", | |
3483 "", | |
3484 "", | |
3485 "", | |
3486 "", | |
3487 "", | |
3488 "", | |
3489 "", | |
3490 "", | |
3491 "", | |
3492 "", | |
3493 "", | |
3494 "", | |
3495 "", | |
3496 "", | |
3497 "", | |
3498 "", | |
3499 "", | |
3500 "" | |
3501 ], | |
3502 "location": "query", | |
3503 "repeated": true, | |
3504 "type": "string" | |
3505 } | |
3506 }, | |
3507 "path": "userprofiles/{profileId}/creatives", | |
3508 "response": { | |
3509 "$ref": "CreativesListResponse" | |
3510 }, | |
3511 "scopes": [ | |
3512 "https://www.googleapis.com/auth/dfatrafficking" | |
3513 ] | |
3514 }, | |
3515 "patch": { | |
3516 "description": "Updates an existing creative. This method su
pports patch semantics.", | |
3517 "httpMethod": "PATCH", | |
3518 "id": "dfareporting.creatives.patch", | |
3519 "parameterOrder": [ | |
3520 "profileId", | |
3521 "id" | |
3522 ], | |
3523 "parameters": { | |
3524 "id": { | |
3525 "description": "Creative ID.", | |
3526 "format": "int64", | |
3527 "location": "query", | |
3528 "required": true, | |
3529 "type": "string" | |
3530 }, | |
3531 "profileId": { | |
3532 "description": "User profile ID associated with this
request.", | |
3533 "format": "int64", | |
3534 "location": "path", | |
3535 "required": true, | |
3536 "type": "string" | |
3537 } | |
3538 }, | |
3539 "path": "userprofiles/{profileId}/creatives", | |
3540 "request": { | |
3541 "$ref": "Creative" | |
3542 }, | |
3543 "response": { | |
3544 "$ref": "Creative" | |
3545 }, | |
3546 "scopes": [ | |
3547 "https://www.googleapis.com/auth/dfatrafficking" | |
3548 ] | |
3549 }, | |
3550 "update": { | |
3551 "description": "Updates an existing creative.", | |
3552 "httpMethod": "PUT", | |
3553 "id": "dfareporting.creatives.update", | |
3554 "parameterOrder": [ | |
3555 "profileId" | |
3556 ], | |
3557 "parameters": { | |
3558 "profileId": { | |
3559 "description": "User profile ID associated with this
request.", | |
3560 "format": "int64", | |
3561 "location": "path", | |
3562 "required": true, | |
3563 "type": "string" | |
3564 } | |
3565 }, | |
3566 "path": "userprofiles/{profileId}/creatives", | |
3567 "request": { | |
3568 "$ref": "Creative" | |
3569 }, | |
3570 "response": { | |
3571 "$ref": "Creative" | |
3572 }, | |
3573 "scopes": [ | |
3574 "https://www.googleapis.com/auth/dfatrafficking" | |
3575 ] | |
3576 } | |
3577 } | |
3578 }, | |
3579 "dimensionValues": { | |
3580 "methods": { | |
3581 "query": { | |
3582 "description": "Retrieves list of report dimension values fo
r a list of filters.", | |
3583 "httpMethod": "POST", | |
3584 "id": "dfareporting.dimensionValues.query", | |
3585 "parameterOrder": [ | |
3586 "profileId" | |
3587 ], | |
3588 "parameters": { | |
3589 "maxResults": { | |
3590 "description": "Maximum number of results to return.
", | |
3591 "format": "int32", | |
3592 "location": "query", | |
3593 "maximum": "100", | |
3594 "minimum": "0", | |
3595 "type": "integer" | |
3596 }, | |
3597 "pageToken": { | |
3598 "description": "The value of the nextToken from the
previous result page.", | |
3599 "location": "query", | |
3600 "type": "string" | |
3601 }, | |
3602 "profileId": { | |
3603 "description": "The DFA user profile ID.", | |
3604 "format": "int64", | |
3605 "location": "path", | |
3606 "required": true, | |
3607 "type": "string" | |
3608 } | |
3609 }, | |
3610 "path": "userprofiles/{profileId}/dimensionvalues/query", | |
3611 "request": { | |
3612 "$ref": "DimensionValueRequest" | |
3613 }, | |
3614 "response": { | |
3615 "$ref": "DimensionValueList" | |
3616 }, | |
3617 "scopes": [ | |
3618 "https://www.googleapis.com/auth/dfareporting" | |
3619 ] | |
3620 } | |
3621 } | |
3622 }, | |
3623 "directorySiteContacts": { | |
3624 "methods": { | |
3625 "get": { | |
3626 "description": "Gets one directory site contact by ID.", | |
3627 "httpMethod": "GET", | |
3628 "id": "dfareporting.directorySiteContacts.get", | |
3629 "parameterOrder": [ | |
3630 "profileId", | |
3631 "id" | |
3632 ], | |
3633 "parameters": { | |
3634 "id": { | |
3635 "description": "Directory site contact ID.", | |
3636 "format": "int64", | |
3637 "location": "path", | |
3638 "required": true, | |
3639 "type": "string" | |
3640 }, | |
3641 "profileId": { | |
3642 "description": "User profile ID associated with this
request.", | |
3643 "format": "int64", | |
3644 "location": "path", | |
3645 "required": true, | |
3646 "type": "string" | |
3647 } | |
3648 }, | |
3649 "path": "userprofiles/{profileId}/directorySiteContacts/{id}
", | |
3650 "response": { | |
3651 "$ref": "DirectorySiteContact" | |
3652 }, | |
3653 "scopes": [ | |
3654 "https://www.googleapis.com/auth/dfatrafficking" | |
3655 ] | |
3656 }, | |
3657 "list": { | |
3658 "description": "Retrieves a list of directory site contacts,
possibly filtered.", | |
3659 "httpMethod": "GET", | |
3660 "id": "dfareporting.directorySiteContacts.list", | |
3661 "parameterOrder": [ | |
3662 "profileId" | |
3663 ], | |
3664 "parameters": { | |
3665 "directorySiteIds": { | |
3666 "description": "Select only directory site contacts
with these directory site IDs. This is a required field.", | |
3667 "format": "int64", | |
3668 "location": "query", | |
3669 "repeated": true, | |
3670 "type": "string" | |
3671 }, | |
3672 "ids": { | |
3673 "description": "Select only directory site contacts
with these IDs.", | |
3674 "format": "int64", | |
3675 "location": "query", | |
3676 "repeated": true, | |
3677 "type": "string" | |
3678 }, | |
3679 "maxResults": { | |
3680 "description": "Maximum number of results to return.
", | |
3681 "format": "int32", | |
3682 "location": "query", | |
3683 "type": "integer" | |
3684 }, | |
3685 "pageToken": { | |
3686 "description": "Value of the nextPageToken from the
previous result page.", | |
3687 "location": "query", | |
3688 "type": "string" | |
3689 }, | |
3690 "profileId": { | |
3691 "description": "User profile ID associated with this
request.", | |
3692 "format": "int64", | |
3693 "location": "path", | |
3694 "required": true, | |
3695 "type": "string" | |
3696 }, | |
3697 "searchString": { | |
3698 "description": "Allows searching for objects by name
, ID or email. Wildcards (*) are allowed. For example, \"directory site contact*
2015\" will return objects with names like \"directory site contact June 2015\",
\"directory site contact April 2015\", or simply \"directory site contact 2015\
". Most of the searches also add wildcards implicitly at the start and the end o
f the search string. For example, a search string of \"directory site contact\"
will match objects with name \"my directory site contact\", \"directory site con
tact 2015\", or simply \"directory site contact\".", | |
3699 "location": "query", | |
3700 "type": "string" | |
3701 }, | |
3702 "sortField": { | |
3703 "description": "Field by which to sort the list.", | |
3704 "enum": [ | |
3705 "ID", | |
3706 "NAME" | |
3707 ], | |
3708 "enumDescriptions": [ | |
3709 "", | |
3710 "" | |
3711 ], | |
3712 "location": "query", | |
3713 "type": "string" | |
3714 }, | |
3715 "sortOrder": { | |
3716 "description": "Order of sorted results, default is
ASCENDING.", | |
3717 "enum": [ | |
3718 "ASCENDING", | |
3719 "DESCENDING" | |
3720 ], | |
3721 "enumDescriptions": [ | |
3722 "", | |
3723 "" | |
3724 ], | |
3725 "location": "query", | |
3726 "type": "string" | |
3727 } | |
3728 }, | |
3729 "path": "userprofiles/{profileId}/directorySiteContacts", | |
3730 "response": { | |
3731 "$ref": "DirectorySiteContactsListResponse" | |
3732 }, | |
3733 "scopes": [ | |
3734 "https://www.googleapis.com/auth/dfatrafficking" | |
3735 ] | |
3736 } | |
3737 } | |
3738 }, | |
3739 "directorySites": { | |
3740 "methods": { | |
3741 "get": { | |
3742 "description": "Gets one directory site by ID.", | |
3743 "httpMethod": "GET", | |
3744 "id": "dfareporting.directorySites.get", | |
3745 "parameterOrder": [ | |
3746 "profileId", | |
3747 "id" | |
3748 ], | |
3749 "parameters": { | |
3750 "id": { | |
3751 "description": "Directory site ID.", | |
3752 "format": "int64", | |
3753 "location": "path", | |
3754 "required": true, | |
3755 "type": "string" | |
3756 }, | |
3757 "profileId": { | |
3758 "description": "User profile ID associated with this
request.", | |
3759 "format": "int64", | |
3760 "location": "path", | |
3761 "required": true, | |
3762 "type": "string" | |
3763 } | |
3764 }, | |
3765 "path": "userprofiles/{profileId}/directorySites/{id}", | |
3766 "response": { | |
3767 "$ref": "DirectorySite" | |
3768 }, | |
3769 "scopes": [ | |
3770 "https://www.googleapis.com/auth/dfatrafficking" | |
3771 ] | |
3772 }, | |
3773 "insert": { | |
3774 "description": "Inserts a new directory site.", | |
3775 "httpMethod": "POST", | |
3776 "id": "dfareporting.directorySites.insert", | |
3777 "parameterOrder": [ | |
3778 "profileId" | |
3779 ], | |
3780 "parameters": { | |
3781 "profileId": { | |
3782 "description": "User profile ID associated with this
request.", | |
3783 "format": "int64", | |
3784 "location": "path", | |
3785 "required": true, | |
3786 "type": "string" | |
3787 } | |
3788 }, | |
3789 "path": "userprofiles/{profileId}/directorySites", | |
3790 "request": { | |
3791 "$ref": "DirectorySite" | |
3792 }, | |
3793 "response": { | |
3794 "$ref": "DirectorySite" | |
3795 }, | |
3796 "scopes": [ | |
3797 "https://www.googleapis.com/auth/dfatrafficking" | |
3798 ] | |
3799 }, | |
3800 "list": { | |
3801 "description": "Retrieves a list of directory sites, possibl
y filtered.", | |
3802 "httpMethod": "GET", | |
3803 "id": "dfareporting.directorySites.list", | |
3804 "parameterOrder": [ | |
3805 "profileId" | |
3806 ], | |
3807 "parameters": { | |
3808 "acceptsInStreamVideoPlacements": { | |
3809 "description": "This search filter is no longer supp
orted and will have no effect on the results returned.", | |
3810 "location": "query", | |
3811 "type": "boolean" | |
3812 }, | |
3813 "acceptsInterstitialPlacements": { | |
3814 "description": "This search filter is no longer supp
orted and will have no effect on the results returned.", | |
3815 "location": "query", | |
3816 "type": "boolean" | |
3817 }, | |
3818 "acceptsPublisherPaidPlacements": { | |
3819 "description": "Select only directory sites that acc
ept publisher paid placements. This field can be left blank.", | |
3820 "location": "query", | |
3821 "type": "boolean" | |
3822 }, | |
3823 "active": { | |
3824 "description": "Select only active directory sites.
Leave blank to retrieve both active and inactive directory sites.", | |
3825 "location": "query", | |
3826 "type": "boolean" | |
3827 }, | |
3828 "countryId": { | |
3829 "description": "Select only directory sites with thi
s country ID.", | |
3830 "format": "int64", | |
3831 "location": "query", | |
3832 "type": "string" | |
3833 }, | |
3834 "dfp_network_code": { | |
3835 "description": "Select only directory sites with thi
s DFP network code.", | |
3836 "location": "query", | |
3837 "type": "string" | |
3838 }, | |
3839 "ids": { | |
3840 "description": "Select only directory sites with the
se IDs.", | |
3841 "format": "int64", | |
3842 "location": "query", | |
3843 "repeated": true, | |
3844 "type": "string" | |
3845 }, | |
3846 "maxResults": { | |
3847 "description": "Maximum number of results to return.
", | |
3848 "format": "int32", | |
3849 "location": "query", | |
3850 "type": "integer" | |
3851 }, | |
3852 "pageToken": { | |
3853 "description": "Value of the nextPageToken from the
previous result page.", | |
3854 "location": "query", | |
3855 "type": "string" | |
3856 }, | |
3857 "parentId": { | |
3858 "description": "Select only directory sites with thi
s parent ID.", | |
3859 "format": "int64", | |
3860 "location": "query", | |
3861 "type": "string" | |
3862 }, | |
3863 "profileId": { | |
3864 "description": "User profile ID associated with this
request.", | |
3865 "format": "int64", | |
3866 "location": "path", | |
3867 "required": true, | |
3868 "type": "string" | |
3869 }, | |
3870 "searchString": { | |
3871 "description": "Allows searching for objects by name
, ID or URL. Wildcards (*) are allowed. For example, \"directory site*2015\" wil
l return objects with names like \"directory site June 2015\", \"directory site
April 2015\", or simply \"directory site 2015\". Most of the searches also add w
ildcards implicitly at the start and the end of the search string. For example,
a search string of \"directory site\" will match objects with name \"my director
y site\", \"directory site 2015\" or simply, \"directory site\".", | |
3872 "location": "query", | |
3873 "type": "string" | |
3874 }, | |
3875 "sortField": { | |
3876 "description": "Field by which to sort the list.", | |
3877 "enum": [ | |
3878 "ID", | |
3879 "NAME" | |
3880 ], | |
3881 "enumDescriptions": [ | |
3882 "", | |
3883 "" | |
3884 ], | |
3885 "location": "query", | |
3886 "type": "string" | |
3887 }, | |
3888 "sortOrder": { | |
3889 "description": "Order of sorted results, default is
ASCENDING.", | |
3890 "enum": [ | |
3891 "ASCENDING", | |
3892 "DESCENDING" | |
3893 ], | |
3894 "enumDescriptions": [ | |
3895 "", | |
3896 "" | |
3897 ], | |
3898 "location": "query", | |
3899 "type": "string" | |
3900 } | |
3901 }, | |
3902 "path": "userprofiles/{profileId}/directorySites", | |
3903 "response": { | |
3904 "$ref": "DirectorySitesListResponse" | |
3905 }, | |
3906 "scopes": [ | |
3907 "https://www.googleapis.com/auth/dfatrafficking" | |
3908 ] | |
3909 } | |
3910 } | |
3911 }, | |
3912 "eventTags": { | |
3913 "methods": { | |
3914 "delete": { | |
3915 "description": "Deletes an existing event tag.", | |
3916 "httpMethod": "DELETE", | |
3917 "id": "dfareporting.eventTags.delete", | |
3918 "parameterOrder": [ | |
3919 "profileId", | |
3920 "id" | |
3921 ], | |
3922 "parameters": { | |
3923 "id": { | |
3924 "description": "Event tag ID.", | |
3925 "format": "int64", | |
3926 "location": "path", | |
3927 "required": true, | |
3928 "type": "string" | |
3929 }, | |
3930 "profileId": { | |
3931 "description": "User profile ID associated with this
request.", | |
3932 "format": "int64", | |
3933 "location": "path", | |
3934 "required": true, | |
3935 "type": "string" | |
3936 } | |
3937 }, | |
3938 "path": "userprofiles/{profileId}/eventTags/{id}", | |
3939 "scopes": [ | |
3940 "https://www.googleapis.com/auth/dfatrafficking" | |
3941 ] | |
3942 }, | |
3943 "get": { | |
3944 "description": "Gets one event tag by ID.", | |
3945 "httpMethod": "GET", | |
3946 "id": "dfareporting.eventTags.get", | |
3947 "parameterOrder": [ | |
3948 "profileId", | |
3949 "id" | |
3950 ], | |
3951 "parameters": { | |
3952 "id": { | |
3953 "description": "Event tag ID.", | |
3954 "format": "int64", | |
3955 "location": "path", | |
3956 "required": true, | |
3957 "type": "string" | |
3958 }, | |
3959 "profileId": { | |
3960 "description": "User profile ID associated with this
request.", | |
3961 "format": "int64", | |
3962 "location": "path", | |
3963 "required": true, | |
3964 "type": "string" | |
3965 } | |
3966 }, | |
3967 "path": "userprofiles/{profileId}/eventTags/{id}", | |
3968 "response": { | |
3969 "$ref": "EventTag" | |
3970 }, | |
3971 "scopes": [ | |
3972 "https://www.googleapis.com/auth/dfatrafficking" | |
3973 ] | |
3974 }, | |
3975 "insert": { | |
3976 "description": "Inserts a new event tag.", | |
3977 "httpMethod": "POST", | |
3978 "id": "dfareporting.eventTags.insert", | |
3979 "parameterOrder": [ | |
3980 "profileId" | |
3981 ], | |
3982 "parameters": { | |
3983 "profileId": { | |
3984 "description": "User profile ID associated with this
request.", | |
3985 "format": "int64", | |
3986 "location": "path", | |
3987 "required": true, | |
3988 "type": "string" | |
3989 } | |
3990 }, | |
3991 "path": "userprofiles/{profileId}/eventTags", | |
3992 "request": { | |
3993 "$ref": "EventTag" | |
3994 }, | |
3995 "response": { | |
3996 "$ref": "EventTag" | |
3997 }, | |
3998 "scopes": [ | |
3999 "https://www.googleapis.com/auth/dfatrafficking" | |
4000 ] | |
4001 }, | |
4002 "list": { | |
4003 "description": "Retrieves a list of event tags, possibly fil
tered.", | |
4004 "httpMethod": "GET", | |
4005 "id": "dfareporting.eventTags.list", | |
4006 "parameterOrder": [ | |
4007 "profileId" | |
4008 ], | |
4009 "parameters": { | |
4010 "adId": { | |
4011 "description": "Select only event tags that belong t
o this ad.", | |
4012 "format": "int64", | |
4013 "location": "query", | |
4014 "type": "string" | |
4015 }, | |
4016 "advertiserId": { | |
4017 "description": "Select only event tags that belong t
o this advertiser.", | |
4018 "format": "int64", | |
4019 "location": "query", | |
4020 "type": "string" | |
4021 }, | |
4022 "campaignId": { | |
4023 "description": "Select only event tags that belong t
o this campaign.", | |
4024 "format": "int64", | |
4025 "location": "query", | |
4026 "type": "string" | |
4027 }, | |
4028 "definitionsOnly": { | |
4029 "description": "Examine only the specified campaign
or advertiser's event tags for matching selector criteria. When set to false, th
e parent advertiser and parent campaign of the specified ad or campaign is exami
ned as well. In addition, when set to false, the status field is examined as wel
l, along with the enabledByDefault field. This parameter can not be set to true
when adId is specified as ads do not define their own even tags.", | |
4030 "location": "query", | |
4031 "type": "boolean" | |
4032 }, | |
4033 "enabled": { | |
4034 "description": "Select only enabled event tags. What
is considered enabled or disabled depends on the definitionsOnly parameter. Whe
n definitionsOnly is set to true, only the specified advertiser or campaign's ev
ent tags' enabledByDefault field is examined. When definitionsOnly is set to fal
se, the specified ad or specified campaign's parent advertiser's or parent campa
ign's event tags' enabledByDefault and status fields are examined as well.", | |
4035 "location": "query", | |
4036 "type": "boolean" | |
4037 }, | |
4038 "eventTagTypes": { | |
4039 "description": "Select only event tags with the spec
ified event tag types. Event tag types can be used to specify whether to use a t
hird-party pixel, a third-party JavaScript URL, or a third-party click-through U
RL for either impression or click tracking.", | |
4040 "enum": [ | |
4041 "CLICK_THROUGH_EVENT_TAG", | |
4042 "IMPRESSION_IMAGE_EVENT_TAG", | |
4043 "IMPRESSION_JAVASCRIPT_EVENT_TAG" | |
4044 ], | |
4045 "enumDescriptions": [ | |
4046 "", | |
4047 "", | |
4048 "" | |
4049 ], | |
4050 "location": "query", | |
4051 "repeated": true, | |
4052 "type": "string" | |
4053 }, | |
4054 "ids": { | |
4055 "description": "Select only event tags with these ID
s.", | |
4056 "format": "int64", | |
4057 "location": "query", | |
4058 "repeated": true, | |
4059 "type": "string" | |
4060 }, | |
4061 "profileId": { | |
4062 "description": "User profile ID associated with this
request.", | |
4063 "format": "int64", | |
4064 "location": "path", | |
4065 "required": true, | |
4066 "type": "string" | |
4067 }, | |
4068 "searchString": { | |
4069 "description": "Allows searching for objects by name
or ID. Wildcards (*) are allowed. For example, \"eventtag*2015\" will return ob
jects with names like \"eventtag June 2015\", \"eventtag April 2015\", or simply
\"eventtag 2015\". Most of the searches also add wildcards implicitly at the st
art and the end of the search string. For example, a search string of \"eventtag
\" will match objects with name \"my eventtag\", \"eventtag 2015\", or simply \"
eventtag\".", | |
4070 "location": "query", | |
4071 "type": "string" | |
4072 }, | |
4073 "sortField": { | |
4074 "description": "Field by which to sort the list.", | |
4075 "enum": [ | |
4076 "ID", | |
4077 "NAME" | |
4078 ], | |
4079 "enumDescriptions": [ | |
4080 "", | |
4081 "" | |
4082 ], | |
4083 "location": "query", | |
4084 "type": "string" | |
4085 }, | |
4086 "sortOrder": { | |
4087 "description": "Order of sorted results, default is
ASCENDING.", | |
4088 "enum": [ | |
4089 "ASCENDING", | |
4090 "DESCENDING" | |
4091 ], | |
4092 "enumDescriptions": [ | |
4093 "", | |
4094 "" | |
4095 ], | |
4096 "location": "query", | |
4097 "type": "string" | |
4098 } | |
4099 }, | |
4100 "path": "userprofiles/{profileId}/eventTags", | |
4101 "response": { | |
4102 "$ref": "EventTagsListResponse" | |
4103 }, | |
4104 "scopes": [ | |
4105 "https://www.googleapis.com/auth/dfatrafficking" | |
4106 ] | |
4107 }, | |
4108 "patch": { | |
4109 "description": "Updates an existing event tag. This method s
upports patch semantics.", | |
4110 "httpMethod": "PATCH", | |
4111 "id": "dfareporting.eventTags.patch", | |
4112 "parameterOrder": [ | |
4113 "profileId", | |
4114 "id" | |
4115 ], | |
4116 "parameters": { | |
4117 "id": { | |
4118 "description": "Event tag ID.", | |
4119 "format": "int64", | |
4120 "location": "query", | |
4121 "required": true, | |
4122 "type": "string" | |
4123 }, | |
4124 "profileId": { | |
4125 "description": "User profile ID associated with this
request.", | |
4126 "format": "int64", | |
4127 "location": "path", | |
4128 "required": true, | |
4129 "type": "string" | |
4130 } | |
4131 }, | |
4132 "path": "userprofiles/{profileId}/eventTags", | |
4133 "request": { | |
4134 "$ref": "EventTag" | |
4135 }, | |
4136 "response": { | |
4137 "$ref": "EventTag" | |
4138 }, | |
4139 "scopes": [ | |
4140 "https://www.googleapis.com/auth/dfatrafficking" | |
4141 ] | |
4142 }, | |
4143 "update": { | |
4144 "description": "Updates an existing event tag.", | |
4145 "httpMethod": "PUT", | |
4146 "id": "dfareporting.eventTags.update", | |
4147 "parameterOrder": [ | |
4148 "profileId" | |
4149 ], | |
4150 "parameters": { | |
4151 "profileId": { | |
4152 "description": "User profile ID associated with this
request.", | |
4153 "format": "int64", | |
4154 "location": "path", | |
4155 "required": true, | |
4156 "type": "string" | |
4157 } | |
4158 }, | |
4159 "path": "userprofiles/{profileId}/eventTags", | |
4160 "request": { | |
4161 "$ref": "EventTag" | |
4162 }, | |
4163 "response": { | |
4164 "$ref": "EventTag" | |
4165 }, | |
4166 "scopes": [ | |
4167 "https://www.googleapis.com/auth/dfatrafficking" | |
4168 ] | |
4169 } | |
4170 } | |
4171 }, | |
4172 "files": { | |
4173 "methods": { | |
4174 "get": { | |
4175 "description": "Retrieves a report file by its report ID and
file ID.", | |
4176 "httpMethod": "GET", | |
4177 "id": "dfareporting.files.get", | |
4178 "parameterOrder": [ | |
4179 "reportId", | |
4180 "fileId" | |
4181 ], | |
4182 "parameters": { | |
4183 "fileId": { | |
4184 "description": "The ID of the report file.", | |
4185 "format": "int64", | |
4186 "location": "path", | |
4187 "required": true, | |
4188 "type": "string" | |
4189 }, | |
4190 "reportId": { | |
4191 "description": "The ID of the report.", | |
4192 "format": "int64", | |
4193 "location": "path", | |
4194 "required": true, | |
4195 "type": "string" | |
4196 } | |
4197 }, | |
4198 "path": "reports/{reportId}/files/{fileId}", | |
4199 "response": { | |
4200 "$ref": "File" | |
4201 }, | |
4202 "scopes": [ | |
4203 "https://www.googleapis.com/auth/dfareporting" | |
4204 ], | |
4205 "supportsMediaDownload": true | |
4206 }, | |
4207 "list": { | |
4208 "description": "Lists files for a user profile.", | |
4209 "httpMethod": "GET", | |
4210 "id": "dfareporting.files.list", | |
4211 "parameterOrder": [ | |
4212 "profileId" | |
4213 ], | |
4214 "parameters": { | |
4215 "maxResults": { | |
4216 "description": "Maximum number of results to return.
", | |
4217 "format": "int32", | |
4218 "location": "query", | |
4219 "maximum": "10", | |
4220 "minimum": "0", | |
4221 "type": "integer" | |
4222 }, | |
4223 "pageToken": { | |
4224 "description": "The value of the nextToken from the
previous result page.", | |
4225 "location": "query", | |
4226 "type": "string" | |
4227 }, | |
4228 "profileId": { | |
4229 "description": "The DFA profile ID.", | |
4230 "format": "int64", | |
4231 "location": "path", | |
4232 "required": true, | |
4233 "type": "string" | |
4234 }, | |
4235 "scope": { | |
4236 "default": "MINE", | |
4237 "description": "The scope that defines which results
are returned, default is 'MINE'.", | |
4238 "enum": [ | |
4239 "ALL", | |
4240 "MINE", | |
4241 "SHARED_WITH_ME" | |
4242 ], | |
4243 "enumDescriptions": [ | |
4244 "All files in account.", | |
4245 "My files.", | |
4246 "Files shared with me." | |
4247 ], | |
4248 "location": "query", | |
4249 "type": "string" | |
4250 }, | |
4251 "sortField": { | |
4252 "default": "LAST_MODIFIED_TIME", | |
4253 "description": "The field by which to sort the list.
", | |
4254 "enum": [ | |
4255 "ID", | |
4256 "LAST_MODIFIED_TIME" | |
4257 ], | |
4258 "enumDescriptions": [ | |
4259 "Sort by file ID.", | |
4260 "Sort by 'lastmodifiedAt' field." | |
4261 ], | |
4262 "location": "query", | |
4263 "type": "string" | |
4264 }, | |
4265 "sortOrder": { | |
4266 "default": "DESCENDING", | |
4267 "description": "Order of sorted results, default is
'DESCENDING'.", | |
4268 "enum": [ | |
4269 "ASCENDING", | |
4270 "DESCENDING" | |
4271 ], | |
4272 "enumDescriptions": [ | |
4273 "Ascending order.", | |
4274 "Descending order." | |
4275 ], | |
4276 "location": "query", | |
4277 "type": "string" | |
4278 } | |
4279 }, | |
4280 "path": "userprofiles/{profileId}/files", | |
4281 "response": { | |
4282 "$ref": "FileList" | |
4283 }, | |
4284 "scopes": [ | |
4285 "https://www.googleapis.com/auth/dfareporting" | |
4286 ] | |
4287 } | |
4288 } | |
4289 }, | |
4290 "floodlightActivities": { | |
4291 "methods": { | |
4292 "delete": { | |
4293 "description": "Deletes an existing floodlight activity.", | |
4294 "httpMethod": "DELETE", | |
4295 "id": "dfareporting.floodlightActivities.delete", | |
4296 "parameterOrder": [ | |
4297 "profileId", | |
4298 "id" | |
4299 ], | |
4300 "parameters": { | |
4301 "id": { | |
4302 "description": "Floodlight activity ID.", | |
4303 "format": "int64", | |
4304 "location": "path", | |
4305 "required": true, | |
4306 "type": "string" | |
4307 }, | |
4308 "profileId": { | |
4309 "description": "User profile ID associated with this
request.", | |
4310 "format": "int64", | |
4311 "location": "path", | |
4312 "required": true, | |
4313 "type": "string" | |
4314 } | |
4315 }, | |
4316 "path": "userprofiles/{profileId}/floodlightActivities/{id}"
, | |
4317 "scopes": [ | |
4318 "https://www.googleapis.com/auth/dfatrafficking" | |
4319 ] | |
4320 }, | |
4321 "generatetag": { | |
4322 "description": "Generates a tag for a floodlight activity.", | |
4323 "httpMethod": "POST", | |
4324 "id": "dfareporting.floodlightActivities.generatetag", | |
4325 "parameterOrder": [ | |
4326 "profileId" | |
4327 ], | |
4328 "parameters": { | |
4329 "floodlightActivityId": { | |
4330 "description": "Floodlight activity ID for which we
want to generate a tag.", | |
4331 "format": "int64", | |
4332 "location": "query", | |
4333 "type": "string" | |
4334 }, | |
4335 "profileId": { | |
4336 "description": "User profile ID associated with this
request.", | |
4337 "format": "int64", | |
4338 "location": "path", | |
4339 "required": true, | |
4340 "type": "string" | |
4341 } | |
4342 }, | |
4343 "path": "userprofiles/{profileId}/floodlightActivities/gener
atetag", | |
4344 "response": { | |
4345 "$ref": "FloodlightActivitiesGenerateTagResponse" | |
4346 }, | |
4347 "scopes": [ | |
4348 "https://www.googleapis.com/auth/dfatrafficking" | |
4349 ] | |
4350 }, | |
4351 "get": { | |
4352 "description": "Gets one floodlight activity by ID.", | |
4353 "httpMethod": "GET", | |
4354 "id": "dfareporting.floodlightActivities.get", | |
4355 "parameterOrder": [ | |
4356 "profileId", | |
4357 "id" | |
4358 ], | |
4359 "parameters": { | |
4360 "id": { | |
4361 "description": "Floodlight activity ID.", | |
4362 "format": "int64", | |
4363 "location": "path", | |
4364 "required": true, | |
4365 "type": "string" | |
4366 }, | |
4367 "profileId": { | |
4368 "description": "User profile ID associated with this
request.", | |
4369 "format": "int64", | |
4370 "location": "path", | |
4371 "required": true, | |
4372 "type": "string" | |
4373 } | |
4374 }, | |
4375 "path": "userprofiles/{profileId}/floodlightActivities/{id}"
, | |
4376 "response": { | |
4377 "$ref": "FloodlightActivity" | |
4378 }, | |
4379 "scopes": [ | |
4380 "https://www.googleapis.com/auth/dfatrafficking" | |
4381 ] | |
4382 }, | |
4383 "insert": { | |
4384 "description": "Inserts a new floodlight activity.", | |
4385 "httpMethod": "POST", | |
4386 "id": "dfareporting.floodlightActivities.insert", | |
4387 "parameterOrder": [ | |
4388 "profileId" | |
4389 ], | |
4390 "parameters": { | |
4391 "profileId": { | |
4392 "description": "User profile ID associated with this
request.", | |
4393 "format": "int64", | |
4394 "location": "path", | |
4395 "required": true, | |
4396 "type": "string" | |
4397 } | |
4398 }, | |
4399 "path": "userprofiles/{profileId}/floodlightActivities", | |
4400 "request": { | |
4401 "$ref": "FloodlightActivity" | |
4402 }, | |
4403 "response": { | |
4404 "$ref": "FloodlightActivity" | |
4405 }, | |
4406 "scopes": [ | |
4407 "https://www.googleapis.com/auth/dfatrafficking" | |
4408 ] | |
4409 }, | |
4410 "list": { | |
4411 "description": "Retrieves a list of floodlight activities, p
ossibly filtered.", | |
4412 "httpMethod": "GET", | |
4413 "id": "dfareporting.floodlightActivities.list", | |
4414 "parameterOrder": [ | |
4415 "profileId" | |
4416 ], | |
4417 "parameters": { | |
4418 "advertiserId": { | |
4419 "description": "Select only floodlight activities fo
r the specified advertiser ID. Must specify either ids, advertiserId, or floodli
ghtConfigurationId for a non-empty result.", | |
4420 "format": "int64", | |
4421 "location": "query", | |
4422 "type": "string" | |
4423 }, | |
4424 "floodlightActivityGroupIds": { | |
4425 "description": "Select only floodlight activities wi
th the specified floodlight activity group IDs.", | |
4426 "format": "int64", | |
4427 "location": "query", | |
4428 "repeated": true, | |
4429 "type": "string" | |
4430 }, | |
4431 "floodlightActivityGroupName": { | |
4432 "description": "Select only floodlight activities wi
th the specified floodlight activity group name.", | |
4433 "location": "query", | |
4434 "type": "string" | |
4435 }, | |
4436 "floodlightActivityGroupTagString": { | |
4437 "description": "Select only floodlight activities wi
th the specified floodlight activity group tag string.", | |
4438 "location": "query", | |
4439 "type": "string" | |
4440 }, | |
4441 "floodlightActivityGroupType": { | |
4442 "description": "Select only floodlight activities wi
th the specified floodlight activity group type.", | |
4443 "enum": [ | |
4444 "COUNTER", | |
4445 "SALE" | |
4446 ], | |
4447 "enumDescriptions": [ | |
4448 "", | |
4449 "" | |
4450 ], | |
4451 "location": "query", | |
4452 "type": "string" | |
4453 }, | |
4454 "floodlightConfigurationId": { | |
4455 "description": "Select only floodlight activities fo
r the specified floodlight configuration ID. Must specify either ids, advertiser
Id, or floodlightConfigurationId for a non-empty result.", | |
4456 "format": "int64", | |
4457 "location": "query", | |
4458 "type": "string" | |
4459 }, | |
4460 "ids": { | |
4461 "description": "Select only floodlight activities wi
th the specified IDs. Must specify either ids, advertiserId, or floodlightConfig
urationId for a non-empty result.", | |
4462 "format": "int64", | |
4463 "location": "query", | |
4464 "repeated": true, | |
4465 "type": "string" | |
4466 }, | |
4467 "maxResults": { | |
4468 "description": "Maximum number of results to return.
", | |
4469 "format": "int32", | |
4470 "location": "query", | |
4471 "type": "integer" | |
4472 }, | |
4473 "pageToken": { | |
4474 "description": "Value of the nextPageToken from the
previous result page.", | |
4475 "location": "query", | |
4476 "type": "string" | |
4477 }, | |
4478 "profileId": { | |
4479 "description": "User profile ID associated with this
request.", | |
4480 "format": "int64", | |
4481 "location": "path", | |
4482 "required": true, | |
4483 "type": "string" | |
4484 }, | |
4485 "searchString": { | |
4486 "description": "Allows searching for objects by name
or ID. Wildcards (*) are allowed. For example, \"floodlightactivity*2015\" will
return objects with names like \"floodlightactivity June 2015\", \"floodlightac
tivity April 2015\", or simply \"floodlightactivity 2015\". Most of the searches
also add wildcards implicitly at the start and the end of the search string. Fo
r example, a search string of \"floodlightactivity\" will match objects with nam
e \"my floodlightactivity activity\", \"floodlightactivity 2015\", or simply \"f
loodlightactivity\".", | |
4487 "location": "query", | |
4488 "type": "string" | |
4489 }, | |
4490 "sortField": { | |
4491 "description": "Field by which to sort the list.", | |
4492 "enum": [ | |
4493 "ID", | |
4494 "NAME" | |
4495 ], | |
4496 "enumDescriptions": [ | |
4497 "", | |
4498 "" | |
4499 ], | |
4500 "location": "query", | |
4501 "type": "string" | |
4502 }, | |
4503 "sortOrder": { | |
4504 "description": "Order of sorted results, default is
ASCENDING.", | |
4505 "enum": [ | |
4506 "ASCENDING", | |
4507 "DESCENDING" | |
4508 ], | |
4509 "enumDescriptions": [ | |
4510 "", | |
4511 "" | |
4512 ], | |
4513 "location": "query", | |
4514 "type": "string" | |
4515 }, | |
4516 "tagString": { | |
4517 "description": "Select only floodlight activities wi
th the specified tag string.", | |
4518 "location": "query", | |
4519 "type": "string" | |
4520 } | |
4521 }, | |
4522 "path": "userprofiles/{profileId}/floodlightActivities", | |
4523 "response": { | |
4524 "$ref": "FloodlightActivitiesListResponse" | |
4525 }, | |
4526 "scopes": [ | |
4527 "https://www.googleapis.com/auth/dfatrafficking" | |
4528 ] | |
4529 }, | |
4530 "patch": { | |
4531 "description": "Updates an existing floodlight activity. Thi
s method supports patch semantics.", | |
4532 "httpMethod": "PATCH", | |
4533 "id": "dfareporting.floodlightActivities.patch", | |
4534 "parameterOrder": [ | |
4535 "profileId", | |
4536 "id" | |
4537 ], | |
4538 "parameters": { | |
4539 "id": { | |
4540 "description": "Floodlight activity ID.", | |
4541 "format": "int64", | |
4542 "location": "query", | |
4543 "required": true, | |
4544 "type": "string" | |
4545 }, | |
4546 "profileId": { | |
4547 "description": "User profile ID associated with this
request.", | |
4548 "format": "int64", | |
4549 "location": "path", | |
4550 "required": true, | |
4551 "type": "string" | |
4552 } | |
4553 }, | |
4554 "path": "userprofiles/{profileId}/floodlightActivities", | |
4555 "request": { | |
4556 "$ref": "FloodlightActivity" | |
4557 }, | |
4558 "response": { | |
4559 "$ref": "FloodlightActivity" | |
4560 }, | |
4561 "scopes": [ | |
4562 "https://www.googleapis.com/auth/dfatrafficking" | |
4563 ] | |
4564 }, | |
4565 "update": { | |
4566 "description": "Updates an existing floodlight activity.", | |
4567 "httpMethod": "PUT", | |
4568 "id": "dfareporting.floodlightActivities.update", | |
4569 "parameterOrder": [ | |
4570 "profileId" | |
4571 ], | |
4572 "parameters": { | |
4573 "profileId": { | |
4574 "description": "User profile ID associated with this
request.", | |
4575 "format": "int64", | |
4576 "location": "path", | |
4577 "required": true, | |
4578 "type": "string" | |
4579 } | |
4580 }, | |
4581 "path": "userprofiles/{profileId}/floodlightActivities", | |
4582 "request": { | |
4583 "$ref": "FloodlightActivity" | |
4584 }, | |
4585 "response": { | |
4586 "$ref": "FloodlightActivity" | |
4587 }, | |
4588 "scopes": [ | |
4589 "https://www.googleapis.com/auth/dfatrafficking" | |
4590 ] | |
4591 } | |
4592 } | |
4593 }, | |
4594 "floodlightActivityGroups": { | |
4595 "methods": { | |
4596 "delete": { | |
4597 "description": "Deletes an existing floodlight activity grou
p.", | |
4598 "httpMethod": "DELETE", | |
4599 "id": "dfareporting.floodlightActivityGroups.delete", | |
4600 "parameterOrder": [ | |
4601 "profileId", | |
4602 "id" | |
4603 ], | |
4604 "parameters": { | |
4605 "id": { | |
4606 "description": "Floodlight activity Group ID.", | |
4607 "format": "int64", | |
4608 "location": "path", | |
4609 "required": true, | |
4610 "type": "string" | |
4611 }, | |
4612 "profileId": { | |
4613 "description": "User profile ID associated with this
request.", | |
4614 "format": "int64", | |
4615 "location": "path", | |
4616 "required": true, | |
4617 "type": "string" | |
4618 } | |
4619 }, | |
4620 "path": "userprofiles/{profileId}/floodlightActivityGroups/{
id}", | |
4621 "scopes": [ | |
4622 "https://www.googleapis.com/auth/dfatrafficking" | |
4623 ] | |
4624 }, | |
4625 "get": { | |
4626 "description": "Gets one floodlight activity group by ID.", | |
4627 "httpMethod": "GET", | |
4628 "id": "dfareporting.floodlightActivityGroups.get", | |
4629 "parameterOrder": [ | |
4630 "profileId", | |
4631 "id" | |
4632 ], | |
4633 "parameters": { | |
4634 "id": { | |
4635 "description": "Floodlight activity Group ID.", | |
4636 "format": "int64", | |
4637 "location": "path", | |
4638 "required": true, | |
4639 "type": "string" | |
4640 }, | |
4641 "profileId": { | |
4642 "description": "User profile ID associated with this
request.", | |
4643 "format": "int64", | |
4644 "location": "path", | |
4645 "required": true, | |
4646 "type": "string" | |
4647 } | |
4648 }, | |
4649 "path": "userprofiles/{profileId}/floodlightActivityGroups/{
id}", | |
4650 "response": { | |
4651 "$ref": "FloodlightActivityGroup" | |
4652 }, | |
4653 "scopes": [ | |
4654 "https://www.googleapis.com/auth/dfatrafficking" | |
4655 ] | |
4656 }, | |
4657 "insert": { | |
4658 "description": "Inserts a new floodlight activity group.", | |
4659 "httpMethod": "POST", | |
4660 "id": "dfareporting.floodlightActivityGroups.insert", | |
4661 "parameterOrder": [ | |
4662 "profileId" | |
4663 ], | |
4664 "parameters": { | |
4665 "profileId": { | |
4666 "description": "User profile ID associated with this
request.", | |
4667 "format": "int64", | |
4668 "location": "path", | |
4669 "required": true, | |
4670 "type": "string" | |
4671 } | |
4672 }, | |
4673 "path": "userprofiles/{profileId}/floodlightActivityGroups", | |
4674 "request": { | |
4675 "$ref": "FloodlightActivityGroup" | |
4676 }, | |
4677 "response": { | |
4678 "$ref": "FloodlightActivityGroup" | |
4679 }, | |
4680 "scopes": [ | |
4681 "https://www.googleapis.com/auth/dfatrafficking" | |
4682 ] | |
4683 }, | |
4684 "list": { | |
4685 "description": "Retrieves a list of floodlight activity grou
ps, possibly filtered.", | |
4686 "httpMethod": "GET", | |
4687 "id": "dfareporting.floodlightActivityGroups.list", | |
4688 "parameterOrder": [ | |
4689 "profileId" | |
4690 ], | |
4691 "parameters": { | |
4692 "advertiserId": { | |
4693 "description": "Select only floodlight activity grou
ps with the specified advertiser ID. Must specify either advertiserId or floodli
ghtConfigurationId for a non-empty result.", | |
4694 "format": "int64", | |
4695 "location": "query", | |
4696 "type": "string" | |
4697 }, | |
4698 "floodlightConfigurationId": { | |
4699 "description": "Select only floodlight activity grou
ps with the specified floodlight configuration ID. Must specify either advertise
rId, or floodlightConfigurationId for a non-empty result.", | |
4700 "format": "int64", | |
4701 "location": "query", | |
4702 "type": "string" | |
4703 }, | |
4704 "ids": { | |
4705 "description": "Select only floodlight activity grou
ps with the specified IDs. Must specify either advertiserId or floodlightConfigu
rationId for a non-empty result.", | |
4706 "format": "int64", | |
4707 "location": "query", | |
4708 "repeated": true, | |
4709 "type": "string" | |
4710 }, | |
4711 "maxResults": { | |
4712 "description": "Maximum number of results to return.
", | |
4713 "format": "int32", | |
4714 "location": "query", | |
4715 "type": "integer" | |
4716 }, | |
4717 "pageToken": { | |
4718 "description": "Value of the nextPageToken from the
previous result page.", | |
4719 "location": "query", | |
4720 "type": "string" | |
4721 }, | |
4722 "profileId": { | |
4723 "description": "User profile ID associated with this
request.", | |
4724 "format": "int64", | |
4725 "location": "path", | |
4726 "required": true, | |
4727 "type": "string" | |
4728 }, | |
4729 "searchString": { | |
4730 "description": "Allows searching for objects by name
or ID. Wildcards (*) are allowed. For example, \"floodlightactivitygroup*2015\"
will return objects with names like \"floodlightactivitygroup June 2015\", \"fl
oodlightactivitygroup April 2015\", or simply \"floodlightactivitygroup 2015\".
Most of the searches also add wildcards implicitly at the start and the end of t
he search string. For example, a search string of \"floodlightactivitygroup\" wi
ll match objects with name \"my floodlightactivitygroup activity\", \"floodlight
activitygroup 2015\", or simply \"floodlightactivitygroup\".", | |
4731 "location": "query", | |
4732 "type": "string" | |
4733 }, | |
4734 "sortField": { | |
4735 "description": "Field by which to sort the list.", | |
4736 "enum": [ | |
4737 "ID", | |
4738 "NAME" | |
4739 ], | |
4740 "enumDescriptions": [ | |
4741 "", | |
4742 "" | |
4743 ], | |
4744 "location": "query", | |
4745 "type": "string" | |
4746 }, | |
4747 "sortOrder": { | |
4748 "description": "Order of sorted results, default is
ASCENDING.", | |
4749 "enum": [ | |
4750 "ASCENDING", | |
4751 "DESCENDING" | |
4752 ], | |
4753 "enumDescriptions": [ | |
4754 "", | |
4755 "" | |
4756 ], | |
4757 "location": "query", | |
4758 "type": "string" | |
4759 }, | |
4760 "type": { | |
4761 "description": "Select only floodlight activity grou
ps with the specified floodlight activity group type.", | |
4762 "enum": [ | |
4763 "COUNTER", | |
4764 "SALE" | |
4765 ], | |
4766 "enumDescriptions": [ | |
4767 "", | |
4768 "" | |
4769 ], | |
4770 "location": "query", | |
4771 "type": "string" | |
4772 } | |
4773 }, | |
4774 "path": "userprofiles/{profileId}/floodlightActivityGroups", | |
4775 "response": { | |
4776 "$ref": "FloodlightActivityGroupsListResponse" | |
4777 }, | |
4778 "scopes": [ | |
4779 "https://www.googleapis.com/auth/dfatrafficking" | |
4780 ] | |
4781 }, | |
4782 "patch": { | |
4783 "description": "Updates an existing floodlight activity grou
p. This method supports patch semantics.", | |
4784 "httpMethod": "PATCH", | |
4785 "id": "dfareporting.floodlightActivityGroups.patch", | |
4786 "parameterOrder": [ | |
4787 "profileId", | |
4788 "id" | |
4789 ], | |
4790 "parameters": { | |
4791 "id": { | |
4792 "description": "Floodlight activity Group ID.", | |
4793 "format": "int64", | |
4794 "location": "query", | |
4795 "required": true, | |
4796 "type": "string" | |
4797 }, | |
4798 "profileId": { | |
4799 "description": "User profile ID associated with this
request.", | |
4800 "format": "int64", | |
4801 "location": "path", | |
4802 "required": true, | |
4803 "type": "string" | |
4804 } | |
4805 }, | |
4806 "path": "userprofiles/{profileId}/floodlightActivityGroups", | |
4807 "request": { | |
4808 "$ref": "FloodlightActivityGroup" | |
4809 }, | |
4810 "response": { | |
4811 "$ref": "FloodlightActivityGroup" | |
4812 }, | |
4813 "scopes": [ | |
4814 "https://www.googleapis.com/auth/dfatrafficking" | |
4815 ] | |
4816 }, | |
4817 "update": { | |
4818 "description": "Updates an existing floodlight activity grou
p.", | |
4819 "httpMethod": "PUT", | |
4820 "id": "dfareporting.floodlightActivityGroups.update", | |
4821 "parameterOrder": [ | |
4822 "profileId" | |
4823 ], | |
4824 "parameters": { | |
4825 "profileId": { | |
4826 "description": "User profile ID associated with this
request.", | |
4827 "format": "int64", | |
4828 "location": "path", | |
4829 "required": true, | |
4830 "type": "string" | |
4831 } | |
4832 }, | |
4833 "path": "userprofiles/{profileId}/floodlightActivityGroups", | |
4834 "request": { | |
4835 "$ref": "FloodlightActivityGroup" | |
4836 }, | |
4837 "response": { | |
4838 "$ref": "FloodlightActivityGroup" | |
4839 }, | |
4840 "scopes": [ | |
4841 "https://www.googleapis.com/auth/dfatrafficking" | |
4842 ] | |
4843 } | |
4844 } | |
4845 }, | |
4846 "floodlightConfigurations": { | |
4847 "methods": { | |
4848 "get": { | |
4849 "description": "Gets one floodlight configuration by ID.", | |
4850 "httpMethod": "GET", | |
4851 "id": "dfareporting.floodlightConfigurations.get", | |
4852 "parameterOrder": [ | |
4853 "profileId", | |
4854 "id" | |
4855 ], | |
4856 "parameters": { | |
4857 "id": { | |
4858 "description": "Floodlight configuration ID.", | |
4859 "format": "int64", | |
4860 "location": "path", | |
4861 "required": true, | |
4862 "type": "string" | |
4863 }, | |
4864 "profileId": { | |
4865 "description": "User profile ID associated with this
request.", | |
4866 "format": "int64", | |
4867 "location": "path", | |
4868 "required": true, | |
4869 "type": "string" | |
4870 } | |
4871 }, | |
4872 "path": "userprofiles/{profileId}/floodlightConfigurations/{
id}", | |
4873 "response": { | |
4874 "$ref": "FloodlightConfiguration" | |
4875 }, | |
4876 "scopes": [ | |
4877 "https://www.googleapis.com/auth/dfatrafficking" | |
4878 ] | |
4879 }, | |
4880 "list": { | |
4881 "description": "Retrieves a list of floodlight configuration
s, possibly filtered.", | |
4882 "httpMethod": "GET", | |
4883 "id": "dfareporting.floodlightConfigurations.list", | |
4884 "parameterOrder": [ | |
4885 "profileId" | |
4886 ], | |
4887 "parameters": { | |
4888 "ids": { | |
4889 "description": "Set of IDs of floodlight configurati
ons to retrieve. Required field; otherwise an empty list will be returned.", | |
4890 "format": "int64", | |
4891 "location": "query", | |
4892 "repeated": true, | |
4893 "type": "string" | |
4894 }, | |
4895 "profileId": { | |
4896 "description": "User profile ID associated with this
request.", | |
4897 "format": "int64", | |
4898 "location": "path", | |
4899 "required": true, | |
4900 "type": "string" | |
4901 } | |
4902 }, | |
4903 "path": "userprofiles/{profileId}/floodlightConfigurations", | |
4904 "response": { | |
4905 "$ref": "FloodlightConfigurationsListResponse" | |
4906 }, | |
4907 "scopes": [ | |
4908 "https://www.googleapis.com/auth/dfatrafficking" | |
4909 ] | |
4910 }, | |
4911 "patch": { | |
4912 "description": "Updates an existing floodlight configuration
. This method supports patch semantics.", | |
4913 "httpMethod": "PATCH", | |
4914 "id": "dfareporting.floodlightConfigurations.patch", | |
4915 "parameterOrder": [ | |
4916 "profileId", | |
4917 "id" | |
4918 ], | |
4919 "parameters": { | |
4920 "id": { | |
4921 "description": "Floodlight configuration ID.", | |
4922 "format": "int64", | |
4923 "location": "query", | |
4924 "required": true, | |
4925 "type": "string" | |
4926 }, | |
4927 "profileId": { | |
4928 "description": "User profile ID associated with this
request.", | |
4929 "format": "int64", | |
4930 "location": "path", | |
4931 "required": true, | |
4932 "type": "string" | |
4933 } | |
4934 }, | |
4935 "path": "userprofiles/{profileId}/floodlightConfigurations", | |
4936 "request": { | |
4937 "$ref": "FloodlightConfiguration" | |
4938 }, | |
4939 "response": { | |
4940 "$ref": "FloodlightConfiguration" | |
4941 }, | |
4942 "scopes": [ | |
4943 "https://www.googleapis.com/auth/dfatrafficking" | |
4944 ] | |
4945 }, | |
4946 "update": { | |
4947 "description": "Updates an existing floodlight configuration
.", | |
4948 "httpMethod": "PUT", | |
4949 "id": "dfareporting.floodlightConfigurations.update", | |
4950 "parameterOrder": [ | |
4951 "profileId" | |
4952 ], | |
4953 "parameters": { | |
4954 "profileId": { | |
4955 "description": "User profile ID associated with this
request.", | |
4956 "format": "int64", | |
4957 "location": "path", | |
4958 "required": true, | |
4959 "type": "string" | |
4960 } | |
4961 }, | |
4962 "path": "userprofiles/{profileId}/floodlightConfigurations", | |
4963 "request": { | |
4964 "$ref": "FloodlightConfiguration" | |
4965 }, | |
4966 "response": { | |
4967 "$ref": "FloodlightConfiguration" | |
4968 }, | |
4969 "scopes": [ | |
4970 "https://www.googleapis.com/auth/dfatrafficking" | |
4971 ] | |
4972 } | |
4973 } | |
4974 }, | |
4975 "inventoryItems": { | |
4976 "methods": { | |
4977 "get": { | |
4978 "description": "Gets one inventory item by ID.", | |
4979 "httpMethod": "GET", | |
4980 "id": "dfareporting.inventoryItems.get", | |
4981 "parameterOrder": [ | |
4982 "profileId", | |
4983 "projectId", | |
4984 "id" | |
4985 ], | |
4986 "parameters": { | |
4987 "id": { | |
4988 "description": "Inventory item ID.", | |
4989 "format": "int64", | |
4990 "location": "path", | |
4991 "required": true, | |
4992 "type": "string" | |
4993 }, | |
4994 "profileId": { | |
4995 "description": "User profile ID associated with this
request.", | |
4996 "format": "int64", | |
4997 "location": "path", | |
4998 "required": true, | |
4999 "type": "string" | |
5000 }, | |
5001 "projectId": { | |
5002 "description": "Project ID for order documents.", | |
5003 "format": "int64", | |
5004 "location": "path", | |
5005 "required": true, | |
5006 "type": "string" | |
5007 } | |
5008 }, | |
5009 "path": "userprofiles/{profileId}/projects/{projectId}/inven
toryItems/{id}", | |
5010 "response": { | |
5011 "$ref": "InventoryItem" | |
5012 }, | |
5013 "scopes": [ | |
5014 "https://www.googleapis.com/auth/dfatrafficking" | |
5015 ] | |
5016 }, | |
5017 "list": { | |
5018 "description": "Retrieves a list of inventory items, possibl
y filtered.", | |
5019 "httpMethod": "GET", | |
5020 "id": "dfareporting.inventoryItems.list", | |
5021 "parameterOrder": [ | |
5022 "profileId", | |
5023 "projectId" | |
5024 ], | |
5025 "parameters": { | |
5026 "ids": { | |
5027 "description": "Select only inventory items with the
se IDs.", | |
5028 "format": "int64", | |
5029 "location": "query", | |
5030 "repeated": true, | |
5031 "type": "string" | |
5032 }, | |
5033 "inPlan": { | |
5034 "description": "Select only inventory items that are
in plan.", | |
5035 "location": "query", | |
5036 "type": "boolean" | |
5037 }, | |
5038 "maxResults": { | |
5039 "description": "Maximum number of results to return.
", | |
5040 "format": "int32", | |
5041 "location": "query", | |
5042 "type": "integer" | |
5043 }, | |
5044 "orderId": { | |
5045 "description": "Select only inventory items that bel
ong to specified orders.", | |
5046 "format": "int64", | |
5047 "location": "query", | |
5048 "repeated": true, | |
5049 "type": "string" | |
5050 }, | |
5051 "pageToken": { | |
5052 "description": "Value of the nextPageToken from the
previous result page.", | |
5053 "location": "query", | |
5054 "type": "string" | |
5055 }, | |
5056 "profileId": { | |
5057 "description": "User profile ID associated with this
request.", | |
5058 "format": "int64", | |
5059 "location": "path", | |
5060 "required": true, | |
5061 "type": "string" | |
5062 }, | |
5063 "projectId": { | |
5064 "description": "Project ID for order documents.", | |
5065 "format": "int64", | |
5066 "location": "path", | |
5067 "required": true, | |
5068 "type": "string" | |
5069 }, | |
5070 "siteId": { | |
5071 "description": "Select only inventory items that are
associated with these sites.", | |
5072 "format": "int64", | |
5073 "location": "query", | |
5074 "repeated": true, | |
5075 "type": "string" | |
5076 }, | |
5077 "sortField": { | |
5078 "description": "Field by which to sort the list.", | |
5079 "enum": [ | |
5080 "ID", | |
5081 "NAME" | |
5082 ], | |
5083 "enumDescriptions": [ | |
5084 "", | |
5085 "" | |
5086 ], | |
5087 "location": "query", | |
5088 "type": "string" | |
5089 }, | |
5090 "sortOrder": { | |
5091 "description": "Order of sorted results, default is
ASCENDING.", | |
5092 "enum": [ | |
5093 "ASCENDING", | |
5094 "DESCENDING" | |
5095 ], | |
5096 "enumDescriptions": [ | |
5097 "", | |
5098 "" | |
5099 ], | |
5100 "location": "query", | |
5101 "type": "string" | |
5102 } | |
5103 }, | |
5104 "path": "userprofiles/{profileId}/projects/{projectId}/inven
toryItems", | |
5105 "response": { | |
5106 "$ref": "InventoryItemsListResponse" | |
5107 }, | |
5108 "scopes": [ | |
5109 "https://www.googleapis.com/auth/dfatrafficking" | |
5110 ] | |
5111 } | |
5112 } | |
5113 }, | |
5114 "landingPages": { | |
5115 "methods": { | |
5116 "delete": { | |
5117 "description": "Deletes an existing campaign landing page.", | |
5118 "httpMethod": "DELETE", | |
5119 "id": "dfareporting.landingPages.delete", | |
5120 "parameterOrder": [ | |
5121 "profileId", | |
5122 "campaignId", | |
5123 "id" | |
5124 ], | |
5125 "parameters": { | |
5126 "campaignId": { | |
5127 "description": "Landing page campaign ID.", | |
5128 "format": "int64", | |
5129 "location": "path", | |
5130 "required": true, | |
5131 "type": "string" | |
5132 }, | |
5133 "id": { | |
5134 "description": "Landing page ID.", | |
5135 "format": "int64", | |
5136 "location": "path", | |
5137 "required": true, | |
5138 "type": "string" | |
5139 }, | |
5140 "profileId": { | |
5141 "description": "User profile ID associated with this
request.", | |
5142 "format": "int64", | |
5143 "location": "path", | |
5144 "required": true, | |
5145 "type": "string" | |
5146 } | |
5147 }, | |
5148 "path": "userprofiles/{profileId}/campaigns/{campaignId}/lan
dingPages/{id}", | |
5149 "scopes": [ | |
5150 "https://www.googleapis.com/auth/dfatrafficking" | |
5151 ] | |
5152 }, | |
5153 "get": { | |
5154 "description": "Gets one campaign landing page by ID.", | |
5155 "httpMethod": "GET", | |
5156 "id": "dfareporting.landingPages.get", | |
5157 "parameterOrder": [ | |
5158 "profileId", | |
5159 "campaignId", | |
5160 "id" | |
5161 ], | |
5162 "parameters": { | |
5163 "campaignId": { | |
5164 "description": "Landing page campaign ID.", | |
5165 "format": "int64", | |
5166 "location": "path", | |
5167 "required": true, | |
5168 "type": "string" | |
5169 }, | |
5170 "id": { | |
5171 "description": "Landing page ID.", | |
5172 "format": "int64", | |
5173 "location": "path", | |
5174 "required": true, | |
5175 "type": "string" | |
5176 }, | |
5177 "profileId": { | |
5178 "description": "User profile ID associated with this
request.", | |
5179 "format": "int64", | |
5180 "location": "path", | |
5181 "required": true, | |
5182 "type": "string" | |
5183 } | |
5184 }, | |
5185 "path": "userprofiles/{profileId}/campaigns/{campaignId}/lan
dingPages/{id}", | |
5186 "response": { | |
5187 "$ref": "LandingPage" | |
5188 }, | |
5189 "scopes": [ | |
5190 "https://www.googleapis.com/auth/dfatrafficking" | |
5191 ] | |
5192 }, | |
5193 "insert": { | |
5194 "description": "Inserts a new landing page for the specified
campaign.", | |
5195 "httpMethod": "POST", | |
5196 "id": "dfareporting.landingPages.insert", | |
5197 "parameterOrder": [ | |
5198 "profileId", | |
5199 "campaignId" | |
5200 ], | |
5201 "parameters": { | |
5202 "campaignId": { | |
5203 "description": "Landing page campaign ID.", | |
5204 "format": "int64", | |
5205 "location": "path", | |
5206 "required": true, | |
5207 "type": "string" | |
5208 }, | |
5209 "profileId": { | |
5210 "description": "User profile ID associated with this
request.", | |
5211 "format": "int64", | |
5212 "location": "path", | |
5213 "required": true, | |
5214 "type": "string" | |
5215 } | |
5216 }, | |
5217 "path": "userprofiles/{profileId}/campaigns/{campaignId}/lan
dingPages", | |
5218 "request": { | |
5219 "$ref": "LandingPage" | |
5220 }, | |
5221 "response": { | |
5222 "$ref": "LandingPage" | |
5223 }, | |
5224 "scopes": [ | |
5225 "https://www.googleapis.com/auth/dfatrafficking" | |
5226 ] | |
5227 }, | |
5228 "list": { | |
5229 "description": "Retrieves the list of landing pages for the
specified campaign.", | |
5230 "httpMethod": "GET", | |
5231 "id": "dfareporting.landingPages.list", | |
5232 "parameterOrder": [ | |
5233 "profileId", | |
5234 "campaignId" | |
5235 ], | |
5236 "parameters": { | |
5237 "campaignId": { | |
5238 "description": "Landing page campaign ID.", | |
5239 "format": "int64", | |
5240 "location": "path", | |
5241 "required": true, | |
5242 "type": "string" | |
5243 }, | |
5244 "profileId": { | |
5245 "description": "User profile ID associated with this
request.", | |
5246 "format": "int64", | |
5247 "location": "path", | |
5248 "required": true, | |
5249 "type": "string" | |
5250 } | |
5251 }, | |
5252 "path": "userprofiles/{profileId}/campaigns/{campaignId}/lan
dingPages", | |
5253 "response": { | |
5254 "$ref": "LandingPagesListResponse" | |
5255 }, | |
5256 "scopes": [ | |
5257 "https://www.googleapis.com/auth/dfatrafficking" | |
5258 ] | |
5259 }, | |
5260 "patch": { | |
5261 "description": "Updates an existing campaign landing page. T
his method supports patch semantics.", | |
5262 "httpMethod": "PATCH", | |
5263 "id": "dfareporting.landingPages.patch", | |
5264 "parameterOrder": [ | |
5265 "profileId", | |
5266 "campaignId", | |
5267 "id" | |
5268 ], | |
5269 "parameters": { | |
5270 "campaignId": { | |
5271 "description": "Landing page campaign ID.", | |
5272 "format": "int64", | |
5273 "location": "path", | |
5274 "required": true, | |
5275 "type": "string" | |
5276 }, | |
5277 "id": { | |
5278 "description": "Landing page ID.", | |
5279 "format": "int64", | |
5280 "location": "query", | |
5281 "required": true, | |
5282 "type": "string" | |
5283 }, | |
5284 "profileId": { | |
5285 "description": "User profile ID associated with this
request.", | |
5286 "format": "int64", | |
5287 "location": "path", | |
5288 "required": true, | |
5289 "type": "string" | |
5290 } | |
5291 }, | |
5292 "path": "userprofiles/{profileId}/campaigns/{campaignId}/lan
dingPages", | |
5293 "request": { | |
5294 "$ref": "LandingPage" | |
5295 }, | |
5296 "response": { | |
5297 "$ref": "LandingPage" | |
5298 }, | |
5299 "scopes": [ | |
5300 "https://www.googleapis.com/auth/dfatrafficking" | |
5301 ] | |
5302 }, | |
5303 "update": { | |
5304 "description": "Updates an existing campaign landing page.", | |
5305 "httpMethod": "PUT", | |
5306 "id": "dfareporting.landingPages.update", | |
5307 "parameterOrder": [ | |
5308 "profileId", | |
5309 "campaignId" | |
5310 ], | |
5311 "parameters": { | |
5312 "campaignId": { | |
5313 "description": "Landing page campaign ID.", | |
5314 "format": "int64", | |
5315 "location": "path", | |
5316 "required": true, | |
5317 "type": "string" | |
5318 }, | |
5319 "profileId": { | |
5320 "description": "User profile ID associated with this
request.", | |
5321 "format": "int64", | |
5322 "location": "path", | |
5323 "required": true, | |
5324 "type": "string" | |
5325 } | |
5326 }, | |
5327 "path": "userprofiles/{profileId}/campaigns/{campaignId}/lan
dingPages", | |
5328 "request": { | |
5329 "$ref": "LandingPage" | |
5330 }, | |
5331 "response": { | |
5332 "$ref": "LandingPage" | |
5333 }, | |
5334 "scopes": [ | |
5335 "https://www.googleapis.com/auth/dfatrafficking" | |
5336 ] | |
5337 } | |
5338 } | |
5339 }, | |
5340 "metros": { | |
5341 "methods": { | |
5342 "list": { | |
5343 "description": "Retrieves a list of metros.", | |
5344 "httpMethod": "GET", | |
5345 "id": "dfareporting.metros.list", | |
5346 "parameterOrder": [ | |
5347 "profileId" | |
5348 ], | |
5349 "parameters": { | |
5350 "profileId": { | |
5351 "description": "User profile ID associated with this
request.", | |
5352 "format": "int64", | |
5353 "location": "path", | |
5354 "required": true, | |
5355 "type": "string" | |
5356 } | |
5357 }, | |
5358 "path": "userprofiles/{profileId}/metros", | |
5359 "response": { | |
5360 "$ref": "MetrosListResponse" | |
5361 }, | |
5362 "scopes": [ | |
5363 "https://www.googleapis.com/auth/dfatrafficking" | |
5364 ] | |
5365 } | |
5366 } | |
5367 }, | |
5368 "mobileCarriers": { | |
5369 "methods": { | |
5370 "get": { | |
5371 "description": "Gets one mobile carrier by ID.", | |
5372 "httpMethod": "GET", | |
5373 "id": "dfareporting.mobileCarriers.get", | |
5374 "parameterOrder": [ | |
5375 "profileId", | |
5376 "id" | |
5377 ], | |
5378 "parameters": { | |
5379 "id": { | |
5380 "description": "Mobile carrier ID.", | |
5381 "format": "int64", | |
5382 "location": "path", | |
5383 "required": true, | |
5384 "type": "string" | |
5385 }, | |
5386 "profileId": { | |
5387 "description": "User profile ID associated with this
request.", | |
5388 "format": "int64", | |
5389 "location": "path", | |
5390 "required": true, | |
5391 "type": "string" | |
5392 } | |
5393 }, | |
5394 "path": "userprofiles/{profileId}/mobileCarriers/{id}", | |
5395 "response": { | |
5396 "$ref": "MobileCarrier" | |
5397 }, | |
5398 "scopes": [ | |
5399 "https://www.googleapis.com/auth/dfatrafficking" | |
5400 ] | |
5401 }, | |
5402 "list": { | |
5403 "description": "Retrieves a list of mobile carriers.", | |
5404 "httpMethod": "GET", | |
5405 "id": "dfareporting.mobileCarriers.list", | |
5406 "parameterOrder": [ | |
5407 "profileId" | |
5408 ], | |
5409 "parameters": { | |
5410 "profileId": { | |
5411 "description": "User profile ID associated with this
request.", | |
5412 "format": "int64", | |
5413 "location": "path", | |
5414 "required": true, | |
5415 "type": "string" | |
5416 } | |
5417 }, | |
5418 "path": "userprofiles/{profileId}/mobileCarriers", | |
5419 "response": { | |
5420 "$ref": "MobileCarriersListResponse" | |
5421 }, | |
5422 "scopes": [ | |
5423 "https://www.googleapis.com/auth/dfatrafficking" | |
5424 ] | |
5425 } | |
5426 } | |
5427 }, | |
5428 "operatingSystemVersions": { | |
5429 "methods": { | |
5430 "get": { | |
5431 "description": "Gets one operating system version by ID.", | |
5432 "httpMethod": "GET", | |
5433 "id": "dfareporting.operatingSystemVersions.get", | |
5434 "parameterOrder": [ | |
5435 "profileId", | |
5436 "id" | |
5437 ], | |
5438 "parameters": { | |
5439 "id": { | |
5440 "description": "Operating system version ID.", | |
5441 "format": "int64", | |
5442 "location": "path", | |
5443 "required": true, | |
5444 "type": "string" | |
5445 }, | |
5446 "profileId": { | |
5447 "description": "User profile ID associated with this
request.", | |
5448 "format": "int64", | |
5449 "location": "path", | |
5450 "required": true, | |
5451 "type": "string" | |
5452 } | |
5453 }, | |
5454 "path": "userprofiles/{profileId}/operatingSystemVersions/{i
d}", | |
5455 "response": { | |
5456 "$ref": "OperatingSystemVersion" | |
5457 }, | |
5458 "scopes": [ | |
5459 "https://www.googleapis.com/auth/dfatrafficking" | |
5460 ] | |
5461 }, | |
5462 "list": { | |
5463 "description": "Retrieves a list of operating system version
s.", | |
5464 "httpMethod": "GET", | |
5465 "id": "dfareporting.operatingSystemVersions.list", | |
5466 "parameterOrder": [ | |
5467 "profileId" | |
5468 ], | |
5469 "parameters": { | |
5470 "profileId": { | |
5471 "description": "User profile ID associated with this
request.", | |
5472 "format": "int64", | |
5473 "location": "path", | |
5474 "required": true, | |
5475 "type": "string" | |
5476 } | |
5477 }, | |
5478 "path": "userprofiles/{profileId}/operatingSystemVersions", | |
5479 "response": { | |
5480 "$ref": "OperatingSystemVersionsListResponse" | |
5481 }, | |
5482 "scopes": [ | |
5483 "https://www.googleapis.com/auth/dfatrafficking" | |
5484 ] | |
5485 } | |
5486 } | |
5487 }, | |
5488 "operatingSystems": { | |
5489 "methods": { | |
5490 "get": { | |
5491 "description": "Gets one operating system by DART ID.", | |
5492 "httpMethod": "GET", | |
5493 "id": "dfareporting.operatingSystems.get", | |
5494 "parameterOrder": [ | |
5495 "profileId", | |
5496 "dartId" | |
5497 ], | |
5498 "parameters": { | |
5499 "dartId": { | |
5500 "description": "Operating system DART ID.", | |
5501 "format": "int64", | |
5502 "location": "path", | |
5503 "required": true, | |
5504 "type": "string" | |
5505 }, | |
5506 "profileId": { | |
5507 "description": "User profile ID associated with this
request.", | |
5508 "format": "int64", | |
5509 "location": "path", | |
5510 "required": true, | |
5511 "type": "string" | |
5512 } | |
5513 }, | |
5514 "path": "userprofiles/{profileId}/operatingSystems/{dartId}"
, | |
5515 "response": { | |
5516 "$ref": "OperatingSystem" | |
5517 }, | |
5518 "scopes": [ | |
5519 "https://www.googleapis.com/auth/dfatrafficking" | |
5520 ] | |
5521 }, | |
5522 "list": { | |
5523 "description": "Retrieves a list of operating systems.", | |
5524 "httpMethod": "GET", | |
5525 "id": "dfareporting.operatingSystems.list", | |
5526 "parameterOrder": [ | |
5527 "profileId" | |
5528 ], | |
5529 "parameters": { | |
5530 "profileId": { | |
5531 "description": "User profile ID associated with this
request.", | |
5532 "format": "int64", | |
5533 "location": "path", | |
5534 "required": true, | |
5535 "type": "string" | |
5536 } | |
5537 }, | |
5538 "path": "userprofiles/{profileId}/operatingSystems", | |
5539 "response": { | |
5540 "$ref": "OperatingSystemsListResponse" | |
5541 }, | |
5542 "scopes": [ | |
5543 "https://www.googleapis.com/auth/dfatrafficking" | |
5544 ] | |
5545 } | |
5546 } | |
5547 }, | |
5548 "orderDocuments": { | |
5549 "methods": { | |
5550 "get": { | |
5551 "description": "Gets one order document by ID.", | |
5552 "httpMethod": "GET", | |
5553 "id": "dfareporting.orderDocuments.get", | |
5554 "parameterOrder": [ | |
5555 "profileId", | |
5556 "projectId", | |
5557 "id" | |
5558 ], | |
5559 "parameters": { | |
5560 "id": { | |
5561 "description": "Order document ID.", | |
5562 "format": "int64", | |
5563 "location": "path", | |
5564 "required": true, | |
5565 "type": "string" | |
5566 }, | |
5567 "profileId": { | |
5568 "description": "User profile ID associated with this
request.", | |
5569 "format": "int64", | |
5570 "location": "path", | |
5571 "required": true, | |
5572 "type": "string" | |
5573 }, | |
5574 "projectId": { | |
5575 "description": "Project ID for order documents.", | |
5576 "format": "int64", | |
5577 "location": "path", | |
5578 "required": true, | |
5579 "type": "string" | |
5580 } | |
5581 }, | |
5582 "path": "userprofiles/{profileId}/projects/{projectId}/order
Documents/{id}", | |
5583 "response": { | |
5584 "$ref": "OrderDocument" | |
5585 }, | |
5586 "scopes": [ | |
5587 "https://www.googleapis.com/auth/dfatrafficking" | |
5588 ] | |
5589 }, | |
5590 "list": { | |
5591 "description": "Retrieves a list of order documents, possibl
y filtered.", | |
5592 "httpMethod": "GET", | |
5593 "id": "dfareporting.orderDocuments.list", | |
5594 "parameterOrder": [ | |
5595 "profileId", | |
5596 "projectId" | |
5597 ], | |
5598 "parameters": { | |
5599 "approved": { | |
5600 "description": "Select only order documents that hav
e been approved by at least one user.", | |
5601 "location": "query", | |
5602 "type": "boolean" | |
5603 }, | |
5604 "ids": { | |
5605 "description": "Select only order documents with the
se IDs.", | |
5606 "format": "int64", | |
5607 "location": "query", | |
5608 "repeated": true, | |
5609 "type": "string" | |
5610 }, | |
5611 "maxResults": { | |
5612 "description": "Maximum number of results to return.
", | |
5613 "format": "int32", | |
5614 "location": "query", | |
5615 "type": "integer" | |
5616 }, | |
5617 "orderId": { | |
5618 "description": "Select only order documents for spec
ified orders.", | |
5619 "format": "int64", | |
5620 "location": "query", | |
5621 "repeated": true, | |
5622 "type": "string" | |
5623 }, | |
5624 "pageToken": { | |
5625 "description": "Value of the nextPageToken from the
previous result page.", | |
5626 "location": "query", | |
5627 "type": "string" | |
5628 }, | |
5629 "profileId": { | |
5630 "description": "User profile ID associated with this
request.", | |
5631 "format": "int64", | |
5632 "location": "path", | |
5633 "required": true, | |
5634 "type": "string" | |
5635 }, | |
5636 "projectId": { | |
5637 "description": "Project ID for order documents.", | |
5638 "format": "int64", | |
5639 "location": "path", | |
5640 "required": true, | |
5641 "type": "string" | |
5642 }, | |
5643 "searchString": { | |
5644 "description": "Allows searching for order documents
by name or ID. Wildcards (*) are allowed. For example, \"orderdocument*2015\" w
ill return order documents with names like \"orderdocument June 2015\", \"orderd
ocument April 2015\", or simply \"orderdocument 2015\". Most of the searches als
o add wildcards implicitly at the start and the end of the search string. For ex
ample, a search string of \"orderdocument\" will match order documents with name
\"my orderdocument\", \"orderdocument 2015\", or simply \"orderdocument\".", | |
5645 "location": "query", | |
5646 "type": "string" | |
5647 }, | |
5648 "siteId": { | |
5649 "description": "Select only order documents that are
associated with these sites.", | |
5650 "format": "int64", | |
5651 "location": "query", | |
5652 "repeated": true, | |
5653 "type": "string" | |
5654 }, | |
5655 "sortField": { | |
5656 "description": "Field by which to sort the list.", | |
5657 "enum": [ | |
5658 "ID", | |
5659 "NAME" | |
5660 ], | |
5661 "enumDescriptions": [ | |
5662 "", | |
5663 "" | |
5664 ], | |
5665 "location": "query", | |
5666 "type": "string" | |
5667 }, | |
5668 "sortOrder": { | |
5669 "description": "Order of sorted results, default is
ASCENDING.", | |
5670 "enum": [ | |
5671 "ASCENDING", | |
5672 "DESCENDING" | |
5673 ], | |
5674 "enumDescriptions": [ | |
5675 "", | |
5676 "" | |
5677 ], | |
5678 "location": "query", | |
5679 "type": "string" | |
5680 } | |
5681 }, | |
5682 "path": "userprofiles/{profileId}/projects/{projectId}/order
Documents", | |
5683 "response": { | |
5684 "$ref": "OrderDocumentsListResponse" | |
5685 }, | |
5686 "scopes": [ | |
5687 "https://www.googleapis.com/auth/dfatrafficking" | |
5688 ] | |
5689 } | |
5690 } | |
5691 }, | |
5692 "orders": { | |
5693 "methods": { | |
5694 "get": { | |
5695 "description": "Gets one order by ID.", | |
5696 "httpMethod": "GET", | |
5697 "id": "dfareporting.orders.get", | |
5698 "parameterOrder": [ | |
5699 "profileId", | |
5700 "projectId", | |
5701 "id" | |
5702 ], | |
5703 "parameters": { | |
5704 "id": { | |
5705 "description": "Order ID.", | |
5706 "format": "int64", | |
5707 "location": "path", | |
5708 "required": true, | |
5709 "type": "string" | |
5710 }, | |
5711 "profileId": { | |
5712 "description": "User profile ID associated with this
request.", | |
5713 "format": "int64", | |
5714 "location": "path", | |
5715 "required": true, | |
5716 "type": "string" | |
5717 }, | |
5718 "projectId": { | |
5719 "description": "Project ID for orders.", | |
5720 "format": "int64", | |
5721 "location": "path", | |
5722 "required": true, | |
5723 "type": "string" | |
5724 } | |
5725 }, | |
5726 "path": "userprofiles/{profileId}/projects/{projectId}/order
s/{id}", | |
5727 "response": { | |
5728 "$ref": "Order" | |
5729 }, | |
5730 "scopes": [ | |
5731 "https://www.googleapis.com/auth/dfatrafficking" | |
5732 ] | |
5733 }, | |
5734 "list": { | |
5735 "description": "Retrieves a list of orders, possibly filtere
d.", | |
5736 "httpMethod": "GET", | |
5737 "id": "dfareporting.orders.list", | |
5738 "parameterOrder": [ | |
5739 "profileId", | |
5740 "projectId" | |
5741 ], | |
5742 "parameters": { | |
5743 "ids": { | |
5744 "description": "Select only orders with these IDs.", | |
5745 "format": "int64", | |
5746 "location": "query", | |
5747 "repeated": true, | |
5748 "type": "string" | |
5749 }, | |
5750 "maxResults": { | |
5751 "description": "Maximum number of results to return.
", | |
5752 "format": "int32", | |
5753 "location": "query", | |
5754 "type": "integer" | |
5755 }, | |
5756 "pageToken": { | |
5757 "description": "Value of the nextPageToken from the
previous result page.", | |
5758 "location": "query", | |
5759 "type": "string" | |
5760 }, | |
5761 "profileId": { | |
5762 "description": "User profile ID associated with this
request.", | |
5763 "format": "int64", | |
5764 "location": "path", | |
5765 "required": true, | |
5766 "type": "string" | |
5767 }, | |
5768 "projectId": { | |
5769 "description": "Project ID for orders.", | |
5770 "format": "int64", | |
5771 "location": "path", | |
5772 "required": true, | |
5773 "type": "string" | |
5774 }, | |
5775 "searchString": { | |
5776 "description": "Allows searching for orders by name
or ID. Wildcards (*) are allowed. For example, \"order*2015\" will return orders
with names like \"order June 2015\", \"order April 2015\", or simply \"order 20
15\". Most of the searches also add wildcards implicitly at the start and the en
d of the search string. For example, a search string of \"order\" will match ord
ers with name \"my order\", \"order 2015\", or simply \"order\".", | |
5777 "location": "query", | |
5778 "type": "string" | |
5779 }, | |
5780 "siteId": { | |
5781 "description": "Select only orders that are associat
ed with these site IDs.", | |
5782 "format": "int64", | |
5783 "location": "query", | |
5784 "repeated": true, | |
5785 "type": "string" | |
5786 }, | |
5787 "sortField": { | |
5788 "description": "Field by which to sort the list.", | |
5789 "enum": [ | |
5790 "ID", | |
5791 "NAME" | |
5792 ], | |
5793 "enumDescriptions": [ | |
5794 "", | |
5795 "" | |
5796 ], | |
5797 "location": "query", | |
5798 "type": "string" | |
5799 }, | |
5800 "sortOrder": { | |
5801 "description": "Order of sorted results, default is
ASCENDING.", | |
5802 "enum": [ | |
5803 "ASCENDING", | |
5804 "DESCENDING" | |
5805 ], | |
5806 "enumDescriptions": [ | |
5807 "", | |
5808 "" | |
5809 ], | |
5810 "location": "query", | |
5811 "type": "string" | |
5812 } | |
5813 }, | |
5814 "path": "userprofiles/{profileId}/projects/{projectId}/order
s", | |
5815 "response": { | |
5816 "$ref": "OrdersListResponse" | |
5817 }, | |
5818 "scopes": [ | |
5819 "https://www.googleapis.com/auth/dfatrafficking" | |
5820 ] | |
5821 } | |
5822 } | |
5823 }, | |
5824 "placementGroups": { | |
5825 "methods": { | |
5826 "get": { | |
5827 "description": "Gets one placement group by ID.", | |
5828 "httpMethod": "GET", | |
5829 "id": "dfareporting.placementGroups.get", | |
5830 "parameterOrder": [ | |
5831 "profileId", | |
5832 "id" | |
5833 ], | |
5834 "parameters": { | |
5835 "id": { | |
5836 "description": "Placement group ID.", | |
5837 "format": "int64", | |
5838 "location": "path", | |
5839 "required": true, | |
5840 "type": "string" | |
5841 }, | |
5842 "profileId": { | |
5843 "description": "User profile ID associated with this
request.", | |
5844 "format": "int64", | |
5845 "location": "path", | |
5846 "required": true, | |
5847 "type": "string" | |
5848 } | |
5849 }, | |
5850 "path": "userprofiles/{profileId}/placementGroups/{id}", | |
5851 "response": { | |
5852 "$ref": "PlacementGroup" | |
5853 }, | |
5854 "scopes": [ | |
5855 "https://www.googleapis.com/auth/dfatrafficking" | |
5856 ] | |
5857 }, | |
5858 "insert": { | |
5859 "description": "Inserts a new placement group.", | |
5860 "httpMethod": "POST", | |
5861 "id": "dfareporting.placementGroups.insert", | |
5862 "parameterOrder": [ | |
5863 "profileId" | |
5864 ], | |
5865 "parameters": { | |
5866 "profileId": { | |
5867 "description": "User profile ID associated with this
request.", | |
5868 "format": "int64", | |
5869 "location": "path", | |
5870 "required": true, | |
5871 "type": "string" | |
5872 } | |
5873 }, | |
5874 "path": "userprofiles/{profileId}/placementGroups", | |
5875 "request": { | |
5876 "$ref": "PlacementGroup" | |
5877 }, | |
5878 "response": { | |
5879 "$ref": "PlacementGroup" | |
5880 }, | |
5881 "scopes": [ | |
5882 "https://www.googleapis.com/auth/dfatrafficking" | |
5883 ] | |
5884 }, | |
5885 "list": { | |
5886 "description": "Retrieves a list of placement groups, possib
ly filtered.", | |
5887 "httpMethod": "GET", | |
5888 "id": "dfareporting.placementGroups.list", | |
5889 "parameterOrder": [ | |
5890 "profileId" | |
5891 ], | |
5892 "parameters": { | |
5893 "advertiserIds": { | |
5894 "description": "Select only placement groups that be
long to these advertisers.", | |
5895 "format": "int64", | |
5896 "location": "query", | |
5897 "repeated": true, | |
5898 "type": "string" | |
5899 }, | |
5900 "archived": { | |
5901 "description": "Select only archived placements. Don
't set this field to select both archived and non-archived placements.", | |
5902 "location": "query", | |
5903 "type": "boolean" | |
5904 }, | |
5905 "campaignIds": { | |
5906 "description": "Select only placement groups that be
long to these campaigns.", | |
5907 "format": "int64", | |
5908 "location": "query", | |
5909 "repeated": true, | |
5910 "type": "string" | |
5911 }, | |
5912 "contentCategoryIds": { | |
5913 "description": "Select only placement groups that ar
e associated with these content categories.", | |
5914 "format": "int64", | |
5915 "location": "query", | |
5916 "repeated": true, | |
5917 "type": "string" | |
5918 }, | |
5919 "directorySiteIds": { | |
5920 "description": "Select only placement groups that ar
e associated with these directory sites.", | |
5921 "format": "int64", | |
5922 "location": "query", | |
5923 "repeated": true, | |
5924 "type": "string" | |
5925 }, | |
5926 "ids": { | |
5927 "description": "Select only placement groups with th
ese IDs.", | |
5928 "format": "int64", | |
5929 "location": "query", | |
5930 "repeated": true, | |
5931 "type": "string" | |
5932 }, | |
5933 "maxEndDate": { | |
5934 "description": "Select only placements or placement
groups whose end date is on or before the specified maxEndDate. The date should
be formatted as \"yyyy-MM-dd\".", | |
5935 "location": "query", | |
5936 "type": "string" | |
5937 }, | |
5938 "maxResults": { | |
5939 "description": "Maximum number of results to return.
", | |
5940 "format": "int32", | |
5941 "location": "query", | |
5942 "type": "integer" | |
5943 }, | |
5944 "maxStartDate": { | |
5945 "description": "Select only placements or placement
groups whose start date is on or before the specified maxStartDate. The date sho
uld be formatted as \"yyyy-MM-dd\".", | |
5946 "location": "query", | |
5947 "type": "string" | |
5948 }, | |
5949 "minEndDate": { | |
5950 "description": "Select only placements or placement
groups whose end date is on or after the specified minEndDate. The date should b
e formatted as \"yyyy-MM-dd\".", | |
5951 "location": "query", | |
5952 "type": "string" | |
5953 }, | |
5954 "minStartDate": { | |
5955 "description": "Select only placements or placement
groups whose start date is on or after the specified minStartDate. The date shou
ld be formatted as \"yyyy-MM-dd\".", | |
5956 "location": "query", | |
5957 "type": "string" | |
5958 }, | |
5959 "pageToken": { | |
5960 "description": "Value of the nextPageToken from the
previous result page.", | |
5961 "location": "query", | |
5962 "type": "string" | |
5963 }, | |
5964 "placementGroupType": { | |
5965 "description": "Select only placement groups belongi
ng with this group type. A package is a simple group of placements that acts as
a single pricing point for a group of tags. A roadblock is a group of placements
that not only acts as a single pricing point but also assumes that all the tags
in it will be served at the same time. A roadblock requires one of its assigned
placements to be marked as primary for reporting.", | |
5966 "enum": [ | |
5967 "PLACEMENT_PACKAGE", | |
5968 "PLACEMENT_ROADBLOCK" | |
5969 ], | |
5970 "enumDescriptions": [ | |
5971 "", | |
5972 "" | |
5973 ], | |
5974 "location": "query", | |
5975 "type": "string" | |
5976 }, | |
5977 "placementStrategyIds": { | |
5978 "description": "Select only placement groups that ar
e associated with these placement strategies.", | |
5979 "format": "int64", | |
5980 "location": "query", | |
5981 "repeated": true, | |
5982 "type": "string" | |
5983 }, | |
5984 "pricingTypes": { | |
5985 "description": "Select only placement groups with th
ese pricing types.", | |
5986 "enum": [ | |
5987 "PRICING_TYPE_CPA", | |
5988 "PRICING_TYPE_CPC", | |
5989 "PRICING_TYPE_CPM", | |
5990 "PRICING_TYPE_CPM_ACTIVEVIEW", | |
5991 "PRICING_TYPE_FLAT_RATE_CLICKS", | |
5992 "PRICING_TYPE_FLAT_RATE_IMPRESSIONS" | |
5993 ], | |
5994 "enumDescriptions": [ | |
5995 "", | |
5996 "", | |
5997 "", | |
5998 "", | |
5999 "", | |
6000 "" | |
6001 ], | |
6002 "location": "query", | |
6003 "repeated": true, | |
6004 "type": "string" | |
6005 }, | |
6006 "profileId": { | |
6007 "description": "User profile ID associated with this
request.", | |
6008 "format": "int64", | |
6009 "location": "path", | |
6010 "required": true, | |
6011 "type": "string" | |
6012 }, | |
6013 "searchString": { | |
6014 "description": "Allows searching for placement group
s by name or ID. Wildcards (*) are allowed. For example, \"placement*2015\" will
return placement groups with names like \"placement group June 2015\", \"placem
ent group May 2015\", or simply \"placements 2015\". Most of the searches also a
dd wildcards implicitly at the start and the end of the search string. For examp
le, a search string of \"placementgroup\" will match placement groups with name
\"my placementgroup\", \"placementgroup 2015\", or simply \"placementgroup\".", | |
6015 "location": "query", | |
6016 "type": "string" | |
6017 }, | |
6018 "siteIds": { | |
6019 "description": "Select only placement groups that ar
e associated with these sites.", | |
6020 "format": "int64", | |
6021 "location": "query", | |
6022 "repeated": true, | |
6023 "type": "string" | |
6024 }, | |
6025 "sortField": { | |
6026 "description": "Field by which to sort the list.", | |
6027 "enum": [ | |
6028 "ID", | |
6029 "NAME" | |
6030 ], | |
6031 "enumDescriptions": [ | |
6032 "", | |
6033 "" | |
6034 ], | |
6035 "location": "query", | |
6036 "type": "string" | |
6037 }, | |
6038 "sortOrder": { | |
6039 "description": "Order of sorted results, default is
ASCENDING.", | |
6040 "enum": [ | |
6041 "ASCENDING", | |
6042 "DESCENDING" | |
6043 ], | |
6044 "enumDescriptions": [ | |
6045 "", | |
6046 "" | |
6047 ], | |
6048 "location": "query", | |
6049 "type": "string" | |
6050 } | |
6051 }, | |
6052 "path": "userprofiles/{profileId}/placementGroups", | |
6053 "response": { | |
6054 "$ref": "PlacementGroupsListResponse" | |
6055 }, | |
6056 "scopes": [ | |
6057 "https://www.googleapis.com/auth/dfatrafficking" | |
6058 ] | |
6059 }, | |
6060 "patch": { | |
6061 "description": "Updates an existing placement group. This me
thod supports patch semantics.", | |
6062 "httpMethod": "PATCH", | |
6063 "id": "dfareporting.placementGroups.patch", | |
6064 "parameterOrder": [ | |
6065 "profileId", | |
6066 "id" | |
6067 ], | |
6068 "parameters": { | |
6069 "id": { | |
6070 "description": "Placement group ID.", | |
6071 "format": "int64", | |
6072 "location": "query", | |
6073 "required": true, | |
6074 "type": "string" | |
6075 }, | |
6076 "profileId": { | |
6077 "description": "User profile ID associated with this
request.", | |
6078 "format": "int64", | |
6079 "location": "path", | |
6080 "required": true, | |
6081 "type": "string" | |
6082 } | |
6083 }, | |
6084 "path": "userprofiles/{profileId}/placementGroups", | |
6085 "request": { | |
6086 "$ref": "PlacementGroup" | |
6087 }, | |
6088 "response": { | |
6089 "$ref": "PlacementGroup" | |
6090 }, | |
6091 "scopes": [ | |
6092 "https://www.googleapis.com/auth/dfatrafficking" | |
6093 ] | |
6094 }, | |
6095 "update": { | |
6096 "description": "Updates an existing placement group.", | |
6097 "httpMethod": "PUT", | |
6098 "id": "dfareporting.placementGroups.update", | |
6099 "parameterOrder": [ | |
6100 "profileId" | |
6101 ], | |
6102 "parameters": { | |
6103 "profileId": { | |
6104 "description": "User profile ID associated with this
request.", | |
6105 "format": "int64", | |
6106 "location": "path", | |
6107 "required": true, | |
6108 "type": "string" | |
6109 } | |
6110 }, | |
6111 "path": "userprofiles/{profileId}/placementGroups", | |
6112 "request": { | |
6113 "$ref": "PlacementGroup" | |
6114 }, | |
6115 "response": { | |
6116 "$ref": "PlacementGroup" | |
6117 }, | |
6118 "scopes": [ | |
6119 "https://www.googleapis.com/auth/dfatrafficking" | |
6120 ] | |
6121 } | |
6122 } | |
6123 }, | |
6124 "placementStrategies": { | |
6125 "methods": { | |
6126 "delete": { | |
6127 "description": "Deletes an existing placement strategy.", | |
6128 "httpMethod": "DELETE", | |
6129 "id": "dfareporting.placementStrategies.delete", | |
6130 "parameterOrder": [ | |
6131 "profileId", | |
6132 "id" | |
6133 ], | |
6134 "parameters": { | |
6135 "id": { | |
6136 "description": "Placement strategy ID.", | |
6137 "format": "int64", | |
6138 "location": "path", | |
6139 "required": true, | |
6140 "type": "string" | |
6141 }, | |
6142 "profileId": { | |
6143 "description": "User profile ID associated with this
request.", | |
6144 "format": "int64", | |
6145 "location": "path", | |
6146 "required": true, | |
6147 "type": "string" | |
6148 } | |
6149 }, | |
6150 "path": "userprofiles/{profileId}/placementStrategies/{id}", | |
6151 "scopes": [ | |
6152 "https://www.googleapis.com/auth/dfatrafficking" | |
6153 ] | |
6154 }, | |
6155 "get": { | |
6156 "description": "Gets one placement strategy by ID.", | |
6157 "httpMethod": "GET", | |
6158 "id": "dfareporting.placementStrategies.get", | |
6159 "parameterOrder": [ | |
6160 "profileId", | |
6161 "id" | |
6162 ], | |
6163 "parameters": { | |
6164 "id": { | |
6165 "description": "Placement strategy ID.", | |
6166 "format": "int64", | |
6167 "location": "path", | |
6168 "required": true, | |
6169 "type": "string" | |
6170 }, | |
6171 "profileId": { | |
6172 "description": "User profile ID associated with this
request.", | |
6173 "format": "int64", | |
6174 "location": "path", | |
6175 "required": true, | |
6176 "type": "string" | |
6177 } | |
6178 }, | |
6179 "path": "userprofiles/{profileId}/placementStrategies/{id}", | |
6180 "response": { | |
6181 "$ref": "PlacementStrategy" | |
6182 }, | |
6183 "scopes": [ | |
6184 "https://www.googleapis.com/auth/dfatrafficking" | |
6185 ] | |
6186 }, | |
6187 "insert": { | |
6188 "description": "Inserts a new placement strategy.", | |
6189 "httpMethod": "POST", | |
6190 "id": "dfareporting.placementStrategies.insert", | |
6191 "parameterOrder": [ | |
6192 "profileId" | |
6193 ], | |
6194 "parameters": { | |
6195 "profileId": { | |
6196 "description": "User profile ID associated with this
request.", | |
6197 "format": "int64", | |
6198 "location": "path", | |
6199 "required": true, | |
6200 "type": "string" | |
6201 } | |
6202 }, | |
6203 "path": "userprofiles/{profileId}/placementStrategies", | |
6204 "request": { | |
6205 "$ref": "PlacementStrategy" | |
6206 }, | |
6207 "response": { | |
6208 "$ref": "PlacementStrategy" | |
6209 }, | |
6210 "scopes": [ | |
6211 "https://www.googleapis.com/auth/dfatrafficking" | |
6212 ] | |
6213 }, | |
6214 "list": { | |
6215 "description": "Retrieves a list of placement strategies, po
ssibly filtered.", | |
6216 "httpMethod": "GET", | |
6217 "id": "dfareporting.placementStrategies.list", | |
6218 "parameterOrder": [ | |
6219 "profileId" | |
6220 ], | |
6221 "parameters": { | |
6222 "ids": { | |
6223 "description": "Select only placement strategies wit
h these IDs.", | |
6224 "format": "int64", | |
6225 "location": "query", | |
6226 "repeated": true, | |
6227 "type": "string" | |
6228 }, | |
6229 "maxResults": { | |
6230 "description": "Maximum number of results to return.
", | |
6231 "format": "int32", | |
6232 "location": "query", | |
6233 "type": "integer" | |
6234 }, | |
6235 "pageToken": { | |
6236 "description": "Value of the nextPageToken from the
previous result page.", | |
6237 "location": "query", | |
6238 "type": "string" | |
6239 }, | |
6240 "profileId": { | |
6241 "description": "User profile ID associated with this
request.", | |
6242 "format": "int64", | |
6243 "location": "path", | |
6244 "required": true, | |
6245 "type": "string" | |
6246 }, | |
6247 "searchString": { | |
6248 "description": "Allows searching for objects by name
or ID. Wildcards (*) are allowed. For example, \"placementstrategy*2015\" will
return objects with names like \"placementstrategy June 2015\", \"placementstrat
egy April 2015\", or simply \"placementstrategy 2015\". Most of the searches als
o add wildcards implicitly at the start and the end of the search string. For ex
ample, a search string of \"placementstrategy\" will match objects with name \"m
y placementstrategy\", \"placementstrategy 2015\", or simply \"placementstrategy
\".", | |
6249 "location": "query", | |
6250 "type": "string" | |
6251 }, | |
6252 "sortField": { | |
6253 "description": "Field by which to sort the list.", | |
6254 "enum": [ | |
6255 "ID", | |
6256 "NAME" | |
6257 ], | |
6258 "enumDescriptions": [ | |
6259 "", | |
6260 "" | |
6261 ], | |
6262 "location": "query", | |
6263 "type": "string" | |
6264 }, | |
6265 "sortOrder": { | |
6266 "description": "Order of sorted results, default is
ASCENDING.", | |
6267 "enum": [ | |
6268 "ASCENDING", | |
6269 "DESCENDING" | |
6270 ], | |
6271 "enumDescriptions": [ | |
6272 "", | |
6273 "" | |
6274 ], | |
6275 "location": "query", | |
6276 "type": "string" | |
6277 } | |
6278 }, | |
6279 "path": "userprofiles/{profileId}/placementStrategies", | |
6280 "response": { | |
6281 "$ref": "PlacementStrategiesListResponse" | |
6282 }, | |
6283 "scopes": [ | |
6284 "https://www.googleapis.com/auth/dfatrafficking" | |
6285 ] | |
6286 }, | |
6287 "patch": { | |
6288 "description": "Updates an existing placement strategy. This
method supports patch semantics.", | |
6289 "httpMethod": "PATCH", | |
6290 "id": "dfareporting.placementStrategies.patch", | |
6291 "parameterOrder": [ | |
6292 "profileId", | |
6293 "id" | |
6294 ], | |
6295 "parameters": { | |
6296 "id": { | |
6297 "description": "Placement strategy ID.", | |
6298 "format": "int64", | |
6299 "location": "query", | |
6300 "required": true, | |
6301 "type": "string" | |
6302 }, | |
6303 "profileId": { | |
6304 "description": "User profile ID associated with this
request.", | |
6305 "format": "int64", | |
6306 "location": "path", | |
6307 "required": true, | |
6308 "type": "string" | |
6309 } | |
6310 }, | |
6311 "path": "userprofiles/{profileId}/placementStrategies", | |
6312 "request": { | |
6313 "$ref": "PlacementStrategy" | |
6314 }, | |
6315 "response": { | |
6316 "$ref": "PlacementStrategy" | |
6317 }, | |
6318 "scopes": [ | |
6319 "https://www.googleapis.com/auth/dfatrafficking" | |
6320 ] | |
6321 }, | |
6322 "update": { | |
6323 "description": "Updates an existing placement strategy.", | |
6324 "httpMethod": "PUT", | |
6325 "id": "dfareporting.placementStrategies.update", | |
6326 "parameterOrder": [ | |
6327 "profileId" | |
6328 ], | |
6329 "parameters": { | |
6330 "profileId": { | |
6331 "description": "User profile ID associated with this
request.", | |
6332 "format": "int64", | |
6333 "location": "path", | |
6334 "required": true, | |
6335 "type": "string" | |
6336 } | |
6337 }, | |
6338 "path": "userprofiles/{profileId}/placementStrategies", | |
6339 "request": { | |
6340 "$ref": "PlacementStrategy" | |
6341 }, | |
6342 "response": { | |
6343 "$ref": "PlacementStrategy" | |
6344 }, | |
6345 "scopes": [ | |
6346 "https://www.googleapis.com/auth/dfatrafficking" | |
6347 ] | |
6348 } | |
6349 } | |
6350 }, | |
6351 "placements": { | |
6352 "methods": { | |
6353 "generatetags": { | |
6354 "description": "Generates tags for a placement.", | |
6355 "httpMethod": "POST", | |
6356 "id": "dfareporting.placements.generatetags", | |
6357 "parameterOrder": [ | |
6358 "profileId" | |
6359 ], | |
6360 "parameters": { | |
6361 "campaignId": { | |
6362 "description": "Generate placements belonging to thi
s campaign. This is a required field.", | |
6363 "format": "int64", | |
6364 "location": "query", | |
6365 "type": "string" | |
6366 }, | |
6367 "placementIds": { | |
6368 "description": "Generate tags for these placements."
, | |
6369 "format": "int64", | |
6370 "location": "query", | |
6371 "repeated": true, | |
6372 "type": "string" | |
6373 }, | |
6374 "profileId": { | |
6375 "description": "User profile ID associated with this
request.", | |
6376 "format": "int64", | |
6377 "location": "path", | |
6378 "required": true, | |
6379 "type": "string" | |
6380 }, | |
6381 "tagFormats": { | |
6382 "description": "Tag formats to generate for these pl
acements.", | |
6383 "enum": [ | |
6384 "PLACEMENT_TAG_CLICK_COMMANDS", | |
6385 "PLACEMENT_TAG_IFRAME_ILAYER", | |
6386 "PLACEMENT_TAG_IFRAME_JAVASCRIPT", | |
6387 "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY", | |
6388 "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH", | |
6389 "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3", | |
6390 "PLACEMENT_TAG_INTERNAL_REDIRECT", | |
6391 "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT", | |
6392 "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LE
GACY", | |
6393 "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT", | |
6394 "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT", | |
6395 "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY", | |
6396 "PLACEMENT_TAG_JAVASCRIPT", | |
6397 "PLACEMENT_TAG_JAVASCRIPT_LEGACY", | |
6398 "PLACEMENT_TAG_STANDARD", | |
6399 "PLACEMENT_TAG_TRACKING", | |
6400 "PLACEMENT_TAG_TRACKING_IFRAME", | |
6401 "PLACEMENT_TAG_TRACKING_JAVASCRIPT" | |
6402 ], | |
6403 "enumDescriptions": [ | |
6404 "", | |
6405 "", | |
6406 "", | |
6407 "", | |
6408 "", | |
6409 "", | |
6410 "", | |
6411 "", | |
6412 "", | |
6413 "", | |
6414 "", | |
6415 "", | |
6416 "", | |
6417 "", | |
6418 "", | |
6419 "", | |
6420 "", | |
6421 "" | |
6422 ], | |
6423 "location": "query", | |
6424 "repeated": true, | |
6425 "type": "string" | |
6426 } | |
6427 }, | |
6428 "path": "userprofiles/{profileId}/placements/generatetags", | |
6429 "response": { | |
6430 "$ref": "PlacementsGenerateTagsResponse" | |
6431 }, | |
6432 "scopes": [ | |
6433 "https://www.googleapis.com/auth/dfatrafficking" | |
6434 ] | |
6435 }, | |
6436 "get": { | |
6437 "description": "Gets one placement by ID.", | |
6438 "httpMethod": "GET", | |
6439 "id": "dfareporting.placements.get", | |
6440 "parameterOrder": [ | |
6441 "profileId", | |
6442 "id" | |
6443 ], | |
6444 "parameters": { | |
6445 "id": { | |
6446 "description": "Placement ID.", | |
6447 "format": "int64", | |
6448 "location": "path", | |
6449 "required": true, | |
6450 "type": "string" | |
6451 }, | |
6452 "profileId": { | |
6453 "description": "User profile ID associated with this
request.", | |
6454 "format": "int64", | |
6455 "location": "path", | |
6456 "required": true, | |
6457 "type": "string" | |
6458 } | |
6459 }, | |
6460 "path": "userprofiles/{profileId}/placements/{id}", | |
6461 "response": { | |
6462 "$ref": "Placement" | |
6463 }, | |
6464 "scopes": [ | |
6465 "https://www.googleapis.com/auth/dfatrafficking" | |
6466 ] | |
6467 }, | |
6468 "insert": { | |
6469 "description": "Inserts a new placement.", | |
6470 "httpMethod": "POST", | |
6471 "id": "dfareporting.placements.insert", | |
6472 "parameterOrder": [ | |
6473 "profileId" | |
6474 ], | |
6475 "parameters": { | |
6476 "profileId": { | |
6477 "description": "User profile ID associated with this
request.", | |
6478 "format": "int64", | |
6479 "location": "path", | |
6480 "required": true, | |
6481 "type": "string" | |
6482 } | |
6483 }, | |
6484 "path": "userprofiles/{profileId}/placements", | |
6485 "request": { | |
6486 "$ref": "Placement" | |
6487 }, | |
6488 "response": { | |
6489 "$ref": "Placement" | |
6490 }, | |
6491 "scopes": [ | |
6492 "https://www.googleapis.com/auth/dfatrafficking" | |
6493 ] | |
6494 }, | |
6495 "list": { | |
6496 "description": "Retrieves a list of placements, possibly fil
tered.", | |
6497 "httpMethod": "GET", | |
6498 "id": "dfareporting.placements.list", | |
6499 "parameterOrder": [ | |
6500 "profileId" | |
6501 ], | |
6502 "parameters": { | |
6503 "advertiserIds": { | |
6504 "description": "Select only placements that belong t
o these advertisers.", | |
6505 "format": "int64", | |
6506 "location": "query", | |
6507 "repeated": true, | |
6508 "type": "string" | |
6509 }, | |
6510 "archived": { | |
6511 "description": "Select only archived placements. Don
't set this field to select both archived and non-archived placements.", | |
6512 "location": "query", | |
6513 "type": "boolean" | |
6514 }, | |
6515 "campaignIds": { | |
6516 "description": "Select only placements that belong t
o these campaigns.", | |
6517 "format": "int64", | |
6518 "location": "query", | |
6519 "repeated": true, | |
6520 "type": "string" | |
6521 }, | |
6522 "compatibilities": { | |
6523 "description": "Select only placements that are asso
ciated with these compatibilities. WEB and WEB_INTERSTITIAL refer to rendering e
ither on desktop or on mobile devices for regular or interstitial ads respective
ly. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO r
efers to rendering in in-stream video ads developed with the VAST standard.", | |
6524 "enum": [ | |
6525 "APP", | |
6526 "APP_INTERSTITIAL", | |
6527 "IN_STREAM_VIDEO", | |
6528 "WEB", | |
6529 "WEB_INTERSTITIAL" | |
6530 ], | |
6531 "enumDescriptions": [ | |
6532 "", | |
6533 "", | |
6534 "", | |
6535 "", | |
6536 "" | |
6537 ], | |
6538 "location": "query", | |
6539 "repeated": true, | |
6540 "type": "string" | |
6541 }, | |
6542 "contentCategoryIds": { | |
6543 "description": "Select only placements that are asso
ciated with these content categories.", | |
6544 "format": "int64", | |
6545 "location": "query", | |
6546 "repeated": true, | |
6547 "type": "string" | |
6548 }, | |
6549 "directorySiteIds": { | |
6550 "description": "Select only placements that are asso
ciated with these directory sites.", | |
6551 "format": "int64", | |
6552 "location": "query", | |
6553 "repeated": true, | |
6554 "type": "string" | |
6555 }, | |
6556 "groupIds": { | |
6557 "description": "Select only placements that belong t
o these placement groups.", | |
6558 "format": "int64", | |
6559 "location": "query", | |
6560 "repeated": true, | |
6561 "type": "string" | |
6562 }, | |
6563 "ids": { | |
6564 "description": "Select only placements with these ID
s.", | |
6565 "format": "int64", | |
6566 "location": "query", | |
6567 "repeated": true, | |
6568 "type": "string" | |
6569 }, | |
6570 "maxEndDate": { | |
6571 "description": "Select only placements or placement
groups whose end date is on or before the specified maxEndDate. The date should
be formatted as \"yyyy-MM-dd\".", | |
6572 "location": "query", | |
6573 "type": "string" | |
6574 }, | |
6575 "maxResults": { | |
6576 "description": "Maximum number of results to return.
", | |
6577 "format": "int32", | |
6578 "location": "query", | |
6579 "type": "integer" | |
6580 }, | |
6581 "maxStartDate": { | |
6582 "description": "Select only placements or placement
groups whose start date is on or before the specified maxStartDate. The date sho
uld be formatted as \"yyyy-MM-dd\".", | |
6583 "location": "query", | |
6584 "type": "string" | |
6585 }, | |
6586 "minEndDate": { | |
6587 "description": "Select only placements or placement
groups whose end date is on or after the specified minEndDate. The date should b
e formatted as \"yyyy-MM-dd\".", | |
6588 "location": "query", | |
6589 "type": "string" | |
6590 }, | |
6591 "minStartDate": { | |
6592 "description": "Select only placements or placement
groups whose start date is on or after the specified minStartDate. The date shou
ld be formatted as \"yyyy-MM-dd\".", | |
6593 "location": "query", | |
6594 "type": "string" | |
6595 }, | |
6596 "pageToken": { | |
6597 "description": "Value of the nextPageToken from the
previous result page.", | |
6598 "location": "query", | |
6599 "type": "string" | |
6600 }, | |
6601 "paymentSource": { | |
6602 "description": "Select only placements with this pay
ment source.", | |
6603 "enum": [ | |
6604 "PLACEMENT_AGENCY_PAID", | |
6605 "PLACEMENT_PUBLISHER_PAID" | |
6606 ], | |
6607 "enumDescriptions": [ | |
6608 "", | |
6609 "" | |
6610 ], | |
6611 "location": "query", | |
6612 "type": "string" | |
6613 }, | |
6614 "placementStrategyIds": { | |
6615 "description": "Select only placements that are asso
ciated with these placement strategies.", | |
6616 "format": "int64", | |
6617 "location": "query", | |
6618 "repeated": true, | |
6619 "type": "string" | |
6620 }, | |
6621 "pricingTypes": { | |
6622 "description": "Select only placements with these pr
icing types.", | |
6623 "enum": [ | |
6624 "PRICING_TYPE_CPA", | |
6625 "PRICING_TYPE_CPC", | |
6626 "PRICING_TYPE_CPM", | |
6627 "PRICING_TYPE_CPM_ACTIVEVIEW", | |
6628 "PRICING_TYPE_FLAT_RATE_CLICKS", | |
6629 "PRICING_TYPE_FLAT_RATE_IMPRESSIONS" | |
6630 ], | |
6631 "enumDescriptions": [ | |
6632 "", | |
6633 "", | |
6634 "", | |
6635 "", | |
6636 "", | |
6637 "" | |
6638 ], | |
6639 "location": "query", | |
6640 "repeated": true, | |
6641 "type": "string" | |
6642 }, | |
6643 "profileId": { | |
6644 "description": "User profile ID associated with this
request.", | |
6645 "format": "int64", | |
6646 "location": "path", | |
6647 "required": true, | |
6648 "type": "string" | |
6649 }, | |
6650 "searchString": { | |
6651 "description": "Allows searching for placements by n
ame or ID. Wildcards (*) are allowed. For example, \"placement*2015\" will retur
n placements with names like \"placement June 2015\", \"placement May 2015\", or
simply \"placements 2015\". Most of the searches also add wildcards implicitly
at the start and the end of the search string. For example, a search string of \
"placement\" will match placements with name \"my placement\", \"placement 2015\
", or simply \"placement\".", | |
6652 "location": "query", | |
6653 "type": "string" | |
6654 }, | |
6655 "siteIds": { | |
6656 "description": "Select only placements that are asso
ciated with these sites.", | |
6657 "format": "int64", | |
6658 "location": "query", | |
6659 "repeated": true, | |
6660 "type": "string" | |
6661 }, | |
6662 "sizeIds": { | |
6663 "description": "Select only placements that are asso
ciated with these sizes.", | |
6664 "format": "int64", | |
6665 "location": "query", | |
6666 "repeated": true, | |
6667 "type": "string" | |
6668 }, | |
6669 "sortField": { | |
6670 "description": "Field by which to sort the list.", | |
6671 "enum": [ | |
6672 "ID", | |
6673 "NAME" | |
6674 ], | |
6675 "enumDescriptions": [ | |
6676 "", | |
6677 "" | |
6678 ], | |
6679 "location": "query", | |
6680 "type": "string" | |
6681 }, | |
6682 "sortOrder": { | |
6683 "description": "Order of sorted results, default is
ASCENDING.", | |
6684 "enum": [ | |
6685 "ASCENDING", | |
6686 "DESCENDING" | |
6687 ], | |
6688 "enumDescriptions": [ | |
6689 "", | |
6690 "" | |
6691 ], | |
6692 "location": "query", | |
6693 "type": "string" | |
6694 } | |
6695 }, | |
6696 "path": "userprofiles/{profileId}/placements", | |
6697 "response": { | |
6698 "$ref": "PlacementsListResponse" | |
6699 }, | |
6700 "scopes": [ | |
6701 "https://www.googleapis.com/auth/dfatrafficking" | |
6702 ] | |
6703 }, | |
6704 "patch": { | |
6705 "description": "Updates an existing placement. This method s
upports patch semantics.", | |
6706 "httpMethod": "PATCH", | |
6707 "id": "dfareporting.placements.patch", | |
6708 "parameterOrder": [ | |
6709 "profileId", | |
6710 "id" | |
6711 ], | |
6712 "parameters": { | |
6713 "id": { | |
6714 "description": "Placement ID.", | |
6715 "format": "int64", | |
6716 "location": "query", | |
6717 "required": true, | |
6718 "type": "string" | |
6719 }, | |
6720 "profileId": { | |
6721 "description": "User profile ID associated with this
request.", | |
6722 "format": "int64", | |
6723 "location": "path", | |
6724 "required": true, | |
6725 "type": "string" | |
6726 } | |
6727 }, | |
6728 "path": "userprofiles/{profileId}/placements", | |
6729 "request": { | |
6730 "$ref": "Placement" | |
6731 }, | |
6732 "response": { | |
6733 "$ref": "Placement" | |
6734 }, | |
6735 "scopes": [ | |
6736 "https://www.googleapis.com/auth/dfatrafficking" | |
6737 ] | |
6738 }, | |
6739 "update": { | |
6740 "description": "Updates an existing placement.", | |
6741 "httpMethod": "PUT", | |
6742 "id": "dfareporting.placements.update", | |
6743 "parameterOrder": [ | |
6744 "profileId" | |
6745 ], | |
6746 "parameters": { | |
6747 "profileId": { | |
6748 "description": "User profile ID associated with this
request.", | |
6749 "format": "int64", | |
6750 "location": "path", | |
6751 "required": true, | |
6752 "type": "string" | |
6753 } | |
6754 }, | |
6755 "path": "userprofiles/{profileId}/placements", | |
6756 "request": { | |
6757 "$ref": "Placement" | |
6758 }, | |
6759 "response": { | |
6760 "$ref": "Placement" | |
6761 }, | |
6762 "scopes": [ | |
6763 "https://www.googleapis.com/auth/dfatrafficking" | |
6764 ] | |
6765 } | |
6766 } | |
6767 }, | |
6768 "platformTypes": { | |
6769 "methods": { | |
6770 "get": { | |
6771 "description": "Gets one platform type by ID.", | |
6772 "httpMethod": "GET", | |
6773 "id": "dfareporting.platformTypes.get", | |
6774 "parameterOrder": [ | |
6775 "profileId", | |
6776 "id" | |
6777 ], | |
6778 "parameters": { | |
6779 "id": { | |
6780 "description": "Platform type ID.", | |
6781 "format": "int64", | |
6782 "location": "path", | |
6783 "required": true, | |
6784 "type": "string" | |
6785 }, | |
6786 "profileId": { | |
6787 "description": "User profile ID associated with this
request.", | |
6788 "format": "int64", | |
6789 "location": "path", | |
6790 "required": true, | |
6791 "type": "string" | |
6792 } | |
6793 }, | |
6794 "path": "userprofiles/{profileId}/platformTypes/{id}", | |
6795 "response": { | |
6796 "$ref": "PlatformType" | |
6797 }, | |
6798 "scopes": [ | |
6799 "https://www.googleapis.com/auth/dfatrafficking" | |
6800 ] | |
6801 }, | |
6802 "list": { | |
6803 "description": "Retrieves a list of platform types.", | |
6804 "httpMethod": "GET", | |
6805 "id": "dfareporting.platformTypes.list", | |
6806 "parameterOrder": [ | |
6807 "profileId" | |
6808 ], | |
6809 "parameters": { | |
6810 "profileId": { | |
6811 "description": "User profile ID associated with this
request.", | |
6812 "format": "int64", | |
6813 "location": "path", | |
6814 "required": true, | |
6815 "type": "string" | |
6816 } | |
6817 }, | |
6818 "path": "userprofiles/{profileId}/platformTypes", | |
6819 "response": { | |
6820 "$ref": "PlatformTypesListResponse" | |
6821 }, | |
6822 "scopes": [ | |
6823 "https://www.googleapis.com/auth/dfatrafficking" | |
6824 ] | |
6825 } | |
6826 } | |
6827 }, | |
6828 "postalCodes": { | |
6829 "methods": { | |
6830 "get": { | |
6831 "description": "Gets one postal code by ID.", | |
6832 "httpMethod": "GET", | |
6833 "id": "dfareporting.postalCodes.get", | |
6834 "parameterOrder": [ | |
6835 "profileId", | |
6836 "code" | |
6837 ], | |
6838 "parameters": { | |
6839 "code": { | |
6840 "description": "Postal code ID.", | |
6841 "location": "path", | |
6842 "required": true, | |
6843 "type": "string" | |
6844 }, | |
6845 "profileId": { | |
6846 "description": "User profile ID associated with this
request.", | |
6847 "format": "int64", | |
6848 "location": "path", | |
6849 "required": true, | |
6850 "type": "string" | |
6851 } | |
6852 }, | |
6853 "path": "userprofiles/{profileId}/postalCodes/{code}", | |
6854 "response": { | |
6855 "$ref": "PostalCode" | |
6856 }, | |
6857 "scopes": [ | |
6858 "https://www.googleapis.com/auth/dfatrafficking" | |
6859 ] | |
6860 }, | |
6861 "list": { | |
6862 "description": "Retrieves a list of postal codes.", | |
6863 "httpMethod": "GET", | |
6864 "id": "dfareporting.postalCodes.list", | |
6865 "parameterOrder": [ | |
6866 "profileId" | |
6867 ], | |
6868 "parameters": { | |
6869 "profileId": { | |
6870 "description": "User profile ID associated with this
request.", | |
6871 "format": "int64", | |
6872 "location": "path", | |
6873 "required": true, | |
6874 "type": "string" | |
6875 } | |
6876 }, | |
6877 "path": "userprofiles/{profileId}/postalCodes", | |
6878 "response": { | |
6879 "$ref": "PostalCodesListResponse" | |
6880 }, | |
6881 "scopes": [ | |
6882 "https://www.googleapis.com/auth/dfatrafficking" | |
6883 ] | |
6884 } | |
6885 } | |
6886 }, | |
6887 "projects": { | |
6888 "methods": { | |
6889 "get": { | |
6890 "description": "Gets one project by ID.", | |
6891 "httpMethod": "GET", | |
6892 "id": "dfareporting.projects.get", | |
6893 "parameterOrder": [ | |
6894 "profileId", | |
6895 "id" | |
6896 ], | |
6897 "parameters": { | |
6898 "id": { | |
6899 "description": "Project ID.", | |
6900 "format": "int64", | |
6901 "location": "path", | |
6902 "required": true, | |
6903 "type": "string" | |
6904 }, | |
6905 "profileId": { | |
6906 "description": "User profile ID associated with this
request.", | |
6907 "format": "int64", | |
6908 "location": "path", | |
6909 "required": true, | |
6910 "type": "string" | |
6911 } | |
6912 }, | |
6913 "path": "userprofiles/{profileId}/projects/{id}", | |
6914 "response": { | |
6915 "$ref": "Project" | |
6916 }, | |
6917 "scopes": [ | |
6918 "https://www.googleapis.com/auth/dfatrafficking" | |
6919 ] | |
6920 }, | |
6921 "list": { | |
6922 "description": "Retrieves a list of projects, possibly filte
red.", | |
6923 "httpMethod": "GET", | |
6924 "id": "dfareporting.projects.list", | |
6925 "parameterOrder": [ | |
6926 "profileId" | |
6927 ], | |
6928 "parameters": { | |
6929 "advertiserIds": { | |
6930 "description": "Select only projects with these adve
rtiser IDs.", | |
6931 "format": "int64", | |
6932 "location": "query", | |
6933 "repeated": true, | |
6934 "type": "string" | |
6935 }, | |
6936 "ids": { | |
6937 "description": "Select only projects with these IDs.
", | |
6938 "format": "int64", | |
6939 "location": "query", | |
6940 "repeated": true, | |
6941 "type": "string" | |
6942 }, | |
6943 "maxResults": { | |
6944 "description": "Maximum number of results to return.
", | |
6945 "format": "int32", | |
6946 "location": "query", | |
6947 "type": "integer" | |
6948 }, | |
6949 "pageToken": { | |
6950 "description": "Value of the nextPageToken from the
previous result page.", | |
6951 "location": "query", | |
6952 "type": "string" | |
6953 }, | |
6954 "profileId": { | |
6955 "description": "User profile ID associated with this
request.", | |
6956 "format": "int64", | |
6957 "location": "path", | |
6958 "required": true, | |
6959 "type": "string" | |
6960 }, | |
6961 "searchString": { | |
6962 "description": "Allows searching for projects by nam
e or ID. Wildcards (*) are allowed. For example, \"project*2015\" will return pr
ojects with names like \"project June 2015\", \"project April 2015\", or simply
\"project 2015\". Most of the searches also add wildcards implicitly at the star
t and the end of the search string. For example, a search string of \"project\"
will match projects with name \"my project\", \"project 2015\", or simply \"proj
ect\".", | |
6963 "location": "query", | |
6964 "type": "string" | |
6965 }, | |
6966 "sortField": { | |
6967 "description": "Field by which to sort the list.", | |
6968 "enum": [ | |
6969 "ID", | |
6970 "NAME" | |
6971 ], | |
6972 "enumDescriptions": [ | |
6973 "", | |
6974 "" | |
6975 ], | |
6976 "location": "query", | |
6977 "type": "string" | |
6978 }, | |
6979 "sortOrder": { | |
6980 "description": "Order of sorted results, default is
ASCENDING.", | |
6981 "enum": [ | |
6982 "ASCENDING", | |
6983 "DESCENDING" | |
6984 ], | |
6985 "enumDescriptions": [ | |
6986 "", | |
6987 "" | |
6988 ], | |
6989 "location": "query", | |
6990 "type": "string" | |
6991 } | |
6992 }, | |
6993 "path": "userprofiles/{profileId}/projects", | |
6994 "response": { | |
6995 "$ref": "ProjectsListResponse" | |
6996 }, | |
6997 "scopes": [ | |
6998 "https://www.googleapis.com/auth/dfatrafficking" | |
6999 ] | |
7000 } | |
7001 } | |
7002 }, | |
7003 "regions": { | |
7004 "methods": { | |
7005 "list": { | |
7006 "description": "Retrieves a list of regions.", | |
7007 "httpMethod": "GET", | |
7008 "id": "dfareporting.regions.list", | |
7009 "parameterOrder": [ | |
7010 "profileId" | |
7011 ], | |
7012 "parameters": { | |
7013 "profileId": { | |
7014 "description": "User profile ID associated with this
request.", | |
7015 "format": "int64", | |
7016 "location": "path", | |
7017 "required": true, | |
7018 "type": "string" | |
7019 } | |
7020 }, | |
7021 "path": "userprofiles/{profileId}/regions", | |
7022 "response": { | |
7023 "$ref": "RegionsListResponse" | |
7024 }, | |
7025 "scopes": [ | |
7026 "https://www.googleapis.com/auth/dfatrafficking" | |
7027 ] | |
7028 } | |
7029 } | |
7030 }, | |
7031 "remarketingListShares": { | |
7032 "methods": { | |
7033 "get": { | |
7034 "description": "Gets one remarketing list share by remarketi
ng list ID.", | |
7035 "httpMethod": "GET", | |
7036 "id": "dfareporting.remarketingListShares.get", | |
7037 "parameterOrder": [ | |
7038 "profileId", | |
7039 "remarketingListId" | |
7040 ], | |
7041 "parameters": { | |
7042 "profileId": { | |
7043 "description": "User profile ID associated with this
request.", | |
7044 "format": "int64", | |
7045 "location": "path", | |
7046 "required": true, | |
7047 "type": "string" | |
7048 }, | |
7049 "remarketingListId": { | |
7050 "description": "Remarketing list ID.", | |
7051 "format": "int64", | |
7052 "location": "path", | |
7053 "required": true, | |
7054 "type": "string" | |
7055 } | |
7056 }, | |
7057 "path": "userprofiles/{profileId}/remarketingListShares/{rem
arketingListId}", | |
7058 "response": { | |
7059 "$ref": "RemarketingListShare" | |
7060 }, | |
7061 "scopes": [ | |
7062 "https://www.googleapis.com/auth/dfatrafficking" | |
7063 ] | |
7064 }, | |
7065 "patch": { | |
7066 "description": "Updates an existing remarketing list share.
This method supports patch semantics.", | |
7067 "httpMethod": "PATCH", | |
7068 "id": "dfareporting.remarketingListShares.patch", | |
7069 "parameterOrder": [ | |
7070 "profileId", | |
7071 "remarketingListId" | |
7072 ], | |
7073 "parameters": { | |
7074 "profileId": { | |
7075 "description": "User profile ID associated with this
request.", | |
7076 "format": "int64", | |
7077 "location": "path", | |
7078 "required": true, | |
7079 "type": "string" | |
7080 }, | |
7081 "remarketingListId": { | |
7082 "description": "Remarketing list ID.", | |
7083 "format": "int64", | |
7084 "location": "query", | |
7085 "required": true, | |
7086 "type": "string" | |
7087 } | |
7088 }, | |
7089 "path": "userprofiles/{profileId}/remarketingListShares", | |
7090 "request": { | |
7091 "$ref": "RemarketingListShare" | |
7092 }, | |
7093 "response": { | |
7094 "$ref": "RemarketingListShare" | |
7095 }, | |
7096 "scopes": [ | |
7097 "https://www.googleapis.com/auth/dfatrafficking" | |
7098 ] | |
7099 }, | |
7100 "update": { | |
7101 "description": "Updates an existing remarketing list share."
, | |
7102 "httpMethod": "PUT", | |
7103 "id": "dfareporting.remarketingListShares.update", | |
7104 "parameterOrder": [ | |
7105 "profileId" | |
7106 ], | |
7107 "parameters": { | |
7108 "profileId": { | |
7109 "description": "User profile ID associated with this
request.", | |
7110 "format": "int64", | |
7111 "location": "path", | |
7112 "required": true, | |
7113 "type": "string" | |
7114 } | |
7115 }, | |
7116 "path": "userprofiles/{profileId}/remarketingListShares", | |
7117 "request": { | |
7118 "$ref": "RemarketingListShare" | |
7119 }, | |
7120 "response": { | |
7121 "$ref": "RemarketingListShare" | |
7122 }, | |
7123 "scopes": [ | |
7124 "https://www.googleapis.com/auth/dfatrafficking" | |
7125 ] | |
7126 } | |
7127 } | |
7128 }, | |
7129 "remarketingLists": { | |
7130 "methods": { | |
7131 "get": { | |
7132 "description": "Gets one remarketing list by ID.", | |
7133 "httpMethod": "GET", | |
7134 "id": "dfareporting.remarketingLists.get", | |
7135 "parameterOrder": [ | |
7136 "profileId", | |
7137 "id" | |
7138 ], | |
7139 "parameters": { | |
7140 "id": { | |
7141 "description": "Remarketing list ID.", | |
7142 "format": "int64", | |
7143 "location": "path", | |
7144 "required": true, | |
7145 "type": "string" | |
7146 }, | |
7147 "profileId": { | |
7148 "description": "User profile ID associated with this
request.", | |
7149 "format": "int64", | |
7150 "location": "path", | |
7151 "required": true, | |
7152 "type": "string" | |
7153 } | |
7154 }, | |
7155 "path": "userprofiles/{profileId}/remarketingLists/{id}", | |
7156 "response": { | |
7157 "$ref": "RemarketingList" | |
7158 }, | |
7159 "scopes": [ | |
7160 "https://www.googleapis.com/auth/dfatrafficking" | |
7161 ] | |
7162 }, | |
7163 "insert": { | |
7164 "description": "Inserts a new remarketing list.", | |
7165 "httpMethod": "POST", | |
7166 "id": "dfareporting.remarketingLists.insert", | |
7167 "parameterOrder": [ | |
7168 "profileId" | |
7169 ], | |
7170 "parameters": { | |
7171 "profileId": { | |
7172 "description": "User profile ID associated with this
request.", | |
7173 "format": "int64", | |
7174 "location": "path", | |
7175 "required": true, | |
7176 "type": "string" | |
7177 } | |
7178 }, | |
7179 "path": "userprofiles/{profileId}/remarketingLists", | |
7180 "request": { | |
7181 "$ref": "RemarketingList" | |
7182 }, | |
7183 "response": { | |
7184 "$ref": "RemarketingList" | |
7185 }, | |
7186 "scopes": [ | |
7187 "https://www.googleapis.com/auth/dfatrafficking" | |
7188 ] | |
7189 }, | |
7190 "list": { | |
7191 "description": "Retrieves a list of remarketing lists, possi
bly filtered.", | |
7192 "httpMethod": "GET", | |
7193 "id": "dfareporting.remarketingLists.list", | |
7194 "parameterOrder": [ | |
7195 "profileId", | |
7196 "advertiserId" | |
7197 ], | |
7198 "parameters": { | |
7199 "active": { | |
7200 "description": "Select only active or only inactive
remarketing lists.", | |
7201 "location": "query", | |
7202 "type": "boolean" | |
7203 }, | |
7204 "advertiserId": { | |
7205 "description": "Select only remarketing lists owned
by this advertiser.", | |
7206 "format": "int64", | |
7207 "location": "query", | |
7208 "required": true, | |
7209 "type": "string" | |
7210 }, | |
7211 "floodlightActivityId": { | |
7212 "description": "Select only remarketing lists that h
ave this floodlight activity ID.", | |
7213 "format": "int64", | |
7214 "location": "query", | |
7215 "type": "string" | |
7216 }, | |
7217 "maxResults": { | |
7218 "description": "Maximum number of results to return.
", | |
7219 "format": "int32", | |
7220 "location": "query", | |
7221 "type": "integer" | |
7222 }, | |
7223 "name": { | |
7224 "description": "Allows searching for objects by name
or ID. Wildcards (*) are allowed. For example, \"remarketing list*2015\" will r
eturn objects with names like \"remarketing list June 2015\", \"remarketing list
April 2015\", or simply \"remarketing list 2015\". Most of the searches also ad
d wildcards implicitly at the start and the end of the search string. For exampl
e, a search string of \"remarketing list\" will match objects with name \"my rem
arketing list\", \"remarketing list 2015\", or simply \"remarketing list\".", | |
7225 "location": "query", | |
7226 "type": "string" | |
7227 }, | |
7228 "pageToken": { | |
7229 "description": "Value of the nextPageToken from the
previous result page.", | |
7230 "location": "query", | |
7231 "type": "string" | |
7232 }, | |
7233 "profileId": { | |
7234 "description": "User profile ID associated with this
request.", | |
7235 "format": "int64", | |
7236 "location": "path", | |
7237 "required": true, | |
7238 "type": "string" | |
7239 }, | |
7240 "sortField": { | |
7241 "description": "Field by which to sort the list.", | |
7242 "enum": [ | |
7243 "ID", | |
7244 "NAME" | |
7245 ], | |
7246 "enumDescriptions": [ | |
7247 "", | |
7248 "" | |
7249 ], | |
7250 "location": "query", | |
7251 "type": "string" | |
7252 }, | |
7253 "sortOrder": { | |
7254 "description": "Order of sorted results, default is
ASCENDING.", | |
7255 "enum": [ | |
7256 "ASCENDING", | |
7257 "DESCENDING" | |
7258 ], | |
7259 "enumDescriptions": [ | |
7260 "", | |
7261 "" | |
7262 ], | |
7263 "location": "query", | |
7264 "type": "string" | |
7265 } | |
7266 }, | |
7267 "path": "userprofiles/{profileId}/remarketingLists", | |
7268 "response": { | |
7269 "$ref": "RemarketingListsListResponse" | |
7270 }, | |
7271 "scopes": [ | |
7272 "https://www.googleapis.com/auth/dfatrafficking" | |
7273 ] | |
7274 }, | |
7275 "patch": { | |
7276 "description": "Updates an existing remarketing list. This m
ethod supports patch semantics.", | |
7277 "httpMethod": "PATCH", | |
7278 "id": "dfareporting.remarketingLists.patch", | |
7279 "parameterOrder": [ | |
7280 "profileId", | |
7281 "id" | |
7282 ], | |
7283 "parameters": { | |
7284 "id": { | |
7285 "description": "Remarketing list ID.", | |
7286 "format": "int64", | |
7287 "location": "query", | |
7288 "required": true, | |
7289 "type": "string" | |
7290 }, | |
7291 "profileId": { | |
7292 "description": "User profile ID associated with this
request.", | |
7293 "format": "int64", | |
7294 "location": "path", | |
7295 "required": true, | |
7296 "type": "string" | |
7297 } | |
7298 }, | |
7299 "path": "userprofiles/{profileId}/remarketingLists", | |
7300 "request": { | |
7301 "$ref": "RemarketingList" | |
7302 }, | |
7303 "response": { | |
7304 "$ref": "RemarketingList" | |
7305 }, | |
7306 "scopes": [ | |
7307 "https://www.googleapis.com/auth/dfatrafficking" | |
7308 ] | |
7309 }, | |
7310 "update": { | |
7311 "description": "Updates an existing remarketing list.", | |
7312 "httpMethod": "PUT", | |
7313 "id": "dfareporting.remarketingLists.update", | |
7314 "parameterOrder": [ | |
7315 "profileId" | |
7316 ], | |
7317 "parameters": { | |
7318 "profileId": { | |
7319 "description": "User profile ID associated with this
request.", | |
7320 "format": "int64", | |
7321 "location": "path", | |
7322 "required": true, | |
7323 "type": "string" | |
7324 } | |
7325 }, | |
7326 "path": "userprofiles/{profileId}/remarketingLists", | |
7327 "request": { | |
7328 "$ref": "RemarketingList" | |
7329 }, | |
7330 "response": { | |
7331 "$ref": "RemarketingList" | |
7332 }, | |
7333 "scopes": [ | |
7334 "https://www.googleapis.com/auth/dfatrafficking" | |
7335 ] | |
7336 } | |
7337 } | |
7338 }, | |
7339 "reports": { | |
7340 "methods": { | |
7341 "delete": { | |
7342 "description": "Deletes a report by its ID.", | |
7343 "httpMethod": "DELETE", | |
7344 "id": "dfareporting.reports.delete", | |
7345 "parameterOrder": [ | |
7346 "profileId", | |
7347 "reportId" | |
7348 ], | |
7349 "parameters": { | |
7350 "profileId": { | |
7351 "description": "The DFA user profile ID.", | |
7352 "format": "int64", | |
7353 "location": "path", | |
7354 "required": true, | |
7355 "type": "string" | |
7356 }, | |
7357 "reportId": { | |
7358 "description": "The ID of the report.", | |
7359 "format": "int64", | |
7360 "location": "path", | |
7361 "required": true, | |
7362 "type": "string" | |
7363 } | |
7364 }, | |
7365 "path": "userprofiles/{profileId}/reports/{reportId}", | |
7366 "scopes": [ | |
7367 "https://www.googleapis.com/auth/dfareporting" | |
7368 ] | |
7369 }, | |
7370 "get": { | |
7371 "description": "Retrieves a report by its ID.", | |
7372 "httpMethod": "GET", | |
7373 "id": "dfareporting.reports.get", | |
7374 "parameterOrder": [ | |
7375 "profileId", | |
7376 "reportId" | |
7377 ], | |
7378 "parameters": { | |
7379 "profileId": { | |
7380 "description": "The DFA user profile ID.", | |
7381 "format": "int64", | |
7382 "location": "path", | |
7383 "required": true, | |
7384 "type": "string" | |
7385 }, | |
7386 "reportId": { | |
7387 "description": "The ID of the report.", | |
7388 "format": "int64", | |
7389 "location": "path", | |
7390 "required": true, | |
7391 "type": "string" | |
7392 } | |
7393 }, | |
7394 "path": "userprofiles/{profileId}/reports/{reportId}", | |
7395 "response": { | |
7396 "$ref": "Report" | |
7397 }, | |
7398 "scopes": [ | |
7399 "https://www.googleapis.com/auth/dfareporting" | |
7400 ] | |
7401 }, | |
7402 "insert": { | |
7403 "description": "Creates a report.", | |
7404 "httpMethod": "POST", | |
7405 "id": "dfareporting.reports.insert", | |
7406 "parameterOrder": [ | |
7407 "profileId" | |
7408 ], | |
7409 "parameters": { | |
7410 "profileId": { | |
7411 "description": "The DFA user profile ID.", | |
7412 "format": "int64", | |
7413 "location": "path", | |
7414 "required": true, | |
7415 "type": "string" | |
7416 } | |
7417 }, | |
7418 "path": "userprofiles/{profileId}/reports", | |
7419 "request": { | |
7420 "$ref": "Report" | |
7421 }, | |
7422 "response": { | |
7423 "$ref": "Report" | |
7424 }, | |
7425 "scopes": [ | |
7426 "https://www.googleapis.com/auth/dfareporting" | |
7427 ] | |
7428 }, | |
7429 "list": { | |
7430 "description": "Retrieves list of reports.", | |
7431 "httpMethod": "GET", | |
7432 "id": "dfareporting.reports.list", | |
7433 "parameterOrder": [ | |
7434 "profileId" | |
7435 ], | |
7436 "parameters": { | |
7437 "maxResults": { | |
7438 "description": "Maximum number of results to return.
", | |
7439 "format": "int32", | |
7440 "location": "query", | |
7441 "maximum": "10", | |
7442 "minimum": "0", | |
7443 "type": "integer" | |
7444 }, | |
7445 "pageToken": { | |
7446 "description": "The value of the nextToken from the
previous result page.", | |
7447 "location": "query", | |
7448 "type": "string" | |
7449 }, | |
7450 "profileId": { | |
7451 "description": "The DFA user profile ID.", | |
7452 "format": "int64", | |
7453 "location": "path", | |
7454 "required": true, | |
7455 "type": "string" | |
7456 }, | |
7457 "scope": { | |
7458 "default": "MINE", | |
7459 "description": "The scope that defines which results
are returned, default is 'MINE'.", | |
7460 "enum": [ | |
7461 "ALL", | |
7462 "MINE" | |
7463 ], | |
7464 "enumDescriptions": [ | |
7465 "All reports in account.", | |
7466 "My reports." | |
7467 ], | |
7468 "location": "query", | |
7469 "type": "string" | |
7470 }, | |
7471 "sortField": { | |
7472 "default": "LAST_MODIFIED_TIME", | |
7473 "description": "The field by which to sort the list.
", | |
7474 "enum": [ | |
7475 "ID", | |
7476 "LAST_MODIFIED_TIME", | |
7477 "NAME" | |
7478 ], | |
7479 "enumDescriptions": [ | |
7480 "Sort by report ID.", | |
7481 "Sort by 'lastModifiedTime' field.", | |
7482 "Sort by name of reports." | |
7483 ], | |
7484 "location": "query", | |
7485 "type": "string" | |
7486 }, | |
7487 "sortOrder": { | |
7488 "default": "DESCENDING", | |
7489 "description": "Order of sorted results, default is
'DESCENDING'.", | |
7490 "enum": [ | |
7491 "ASCENDING", | |
7492 "DESCENDING" | |
7493 ], | |
7494 "enumDescriptions": [ | |
7495 "Ascending order.", | |
7496 "Descending order." | |
7497 ], | |
7498 "location": "query", | |
7499 "type": "string" | |
7500 } | |
7501 }, | |
7502 "path": "userprofiles/{profileId}/reports", | |
7503 "response": { | |
7504 "$ref": "ReportList" | |
7505 }, | |
7506 "scopes": [ | |
7507 "https://www.googleapis.com/auth/dfareporting" | |
7508 ] | |
7509 }, | |
7510 "patch": { | |
7511 "description": "Updates a report. This method supports patch
semantics.", | |
7512 "httpMethod": "PATCH", | |
7513 "id": "dfareporting.reports.patch", | |
7514 "parameterOrder": [ | |
7515 "profileId", | |
7516 "reportId" | |
7517 ], | |
7518 "parameters": { | |
7519 "profileId": { | |
7520 "description": "The DFA user profile ID.", | |
7521 "format": "int64", | |
7522 "location": "path", | |
7523 "required": true, | |
7524 "type": "string" | |
7525 }, | |
7526 "reportId": { | |
7527 "description": "The ID of the report.", | |
7528 "format": "int64", | |
7529 "location": "path", | |
7530 "required": true, | |
7531 "type": "string" | |
7532 } | |
7533 }, | |
7534 "path": "userprofiles/{profileId}/reports/{reportId}", | |
7535 "request": { | |
7536 "$ref": "Report" | |
7537 }, | |
7538 "response": { | |
7539 "$ref": "Report" | |
7540 }, | |
7541 "scopes": [ | |
7542 "https://www.googleapis.com/auth/dfareporting" | |
7543 ] | |
7544 }, | |
7545 "run": { | |
7546 "description": "Runs a report.", | |
7547 "httpMethod": "POST", | |
7548 "id": "dfareporting.reports.run", | |
7549 "parameterOrder": [ | |
7550 "profileId", | |
7551 "reportId" | |
7552 ], | |
7553 "parameters": { | |
7554 "profileId": { | |
7555 "description": "The DFA profile ID.", | |
7556 "format": "int64", | |
7557 "location": "path", | |
7558 "required": true, | |
7559 "type": "string" | |
7560 }, | |
7561 "reportId": { | |
7562 "description": "The ID of the report.", | |
7563 "format": "int64", | |
7564 "location": "path", | |
7565 "required": true, | |
7566 "type": "string" | |
7567 }, | |
7568 "synchronous": { | |
7569 "description": "If set and true, tries to run the re
port synchronously.", | |
7570 "location": "query", | |
7571 "type": "boolean" | |
7572 } | |
7573 }, | |
7574 "path": "userprofiles/{profileId}/reports/{reportId}/run", | |
7575 "response": { | |
7576 "$ref": "File" | |
7577 }, | |
7578 "scopes": [ | |
7579 "https://www.googleapis.com/auth/dfareporting" | |
7580 ] | |
7581 }, | |
7582 "update": { | |
7583 "description": "Updates a report.", | |
7584 "httpMethod": "PUT", | |
7585 "id": "dfareporting.reports.update", | |
7586 "parameterOrder": [ | |
7587 "profileId", | |
7588 "reportId" | |
7589 ], | |
7590 "parameters": { | |
7591 "profileId": { | |
7592 "description": "The DFA user profile ID.", | |
7593 "format": "int64", | |
7594 "location": "path", | |
7595 "required": true, | |
7596 "type": "string" | |
7597 }, | |
7598 "reportId": { | |
7599 "description": "The ID of the report.", | |
7600 "format": "int64", | |
7601 "location": "path", | |
7602 "required": true, | |
7603 "type": "string" | |
7604 } | |
7605 }, | |
7606 "path": "userprofiles/{profileId}/reports/{reportId}", | |
7607 "request": { | |
7608 "$ref": "Report" | |
7609 }, | |
7610 "response": { | |
7611 "$ref": "Report" | |
7612 }, | |
7613 "scopes": [ | |
7614 "https://www.googleapis.com/auth/dfareporting" | |
7615 ] | |
7616 } | |
7617 }, | |
7618 "resources": { | |
7619 "compatibleFields": { | |
7620 "methods": { | |
7621 "query": { | |
7622 "description": "Returns the fields that are compatib
le to be selected in the respective sections of a report criteria, given the fie
lds already selected in the input report and user permissions.", | |
7623 "httpMethod": "POST", | |
7624 "id": "dfareporting.reports.compatibleFields.query", | |
7625 "parameterOrder": [ | |
7626 "profileId" | |
7627 ], | |
7628 "parameters": { | |
7629 "profileId": { | |
7630 "description": "The DFA user profile ID.", | |
7631 "format": "int64", | |
7632 "location": "path", | |
7633 "required": true, | |
7634 "type": "string" | |
7635 } | |
7636 }, | |
7637 "path": "userprofiles/{profileId}/reports/compatible
fields/query", | |
7638 "request": { | |
7639 "$ref": "Report" | |
7640 }, | |
7641 "response": { | |
7642 "$ref": "CompatibleFields" | |
7643 }, | |
7644 "scopes": [ | |
7645 "https://www.googleapis.com/auth/dfareporting" | |
7646 ] | |
7647 } | |
7648 } | |
7649 }, | |
7650 "files": { | |
7651 "methods": { | |
7652 "get": { | |
7653 "description": "Retrieves a report file.", | |
7654 "httpMethod": "GET", | |
7655 "id": "dfareporting.reports.files.get", | |
7656 "parameterOrder": [ | |
7657 "profileId", | |
7658 "reportId", | |
7659 "fileId" | |
7660 ], | |
7661 "parameters": { | |
7662 "fileId": { | |
7663 "description": "The ID of the report file.", | |
7664 "format": "int64", | |
7665 "location": "path", | |
7666 "required": true, | |
7667 "type": "string" | |
7668 }, | |
7669 "profileId": { | |
7670 "description": "The DFA profile ID.", | |
7671 "format": "int64", | |
7672 "location": "path", | |
7673 "required": true, | |
7674 "type": "string" | |
7675 }, | |
7676 "reportId": { | |
7677 "description": "The ID of the report.", | |
7678 "format": "int64", | |
7679 "location": "path", | |
7680 "required": true, | |
7681 "type": "string" | |
7682 } | |
7683 }, | |
7684 "path": "userprofiles/{profileId}/reports/{reportId}
/files/{fileId}", | |
7685 "response": { | |
7686 "$ref": "File" | |
7687 }, | |
7688 "scopes": [ | |
7689 "https://www.googleapis.com/auth/dfareporting" | |
7690 ], | |
7691 "supportsMediaDownload": true | |
7692 }, | |
7693 "list": { | |
7694 "description": "Lists files for a report.", | |
7695 "httpMethod": "GET", | |
7696 "id": "dfareporting.reports.files.list", | |
7697 "parameterOrder": [ | |
7698 "profileId", | |
7699 "reportId" | |
7700 ], | |
7701 "parameters": { | |
7702 "maxResults": { | |
7703 "description": "Maximum number of results to
return.", | |
7704 "format": "int32", | |
7705 "location": "query", | |
7706 "maximum": "10", | |
7707 "minimum": "0", | |
7708 "type": "integer" | |
7709 }, | |
7710 "pageToken": { | |
7711 "description": "The value of the nextToken f
rom the previous result page.", | |
7712 "location": "query", | |
7713 "type": "string" | |
7714 }, | |
7715 "profileId": { | |
7716 "description": "The DFA profile ID.", | |
7717 "format": "int64", | |
7718 "location": "path", | |
7719 "required": true, | |
7720 "type": "string" | |
7721 }, | |
7722 "reportId": { | |
7723 "description": "The ID of the parent report.
", | |
7724 "format": "int64", | |
7725 "location": "path", | |
7726 "required": true, | |
7727 "type": "string" | |
7728 }, | |
7729 "sortField": { | |
7730 "default": "LAST_MODIFIED_TIME", | |
7731 "description": "The field by which to sort t
he list.", | |
7732 "enum": [ | |
7733 "ID", | |
7734 "LAST_MODIFIED_TIME" | |
7735 ], | |
7736 "enumDescriptions": [ | |
7737 "Sort by file ID.", | |
7738 "Sort by 'lastmodifiedAt' field." | |
7739 ], | |
7740 "location": "query", | |
7741 "type": "string" | |
7742 }, | |
7743 "sortOrder": { | |
7744 "default": "DESCENDING", | |
7745 "description": "Order of sorted results, def
ault is 'DESCENDING'.", | |
7746 "enum": [ | |
7747 "ASCENDING", | |
7748 "DESCENDING" | |
7749 ], | |
7750 "enumDescriptions": [ | |
7751 "Ascending order.", | |
7752 "Descending order." | |
7753 ], | |
7754 "location": "query", | |
7755 "type": "string" | |
7756 } | |
7757 }, | |
7758 "path": "userprofiles/{profileId}/reports/{reportId}
/files", | |
7759 "response": { | |
7760 "$ref": "FileList" | |
7761 }, | |
7762 "scopes": [ | |
7763 "https://www.googleapis.com/auth/dfareporting" | |
7764 ] | |
7765 } | |
7766 } | |
7767 } | |
7768 } | |
7769 }, | |
7770 "sites": { | |
7771 "methods": { | |
7772 "get": { | |
7773 "description": "Gets one site by ID.", | |
7774 "httpMethod": "GET", | |
7775 "id": "dfareporting.sites.get", | |
7776 "parameterOrder": [ | |
7777 "profileId", | |
7778 "id" | |
7779 ], | |
7780 "parameters": { | |
7781 "id": { | |
7782 "description": "Site ID.", | |
7783 "format": "int64", | |
7784 "location": "path", | |
7785 "required": true, | |
7786 "type": "string" | |
7787 }, | |
7788 "profileId": { | |
7789 "description": "User profile ID associated with this
request.", | |
7790 "format": "int64", | |
7791 "location": "path", | |
7792 "required": true, | |
7793 "type": "string" | |
7794 } | |
7795 }, | |
7796 "path": "userprofiles/{profileId}/sites/{id}", | |
7797 "response": { | |
7798 "$ref": "Site" | |
7799 }, | |
7800 "scopes": [ | |
7801 "https://www.googleapis.com/auth/dfatrafficking" | |
7802 ] | |
7803 }, | |
7804 "insert": { | |
7805 "description": "Inserts a new site.", | |
7806 "httpMethod": "POST", | |
7807 "id": "dfareporting.sites.insert", | |
7808 "parameterOrder": [ | |
7809 "profileId" | |
7810 ], | |
7811 "parameters": { | |
7812 "profileId": { | |
7813 "description": "User profile ID associated with this
request.", | |
7814 "format": "int64", | |
7815 "location": "path", | |
7816 "required": true, | |
7817 "type": "string" | |
7818 } | |
7819 }, | |
7820 "path": "userprofiles/{profileId}/sites", | |
7821 "request": { | |
7822 "$ref": "Site" | |
7823 }, | |
7824 "response": { | |
7825 "$ref": "Site" | |
7826 }, | |
7827 "scopes": [ | |
7828 "https://www.googleapis.com/auth/dfatrafficking" | |
7829 ] | |
7830 }, | |
7831 "list": { | |
7832 "description": "Retrieves a list of sites, possibly filtered
.", | |
7833 "httpMethod": "GET", | |
7834 "id": "dfareporting.sites.list", | |
7835 "parameterOrder": [ | |
7836 "profileId" | |
7837 ], | |
7838 "parameters": { | |
7839 "acceptsInStreamVideoPlacements": { | |
7840 "description": "This search filter is no longer supp
orted and will have no effect on the results returned.", | |
7841 "location": "query", | |
7842 "type": "boolean" | |
7843 }, | |
7844 "acceptsInterstitialPlacements": { | |
7845 "description": "This search filter is no longer supp
orted and will have no effect on the results returned.", | |
7846 "location": "query", | |
7847 "type": "boolean" | |
7848 }, | |
7849 "acceptsPublisherPaidPlacements": { | |
7850 "description": "Select only sites that accept publis
her paid placements.", | |
7851 "location": "query", | |
7852 "type": "boolean" | |
7853 }, | |
7854 "adWordsSite": { | |
7855 "description": "Select only AdWords sites.", | |
7856 "location": "query", | |
7857 "type": "boolean" | |
7858 }, | |
7859 "approved": { | |
7860 "description": "Select only approved sites.", | |
7861 "location": "query", | |
7862 "type": "boolean" | |
7863 }, | |
7864 "campaignIds": { | |
7865 "description": "Select only sites with these campaig
n IDs.", | |
7866 "format": "int64", | |
7867 "location": "query", | |
7868 "repeated": true, | |
7869 "type": "string" | |
7870 }, | |
7871 "directorySiteIds": { | |
7872 "description": "Select only sites with these directo
ry site IDs.", | |
7873 "format": "int64", | |
7874 "location": "query", | |
7875 "repeated": true, | |
7876 "type": "string" | |
7877 }, | |
7878 "ids": { | |
7879 "description": "Select only sites with these IDs.", | |
7880 "format": "int64", | |
7881 "location": "query", | |
7882 "repeated": true, | |
7883 "type": "string" | |
7884 }, | |
7885 "maxResults": { | |
7886 "description": "Maximum number of results to return.
", | |
7887 "format": "int32", | |
7888 "location": "query", | |
7889 "type": "integer" | |
7890 }, | |
7891 "pageToken": { | |
7892 "description": "Value of the nextPageToken from the
previous result page.", | |
7893 "location": "query", | |
7894 "type": "string" | |
7895 }, | |
7896 "profileId": { | |
7897 "description": "User profile ID associated with this
request.", | |
7898 "format": "int64", | |
7899 "location": "path", | |
7900 "required": true, | |
7901 "type": "string" | |
7902 }, | |
7903 "searchString": { | |
7904 "description": "Allows searching for objects by name
, ID or keyName. Wildcards (*) are allowed. For example, \"site*2015\" will retu
rn objects with names like \"site June 2015\", \"site April 2015\", or simply \"
site 2015\". Most of the searches also add wildcards implicitly at the start and
the end of the search string. For example, a search string of \"site\" will mat
ch objects with name \"my site\", \"site 2015\", or simply \"site\".", | |
7905 "location": "query", | |
7906 "type": "string" | |
7907 }, | |
7908 "sortField": { | |
7909 "description": "Field by which to sort the list.", | |
7910 "enum": [ | |
7911 "ID", | |
7912 "NAME" | |
7913 ], | |
7914 "enumDescriptions": [ | |
7915 "", | |
7916 "" | |
7917 ], | |
7918 "location": "query", | |
7919 "type": "string" | |
7920 }, | |
7921 "sortOrder": { | |
7922 "description": "Order of sorted results, default is
ASCENDING.", | |
7923 "enum": [ | |
7924 "ASCENDING", | |
7925 "DESCENDING" | |
7926 ], | |
7927 "enumDescriptions": [ | |
7928 "", | |
7929 "" | |
7930 ], | |
7931 "location": "query", | |
7932 "type": "string" | |
7933 }, | |
7934 "subaccountId": { | |
7935 "description": "Select only sites with this subaccou
nt ID.", | |
7936 "format": "int64", | |
7937 "location": "query", | |
7938 "type": "string" | |
7939 }, | |
7940 "unmappedSite": { | |
7941 "description": "Select only sites that have not been
mapped to a directory site.", | |
7942 "location": "query", | |
7943 "type": "boolean" | |
7944 } | |
7945 }, | |
7946 "path": "userprofiles/{profileId}/sites", | |
7947 "response": { | |
7948 "$ref": "SitesListResponse" | |
7949 }, | |
7950 "scopes": [ | |
7951 "https://www.googleapis.com/auth/dfatrafficking" | |
7952 ] | |
7953 }, | |
7954 "patch": { | |
7955 "description": "Updates an existing site. This method suppor
ts patch semantics.", | |
7956 "httpMethod": "PATCH", | |
7957 "id": "dfareporting.sites.patch", | |
7958 "parameterOrder": [ | |
7959 "profileId", | |
7960 "id" | |
7961 ], | |
7962 "parameters": { | |
7963 "id": { | |
7964 "description": "Site ID.", | |
7965 "format": "int64", | |
7966 "location": "query", | |
7967 "required": true, | |
7968 "type": "string" | |
7969 }, | |
7970 "profileId": { | |
7971 "description": "User profile ID associated with this
request.", | |
7972 "format": "int64", | |
7973 "location": "path", | |
7974 "required": true, | |
7975 "type": "string" | |
7976 } | |
7977 }, | |
7978 "path": "userprofiles/{profileId}/sites", | |
7979 "request": { | |
7980 "$ref": "Site" | |
7981 }, | |
7982 "response": { | |
7983 "$ref": "Site" | |
7984 }, | |
7985 "scopes": [ | |
7986 "https://www.googleapis.com/auth/dfatrafficking" | |
7987 ] | |
7988 }, | |
7989 "update": { | |
7990 "description": "Updates an existing site.", | |
7991 "httpMethod": "PUT", | |
7992 "id": "dfareporting.sites.update", | |
7993 "parameterOrder": [ | |
7994 "profileId" | |
7995 ], | |
7996 "parameters": { | |
7997 "profileId": { | |
7998 "description": "User profile ID associated with this
request.", | |
7999 "format": "int64", | |
8000 "location": "path", | |
8001 "required": true, | |
8002 "type": "string" | |
8003 } | |
8004 }, | |
8005 "path": "userprofiles/{profileId}/sites", | |
8006 "request": { | |
8007 "$ref": "Site" | |
8008 }, | |
8009 "response": { | |
8010 "$ref": "Site" | |
8011 }, | |
8012 "scopes": [ | |
8013 "https://www.googleapis.com/auth/dfatrafficking" | |
8014 ] | |
8015 } | |
8016 } | |
8017 }, | |
8018 "sizes": { | |
8019 "methods": { | |
8020 "get": { | |
8021 "description": "Gets one size by ID.", | |
8022 "httpMethod": "GET", | |
8023 "id": "dfareporting.sizes.get", | |
8024 "parameterOrder": [ | |
8025 "profileId", | |
8026 "id" | |
8027 ], | |
8028 "parameters": { | |
8029 "id": { | |
8030 "description": "Size ID.", | |
8031 "format": "int64", | |
8032 "location": "path", | |
8033 "required": true, | |
8034 "type": "string" | |
8035 }, | |
8036 "profileId": { | |
8037 "description": "User profile ID associated with this
request.", | |
8038 "format": "int64", | |
8039 "location": "path", | |
8040 "required": true, | |
8041 "type": "string" | |
8042 } | |
8043 }, | |
8044 "path": "userprofiles/{profileId}/sizes/{id}", | |
8045 "response": { | |
8046 "$ref": "Size" | |
8047 }, | |
8048 "scopes": [ | |
8049 "https://www.googleapis.com/auth/dfatrafficking" | |
8050 ] | |
8051 }, | |
8052 "insert": { | |
8053 "description": "Inserts a new size.", | |
8054 "httpMethod": "POST", | |
8055 "id": "dfareporting.sizes.insert", | |
8056 "parameterOrder": [ | |
8057 "profileId" | |
8058 ], | |
8059 "parameters": { | |
8060 "profileId": { | |
8061 "description": "User profile ID associated with this
request.", | |
8062 "format": "int64", | |
8063 "location": "path", | |
8064 "required": true, | |
8065 "type": "string" | |
8066 } | |
8067 }, | |
8068 "path": "userprofiles/{profileId}/sizes", | |
8069 "request": { | |
8070 "$ref": "Size" | |
8071 }, | |
8072 "response": { | |
8073 "$ref": "Size" | |
8074 }, | |
8075 "scopes": [ | |
8076 "https://www.googleapis.com/auth/dfatrafficking" | |
8077 ] | |
8078 }, | |
8079 "list": { | |
8080 "description": "Retrieves a list of sizes, possibly filtered
.", | |
8081 "httpMethod": "GET", | |
8082 "id": "dfareporting.sizes.list", | |
8083 "parameterOrder": [ | |
8084 "profileId" | |
8085 ], | |
8086 "parameters": { | |
8087 "height": { | |
8088 "description": "Select only sizes with this height."
, | |
8089 "format": "int32", | |
8090 "location": "query", | |
8091 "type": "integer" | |
8092 }, | |
8093 "iabStandard": { | |
8094 "description": "Select only IAB standard sizes.", | |
8095 "location": "query", | |
8096 "type": "boolean" | |
8097 }, | |
8098 "ids": { | |
8099 "description": "Select only sizes with these IDs.", | |
8100 "format": "int64", | |
8101 "location": "query", | |
8102 "repeated": true, | |
8103 "type": "string" | |
8104 }, | |
8105 "profileId": { | |
8106 "description": "User profile ID associated with this
request.", | |
8107 "format": "int64", | |
8108 "location": "path", | |
8109 "required": true, | |
8110 "type": "string" | |
8111 }, | |
8112 "width": { | |
8113 "description": "Select only sizes with this width.", | |
8114 "format": "int32", | |
8115 "location": "query", | |
8116 "type": "integer" | |
8117 } | |
8118 }, | |
8119 "path": "userprofiles/{profileId}/sizes", | |
8120 "response": { | |
8121 "$ref": "SizesListResponse" | |
8122 }, | |
8123 "scopes": [ | |
8124 "https://www.googleapis.com/auth/dfatrafficking" | |
8125 ] | |
8126 } | |
8127 } | |
8128 }, | |
8129 "subaccounts": { | |
8130 "methods": { | |
8131 "get": { | |
8132 "description": "Gets one subaccount by ID.", | |
8133 "httpMethod": "GET", | |
8134 "id": "dfareporting.subaccounts.get", | |
8135 "parameterOrder": [ | |
8136 "profileId", | |
8137 "id" | |
8138 ], | |
8139 "parameters": { | |
8140 "id": { | |
8141 "description": "Subaccount ID.", | |
8142 "format": "int64", | |
8143 "location": "path", | |
8144 "required": true, | |
8145 "type": "string" | |
8146 }, | |
8147 "profileId": { | |
8148 "description": "User profile ID associated with this
request.", | |
8149 "format": "int64", | |
8150 "location": "path", | |
8151 "required": true, | |
8152 "type": "string" | |
8153 } | |
8154 }, | |
8155 "path": "userprofiles/{profileId}/subaccounts/{id}", | |
8156 "response": { | |
8157 "$ref": "Subaccount" | |
8158 }, | |
8159 "scopes": [ | |
8160 "https://www.googleapis.com/auth/dfatrafficking" | |
8161 ] | |
8162 }, | |
8163 "insert": { | |
8164 "description": "Inserts a new subaccount.", | |
8165 "httpMethod": "POST", | |
8166 "id": "dfareporting.subaccounts.insert", | |
8167 "parameterOrder": [ | |
8168 "profileId" | |
8169 ], | |
8170 "parameters": { | |
8171 "profileId": { | |
8172 "description": "User profile ID associated with this
request.", | |
8173 "format": "int64", | |
8174 "location": "path", | |
8175 "required": true, | |
8176 "type": "string" | |
8177 } | |
8178 }, | |
8179 "path": "userprofiles/{profileId}/subaccounts", | |
8180 "request": { | |
8181 "$ref": "Subaccount" | |
8182 }, | |
8183 "response": { | |
8184 "$ref": "Subaccount" | |
8185 }, | |
8186 "scopes": [ | |
8187 "https://www.googleapis.com/auth/dfatrafficking" | |
8188 ] | |
8189 }, | |
8190 "list": { | |
8191 "description": "Gets a list of subaccounts, possibly filtere
d.", | |
8192 "httpMethod": "GET", | |
8193 "id": "dfareporting.subaccounts.list", | |
8194 "parameterOrder": [ | |
8195 "profileId" | |
8196 ], | |
8197 "parameters": { | |
8198 "ids": { | |
8199 "description": "Select only subaccounts with these I
Ds.", | |
8200 "format": "int64", | |
8201 "location": "query", | |
8202 "repeated": true, | |
8203 "type": "string" | |
8204 }, | |
8205 "maxResults": { | |
8206 "description": "Maximum number of results to return.
", | |
8207 "format": "int32", | |
8208 "location": "query", | |
8209 "type": "integer" | |
8210 }, | |
8211 "pageToken": { | |
8212 "description": "Value of the nextPageToken from the
previous result page.", | |
8213 "location": "query", | |
8214 "type": "string" | |
8215 }, | |
8216 "profileId": { | |
8217 "description": "User profile ID associated with this
request.", | |
8218 "format": "int64", | |
8219 "location": "path", | |
8220 "required": true, | |
8221 "type": "string" | |
8222 }, | |
8223 "searchString": { | |
8224 "description": "Allows searching for objects by name
or ID. Wildcards (*) are allowed. For example, \"subaccount*2015\" will return
objects with names like \"subaccount June 2015\", \"subaccount April 2015\", or
simply \"subaccount 2015\". Most of the searches also add wildcards implicitly a
t the start and the end of the search string. For example, a search string of \"
subaccount\" will match objects with name \"my subaccount\", \"subaccount 2015\"
, or simply \"subaccount\".", | |
8225 "location": "query", | |
8226 "type": "string" | |
8227 }, | |
8228 "sortField": { | |
8229 "description": "Field by which to sort the list.", | |
8230 "enum": [ | |
8231 "ID", | |
8232 "NAME" | |
8233 ], | |
8234 "enumDescriptions": [ | |
8235 "", | |
8236 "" | |
8237 ], | |
8238 "location": "query", | |
8239 "type": "string" | |
8240 }, | |
8241 "sortOrder": { | |
8242 "description": "Order of sorted results, default is
ASCENDING.", | |
8243 "enum": [ | |
8244 "ASCENDING", | |
8245 "DESCENDING" | |
8246 ], | |
8247 "enumDescriptions": [ | |
8248 "", | |
8249 "" | |
8250 ], | |
8251 "location": "query", | |
8252 "type": "string" | |
8253 } | |
8254 }, | |
8255 "path": "userprofiles/{profileId}/subaccounts", | |
8256 "response": { | |
8257 "$ref": "SubaccountsListResponse" | |
8258 }, | |
8259 "scopes": [ | |
8260 "https://www.googleapis.com/auth/dfatrafficking" | |
8261 ] | |
8262 }, | |
8263 "patch": { | |
8264 "description": "Updates an existing subaccount. This method
supports patch semantics.", | |
8265 "httpMethod": "PATCH", | |
8266 "id": "dfareporting.subaccounts.patch", | |
8267 "parameterOrder": [ | |
8268 "profileId", | |
8269 "id" | |
8270 ], | |
8271 "parameters": { | |
8272 "id": { | |
8273 "description": "Subaccount ID.", | |
8274 "format": "int64", | |
8275 "location": "query", | |
8276 "required": true, | |
8277 "type": "string" | |
8278 }, | |
8279 "profileId": { | |
8280 "description": "User profile ID associated with this
request.", | |
8281 "format": "int64", | |
8282 "location": "path", | |
8283 "required": true, | |
8284 "type": "string" | |
8285 } | |
8286 }, | |
8287 "path": "userprofiles/{profileId}/subaccounts", | |
8288 "request": { | |
8289 "$ref": "Subaccount" | |
8290 }, | |
8291 "response": { | |
8292 "$ref": "Subaccount" | |
8293 }, | |
8294 "scopes": [ | |
8295 "https://www.googleapis.com/auth/dfatrafficking" | |
8296 ] | |
8297 }, | |
8298 "update": { | |
8299 "description": "Updates an existing subaccount.", | |
8300 "httpMethod": "PUT", | |
8301 "id": "dfareporting.subaccounts.update", | |
8302 "parameterOrder": [ | |
8303 "profileId" | |
8304 ], | |
8305 "parameters": { | |
8306 "profileId": { | |
8307 "description": "User profile ID associated with this
request.", | |
8308 "format": "int64", | |
8309 "location": "path", | |
8310 "required": true, | |
8311 "type": "string" | |
8312 } | |
8313 }, | |
8314 "path": "userprofiles/{profileId}/subaccounts", | |
8315 "request": { | |
8316 "$ref": "Subaccount" | |
8317 }, | |
8318 "response": { | |
8319 "$ref": "Subaccount" | |
8320 }, | |
8321 "scopes": [ | |
8322 "https://www.googleapis.com/auth/dfatrafficking" | |
8323 ] | |
8324 } | |
8325 } | |
8326 }, | |
8327 "targetableRemarketingLists": { | |
8328 "methods": { | |
8329 "get": { | |
8330 "description": "Gets one remarketing list by ID.", | |
8331 "httpMethod": "GET", | |
8332 "id": "dfareporting.targetableRemarketingLists.get", | |
8333 "parameterOrder": [ | |
8334 "profileId", | |
8335 "id" | |
8336 ], | |
8337 "parameters": { | |
8338 "id": { | |
8339 "description": "Remarketing list ID.", | |
8340 "format": "int64", | |
8341 "location": "path", | |
8342 "required": true, | |
8343 "type": "string" | |
8344 }, | |
8345 "profileId": { | |
8346 "description": "User profile ID associated with this
request.", | |
8347 "format": "int64", | |
8348 "location": "path", | |
8349 "required": true, | |
8350 "type": "string" | |
8351 } | |
8352 }, | |
8353 "path": "userprofiles/{profileId}/targetableRemarketingLists
/{id}", | |
8354 "response": { | |
8355 "$ref": "TargetableRemarketingList" | |
8356 }, | |
8357 "scopes": [ | |
8358 "https://www.googleapis.com/auth/dfatrafficking" | |
8359 ] | |
8360 }, | |
8361 "list": { | |
8362 "description": "Retrieves a list of targetable remarketing l
ists, possibly filtered.", | |
8363 "httpMethod": "GET", | |
8364 "id": "dfareporting.targetableRemarketingLists.list", | |
8365 "parameterOrder": [ | |
8366 "profileId", | |
8367 "advertiserId" | |
8368 ], | |
8369 "parameters": { | |
8370 "active": { | |
8371 "description": "Select only active or only inactive
targetable remarketing lists.", | |
8372 "location": "query", | |
8373 "type": "boolean" | |
8374 }, | |
8375 "advertiserId": { | |
8376 "description": "Select only targetable remarketing l
ists targetable by these advertisers.", | |
8377 "format": "int64", | |
8378 "location": "query", | |
8379 "required": true, | |
8380 "type": "string" | |
8381 }, | |
8382 "maxResults": { | |
8383 "description": "Maximum number of results to return.
", | |
8384 "format": "int32", | |
8385 "location": "query", | |
8386 "type": "integer" | |
8387 }, | |
8388 "name": { | |
8389 "description": "Allows searching for objects by name
or ID. Wildcards (*) are allowed. For example, \"remarketing list*2015\" will r
eturn objects with names like \"remarketing list June 2015\", \"remarketing list
April 2015\", or simply \"remarketing list 2015\". Most of the searches also ad
d wildcards implicitly at the start and the end of the search string. For exampl
e, a search string of \"remarketing list\" will match objects with name \"my rem
arketing list\", \"remarketing list 2015\", or simply \"remarketing list\".", | |
8390 "location": "query", | |
8391 "type": "string" | |
8392 }, | |
8393 "pageToken": { | |
8394 "description": "Value of the nextPageToken from the
previous result page.", | |
8395 "location": "query", | |
8396 "type": "string" | |
8397 }, | |
8398 "profileId": { | |
8399 "description": "User profile ID associated with this
request.", | |
8400 "format": "int64", | |
8401 "location": "path", | |
8402 "required": true, | |
8403 "type": "string" | |
8404 }, | |
8405 "sortField": { | |
8406 "description": "Field by which to sort the list.", | |
8407 "enum": [ | |
8408 "ID", | |
8409 "NAME" | |
8410 ], | |
8411 "enumDescriptions": [ | |
8412 "", | |
8413 "" | |
8414 ], | |
8415 "location": "query", | |
8416 "type": "string" | |
8417 }, | |
8418 "sortOrder": { | |
8419 "description": "Order of sorted results, default is
ASCENDING.", | |
8420 "enum": [ | |
8421 "ASCENDING", | |
8422 "DESCENDING" | |
8423 ], | |
8424 "enumDescriptions": [ | |
8425 "", | |
8426 "" | |
8427 ], | |
8428 "location": "query", | |
8429 "type": "string" | |
8430 } | |
8431 }, | |
8432 "path": "userprofiles/{profileId}/targetableRemarketingLists
", | |
8433 "response": { | |
8434 "$ref": "TargetableRemarketingListsListResponse" | |
8435 }, | |
8436 "scopes": [ | |
8437 "https://www.googleapis.com/auth/dfatrafficking" | |
8438 ] | |
8439 } | |
8440 } | |
8441 }, | |
8442 "userProfiles": { | |
8443 "methods": { | |
8444 "get": { | |
8445 "description": "Gets one user profile by ID.", | |
8446 "httpMethod": "GET", | |
8447 "id": "dfareporting.userProfiles.get", | |
8448 "parameterOrder": [ | |
8449 "profileId" | |
8450 ], | |
8451 "parameters": { | |
8452 "profileId": { | |
8453 "description": "The user profile ID.", | |
8454 "format": "int64", | |
8455 "location": "path", | |
8456 "required": true, | |
8457 "type": "string" | |
8458 } | |
8459 }, | |
8460 "path": "userprofiles/{profileId}", | |
8461 "response": { | |
8462 "$ref": "UserProfile" | |
8463 }, | |
8464 "scopes": [ | |
8465 "https://www.googleapis.com/auth/dfareporting", | |
8466 "https://www.googleapis.com/auth/dfatrafficking" | |
8467 ] | |
8468 }, | |
8469 "list": { | |
8470 "description": "Retrieves list of user profiles for a user."
, | |
8471 "httpMethod": "GET", | |
8472 "id": "dfareporting.userProfiles.list", | |
8473 "path": "userprofiles", | |
8474 "response": { | |
8475 "$ref": "UserProfileList" | |
8476 }, | |
8477 "scopes": [ | |
8478 "https://www.googleapis.com/auth/dfareporting", | |
8479 "https://www.googleapis.com/auth/dfatrafficking" | |
8480 ] | |
8481 } | |
8482 } | |
8483 }, | |
8484 "userRolePermissionGroups": { | |
8485 "methods": { | |
8486 "get": { | |
8487 "description": "Gets one user role permission group by ID.", | |
8488 "httpMethod": "GET", | |
8489 "id": "dfareporting.userRolePermissionGroups.get", | |
8490 "parameterOrder": [ | |
8491 "profileId", | |
8492 "id" | |
8493 ], | |
8494 "parameters": { | |
8495 "id": { | |
8496 "description": "User role permission group ID.", | |
8497 "format": "int64", | |
8498 "location": "path", | |
8499 "required": true, | |
8500 "type": "string" | |
8501 }, | |
8502 "profileId": { | |
8503 "description": "User profile ID associated with this
request.", | |
8504 "format": "int64", | |
8505 "location": "path", | |
8506 "required": true, | |
8507 "type": "string" | |
8508 } | |
8509 }, | |
8510 "path": "userprofiles/{profileId}/userRolePermissionGroups/{
id}", | |
8511 "response": { | |
8512 "$ref": "UserRolePermissionGroup" | |
8513 }, | |
8514 "scopes": [ | |
8515 "https://www.googleapis.com/auth/dfatrafficking" | |
8516 ] | |
8517 }, | |
8518 "list": { | |
8519 "description": "Gets a list of all supported user role permi
ssion groups.", | |
8520 "httpMethod": "GET", | |
8521 "id": "dfareporting.userRolePermissionGroups.list", | |
8522 "parameterOrder": [ | |
8523 "profileId" | |
8524 ], | |
8525 "parameters": { | |
8526 "profileId": { | |
8527 "description": "User profile ID associated with this
request.", | |
8528 "format": "int64", | |
8529 "location": "path", | |
8530 "required": true, | |
8531 "type": "string" | |
8532 } | |
8533 }, | |
8534 "path": "userprofiles/{profileId}/userRolePermissionGroups", | |
8535 "response": { | |
8536 "$ref": "UserRolePermissionGroupsListResponse" | |
8537 }, | |
8538 "scopes": [ | |
8539 "https://www.googleapis.com/auth/dfatrafficking" | |
8540 ] | |
8541 } | |
8542 } | |
8543 }, | |
8544 "userRolePermissions": { | |
8545 "methods": { | |
8546 "get": { | |
8547 "description": "Gets one user role permission by ID.", | |
8548 "httpMethod": "GET", | |
8549 "id": "dfareporting.userRolePermissions.get", | |
8550 "parameterOrder": [ | |
8551 "profileId", | |
8552 "id" | |
8553 ], | |
8554 "parameters": { | |
8555 "id": { | |
8556 "description": "User role permission ID.", | |
8557 "format": "int64", | |
8558 "location": "path", | |
8559 "required": true, | |
8560 "type": "string" | |
8561 }, | |
8562 "profileId": { | |
8563 "description": "User profile ID associated with this
request.", | |
8564 "format": "int64", | |
8565 "location": "path", | |
8566 "required": true, | |
8567 "type": "string" | |
8568 } | |
8569 }, | |
8570 "path": "userprofiles/{profileId}/userRolePermissions/{id}", | |
8571 "response": { | |
8572 "$ref": "UserRolePermission" | |
8573 }, | |
8574 "scopes": [ | |
8575 "https://www.googleapis.com/auth/dfatrafficking" | |
8576 ] | |
8577 }, | |
8578 "list": { | |
8579 "description": "Gets a list of user role permissions, possib
ly filtered.", | |
8580 "httpMethod": "GET", | |
8581 "id": "dfareporting.userRolePermissions.list", | |
8582 "parameterOrder": [ | |
8583 "profileId" | |
8584 ], | |
8585 "parameters": { | |
8586 "ids": { | |
8587 "description": "Select only user role permissions wi
th these IDs.", | |
8588 "format": "int64", | |
8589 "location": "query", | |
8590 "repeated": true, | |
8591 "type": "string" | |
8592 }, | |
8593 "profileId": { | |
8594 "description": "User profile ID associated with this
request.", | |
8595 "format": "int64", | |
8596 "location": "path", | |
8597 "required": true, | |
8598 "type": "string" | |
8599 } | |
8600 }, | |
8601 "path": "userprofiles/{profileId}/userRolePermissions", | |
8602 "response": { | |
8603 "$ref": "UserRolePermissionsListResponse" | |
8604 }, | |
8605 "scopes": [ | |
8606 "https://www.googleapis.com/auth/dfatrafficking" | |
8607 ] | |
8608 } | |
8609 } | |
8610 }, | |
8611 "userRoles": { | |
8612 "methods": { | |
8613 "delete": { | |
8614 "description": "Deletes an existing user role.", | |
8615 "httpMethod": "DELETE", | |
8616 "id": "dfareporting.userRoles.delete", | |
8617 "parameterOrder": [ | |
8618 "profileId", | |
8619 "id" | |
8620 ], | |
8621 "parameters": { | |
8622 "id": { | |
8623 "description": "User role ID.", | |
8624 "format": "int64", | |
8625 "location": "path", | |
8626 "required": true, | |
8627 "type": "string" | |
8628 }, | |
8629 "profileId": { | |
8630 "description": "User profile ID associated with this
request.", | |
8631 "format": "int64", | |
8632 "location": "path", | |
8633 "required": true, | |
8634 "type": "string" | |
8635 } | |
8636 }, | |
8637 "path": "userprofiles/{profileId}/userRoles/{id}", | |
8638 "scopes": [ | |
8639 "https://www.googleapis.com/auth/dfatrafficking" | |
8640 ] | |
8641 }, | |
8642 "get": { | |
8643 "description": "Gets one user role by ID.", | |
8644 "httpMethod": "GET", | |
8645 "id": "dfareporting.userRoles.get", | |
8646 "parameterOrder": [ | |
8647 "profileId", | |
8648 "id" | |
8649 ], | |
8650 "parameters": { | |
8651 "id": { | |
8652 "description": "User role ID.", | |
8653 "format": "int64", | |
8654 "location": "path", | |
8655 "required": true, | |
8656 "type": "string" | |
8657 }, | |
8658 "profileId": { | |
8659 "description": "User profile ID associated with this
request.", | |
8660 "format": "int64", | |
8661 "location": "path", | |
8662 "required": true, | |
8663 "type": "string" | |
8664 } | |
8665 }, | |
8666 "path": "userprofiles/{profileId}/userRoles/{id}", | |
8667 "response": { | |
8668 "$ref": "UserRole" | |
8669 }, | |
8670 "scopes": [ | |
8671 "https://www.googleapis.com/auth/dfatrafficking" | |
8672 ] | |
8673 }, | |
8674 "insert": { | |
8675 "description": "Inserts a new user role.", | |
8676 "httpMethod": "POST", | |
8677 "id": "dfareporting.userRoles.insert", | |
8678 "parameterOrder": [ | |
8679 "profileId" | |
8680 ], | |
8681 "parameters": { | |
8682 "profileId": { | |
8683 "description": "User profile ID associated with this
request.", | |
8684 "format": "int64", | |
8685 "location": "path", | |
8686 "required": true, | |
8687 "type": "string" | |
8688 } | |
8689 }, | |
8690 "path": "userprofiles/{profileId}/userRoles", | |
8691 "request": { | |
8692 "$ref": "UserRole" | |
8693 }, | |
8694 "response": { | |
8695 "$ref": "UserRole" | |
8696 }, | |
8697 "scopes": [ | |
8698 "https://www.googleapis.com/auth/dfatrafficking" | |
8699 ] | |
8700 }, | |
8701 "list": { | |
8702 "description": "Retrieves a list of user roles, possibly fil
tered.", | |
8703 "httpMethod": "GET", | |
8704 "id": "dfareporting.userRoles.list", | |
8705 "parameterOrder": [ | |
8706 "profileId" | |
8707 ], | |
8708 "parameters": { | |
8709 "accountUserRoleOnly": { | |
8710 "description": "Select only account level user roles
not associated with any specific subaccount.", | |
8711 "location": "query", | |
8712 "type": "boolean" | |
8713 }, | |
8714 "ids": { | |
8715 "description": "Select only user roles with the spec
ified IDs.", | |
8716 "format": "int64", | |
8717 "location": "query", | |
8718 "repeated": true, | |
8719 "type": "string" | |
8720 }, | |
8721 "maxResults": { | |
8722 "description": "Maximum number of results to return.
", | |
8723 "format": "int32", | |
8724 "location": "query", | |
8725 "type": "integer" | |
8726 }, | |
8727 "pageToken": { | |
8728 "description": "Value of the nextPageToken from the
previous result page.", | |
8729 "location": "query", | |
8730 "type": "string" | |
8731 }, | |
8732 "profileId": { | |
8733 "description": "User profile ID associated with this
request.", | |
8734 "format": "int64", | |
8735 "location": "path", | |
8736 "required": true, | |
8737 "type": "string" | |
8738 }, | |
8739 "searchString": { | |
8740 "description": "Allows searching for objects by name
or ID. Wildcards (*) are allowed. For example, \"userrole*2015\" will return ob
jects with names like \"userrole June 2015\", \"userrole April 2015\", or simply
\"userrole 2015\". Most of the searches also add wildcards implicitly at the st
art and the end of the search string. For example, a search string of \"userrole
\" will match objects with name \"my userrole\", \"userrole 2015\", or simply \"
userrole\".", | |
8741 "location": "query", | |
8742 "type": "string" | |
8743 }, | |
8744 "sortField": { | |
8745 "description": "Field by which to sort the list.", | |
8746 "enum": [ | |
8747 "ID", | |
8748 "NAME" | |
8749 ], | |
8750 "enumDescriptions": [ | |
8751 "", | |
8752 "" | |
8753 ], | |
8754 "location": "query", | |
8755 "type": "string" | |
8756 }, | |
8757 "sortOrder": { | |
8758 "description": "Order of sorted results, default is
ASCENDING.", | |
8759 "enum": [ | |
8760 "ASCENDING", | |
8761 "DESCENDING" | |
8762 ], | |
8763 "enumDescriptions": [ | |
8764 "", | |
8765 "" | |
8766 ], | |
8767 "location": "query", | |
8768 "type": "string" | |
8769 }, | |
8770 "subaccountId": { | |
8771 "description": "Select only user roles that belong t
o this subaccount.", | |
8772 "format": "int64", | |
8773 "location": "query", | |
8774 "type": "string" | |
8775 } | |
8776 }, | |
8777 "path": "userprofiles/{profileId}/userRoles", | |
8778 "response": { | |
8779 "$ref": "UserRolesListResponse" | |
8780 }, | |
8781 "scopes": [ | |
8782 "https://www.googleapis.com/auth/dfatrafficking" | |
8783 ] | |
8784 }, | |
8785 "patch": { | |
8786 "description": "Updates an existing user role. This method s
upports patch semantics.", | |
8787 "httpMethod": "PATCH", | |
8788 "id": "dfareporting.userRoles.patch", | |
8789 "parameterOrder": [ | |
8790 "profileId", | |
8791 "id" | |
8792 ], | |
8793 "parameters": { | |
8794 "id": { | |
8795 "description": "User role ID.", | |
8796 "format": "int64", | |
8797 "location": "query", | |
8798 "required": true, | |
8799 "type": "string" | |
8800 }, | |
8801 "profileId": { | |
8802 "description": "User profile ID associated with this
request.", | |
8803 "format": "int64", | |
8804 "location": "path", | |
8805 "required": true, | |
8806 "type": "string" | |
8807 } | |
8808 }, | |
8809 "path": "userprofiles/{profileId}/userRoles", | |
8810 "request": { | |
8811 "$ref": "UserRole" | |
8812 }, | |
8813 "response": { | |
8814 "$ref": "UserRole" | |
8815 }, | |
8816 "scopes": [ | |
8817 "https://www.googleapis.com/auth/dfatrafficking" | |
8818 ] | |
8819 }, | |
8820 "update": { | |
8821 "description": "Updates an existing user role.", | |
8822 "httpMethod": "PUT", | |
8823 "id": "dfareporting.userRoles.update", | |
8824 "parameterOrder": [ | |
8825 "profileId" | |
8826 ], | |
8827 "parameters": { | |
8828 "profileId": { | |
8829 "description": "User profile ID associated with this
request.", | |
8830 "format": "int64", | |
8831 "location": "path", | |
8832 "required": true, | |
8833 "type": "string" | |
8834 } | |
8835 }, | |
8836 "path": "userprofiles/{profileId}/userRoles", | |
8837 "request": { | |
8838 "$ref": "UserRole" | |
8839 }, | |
8840 "response": { | |
8841 "$ref": "UserRole" | |
8842 }, | |
8843 "scopes": [ | |
8844 "https://www.googleapis.com/auth/dfatrafficking" | |
8845 ] | |
8846 } | |
8847 } | |
8848 } | |
8849 }, | |
8850 "revision": "20160803", | |
8851 "rootUrl": "https://www.googleapis.com/", | |
8852 "schemas": { | |
8853 "Account": { | |
8854 "description": "Contains properties of a DCM account.", | |
8855 "id": "Account", | |
8856 "properties": { | |
8857 "accountPermissionIds": { | |
8858 "description": "Account permissions assigned to this account
.", | |
8859 "items": { | |
8860 "format": "int64", | |
8861 "type": "string" | |
8862 }, | |
8863 "type": "array" | |
8864 }, | |
8865 "accountProfile": { | |
8866 "description": "Profile for this account. This is a read-onl
y field that can be left blank.", | |
8867 "enum": [ | |
8868 "ACCOUNT_PROFILE_BASIC", | |
8869 "ACCOUNT_PROFILE_STANDARD" | |
8870 ], | |
8871 "enumDescriptions": [ | |
8872 "", | |
8873 "" | |
8874 ], | |
8875 "type": "string" | |
8876 }, | |
8877 "active": { | |
8878 "description": "Whether this account is active.", | |
8879 "type": "boolean" | |
8880 }, | |
8881 "activeAdsLimitTier": { | |
8882 "description": "Maximum number of active ads allowed for thi
s account.", | |
8883 "enum": [ | |
8884 "ACTIVE_ADS_TIER_100K", | |
8885 "ACTIVE_ADS_TIER_200K", | |
8886 "ACTIVE_ADS_TIER_300K", | |
8887 "ACTIVE_ADS_TIER_40K", | |
8888 "ACTIVE_ADS_TIER_500K", | |
8889 "ACTIVE_ADS_TIER_75K" | |
8890 ], | |
8891 "enumDescriptions": [ | |
8892 "", | |
8893 "", | |
8894 "", | |
8895 "", | |
8896 "", | |
8897 "" | |
8898 ], | |
8899 "type": "string" | |
8900 }, | |
8901 "activeViewOptOut": { | |
8902 "description": "Whether to serve creatives with Active View
tags. If disabled, viewability data will not be available for any impressions.", | |
8903 "type": "boolean" | |
8904 }, | |
8905 "availablePermissionIds": { | |
8906 "description": "User role permissions available to the user
roles of this account.", | |
8907 "items": { | |
8908 "format": "int64", | |
8909 "type": "string" | |
8910 }, | |
8911 "type": "array" | |
8912 }, | |
8913 "comscoreVceEnabled": { | |
8914 "description": "Whether campaigns created in this account wi
ll be enabled for comScore vCE by default.", | |
8915 "type": "boolean" | |
8916 }, | |
8917 "countryId": { | |
8918 "description": "ID of the country associated with this accou
nt.", | |
8919 "format": "int64", | |
8920 "type": "string" | |
8921 }, | |
8922 "currencyId": { | |
8923 "description": "ID of currency associated with this account.
This is a required field.\nAcceptable values are: \n- \"1\" for USD \n- \"2\" f
or GBP \n- \"3\" for ESP \n- \"4\" for SEK \n- \"5\" for CAD \n- \"6\" for JPY \
n- \"7\" for DEM \n- \"8\" for AUD \n- \"9\" for FRF \n- \"10\" for ITL \n- \"11
\" for DKK \n- \"12\" for NOK \n- \"13\" for FIM \n- \"14\" for ZAR \n- \"15\" f
or IEP \n- \"16\" for NLG \n- \"17\" for EUR \n- \"18\" for KRW \n- \"19\" for T
WD \n- \"20\" for SGD \n- \"21\" for CNY \n- \"22\" for HKD \n- \"23\" for NZD \
n- \"24\" for MYR \n- \"25\" for BRL \n- \"26\" for PTE \n- \"27\" for MXP \n- \
"28\" for CLP \n- \"29\" for TRY \n- \"30\" for ARS \n- \"31\" for PEN \n- \"32\
" for ILS \n- \"33\" for CHF \n- \"34\" for VEF \n- \"35\" for COP \n- \"36\" fo
r GTQ \n- \"37\" for PLN \n- \"39\" for INR \n- \"40\" for THB \n- \"41\" for ID
R \n- \"42\" for CZK \n- \"43\" for RON \n- \"44\" for HUF \n- \"45\" for RUB \n
- \"46\" for AED \n- \"47\" for BGN \n- \"48\" for HRK", | |
8924 "format": "int64", | |
8925 "type": "string" | |
8926 }, | |
8927 "defaultCreativeSizeId": { | |
8928 "description": "Default placement dimensions for this accoun
t.", | |
8929 "format": "int64", | |
8930 "type": "string" | |
8931 }, | |
8932 "description": { | |
8933 "description": "Description of this account.", | |
8934 "type": "string" | |
8935 }, | |
8936 "id": { | |
8937 "description": "ID of this account. This is a read-only, aut
o-generated field.", | |
8938 "format": "int64", | |
8939 "type": "string" | |
8940 }, | |
8941 "kind": { | |
8942 "default": "dfareporting#account", | |
8943 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#account\".", | |
8944 "type": "string" | |
8945 }, | |
8946 "locale": { | |
8947 "description": "Locale of this account.\nAcceptable values a
re: \n- \"cs\" (Czech) \n- \"de\" (German) \n- \"en\" (English) \n- \"en-GB\" (E
nglish United Kingdom) \n- \"es\" (Spanish) \n- \"fr\" (French) \n- \"it\" (Ital
ian) \n- \"ja\" (Japanese) \n- \"ko\" (Korean) \n- \"pl\" (Polish) \n- \"pt-BR\"
(Portuguese Brazil) \n- \"ru\" (Russian) \n- \"sv\" (Swedish) \n- \"tr\" (Turki
sh) \n- \"zh-CN\" (Chinese Simplified) \n- \"zh-TW\" (Chinese Traditional)", | |
8948 "type": "string" | |
8949 }, | |
8950 "maximumImageSize": { | |
8951 "description": "Maximum image size allowed for this account.
", | |
8952 "format": "int64", | |
8953 "type": "string" | |
8954 }, | |
8955 "name": { | |
8956 "description": "Name of this account. This is a required fie
ld, and must be less than 128 characters long and be globally unique.", | |
8957 "type": "string" | |
8958 }, | |
8959 "nielsenOcrEnabled": { | |
8960 "description": "Whether campaigns created in this account wi
ll be enabled for Nielsen OCR reach ratings by default.", | |
8961 "type": "boolean" | |
8962 }, | |
8963 "reportsConfiguration": { | |
8964 "$ref": "ReportsConfiguration", | |
8965 "description": "Reporting configuration of this account." | |
8966 }, | |
8967 "teaserSizeLimit": { | |
8968 "description": "File size limit in kilobytes of Rich Media t
easer creatives. Must be between 1 and 10240.", | |
8969 "format": "int64", | |
8970 "type": "string" | |
8971 } | |
8972 }, | |
8973 "type": "object" | |
8974 }, | |
8975 "AccountActiveAdSummary": { | |
8976 "description": "Gets a summary of active ads in an account.", | |
8977 "id": "AccountActiveAdSummary", | |
8978 "properties": { | |
8979 "accountId": { | |
8980 "description": "ID of the account.", | |
8981 "format": "int64", | |
8982 "type": "string" | |
8983 }, | |
8984 "activeAds": { | |
8985 "description": "Ads that have been activated for the account
", | |
8986 "format": "int64", | |
8987 "type": "string" | |
8988 }, | |
8989 "activeAdsLimitTier": { | |
8990 "description": "Maximum number of active ads allowed for the
account.", | |
8991 "enum": [ | |
8992 "ACTIVE_ADS_TIER_100K", | |
8993 "ACTIVE_ADS_TIER_200K", | |
8994 "ACTIVE_ADS_TIER_300K", | |
8995 "ACTIVE_ADS_TIER_40K", | |
8996 "ACTIVE_ADS_TIER_500K", | |
8997 "ACTIVE_ADS_TIER_75K" | |
8998 ], | |
8999 "enumDescriptions": [ | |
9000 "", | |
9001 "", | |
9002 "", | |
9003 "", | |
9004 "", | |
9005 "" | |
9006 ], | |
9007 "type": "string" | |
9008 }, | |
9009 "availableAds": { | |
9010 "description": "Ads that can be activated for the account.", | |
9011 "format": "int64", | |
9012 "type": "string" | |
9013 }, | |
9014 "kind": { | |
9015 "default": "dfareporting#accountActiveAdSummary", | |
9016 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#accountActiveAdSummary\".", | |
9017 "type": "string" | |
9018 } | |
9019 }, | |
9020 "type": "object" | |
9021 }, | |
9022 "AccountPermission": { | |
9023 "description": "AccountPermissions contains information about a part
icular account permission. Some features of DCM require an account permission to
be present in the account.", | |
9024 "id": "AccountPermission", | |
9025 "properties": { | |
9026 "accountProfiles": { | |
9027 "description": "Account profiles associated with this accoun
t permission.\n\nPossible values are:\n- \"ACCOUNT_PROFILE_BASIC\"\n- \"ACCOUNT_
PROFILE_STANDARD\"", | |
9028 "items": { | |
9029 "enum": [ | |
9030 "ACCOUNT_PROFILE_BASIC", | |
9031 "ACCOUNT_PROFILE_STANDARD" | |
9032 ], | |
9033 "enumDescriptions": [ | |
9034 "", | |
9035 "" | |
9036 ], | |
9037 "type": "string" | |
9038 }, | |
9039 "type": "array" | |
9040 }, | |
9041 "id": { | |
9042 "description": "ID of this account permission.", | |
9043 "format": "int64", | |
9044 "type": "string" | |
9045 }, | |
9046 "kind": { | |
9047 "default": "dfareporting#accountPermission", | |
9048 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#accountPermission\".", | |
9049 "type": "string" | |
9050 }, | |
9051 "level": { | |
9052 "description": "Administrative level required to enable this
account permission.", | |
9053 "enum": [ | |
9054 "ADMINISTRATOR", | |
9055 "USER" | |
9056 ], | |
9057 "enumDescriptions": [ | |
9058 "", | |
9059 "" | |
9060 ], | |
9061 "type": "string" | |
9062 }, | |
9063 "name": { | |
9064 "description": "Name of this account permission.", | |
9065 "type": "string" | |
9066 }, | |
9067 "permissionGroupId": { | |
9068 "description": "Permission group of this account permission.
", | |
9069 "format": "int64", | |
9070 "type": "string" | |
9071 } | |
9072 }, | |
9073 "type": "object" | |
9074 }, | |
9075 "AccountPermissionGroup": { | |
9076 "description": "AccountPermissionGroups contains a mapping of permis
sion group IDs to names. A permission group is a grouping of account permissions
.", | |
9077 "id": "AccountPermissionGroup", | |
9078 "properties": { | |
9079 "id": { | |
9080 "description": "ID of this account permission group.", | |
9081 "format": "int64", | |
9082 "type": "string" | |
9083 }, | |
9084 "kind": { | |
9085 "default": "dfareporting#accountPermissionGroup", | |
9086 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#accountPermissionGroup\".", | |
9087 "type": "string" | |
9088 }, | |
9089 "name": { | |
9090 "description": "Name of this account permission group.", | |
9091 "type": "string" | |
9092 } | |
9093 }, | |
9094 "type": "object" | |
9095 }, | |
9096 "AccountPermissionGroupsListResponse": { | |
9097 "description": "Account Permission Group List Response", | |
9098 "id": "AccountPermissionGroupsListResponse", | |
9099 "properties": { | |
9100 "accountPermissionGroups": { | |
9101 "description": "Account permission group collection.", | |
9102 "items": { | |
9103 "$ref": "AccountPermissionGroup" | |
9104 }, | |
9105 "type": "array" | |
9106 }, | |
9107 "kind": { | |
9108 "default": "dfareporting#accountPermissionGroupsListResponse
", | |
9109 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#accountPermissionGroupsListResponse\".", | |
9110 "type": "string" | |
9111 } | |
9112 }, | |
9113 "type": "object" | |
9114 }, | |
9115 "AccountPermissionsListResponse": { | |
9116 "description": "Account Permission List Response", | |
9117 "id": "AccountPermissionsListResponse", | |
9118 "properties": { | |
9119 "accountPermissions": { | |
9120 "description": "Account permission collection.", | |
9121 "items": { | |
9122 "$ref": "AccountPermission" | |
9123 }, | |
9124 "type": "array" | |
9125 }, | |
9126 "kind": { | |
9127 "default": "dfareporting#accountPermissionsListResponse", | |
9128 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#accountPermissionsListResponse\".", | |
9129 "type": "string" | |
9130 } | |
9131 }, | |
9132 "type": "object" | |
9133 }, | |
9134 "AccountUserProfile": { | |
9135 "description": "AccountUserProfiles contains properties of a DCM use
r profile. This resource is specifically for managing user profiles, whereas Use
rProfiles is for accessing the API.", | |
9136 "id": "AccountUserProfile", | |
9137 "properties": { | |
9138 "accountId": { | |
9139 "description": "Account ID of the user profile. This is a re
ad-only field that can be left blank.", | |
9140 "format": "int64", | |
9141 "type": "string" | |
9142 }, | |
9143 "active": { | |
9144 "description": "Whether this user profile is active. This de
faults to false, and must be set true on insert for the user profile to be usabl
e.", | |
9145 "type": "boolean" | |
9146 }, | |
9147 "advertiserFilter": { | |
9148 "$ref": "ObjectFilter", | |
9149 "description": "Filter that describes which advertisers are
visible to the user profile." | |
9150 }, | |
9151 "campaignFilter": { | |
9152 "$ref": "ObjectFilter", | |
9153 "description": "Filter that describes which campaigns are vi
sible to the user profile." | |
9154 }, | |
9155 "comments": { | |
9156 "description": "Comments for this user profile.", | |
9157 "type": "string" | |
9158 }, | |
9159 "email": { | |
9160 "description": "Email of the user profile. The email address
s must be linked to a Google Account. This field is required on insertion and is
read-only after insertion.", | |
9161 "type": "string" | |
9162 }, | |
9163 "id": { | |
9164 "description": "ID of the user profile. This is a read-only,
auto-generated field.", | |
9165 "format": "int64", | |
9166 "type": "string" | |
9167 }, | |
9168 "kind": { | |
9169 "default": "dfareporting#accountUserProfile", | |
9170 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#accountUserProfile\".", | |
9171 "type": "string" | |
9172 }, | |
9173 "locale": { | |
9174 "description": "Locale of the user profile. This is a requir
ed field.\nAcceptable values are: \n- \"cs\" (Czech) \n- \"de\" (German) \n- \"
en\" (English) \n- \"en-GB\" (English United Kingdom) \n- \"es\" (Spanish) \n- \
"fr\" (French) \n- \"it\" (Italian) \n- \"ja\" (Japanese) \n- \"ko\" (Korean) \n
- \"pl\" (Polish) \n- \"pt-BR\" (Portuguese Brazil)\n- \"ru\" (Russian) \n- \"sv
\" (Swedish) \n- \"tr\" (Turkish) \n- \"zh-CN\" (Chinese Simplified) \n- \"zh-TW
\" (Chinese Traditional)", | |
9175 "type": "string" | |
9176 }, | |
9177 "name": { | |
9178 "description": "Name of the user profile. This is a required
field. Must be less than 64 characters long, must be globally unique, and canno
t contain whitespace or any of the following characters: \"&;\"#%,\".", | |
9179 "type": "string" | |
9180 }, | |
9181 "siteFilter": { | |
9182 "$ref": "ObjectFilter", | |
9183 "description": "Filter that describes which sites are visibl
e to the user profile." | |
9184 }, | |
9185 "subaccountId": { | |
9186 "description": "Subaccount ID of the user profile. This is a
read-only field that can be left blank.", | |
9187 "format": "int64", | |
9188 "type": "string" | |
9189 }, | |
9190 "traffickerType": { | |
9191 "description": "Trafficker type of this user profile.", | |
9192 "enum": [ | |
9193 "EXTERNAL_TRAFFICKER", | |
9194 "INTERNAL_NON_TRAFFICKER", | |
9195 "INTERNAL_TRAFFICKER" | |
9196 ], | |
9197 "enumDescriptions": [ | |
9198 "", | |
9199 "", | |
9200 "" | |
9201 ], | |
9202 "type": "string" | |
9203 }, | |
9204 "userAccessType": { | |
9205 "description": "User type of the user profile. This is a rea
d-only field that can be left blank.", | |
9206 "enum": [ | |
9207 "INTERNAL_ADMINISTRATOR", | |
9208 "NORMAL_USER", | |
9209 "READ_ONLY_SUPER_USER", | |
9210 "SUPER_USER" | |
9211 ], | |
9212 "enumDescriptions": [ | |
9213 "", | |
9214 "", | |
9215 "", | |
9216 "" | |
9217 ], | |
9218 "type": "string" | |
9219 }, | |
9220 "userRoleFilter": { | |
9221 "$ref": "ObjectFilter", | |
9222 "description": "Filter that describes which user roles are v
isible to the user profile." | |
9223 }, | |
9224 "userRoleId": { | |
9225 "description": "User role ID of the user profile. This is a
required field.", | |
9226 "format": "int64", | |
9227 "type": "string" | |
9228 } | |
9229 }, | |
9230 "type": "object" | |
9231 }, | |
9232 "AccountUserProfilesListResponse": { | |
9233 "description": "Account User Profile List Response", | |
9234 "id": "AccountUserProfilesListResponse", | |
9235 "properties": { | |
9236 "accountUserProfiles": { | |
9237 "description": "Account user profile collection.", | |
9238 "items": { | |
9239 "$ref": "AccountUserProfile" | |
9240 }, | |
9241 "type": "array" | |
9242 }, | |
9243 "kind": { | |
9244 "default": "dfareporting#accountUserProfilesListResponse", | |
9245 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#accountUserProfilesListResponse\".", | |
9246 "type": "string" | |
9247 }, | |
9248 "nextPageToken": { | |
9249 "description": "Pagination token to be used for the next lis
t operation.", | |
9250 "type": "string" | |
9251 } | |
9252 }, | |
9253 "type": "object" | |
9254 }, | |
9255 "AccountsListResponse": { | |
9256 "description": "Account List Response", | |
9257 "id": "AccountsListResponse", | |
9258 "properties": { | |
9259 "accounts": { | |
9260 "description": "Account collection.", | |
9261 "items": { | |
9262 "$ref": "Account" | |
9263 }, | |
9264 "type": "array" | |
9265 }, | |
9266 "kind": { | |
9267 "default": "dfareporting#accountsListResponse", | |
9268 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#accountsListResponse\".", | |
9269 "type": "string" | |
9270 }, | |
9271 "nextPageToken": { | |
9272 "description": "Pagination token to be used for the next lis
t operation.", | |
9273 "type": "string" | |
9274 } | |
9275 }, | |
9276 "type": "object" | |
9277 }, | |
9278 "Activities": { | |
9279 "description": "Represents an activity group.", | |
9280 "id": "Activities", | |
9281 "properties": { | |
9282 "filters": { | |
9283 "description": "List of activity filters. The dimension valu
es need to be all either of type \"dfa:activity\" or \"dfa:activityGroup\".", | |
9284 "items": { | |
9285 "$ref": "DimensionValue" | |
9286 }, | |
9287 "type": "array" | |
9288 }, | |
9289 "kind": { | |
9290 "default": "dfareporting#activities", | |
9291 "description": "The kind of resource this is, in this case d
fareporting#activities.", | |
9292 "type": "string" | |
9293 }, | |
9294 "metricNames": { | |
9295 "description": "List of names of floodlight activity metrics
.", | |
9296 "items": { | |
9297 "type": "string" | |
9298 }, | |
9299 "type": "array" | |
9300 } | |
9301 }, | |
9302 "type": "object" | |
9303 }, | |
9304 "Ad": { | |
9305 "description": "Contains properties of a DCM ad.", | |
9306 "id": "Ad", | |
9307 "properties": { | |
9308 "accountId": { | |
9309 "description": "Account ID of this ad. This is a read-only f
ield that can be left blank.", | |
9310 "format": "int64", | |
9311 "type": "string" | |
9312 }, | |
9313 "active": { | |
9314 "description": "Whether this ad is active.", | |
9315 "type": "boolean" | |
9316 }, | |
9317 "advertiserId": { | |
9318 "description": "Advertiser ID of this ad. This is a required
field on insertion.", | |
9319 "format": "int64", | |
9320 "type": "string" | |
9321 }, | |
9322 "advertiserIdDimensionValue": { | |
9323 "$ref": "DimensionValue", | |
9324 "description": "Dimension value for the ID of the advertiser
. This is a read-only, auto-generated field." | |
9325 }, | |
9326 "archived": { | |
9327 "description": "Whether this ad is archived.", | |
9328 "type": "boolean" | |
9329 }, | |
9330 "audienceSegmentId": { | |
9331 "description": "Audience segment ID that is being targeted f
or this ad. Applicable when type is AD_SERVING_STANDARD_AD.", | |
9332 "format": "int64", | |
9333 "type": "string" | |
9334 }, | |
9335 "campaignId": { | |
9336 "description": "Campaign ID of this ad. This is a required f
ield on insertion.", | |
9337 "format": "int64", | |
9338 "type": "string" | |
9339 }, | |
9340 "campaignIdDimensionValue": { | |
9341 "$ref": "DimensionValue", | |
9342 "description": "Dimension value for the ID of the campaign.
This is a read-only, auto-generated field." | |
9343 }, | |
9344 "clickThroughUrl": { | |
9345 "$ref": "ClickThroughUrl", | |
9346 "description": "Click-through URL for this ad. This is a req
uired field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER." | |
9347 }, | |
9348 "clickThroughUrlSuffixProperties": { | |
9349 "$ref": "ClickThroughUrlSuffixProperties", | |
9350 "description": "Click-through URL suffix properties for this
ad. Applies to the URL in the ad or (if overriding ad properties) the URL in th
e creative." | |
9351 }, | |
9352 "comments": { | |
9353 "description": "Comments for this ad.", | |
9354 "type": "string" | |
9355 }, | |
9356 "compatibility": { | |
9357 "description": "Compatibility of this ad. Applicable when ty
pe is AD_SERVING_DEFAULT_AD. WEB and WEB_INTERSTITIAL refer to rendering either
on desktop or on mobile devices for regular or interstitial ads, respectively. A
PP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers
to rendering an in-stream video ads developed with the VAST standard.", | |
9358 "enum": [ | |
9359 "APP", | |
9360 "APP_INTERSTITIAL", | |
9361 "IN_STREAM_VIDEO", | |
9362 "WEB", | |
9363 "WEB_INTERSTITIAL" | |
9364 ], | |
9365 "enumDescriptions": [ | |
9366 "", | |
9367 "", | |
9368 "", | |
9369 "", | |
9370 "" | |
9371 ], | |
9372 "type": "string" | |
9373 }, | |
9374 "createInfo": { | |
9375 "$ref": "LastModifiedInfo", | |
9376 "description": "Information about the creation of this ad. T
his is a read-only field." | |
9377 }, | |
9378 "creativeGroupAssignments": { | |
9379 "description": "Creative group assignments for this ad. Appl
icable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative g
roup number is allowed for a maximum of two assignments.", | |
9380 "items": { | |
9381 "$ref": "CreativeGroupAssignment" | |
9382 }, | |
9383 "type": "array" | |
9384 }, | |
9385 "creativeRotation": { | |
9386 "$ref": "CreativeRotation", | |
9387 "description": "Creative rotation for this ad. Applicable wh
en type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING
. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativ
eAssignment." | |
9388 }, | |
9389 "dayPartTargeting": { | |
9390 "$ref": "DayPartTargeting", | |
9391 "description": "Time and day targeting information for this
ad. This field must be left blank if the ad is using a targeting template. Appli
cable when type is AD_SERVING_STANDARD_AD." | |
9392 }, | |
9393 "defaultClickThroughEventTagProperties": { | |
9394 "$ref": "DefaultClickThroughEventTagProperties", | |
9395 "description": "Default click-through event tag properties f
or this ad." | |
9396 }, | |
9397 "deliverySchedule": { | |
9398 "$ref": "DeliverySchedule", | |
9399 "description": "Delivery schedule information for this ad. A
pplicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field
along with subfields priority and impressionRatio are required on insertion whe
n type is AD_SERVING_STANDARD_AD." | |
9400 }, | |
9401 "dynamicClickTracker": { | |
9402 "description": "Whether this ad is a dynamic click tracker.
Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on in
sert, and is read-only after insert.", | |
9403 "type": "boolean" | |
9404 }, | |
9405 "endTime": { | |
9406 "description": "Date and time that this ad should stop servi
ng. Must be later than the start time. This is a required field on insertion.", | |
9407 "format": "date-time", | |
9408 "type": "string" | |
9409 }, | |
9410 "eventTagOverrides": { | |
9411 "description": "Event tag overrides for this ad.", | |
9412 "items": { | |
9413 "$ref": "EventTagOverride" | |
9414 }, | |
9415 "type": "array" | |
9416 }, | |
9417 "geoTargeting": { | |
9418 "$ref": "GeoTargeting", | |
9419 "description": "Geographical targeting information for this
ad. This field must be left blank if the ad is using a targeting template. Appli
cable when type is AD_SERVING_STANDARD_AD." | |
9420 }, | |
9421 "id": { | |
9422 "description": "ID of this ad. This is a read-only, auto-gen
erated field.", | |
9423 "format": "int64", | |
9424 "type": "string" | |
9425 }, | |
9426 "idDimensionValue": { | |
9427 "$ref": "DimensionValue", | |
9428 "description": "Dimension value for the ID of this ad. This
is a read-only, auto-generated field." | |
9429 }, | |
9430 "keyValueTargetingExpression": { | |
9431 "$ref": "KeyValueTargetingExpression", | |
9432 "description": "Key-value targeting information for this ad.
This field must be left blank if the ad is using a targeting template. Applicab
le when type is AD_SERVING_STANDARD_AD." | |
9433 }, | |
9434 "kind": { | |
9435 "default": "dfareporting#ad", | |
9436 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#ad\".", | |
9437 "type": "string" | |
9438 }, | |
9439 "lastModifiedInfo": { | |
9440 "$ref": "LastModifiedInfo", | |
9441 "description": "Information about the most recent modificati
on of this ad. This is a read-only field." | |
9442 }, | |
9443 "name": { | |
9444 "description": "Name of this ad. This is a required field an
d must be less than 256 characters long.", | |
9445 "type": "string" | |
9446 }, | |
9447 "placementAssignments": { | |
9448 "description": "Placement assignments for this ad.", | |
9449 "items": { | |
9450 "$ref": "PlacementAssignment" | |
9451 }, | |
9452 "type": "array" | |
9453 }, | |
9454 "remarketingListExpression": { | |
9455 "$ref": "ListTargetingExpression", | |
9456 "description": "Remarketing list targeting expression for th
is ad. This field must be left blank if the ad is using a targeting template. Ap
plicable when type is AD_SERVING_STANDARD_AD." | |
9457 }, | |
9458 "size": { | |
9459 "$ref": "Size", | |
9460 "description": "Size of this ad. Applicable when type is AD_
SERVING_DEFAULT_AD." | |
9461 }, | |
9462 "sslCompliant": { | |
9463 "description": "Whether this ad is ssl compliant. This is a
read-only field that is auto-generated when the ad is inserted or updated.", | |
9464 "type": "boolean" | |
9465 }, | |
9466 "sslRequired": { | |
9467 "description": "Whether this ad requires ssl. This is a read
-only field that is auto-generated when the ad is inserted or updated.", | |
9468 "type": "boolean" | |
9469 }, | |
9470 "startTime": { | |
9471 "description": "Date and time that this ad should start serv
ing. If creating an ad, this field must be a time in the future. This is a requi
red field on insertion.", | |
9472 "format": "date-time", | |
9473 "type": "string" | |
9474 }, | |
9475 "subaccountId": { | |
9476 "description": "Subaccount ID of this ad. This is a read-onl
y field that can be left blank.", | |
9477 "format": "int64", | |
9478 "type": "string" | |
9479 }, | |
9480 "technologyTargeting": { | |
9481 "$ref": "TechnologyTargeting", | |
9482 "description": "Technology platform targeting information fo
r this ad. This field must be left blank if the ad is using a targeting template
. Applicable when type is AD_SERVING_STANDARD_AD." | |
9483 }, | |
9484 "type": { | |
9485 "description": "Type of ad. This is a required field on inse
rtion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly
(see Creative resource).", | |
9486 "enum": [ | |
9487 "AD_SERVING_CLICK_TRACKER", | |
9488 "AD_SERVING_DEFAULT_AD", | |
9489 "AD_SERVING_STANDARD_AD", | |
9490 "AD_SERVING_TRACKING" | |
9491 ], | |
9492 "enumDescriptions": [ | |
9493 "", | |
9494 "", | |
9495 "", | |
9496 "" | |
9497 ], | |
9498 "type": "string" | |
9499 } | |
9500 }, | |
9501 "type": "object" | |
9502 }, | |
9503 "AdSlot": { | |
9504 "description": "Ad Slot", | |
9505 "id": "AdSlot", | |
9506 "properties": { | |
9507 "comment": { | |
9508 "description": "Comment for this ad slot.", | |
9509 "type": "string" | |
9510 }, | |
9511 "compatibility": { | |
9512 "description": "Ad slot compatibility. WEB and WEB_INTERSTIT
IAL refer to rendering either on desktop or on mobile devices for regular or int
erstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile
apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with
the VAST standard.", | |
9513 "enum": [ | |
9514 "PLANNING_RENDERING_ENVIRONMENT_TYPE_APP", | |
9515 "PLANNING_RENDERING_ENVIRONMENT_TYPE_APP_INTERSTITIAL", | |
9516 "PLANNING_RENDERING_ENVIRONMENT_TYPE_IN_STREAM_VIDEO", | |
9517 "PLANNING_RENDERING_ENVIRONMENT_TYPE_WEB", | |
9518 "PLANNING_RENDERING_ENVIRONMENT_TYPE_WEB_INTERSTITIAL" | |
9519 ], | |
9520 "enumDescriptions": [ | |
9521 "", | |
9522 "", | |
9523 "", | |
9524 "", | |
9525 "" | |
9526 ], | |
9527 "type": "string" | |
9528 }, | |
9529 "height": { | |
9530 "description": "Height of this ad slot.", | |
9531 "format": "int64", | |
9532 "type": "string" | |
9533 }, | |
9534 "linkedPlacementId": { | |
9535 "description": "ID of the placement from an external platfor
m that is linked to this ad slot.", | |
9536 "format": "int64", | |
9537 "type": "string" | |
9538 }, | |
9539 "name": { | |
9540 "description": "Name of this ad slot.", | |
9541 "type": "string" | |
9542 }, | |
9543 "paymentSourceType": { | |
9544 "description": "Payment source type of this ad slot.", | |
9545 "enum": [ | |
9546 "PLANNING_PAYMENT_SOURCE_TYPE_AGENCY_PAID", | |
9547 "PLANNING_PAYMENT_SOURCE_TYPE_PUBLISHER_PAID" | |
9548 ], | |
9549 "enumDescriptions": [ | |
9550 "", | |
9551 "" | |
9552 ], | |
9553 "type": "string" | |
9554 }, | |
9555 "primary": { | |
9556 "description": "Primary ad slot of a roadblock inventory ite
m.", | |
9557 "type": "boolean" | |
9558 }, | |
9559 "width": { | |
9560 "description": "Width of this ad slot.", | |
9561 "format": "int64", | |
9562 "type": "string" | |
9563 } | |
9564 }, | |
9565 "type": "object" | |
9566 }, | |
9567 "AdsListResponse": { | |
9568 "description": "Ad List Response", | |
9569 "id": "AdsListResponse", | |
9570 "properties": { | |
9571 "ads": { | |
9572 "description": "Ad collection.", | |
9573 "items": { | |
9574 "$ref": "Ad" | |
9575 }, | |
9576 "type": "array" | |
9577 }, | |
9578 "kind": { | |
9579 "default": "dfareporting#adsListResponse", | |
9580 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#adsListResponse\".", | |
9581 "type": "string" | |
9582 }, | |
9583 "nextPageToken": { | |
9584 "description": "Pagination token to be used for the next lis
t operation.", | |
9585 "type": "string" | |
9586 } | |
9587 }, | |
9588 "type": "object" | |
9589 }, | |
9590 "Advertiser": { | |
9591 "description": "Contains properties of a DCM advertiser.", | |
9592 "id": "Advertiser", | |
9593 "properties": { | |
9594 "accountId": { | |
9595 "description": "Account ID of this advertiser.This is a read
-only field that can be left blank.", | |
9596 "format": "int64", | |
9597 "type": "string" | |
9598 }, | |
9599 "advertiserGroupId": { | |
9600 "description": "ID of the advertiser group this advertiser b
elongs to. You can group advertisers for reporting purposes, allowing you to see
aggregated information for all advertisers in each group.", | |
9601 "format": "int64", | |
9602 "type": "string" | |
9603 }, | |
9604 "clickThroughUrlSuffix": { | |
9605 "description": "Suffix added to click-through URL of ad crea
tive associations under this advertiser. Must be less than 129 characters long."
, | |
9606 "type": "string" | |
9607 }, | |
9608 "defaultClickThroughEventTagId": { | |
9609 "description": "ID of the click-through event tag to apply b
y default to the landing pages of this advertiser's campaigns.", | |
9610 "format": "int64", | |
9611 "type": "string" | |
9612 }, | |
9613 "defaultEmail": { | |
9614 "description": "Default email address used in sender field f
or tag emails.", | |
9615 "type": "string" | |
9616 }, | |
9617 "floodlightConfigurationId": { | |
9618 "description": "Floodlight configuration ID of this advertis
er. The floodlight configuration ID will be created automatically, so on insert
this field should be left blank. This field can be set to another advertiser's f
loodlight configuration ID in order to share that advertiser's floodlight config
uration with this advertiser, so long as: \n- This advertiser's original floodli
ght configuration is not already associated with floodlight activities or floodl
ight activity groups. \n- This advertiser's original floodlight configuration is
not already shared with another advertiser.", | |
9619 "format": "int64", | |
9620 "type": "string" | |
9621 }, | |
9622 "floodlightConfigurationIdDimensionValue": { | |
9623 "$ref": "DimensionValue", | |
9624 "description": "Dimension value for the ID of the floodlight
configuration. This is a read-only, auto-generated field." | |
9625 }, | |
9626 "id": { | |
9627 "description": "ID of this advertiser. This is a read-only,
auto-generated field.", | |
9628 "format": "int64", | |
9629 "type": "string" | |
9630 }, | |
9631 "idDimensionValue": { | |
9632 "$ref": "DimensionValue", | |
9633 "description": "Dimension value for the ID of this advertise
r. This is a read-only, auto-generated field." | |
9634 }, | |
9635 "kind": { | |
9636 "default": "dfareporting#advertiser", | |
9637 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#advertiser\".", | |
9638 "type": "string" | |
9639 }, | |
9640 "name": { | |
9641 "description": "Name of this advertiser. This is a required
field and must be less than 256 characters long and unique among advertisers of
the same account.", | |
9642 "type": "string" | |
9643 }, | |
9644 "originalFloodlightConfigurationId": { | |
9645 "description": "Original floodlight configuration before any
sharing occurred. Set the floodlightConfigurationId of this advertiser to origi
nalFloodlightConfigurationId to unshare the advertiser's current floodlight conf
iguration. You cannot unshare an advertiser's floodlight configuration if the sh
ared configuration has activities associated with any campaign or placement.", | |
9646 "format": "int64", | |
9647 "type": "string" | |
9648 }, | |
9649 "status": { | |
9650 "description": "Status of this advertiser.", | |
9651 "enum": [ | |
9652 "APPROVED", | |
9653 "ON_HOLD" | |
9654 ], | |
9655 "enumDescriptions": [ | |
9656 "", | |
9657 "" | |
9658 ], | |
9659 "type": "string" | |
9660 }, | |
9661 "subaccountId": { | |
9662 "description": "Subaccount ID of this advertiser.This is a r
ead-only field that can be left blank.", | |
9663 "format": "int64", | |
9664 "type": "string" | |
9665 }, | |
9666 "suspended": { | |
9667 "description": "Suspension status of this advertiser.", | |
9668 "type": "boolean" | |
9669 } | |
9670 }, | |
9671 "type": "object" | |
9672 }, | |
9673 "AdvertiserGroup": { | |
9674 "description": "Groups advertisers together so that reports can be g
enerated for the entire group at once.", | |
9675 "id": "AdvertiserGroup", | |
9676 "properties": { | |
9677 "accountId": { | |
9678 "description": "Account ID of this advertiser group. This is
a read-only field that can be left blank.", | |
9679 "format": "int64", | |
9680 "type": "string" | |
9681 }, | |
9682 "id": { | |
9683 "description": "ID of this advertiser group. This is a read-
only, auto-generated field.", | |
9684 "format": "int64", | |
9685 "type": "string" | |
9686 }, | |
9687 "kind": { | |
9688 "default": "dfareporting#advertiserGroup", | |
9689 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#advertiserGroup\".", | |
9690 "type": "string" | |
9691 }, | |
9692 "name": { | |
9693 "description": "Name of this advertiser group. This is a req
uired field and must be less than 256 characters long and unique among advertise
r groups of the same account.", | |
9694 "type": "string" | |
9695 } | |
9696 }, | |
9697 "type": "object" | |
9698 }, | |
9699 "AdvertiserGroupsListResponse": { | |
9700 "description": "Advertiser Group List Response", | |
9701 "id": "AdvertiserGroupsListResponse", | |
9702 "properties": { | |
9703 "advertiserGroups": { | |
9704 "description": "Advertiser group collection.", | |
9705 "items": { | |
9706 "$ref": "AdvertiserGroup" | |
9707 }, | |
9708 "type": "array" | |
9709 }, | |
9710 "kind": { | |
9711 "default": "dfareporting#advertiserGroupsListResponse", | |
9712 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#advertiserGroupsListResponse\".", | |
9713 "type": "string" | |
9714 }, | |
9715 "nextPageToken": { | |
9716 "description": "Pagination token to be used for the next lis
t operation.", | |
9717 "type": "string" | |
9718 } | |
9719 }, | |
9720 "type": "object" | |
9721 }, | |
9722 "AdvertisersListResponse": { | |
9723 "description": "Advertiser List Response", | |
9724 "id": "AdvertisersListResponse", | |
9725 "properties": { | |
9726 "advertisers": { | |
9727 "description": "Advertiser collection.", | |
9728 "items": { | |
9729 "$ref": "Advertiser" | |
9730 }, | |
9731 "type": "array" | |
9732 }, | |
9733 "kind": { | |
9734 "default": "dfareporting#advertisersListResponse", | |
9735 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#advertisersListResponse\".", | |
9736 "type": "string" | |
9737 }, | |
9738 "nextPageToken": { | |
9739 "description": "Pagination token to be used for the next lis
t operation.", | |
9740 "type": "string" | |
9741 } | |
9742 }, | |
9743 "type": "object" | |
9744 }, | |
9745 "AudienceSegment": { | |
9746 "description": "Audience Segment.", | |
9747 "id": "AudienceSegment", | |
9748 "properties": { | |
9749 "allocation": { | |
9750 "description": "Weight allocated to this segment. Must be be
tween 1 and 1000. The weight assigned will be understood in proportion to the we
ights assigned to other segments in the same segment group.", | |
9751 "format": "int32", | |
9752 "type": "integer" | |
9753 }, | |
9754 "id": { | |
9755 "description": "ID of this audience segment. This is a read-
only, auto-generated field.", | |
9756 "format": "int64", | |
9757 "type": "string" | |
9758 }, | |
9759 "name": { | |
9760 "description": "Name of this audience segment. This is a req
uired field and must be less than 65 characters long.", | |
9761 "type": "string" | |
9762 } | |
9763 }, | |
9764 "type": "object" | |
9765 }, | |
9766 "AudienceSegmentGroup": { | |
9767 "description": "Audience Segment Group.", | |
9768 "id": "AudienceSegmentGroup", | |
9769 "properties": { | |
9770 "audienceSegments": { | |
9771 "description": "Audience segments assigned to this group. Th
e number of segments must be between 2 and 100.", | |
9772 "items": { | |
9773 "$ref": "AudienceSegment" | |
9774 }, | |
9775 "type": "array" | |
9776 }, | |
9777 "id": { | |
9778 "description": "ID of this audience segment group. This is a
read-only, auto-generated field.", | |
9779 "format": "int64", | |
9780 "type": "string" | |
9781 }, | |
9782 "name": { | |
9783 "description": "Name of this audience segment group. This is
a required field and must be less than 65 characters long.", | |
9784 "type": "string" | |
9785 } | |
9786 }, | |
9787 "type": "object" | |
9788 }, | |
9789 "Browser": { | |
9790 "description": "Contains information about a browser that can be tar
geted by ads.", | |
9791 "id": "Browser", | |
9792 "properties": { | |
9793 "browserVersionId": { | |
9794 "description": "ID referring to this grouping of browser and
version numbers. This is the ID used for targeting.", | |
9795 "format": "int64", | |
9796 "type": "string" | |
9797 }, | |
9798 "dartId": { | |
9799 "description": "DART ID of this browser. This is the ID used
when generating reports.", | |
9800 "format": "int64", | |
9801 "type": "string" | |
9802 }, | |
9803 "kind": { | |
9804 "default": "dfareporting#browser", | |
9805 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#browser\".", | |
9806 "type": "string" | |
9807 }, | |
9808 "majorVersion": { | |
9809 "description": "Major version number (leftmost number) of th
is browser. For example, for Chrome 5.0.376.86 beta, this field should be set to
5. An asterisk (*) may be used to target any version number, and a question mar
k (?) may be used to target cases where the version number cannot be identified.
For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on
. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases whe
re the ad server knows the browser is Firefox but can't tell which version it is
.", | |
9810 "type": "string" | |
9811 }, | |
9812 "minorVersion": { | |
9813 "description": "Minor version number (number after first dot
on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field s
hould be set to 0. An asterisk (*) may be used to target any version number, and
a question mark (?) may be used to target cases where the version number cannot
be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5,
3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? ta
rgets cases where the ad server knows the browser is Firefox but can't tell whic
h version it is.", | |
9814 "type": "string" | |
9815 }, | |
9816 "name": { | |
9817 "description": "Name of this browser.", | |
9818 "type": "string" | |
9819 } | |
9820 }, | |
9821 "type": "object" | |
9822 }, | |
9823 "BrowsersListResponse": { | |
9824 "description": "Browser List Response", | |
9825 "id": "BrowsersListResponse", | |
9826 "properties": { | |
9827 "browsers": { | |
9828 "description": "Browser collection.", | |
9829 "items": { | |
9830 "$ref": "Browser" | |
9831 }, | |
9832 "type": "array" | |
9833 }, | |
9834 "kind": { | |
9835 "default": "dfareporting#browsersListResponse", | |
9836 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#browsersListResponse\".", | |
9837 "type": "string" | |
9838 } | |
9839 }, | |
9840 "type": "object" | |
9841 }, | |
9842 "Campaign": { | |
9843 "description": "Contains properties of a DCM campaign.", | |
9844 "id": "Campaign", | |
9845 "properties": { | |
9846 "accountId": { | |
9847 "description": "Account ID of this campaign. This is a read-
only field that can be left blank.", | |
9848 "format": "int64", | |
9849 "type": "string" | |
9850 }, | |
9851 "additionalCreativeOptimizationConfigurations": { | |
9852 "description": "Additional creative optimization configurati
ons for the campaign.", | |
9853 "items": { | |
9854 "$ref": "CreativeOptimizationConfiguration" | |
9855 }, | |
9856 "type": "array" | |
9857 }, | |
9858 "advertiserGroupId": { | |
9859 "description": "Advertiser group ID of the associated advert
iser.", | |
9860 "format": "int64", | |
9861 "type": "string" | |
9862 }, | |
9863 "advertiserId": { | |
9864 "description": "Advertiser ID of this campaign. This is a re
quired field.", | |
9865 "format": "int64", | |
9866 "type": "string" | |
9867 }, | |
9868 "advertiserIdDimensionValue": { | |
9869 "$ref": "DimensionValue", | |
9870 "description": "Dimension value for the advertiser ID of thi
s campaign. This is a read-only, auto-generated field." | |
9871 }, | |
9872 "archived": { | |
9873 "description": "Whether this campaign has been archived.", | |
9874 "type": "boolean" | |
9875 }, | |
9876 "audienceSegmentGroups": { | |
9877 "description": "Audience segment groups assigned to this cam
paign. Cannot have more than 300 segment groups.", | |
9878 "items": { | |
9879 "$ref": "AudienceSegmentGroup" | |
9880 }, | |
9881 "type": "array" | |
9882 }, | |
9883 "billingInvoiceCode": { | |
9884 "description": "Billing invoice code included in the DCM cli
ent billing invoices associated with the campaign.", | |
9885 "type": "string" | |
9886 }, | |
9887 "clickThroughUrlSuffixProperties": { | |
9888 "$ref": "ClickThroughUrlSuffixProperties", | |
9889 "description": "Click-through URL suffix override properties
for this campaign." | |
9890 }, | |
9891 "comment": { | |
9892 "description": "Arbitrary comments about this campaign. Must
be less than 256 characters long.", | |
9893 "type": "string" | |
9894 }, | |
9895 "comscoreVceEnabled": { | |
9896 "description": "Whether comScore vCE reports are enabled for
this campaign.", | |
9897 "type": "boolean" | |
9898 }, | |
9899 "createInfo": { | |
9900 "$ref": "LastModifiedInfo", | |
9901 "description": "Information about the creation of this campa
ign. This is a read-only field." | |
9902 }, | |
9903 "creativeGroupIds": { | |
9904 "description": "List of creative group IDs that are assigned
to the campaign.", | |
9905 "items": { | |
9906 "format": "int64", | |
9907 "type": "string" | |
9908 }, | |
9909 "type": "array" | |
9910 }, | |
9911 "creativeOptimizationConfiguration": { | |
9912 "$ref": "CreativeOptimizationConfiguration", | |
9913 "description": "Creative optimization configuration for the
campaign." | |
9914 }, | |
9915 "defaultClickThroughEventTagProperties": { | |
9916 "$ref": "DefaultClickThroughEventTagProperties", | |
9917 "description": "Click-through event tag ID override properti
es for this campaign." | |
9918 }, | |
9919 "endDate": { | |
9920 "description": "Date on which the campaign will stop running
. On insert, the end date must be today or a future date. The end date must be l
ater than or be the same as the start date. If, for example, you set 6/25/2015 a
s both the start and end dates, the effective campaign run date is just that day
only, 6/25/2015. The hours, minutes, and seconds of the end date should not be
set, as doing so will result in an error. This is a required field.", | |
9921 "format": "date", | |
9922 "type": "string" | |
9923 }, | |
9924 "eventTagOverrides": { | |
9925 "description": "Overrides that can be used to activate or de
activate advertiser event tags.", | |
9926 "items": { | |
9927 "$ref": "EventTagOverride" | |
9928 }, | |
9929 "type": "array" | |
9930 }, | |
9931 "externalId": { | |
9932 "description": "External ID for this campaign.", | |
9933 "type": "string" | |
9934 }, | |
9935 "id": { | |
9936 "description": "ID of this campaign. This is a read-only aut
o-generated field.", | |
9937 "format": "int64", | |
9938 "type": "string" | |
9939 }, | |
9940 "idDimensionValue": { | |
9941 "$ref": "DimensionValue", | |
9942 "description": "Dimension value for the ID of this campaign.
This is a read-only, auto-generated field." | |
9943 }, | |
9944 "kind": { | |
9945 "default": "dfareporting#campaign", | |
9946 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#campaign\".", | |
9947 "type": "string" | |
9948 }, | |
9949 "lastModifiedInfo": { | |
9950 "$ref": "LastModifiedInfo", | |
9951 "description": "Information about the most recent modificati
on of this campaign. This is a read-only field." | |
9952 }, | |
9953 "lookbackConfiguration": { | |
9954 "$ref": "LookbackConfiguration", | |
9955 "description": "Lookback window settings for the campaign." | |
9956 }, | |
9957 "name": { | |
9958 "description": "Name of this campaign. This is a required fi
eld and must be less than 256 characters long and unique among campaigns of the
same advertiser.", | |
9959 "type": "string" | |
9960 }, | |
9961 "nielsenOcrEnabled": { | |
9962 "description": "Whether Nielsen reports are enabled for this
campaign.", | |
9963 "type": "boolean" | |
9964 }, | |
9965 "startDate": { | |
9966 "description": "Date on which the campaign starts running. T
he start date can be any date. The hours, minutes, and seconds of the start date
should not be set, as doing so will result in an error. This is a required fiel
d.", | |
9967 "format": "date", | |
9968 "type": "string" | |
9969 }, | |
9970 "subaccountId": { | |
9971 "description": "Subaccount ID of this campaign. This is a re
ad-only field that can be left blank.", | |
9972 "format": "int64", | |
9973 "type": "string" | |
9974 }, | |
9975 "traffickerEmails": { | |
9976 "description": "Campaign trafficker contact emails.", | |
9977 "items": { | |
9978 "type": "string" | |
9979 }, | |
9980 "type": "array" | |
9981 } | |
9982 }, | |
9983 "type": "object" | |
9984 }, | |
9985 "CampaignCreativeAssociation": { | |
9986 "description": "Identifies a creative which has been associated with
a given campaign.", | |
9987 "id": "CampaignCreativeAssociation", | |
9988 "properties": { | |
9989 "creativeId": { | |
9990 "description": "ID of the creative associated with the campa
ign. This is a required field.", | |
9991 "format": "int64", | |
9992 "type": "string" | |
9993 }, | |
9994 "kind": { | |
9995 "default": "dfareporting#campaignCreativeAssociation", | |
9996 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#campaignCreativeAssociation\".", | |
9997 "type": "string" | |
9998 } | |
9999 }, | |
10000 "type": "object" | |
10001 }, | |
10002 "CampaignCreativeAssociationsListResponse": { | |
10003 "description": "Campaign Creative Association List Response", | |
10004 "id": "CampaignCreativeAssociationsListResponse", | |
10005 "properties": { | |
10006 "campaignCreativeAssociations": { | |
10007 "description": "Campaign creative association collection", | |
10008 "items": { | |
10009 "$ref": "CampaignCreativeAssociation" | |
10010 }, | |
10011 "type": "array" | |
10012 }, | |
10013 "kind": { | |
10014 "default": "dfareporting#campaignCreativeAssociationsListRes
ponse", | |
10015 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#campaignCreativeAssociationsListResponse\".
", | |
10016 "type": "string" | |
10017 }, | |
10018 "nextPageToken": { | |
10019 "description": "Pagination token to be used for the next lis
t operation.", | |
10020 "type": "string" | |
10021 } | |
10022 }, | |
10023 "type": "object" | |
10024 }, | |
10025 "CampaignsListResponse": { | |
10026 "description": "Campaign List Response", | |
10027 "id": "CampaignsListResponse", | |
10028 "properties": { | |
10029 "campaigns": { | |
10030 "description": "Campaign collection.", | |
10031 "items": { | |
10032 "$ref": "Campaign" | |
10033 }, | |
10034 "type": "array" | |
10035 }, | |
10036 "kind": { | |
10037 "default": "dfareporting#campaignsListResponse", | |
10038 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#campaignsListResponse\".", | |
10039 "type": "string" | |
10040 }, | |
10041 "nextPageToken": { | |
10042 "description": "Pagination token to be used for the next lis
t operation.", | |
10043 "type": "string" | |
10044 } | |
10045 }, | |
10046 "type": "object" | |
10047 }, | |
10048 "ChangeLog": { | |
10049 "description": "Describes a change that a user has made to a resourc
e.", | |
10050 "id": "ChangeLog", | |
10051 "properties": { | |
10052 "accountId": { | |
10053 "description": "Account ID of the modified object.", | |
10054 "format": "int64", | |
10055 "type": "string" | |
10056 }, | |
10057 "action": { | |
10058 "description": "Action which caused the change.", | |
10059 "type": "string" | |
10060 }, | |
10061 "changeTime": { | |
10062 "description": "Time when the object was modified.", | |
10063 "format": "date-time", | |
10064 "type": "string" | |
10065 }, | |
10066 "fieldName": { | |
10067 "description": "Field name of the object which changed.", | |
10068 "type": "string" | |
10069 }, | |
10070 "id": { | |
10071 "description": "ID of this change log.", | |
10072 "format": "int64", | |
10073 "type": "string" | |
10074 }, | |
10075 "kind": { | |
10076 "default": "dfareporting#changeLog", | |
10077 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#changeLog\".", | |
10078 "type": "string" | |
10079 }, | |
10080 "newValue": { | |
10081 "description": "New value of the object field.", | |
10082 "type": "string" | |
10083 }, | |
10084 "objectId": { | |
10085 "description": "ID of the object of this change log. The obj
ect could be a campaign, placement, ad, or other type.", | |
10086 "format": "int64", | |
10087 "type": "string" | |
10088 }, | |
10089 "objectType": { | |
10090 "description": "Object type of the change log.", | |
10091 "type": "string" | |
10092 }, | |
10093 "oldValue": { | |
10094 "description": "Old value of the object field.", | |
10095 "type": "string" | |
10096 }, | |
10097 "subaccountId": { | |
10098 "description": "Subaccount ID of the modified object.", | |
10099 "format": "int64", | |
10100 "type": "string" | |
10101 }, | |
10102 "transactionId": { | |
10103 "description": "Transaction ID of this change log. When a si
ngle API call results in many changes, each change will have a separate ID in th
e change log but will share the same transactionId.", | |
10104 "format": "int64", | |
10105 "type": "string" | |
10106 }, | |
10107 "userProfileId": { | |
10108 "description": "ID of the user who modified the object.", | |
10109 "format": "int64", | |
10110 "type": "string" | |
10111 }, | |
10112 "userProfileName": { | |
10113 "description": "User profile name of the user who modified t
he object.", | |
10114 "type": "string" | |
10115 } | |
10116 }, | |
10117 "type": "object" | |
10118 }, | |
10119 "ChangeLogsListResponse": { | |
10120 "description": "Change Log List Response", | |
10121 "id": "ChangeLogsListResponse", | |
10122 "properties": { | |
10123 "changeLogs": { | |
10124 "description": "Change log collection.", | |
10125 "items": { | |
10126 "$ref": "ChangeLog" | |
10127 }, | |
10128 "type": "array" | |
10129 }, | |
10130 "kind": { | |
10131 "default": "dfareporting#changeLogsListResponse", | |
10132 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#changeLogsListResponse\".", | |
10133 "type": "string" | |
10134 }, | |
10135 "nextPageToken": { | |
10136 "description": "Pagination token to be used for the next lis
t operation.", | |
10137 "type": "string" | |
10138 } | |
10139 }, | |
10140 "type": "object" | |
10141 }, | |
10142 "CitiesListResponse": { | |
10143 "description": "City List Response", | |
10144 "id": "CitiesListResponse", | |
10145 "properties": { | |
10146 "cities": { | |
10147 "description": "City collection.", | |
10148 "items": { | |
10149 "$ref": "City" | |
10150 }, | |
10151 "type": "array" | |
10152 }, | |
10153 "kind": { | |
10154 "default": "dfareporting#citiesListResponse", | |
10155 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#citiesListResponse\".", | |
10156 "type": "string" | |
10157 } | |
10158 }, | |
10159 "type": "object" | |
10160 }, | |
10161 "City": { | |
10162 "description": "Contains information about a city that can be target
ed by ads.", | |
10163 "id": "City", | |
10164 "properties": { | |
10165 "countryCode": { | |
10166 "description": "Country code of the country to which this ci
ty belongs.", | |
10167 "type": "string" | |
10168 }, | |
10169 "countryDartId": { | |
10170 "description": "DART ID of the country to which this city be
longs.", | |
10171 "format": "int64", | |
10172 "type": "string" | |
10173 }, | |
10174 "dartId": { | |
10175 "description": "DART ID of this city. This is the ID used fo
r targeting and generating reports.", | |
10176 "format": "int64", | |
10177 "type": "string" | |
10178 }, | |
10179 "kind": { | |
10180 "default": "dfareporting#city", | |
10181 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#city\".", | |
10182 "type": "string" | |
10183 }, | |
10184 "metroCode": { | |
10185 "description": "Metro region code of the metro region (DMA)
to which this city belongs.", | |
10186 "type": "string" | |
10187 }, | |
10188 "metroDmaId": { | |
10189 "description": "ID of the metro region (DMA) to which this c
ity belongs.", | |
10190 "format": "int64", | |
10191 "type": "string" | |
10192 }, | |
10193 "name": { | |
10194 "description": "Name of this city.", | |
10195 "type": "string" | |
10196 }, | |
10197 "regionCode": { | |
10198 "description": "Region code of the region to which this city
belongs.", | |
10199 "type": "string" | |
10200 }, | |
10201 "regionDartId": { | |
10202 "description": "DART ID of the region to which this city bel
ongs.", | |
10203 "format": "int64", | |
10204 "type": "string" | |
10205 } | |
10206 }, | |
10207 "type": "object" | |
10208 }, | |
10209 "ClickTag": { | |
10210 "description": "Creative Click Tag.", | |
10211 "id": "ClickTag", | |
10212 "properties": { | |
10213 "eventName": { | |
10214 "description": "Advertiser event name associated with the cl
ick tag. This field is used by ENHANCED_IMAGE, and HTML5_BANNER creatives. Appli
cable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE", | |
10215 "type": "string" | |
10216 }, | |
10217 "name": { | |
10218 "description": "Parameter name for the specified click tag.
For ENHANCED_IMAGE creative assets, this field must match the value of the creat
ive asset's creativeAssetId.name field.", | |
10219 "type": "string" | |
10220 }, | |
10221 "value": { | |
10222 "description": "Parameter value for the specified click tag.
This field contains a click-through url.", | |
10223 "type": "string" | |
10224 } | |
10225 }, | |
10226 "type": "object" | |
10227 }, | |
10228 "ClickThroughUrl": { | |
10229 "description": "Click-through URL", | |
10230 "id": "ClickThroughUrl", | |
10231 "properties": { | |
10232 "computedClickThroughUrl": { | |
10233 "description": "Read-only convenience field representing the
actual URL that will be used for this click-through. The URL is computed as fol
lows: \n- If defaultLandingPage is enabled then the campaign's default landing p
age URL is assigned to this field.\n- If defaultLandingPage is not enabled and a
landingPageId is specified then that landing page's URL is assigned to this fie
ld.\n- If neither of the above cases apply, then the customClickThroughUrl is as
signed to this field.", | |
10234 "type": "string" | |
10235 }, | |
10236 "customClickThroughUrl": { | |
10237 "description": "Custom click-through URL. Applicable if the
defaultLandingPage field is set to false and the landingPageId field is left uns
et.", | |
10238 "type": "string" | |
10239 }, | |
10240 "defaultLandingPage": { | |
10241 "description": "Whether the campaign default landing page is
used.", | |
10242 "type": "boolean" | |
10243 }, | |
10244 "landingPageId": { | |
10245 "description": "ID of the landing page for the click-through
URL. Applicable if the defaultLandingPage field is set to false.", | |
10246 "format": "int64", | |
10247 "type": "string" | |
10248 } | |
10249 }, | |
10250 "type": "object" | |
10251 }, | |
10252 "ClickThroughUrlSuffixProperties": { | |
10253 "description": "Click Through URL Suffix settings.", | |
10254 "id": "ClickThroughUrlSuffixProperties", | |
10255 "properties": { | |
10256 "clickThroughUrlSuffix": { | |
10257 "description": "Click-through URL suffix to apply to all ads
in this entity's scope. Must be less than 128 characters long.", | |
10258 "type": "string" | |
10259 }, | |
10260 "overrideInheritedSuffix": { | |
10261 "description": "Whether this entity should override the inhe
rited click-through URL suffix with its own defined value.", | |
10262 "type": "boolean" | |
10263 } | |
10264 }, | |
10265 "type": "object" | |
10266 }, | |
10267 "CompanionClickThroughOverride": { | |
10268 "description": "Companion Click-through override.", | |
10269 "id": "CompanionClickThroughOverride", | |
10270 "properties": { | |
10271 "clickThroughUrl": { | |
10272 "$ref": "ClickThroughUrl", | |
10273 "description": "Click-through URL of this companion click-th
rough override." | |
10274 }, | |
10275 "creativeId": { | |
10276 "description": "ID of the creative for this companion click-
through override.", | |
10277 "format": "int64", | |
10278 "type": "string" | |
10279 } | |
10280 }, | |
10281 "type": "object" | |
10282 }, | |
10283 "CompatibleFields": { | |
10284 "description": "Represents a response to the queryCompatibleFields m
ethod.", | |
10285 "id": "CompatibleFields", | |
10286 "properties": { | |
10287 "crossDimensionReachReportCompatibleFields": { | |
10288 "$ref": "CrossDimensionReachReportCompatibleFields", | |
10289 "description": "Contains items that are compatible to be sel
ected for a report of type \"CROSS_DIMENSION_REACH\"." | |
10290 }, | |
10291 "floodlightReportCompatibleFields": { | |
10292 "$ref": "FloodlightReportCompatibleFields", | |
10293 "description": "Contains items that are compatible to be sel
ected for a report of type \"FLOODLIGHT\"." | |
10294 }, | |
10295 "kind": { | |
10296 "default": "dfareporting#compatibleFields", | |
10297 "description": "The kind of resource this is, in this case d
fareporting#compatibleFields.", | |
10298 "type": "string" | |
10299 }, | |
10300 "pathToConversionReportCompatibleFields": { | |
10301 "$ref": "PathToConversionReportCompatibleFields", | |
10302 "description": "Contains items that are compatible to be sel
ected for a report of type \"PATH_TO_CONVERSION\"." | |
10303 }, | |
10304 "reachReportCompatibleFields": { | |
10305 "$ref": "ReachReportCompatibleFields", | |
10306 "description": "Contains items that are compatible to be sel
ected for a report of type \"REACH\"." | |
10307 }, | |
10308 "reportCompatibleFields": { | |
10309 "$ref": "ReportCompatibleFields", | |
10310 "description": "Contains items that are compatible to be sel
ected for a report of type \"STANDARD\"." | |
10311 } | |
10312 }, | |
10313 "type": "object" | |
10314 }, | |
10315 "ConnectionType": { | |
10316 "description": "Contains information about an internet connection ty
pe that can be targeted by ads. Clients can use the connection type to target mo
bile vs. broadband users.", | |
10317 "id": "ConnectionType", | |
10318 "properties": { | |
10319 "id": { | |
10320 "description": "ID of this connection type.", | |
10321 "format": "int64", | |
10322 "type": "string" | |
10323 }, | |
10324 "kind": { | |
10325 "default": "dfareporting#connectionType", | |
10326 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#connectionType\".", | |
10327 "type": "string" | |
10328 }, | |
10329 "name": { | |
10330 "description": "Name of this connection type.", | |
10331 "type": "string" | |
10332 } | |
10333 }, | |
10334 "type": "object" | |
10335 }, | |
10336 "ConnectionTypesListResponse": { | |
10337 "description": "Connection Type List Response", | |
10338 "id": "ConnectionTypesListResponse", | |
10339 "properties": { | |
10340 "connectionTypes": { | |
10341 "description": "Collection of connection types such as broad
band and mobile.", | |
10342 "items": { | |
10343 "$ref": "ConnectionType" | |
10344 }, | |
10345 "type": "array" | |
10346 }, | |
10347 "kind": { | |
10348 "default": "dfareporting#connectionTypesListResponse", | |
10349 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#connectionTypesListResponse\".", | |
10350 "type": "string" | |
10351 } | |
10352 }, | |
10353 "type": "object" | |
10354 }, | |
10355 "ContentCategoriesListResponse": { | |
10356 "description": "Content Category List Response", | |
10357 "id": "ContentCategoriesListResponse", | |
10358 "properties": { | |
10359 "contentCategories": { | |
10360 "description": "Content category collection.", | |
10361 "items": { | |
10362 "$ref": "ContentCategory" | |
10363 }, | |
10364 "type": "array" | |
10365 }, | |
10366 "kind": { | |
10367 "default": "dfareporting#contentCategoriesListResponse", | |
10368 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#contentCategoriesListResponse\".", | |
10369 "type": "string" | |
10370 }, | |
10371 "nextPageToken": { | |
10372 "description": "Pagination token to be used for the next lis
t operation.", | |
10373 "type": "string" | |
10374 } | |
10375 }, | |
10376 "type": "object" | |
10377 }, | |
10378 "ContentCategory": { | |
10379 "description": "Organizes placements according to the contents of th
eir associated webpages.", | |
10380 "id": "ContentCategory", | |
10381 "properties": { | |
10382 "accountId": { | |
10383 "description": "Account ID of this content category. This is
a read-only field that can be left blank.", | |
10384 "format": "int64", | |
10385 "type": "string" | |
10386 }, | |
10387 "id": { | |
10388 "description": "ID of this content category. This is a read-
only, auto-generated field.", | |
10389 "format": "int64", | |
10390 "type": "string" | |
10391 }, | |
10392 "kind": { | |
10393 "default": "dfareporting#contentCategory", | |
10394 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#contentCategory\".", | |
10395 "type": "string" | |
10396 }, | |
10397 "name": { | |
10398 "description": "Name of this content category. This is a req
uired field and must be less than 256 characters long and unique among content c
ategories of the same account.", | |
10399 "type": "string" | |
10400 } | |
10401 }, | |
10402 "type": "object" | |
10403 }, | |
10404 "CountriesListResponse": { | |
10405 "description": "Country List Response", | |
10406 "id": "CountriesListResponse", | |
10407 "properties": { | |
10408 "countries": { | |
10409 "description": "Country collection.", | |
10410 "items": { | |
10411 "$ref": "Country" | |
10412 }, | |
10413 "type": "array" | |
10414 }, | |
10415 "kind": { | |
10416 "default": "dfareporting#countriesListResponse", | |
10417 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#countriesListResponse\".", | |
10418 "type": "string" | |
10419 } | |
10420 }, | |
10421 "type": "object" | |
10422 }, | |
10423 "Country": { | |
10424 "description": "Contains information about a country that can be tar
geted by ads.", | |
10425 "id": "Country", | |
10426 "properties": { | |
10427 "countryCode": { | |
10428 "description": "Country code.", | |
10429 "type": "string" | |
10430 }, | |
10431 "dartId": { | |
10432 "description": "DART ID of this country. This is the ID used
for targeting and generating reports.", | |
10433 "format": "int64", | |
10434 "type": "string" | |
10435 }, | |
10436 "kind": { | |
10437 "default": "dfareporting#country", | |
10438 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#country\".", | |
10439 "type": "string" | |
10440 }, | |
10441 "name": { | |
10442 "description": "Name of this country.", | |
10443 "type": "string" | |
10444 }, | |
10445 "sslEnabled": { | |
10446 "description": "Whether ad serving supports secure servers i
n this country.", | |
10447 "type": "boolean" | |
10448 } | |
10449 }, | |
10450 "type": "object" | |
10451 }, | |
10452 "Creative": { | |
10453 "description": "Contains properties of a Creative.", | |
10454 "id": "Creative", | |
10455 "properties": { | |
10456 "accountId": { | |
10457 "description": "Account ID of this creative. This field, if
left unset, will be auto-generated for both insert and update operations. Applic
able to all creative types.", | |
10458 "format": "int64", | |
10459 "type": "string" | |
10460 }, | |
10461 "active": { | |
10462 "description": "Whether the creative is active. Applicable t
o all creative types.", | |
10463 "type": "boolean" | |
10464 }, | |
10465 "adParameters": { | |
10466 "description": "Ad parameters user for VPAID creative. This
is a read-only field. Applicable to the following creative types: all VPAID.", | |
10467 "type": "string" | |
10468 }, | |
10469 "adTagKeys": { | |
10470 "description": "Keywords for a Rich Media creative. Keywords
let you customize the creative settings of a Rich Media ad running on your site
without having to contact the advertiser. You can use keywords to dynamically c
hange the look or functionality of a creative. Applicable to the following creat
ive types: all RICH_MEDIA, and all VPAID.", | |
10471 "items": { | |
10472 "type": "string" | |
10473 }, | |
10474 "type": "array" | |
10475 }, | |
10476 "advertiserId": { | |
10477 "description": "Advertiser ID of this creative. This is a re
quired field. Applicable to all creative types.", | |
10478 "format": "int64", | |
10479 "type": "string" | |
10480 }, | |
10481 "allowScriptAccess": { | |
10482 "description": "Whether script access is allowed for this cr
eative. This is a read-only and deprecated field which will automatically be set
to true on update. Applicable to the following creative types: FLASH_INPAGE.", | |
10483 "type": "boolean" | |
10484 }, | |
10485 "archived": { | |
10486 "description": "Whether the creative is archived. Applicable
to all creative types.", | |
10487 "type": "boolean" | |
10488 }, | |
10489 "artworkType": { | |
10490 "description": "Type of artwork used for the creative. This
is a read-only field. Applicable to the following creative types: all RICH_MEDIA
, and all VPAID.", | |
10491 "enum": [ | |
10492 "ARTWORK_TYPE_FLASH", | |
10493 "ARTWORK_TYPE_HTML5", | |
10494 "ARTWORK_TYPE_IMAGE", | |
10495 "ARTWORK_TYPE_MIXED" | |
10496 ], | |
10497 "enumDescriptions": [ | |
10498 "", | |
10499 "", | |
10500 "", | |
10501 "" | |
10502 ], | |
10503 "type": "string" | |
10504 }, | |
10505 "authoringTool": { | |
10506 "description": "Authoring tool for HTML5 banner creatives. T
his is a read-only field. Applicable to the following creative types: HTML5_BANN
ER.", | |
10507 "enum": [ | |
10508 "NINJA", | |
10509 "SWIFFY" | |
10510 ], | |
10511 "enumDescriptions": [ | |
10512 "", | |
10513 "" | |
10514 ], | |
10515 "type": "string" | |
10516 }, | |
10517 "auto_advance_images": { | |
10518 "description": "Whether images are automatically advanced fo
r enhanced image creatives. Applicable to the following creative types: ENHANCED
_IMAGE.", | |
10519 "type": "boolean" | |
10520 }, | |
10521 "backgroundColor": { | |
10522 "description": "The 6-character HTML color code, beginning w
ith #, for the background of the window area where the Flash file is displayed.
Default is white. Applicable to the following creative types: FLASH_INPAGE.", | |
10523 "type": "string" | |
10524 }, | |
10525 "backupImageClickThroughUrl": { | |
10526 "description": "Click-through URL for backup image. Applicab
le to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable t
o ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.", | |
10527 "type": "string" | |
10528 }, | |
10529 "backupImageFeatures": { | |
10530 "description": "List of feature dependencies that will cause
a backup image to be served if the browser that serves the ad does not support
them. Feature dependencies are features that a browser must be able to support i
n order to render your HTML5 creative asset correctly. This field is initially a
uto-generated to contain all features detected by DCM for all the assets of this
creative and can then be modified by the client. To reset this field, copy over
all the creativeAssets' detected features. Applicable to the following creative
types: HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset is no
t HTML_IMAGE.", | |
10531 "items": { | |
10532 "enum": [ | |
10533 "APPLICATION_CACHE", | |
10534 "AUDIO", | |
10535 "CANVAS", | |
10536 "CANVAS_TEXT", | |
10537 "CSS_ANIMATIONS", | |
10538 "CSS_BACKGROUND_SIZE", | |
10539 "CSS_BORDER_IMAGE", | |
10540 "CSS_BORDER_RADIUS", | |
10541 "CSS_BOX_SHADOW", | |
10542 "CSS_COLUMNS", | |
10543 "CSS_FLEX_BOX", | |
10544 "CSS_FONT_FACE", | |
10545 "CSS_GENERATED_CONTENT", | |
10546 "CSS_GRADIENTS", | |
10547 "CSS_HSLA", | |
10548 "CSS_MULTIPLE_BGS", | |
10549 "CSS_OPACITY", | |
10550 "CSS_REFLECTIONS", | |
10551 "CSS_RGBA", | |
10552 "CSS_TEXT_SHADOW", | |
10553 "CSS_TRANSFORMS", | |
10554 "CSS_TRANSFORMS3D", | |
10555 "CSS_TRANSITIONS", | |
10556 "DRAG_AND_DROP", | |
10557 "GEO_LOCATION", | |
10558 "HASH_CHANGE", | |
10559 "HISTORY", | |
10560 "INDEXED_DB", | |
10561 "INLINE_SVG", | |
10562 "INPUT_ATTR_AUTOCOMPLETE", | |
10563 "INPUT_ATTR_AUTOFOCUS", | |
10564 "INPUT_ATTR_LIST", | |
10565 "INPUT_ATTR_MAX", | |
10566 "INPUT_ATTR_MIN", | |
10567 "INPUT_ATTR_MULTIPLE", | |
10568 "INPUT_ATTR_PATTERN", | |
10569 "INPUT_ATTR_PLACEHOLDER", | |
10570 "INPUT_ATTR_REQUIRED", | |
10571 "INPUT_ATTR_STEP", | |
10572 "INPUT_TYPE_COLOR", | |
10573 "INPUT_TYPE_DATE", | |
10574 "INPUT_TYPE_DATETIME", | |
10575 "INPUT_TYPE_DATETIME_LOCAL", | |
10576 "INPUT_TYPE_EMAIL", | |
10577 "INPUT_TYPE_MONTH", | |
10578 "INPUT_TYPE_NUMBER", | |
10579 "INPUT_TYPE_RANGE", | |
10580 "INPUT_TYPE_SEARCH", | |
10581 "INPUT_TYPE_TEL", | |
10582 "INPUT_TYPE_TIME", | |
10583 "INPUT_TYPE_URL", | |
10584 "INPUT_TYPE_WEEK", | |
10585 "LOCAL_STORAGE", | |
10586 "POST_MESSAGE", | |
10587 "SESSION_STORAGE", | |
10588 "SMIL", | |
10589 "SVG_CLIP_PATHS", | |
10590 "SVG_FE_IMAGE", | |
10591 "SVG_FILTERS", | |
10592 "SVG_HREF", | |
10593 "TOUCH", | |
10594 "VIDEO", | |
10595 "WEBGL", | |
10596 "WEB_SOCKETS", | |
10597 "WEB_SQL_DATABASE", | |
10598 "WEB_WORKERS" | |
10599 ], | |
10600 "enumDescriptions": [ | |
10601 "", | |
10602 "", | |
10603 "", | |
10604 "", | |
10605 "", | |
10606 "", | |
10607 "", | |
10608 "", | |
10609 "", | |
10610 "", | |
10611 "", | |
10612 "", | |
10613 "", | |
10614 "", | |
10615 "", | |
10616 "", | |
10617 "", | |
10618 "", | |
10619 "", | |
10620 "", | |
10621 "", | |
10622 "", | |
10623 "", | |
10624 "", | |
10625 "", | |
10626 "", | |
10627 "", | |
10628 "", | |
10629 "", | |
10630 "", | |
10631 "", | |
10632 "", | |
10633 "", | |
10634 "", | |
10635 "", | |
10636 "", | |
10637 "", | |
10638 "", | |
10639 "", | |
10640 "", | |
10641 "", | |
10642 "", | |
10643 "", | |
10644 "", | |
10645 "", | |
10646 "", | |
10647 "", | |
10648 "", | |
10649 "", | |
10650 "", | |
10651 "", | |
10652 "", | |
10653 "", | |
10654 "", | |
10655 "", | |
10656 "", | |
10657 "", | |
10658 "", | |
10659 "", | |
10660 "", | |
10661 "", | |
10662 "", | |
10663 "", | |
10664 "", | |
10665 "", | |
10666 "" | |
10667 ], | |
10668 "type": "string" | |
10669 }, | |
10670 "type": "array" | |
10671 }, | |
10672 "backupImageReportingLabel": { | |
10673 "description": "Reporting label used for HTML5 banner backup
image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IM
AGE.", | |
10674 "type": "string" | |
10675 }, | |
10676 "backupImageTargetWindow": { | |
10677 "$ref": "TargetWindow", | |
10678 "description": "Target window for backup image. Applicable t
o the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to EN
HANCED_BANNER when the primary asset type is not HTML_IMAGE." | |
10679 }, | |
10680 "clickTags": { | |
10681 "description": "Click tags of the creative. For ENHANCED_BAN
NER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected clic
k tags for the assets associated with this creative. After creating a flash asse
t, detected click tags will be returned in the creativeAssetMetadata. When inser
ting the creative, populate the creative clickTags field using the creativeAsset
Metadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly
one entry in this list for each image creative asset. A click tag is matched wit
h a corresponding creative asset by matching the clickTag.name field with the cr
eativeAsset.assetIdentifier.name field. Applicable to the following creative typ
es: ENHANCED_IMAGE, FLASH_INPAGE HTML5_BANNER. Applicable to ENHANCED_BANNER whe
n the primary asset type is not HTML_IMAGE.", | |
10682 "items": { | |
10683 "$ref": "ClickTag" | |
10684 }, | |
10685 "type": "array" | |
10686 }, | |
10687 "commercialId": { | |
10688 "description": "Industry standard ID assigned to creative fo
r reach and frequency. Applicable to the following creative types: all INSTREAM_
VIDEO and all VPAID.", | |
10689 "type": "string" | |
10690 }, | |
10691 "companionCreatives": { | |
10692 "description": "List of companion creatives assigned to an i
n-Stream videocreative. Acceptable values include IDs of existing flash and imag
e creatives. Applicable to the following creative types: all INSTREAM_VIDEO and
all VPAID.", | |
10693 "items": { | |
10694 "format": "int64", | |
10695 "type": "string" | |
10696 }, | |
10697 "type": "array" | |
10698 }, | |
10699 "compatibility": { | |
10700 "description": "Compatibilities associated with this creativ
e. This is a read-only field. WEB and WEB_INTERSTITIAL refer to rendering either
on desktop or on mobile devices for regular or interstitial ads, respectively.
APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refer
s to rendering in in-stream video ads developed with the VAST standard. Applicab
le to all creative types.\n\nAcceptable values are:\n- \"APP\"\n- \"APP_INTERSTI
TIAL\"\n- \"IN_STREAM_VIDEO\"\n- \"WEB\"\n- \"WEB_INTERSTITIAL\"", | |
10701 "items": { | |
10702 "enum": [ | |
10703 "APP", | |
10704 "APP_INTERSTITIAL", | |
10705 "IN_STREAM_VIDEO", | |
10706 "WEB", | |
10707 "WEB_INTERSTITIAL" | |
10708 ], | |
10709 "enumDescriptions": [ | |
10710 "", | |
10711 "", | |
10712 "", | |
10713 "", | |
10714 "" | |
10715 ], | |
10716 "type": "string" | |
10717 }, | |
10718 "type": "array" | |
10719 }, | |
10720 "convertFlashToHtml5": { | |
10721 "description": "Whether Flash assets associated with the cre
ative need to be automatically converted to HTML5. This flag is enabled by defau
lt and users can choose to disable it if they don't want the system to generate
and use HTML5 asset for this creative. Applicable to the following creative type
: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not
HTML_IMAGE.", | |
10722 "type": "boolean" | |
10723 }, | |
10724 "counterCustomEvents": { | |
10725 "description": "List of counter events configured for the cr
eative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated fro
m clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RIC
H_MEDIA, and all VPAID.", | |
10726 "items": { | |
10727 "$ref": "CreativeCustomEvent" | |
10728 }, | |
10729 "type": "array" | |
10730 }, | |
10731 "creativeAssets": { | |
10732 "description": "Assets associated with a creative. Applicabl
e to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTER
NAL_REDIRECT, and REDIRECT", | |
10733 "items": { | |
10734 "$ref": "CreativeAsset" | |
10735 }, | |
10736 "type": "array" | |
10737 }, | |
10738 "creativeFieldAssignments": { | |
10739 "description": "Creative field assignments for this creative
. Applicable to all creative types.", | |
10740 "items": { | |
10741 "$ref": "CreativeFieldAssignment" | |
10742 }, | |
10743 "type": "array" | |
10744 }, | |
10745 "customKeyValues": { | |
10746 "description": "Custom key-values for a Rich Media creative.
Key-values let you customize the creative settings of a Rich Media ad running o
n your site without having to contact the advertiser. You can use key-values to
dynamically change the look or functionality of a creative. Applicable to the fo
llowing creative types: all RICH_MEDIA, and all VPAID.", | |
10747 "items": { | |
10748 "type": "string" | |
10749 }, | |
10750 "type": "array" | |
10751 }, | |
10752 "exitCustomEvents": { | |
10753 "description": "List of exit events configured for the creat
ive. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and a
uto-generated from clickTags, For ENHANCED_BANNER, an event is also created from
the backupImageReportingLabel. Applicable to the following creative types: ENHA
NCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when th
e primary asset is not HTML_IMAGE.", | |
10754 "items": { | |
10755 "$ref": "CreativeCustomEvent" | |
10756 }, | |
10757 "type": "array" | |
10758 }, | |
10759 "fsCommand": { | |
10760 "$ref": "FsCommand", | |
10761 "description": "OpenWindow FSCommand of this creative. This
lets the SWF file communicate with either Flash Player or the program hosting Fl
ash Player, such as a web browser. This is only triggered if allowScriptAccess f
ield is true. Applicable to the following creative types: FLASH_INPAGE." | |
10762 }, | |
10763 "htmlCode": { | |
10764 "description": "HTML code for the creative. This is a requir
ed field when applicable. This field is ignored if htmlCodeLocked is false. Appl
icable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANN
ER, and all RICH_MEDIA.", | |
10765 "type": "string" | |
10766 }, | |
10767 "htmlCodeLocked": { | |
10768 "description": "Whether HTML code is DCM-generated or manual
ly entered. Set to true to ignore changes to htmlCode. Applicable to the followi
ng creative types: FLASH_INPAGE and HTML5_BANNER.", | |
10769 "type": "boolean" | |
10770 }, | |
10771 "id": { | |
10772 "description": "ID of this creative. This is a read-only, au
to-generated field. Applicable to all creative types.", | |
10773 "format": "int64", | |
10774 "type": "string" | |
10775 }, | |
10776 "idDimensionValue": { | |
10777 "$ref": "DimensionValue", | |
10778 "description": "Dimension value for the ID of this creative.
This is a read-only field. Applicable to all creative types." | |
10779 }, | |
10780 "kind": { | |
10781 "default": "dfareporting#creative", | |
10782 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#creative\".", | |
10783 "type": "string" | |
10784 }, | |
10785 "lastModifiedInfo": { | |
10786 "$ref": "LastModifiedInfo", | |
10787 "description": "Creative last modification information. This
is a read-only field. Applicable to all creative types." | |
10788 }, | |
10789 "latestTraffickedCreativeId": { | |
10790 "description": "Latest Studio trafficked creative ID associa
ted with rich media and VPAID creatives. This is a read-only field. Applicable t
o the following creative types: all RICH_MEDIA, and all VPAID.", | |
10791 "format": "int64", | |
10792 "type": "string" | |
10793 }, | |
10794 "name": { | |
10795 "description": "Name of the creative. This is a required fie
ld and must be less than 256 characters long. Applicable to all creative types."
, | |
10796 "type": "string" | |
10797 }, | |
10798 "overrideCss": { | |
10799 "description": "Override CSS value for rich media creatives.
Applicable to the following creative types: all RICH_MEDIA.", | |
10800 "type": "string" | |
10801 }, | |
10802 "redirectUrl": { | |
10803 "description": "URL of hosted image or hosted video or anoth
er ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video red
irect URL. The standard for a VAST (Video Ad Serving Template) ad response allow
s for a redirect link to another VAST 2.0 or 3.0 call. This is a required field
when applicable. Applicable to the following creative types: INTERNAL_REDIRECT,
INTERSTITIAL_INTERNAL_REDIRECT, REDIRECT, and INSTREAM_VIDEO_REDIRECT", | |
10804 "type": "string" | |
10805 }, | |
10806 "renderingId": { | |
10807 "description": "ID of current rendering version. This is a r
ead-only field. Applicable to all creative types.", | |
10808 "format": "int64", | |
10809 "type": "string" | |
10810 }, | |
10811 "renderingIdDimensionValue": { | |
10812 "$ref": "DimensionValue", | |
10813 "description": "Dimension value for the rendering ID of this
creative. This is a read-only field. Applicable to all creative types." | |
10814 }, | |
10815 "requiredFlashPluginVersion": { | |
10816 "description": "The minimum required Flash plugin version fo
r this creative. For example, 11.2.202.235. This is a read-only field. Applicabl
e to the following creative types: all RICH_MEDIA, and all VPAID.", | |
10817 "type": "string" | |
10818 }, | |
10819 "requiredFlashVersion": { | |
10820 "description": "The internal Flash version for this creative
as calculated by DoubleClick Studio. This is a read-only field. Applicable to t
he following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applic
able to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.", | |
10821 "format": "int32", | |
10822 "type": "integer" | |
10823 }, | |
10824 "size": { | |
10825 "$ref": "Size", | |
10826 "description": "Size associated with this creative. When ins
erting or updating a creative either the size ID field or size width and height
fields can be used. This is a required field when applicable; however for IMAGE
and FLASH_INPAGE creatives, and for ENHANCED_BANNER creatives with a primary ass
et of type HTML_IMAGE, if left blank, this field will be automatically set using
the actual size of the associated image assets. Applicable to the following cre
ative types: ENHANCED_BANNER, ENHANCED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE,
and all RICH_MEDIA." | |
10827 }, | |
10828 "skippable": { | |
10829 "description": "Whether the user can choose to skip the crea
tive. Applicable to the following creative types: all INSTREAM_VIDEO and all VPA
ID.", | |
10830 "type": "boolean" | |
10831 }, | |
10832 "sslCompliant": { | |
10833 "description": "Whether the creative is SSL-compliant. This
is a read-only field. Applicable to all creative types.", | |
10834 "type": "boolean" | |
10835 }, | |
10836 "sslOverride": { | |
10837 "description": "Whether creative should be treated as SSL co
mpliant even if the system scan shows it's not. Applicable to all creative types
.", | |
10838 "type": "boolean" | |
10839 }, | |
10840 "studioAdvertiserId": { | |
10841 "description": "Studio advertiser ID associated with rich me
dia and VPAID creatives. This is a read-only field. Applicable to the following
creative types: all RICH_MEDIA, and all VPAID.", | |
10842 "format": "int64", | |
10843 "type": "string" | |
10844 }, | |
10845 "studioCreativeId": { | |
10846 "description": "Studio creative ID associated with rich medi
a and VPAID creatives. This is a read-only field. Applicable to the following cr
eative types: all RICH_MEDIA, and all VPAID.", | |
10847 "format": "int64", | |
10848 "type": "string" | |
10849 }, | |
10850 "studioTraffickedCreativeId": { | |
10851 "description": "Studio trafficked creative ID associated wit
h rich media and VPAID creatives. This is a read-only field. Applicable to the f
ollowing creative types: all RICH_MEDIA, and all VPAID.", | |
10852 "format": "int64", | |
10853 "type": "string" | |
10854 }, | |
10855 "subaccountId": { | |
10856 "description": "Subaccount ID of this creative. This field,
if left unset, will be auto-generated for both insert and update operations. App
licable to all creative types.", | |
10857 "format": "int64", | |
10858 "type": "string" | |
10859 }, | |
10860 "thirdPartyBackupImageImpressionsUrl": { | |
10861 "description": "Third-party URL used to record backup image
impressions. Applicable to the following creative types: all RICH_MEDIA.", | |
10862 "type": "string" | |
10863 }, | |
10864 "thirdPartyRichMediaImpressionsUrl": { | |
10865 "description": "Third-party URL used to record rich media im
pressions. Applicable to the following creative types: all RICH_MEDIA.", | |
10866 "type": "string" | |
10867 }, | |
10868 "thirdPartyUrls": { | |
10869 "description": "Third-party URLs for tracking in-stream vide
o creative events. Applicable to the following creative types: all INSTREAM_VIDE
O and all VPAID.", | |
10870 "items": { | |
10871 "$ref": "ThirdPartyTrackingUrl" | |
10872 }, | |
10873 "type": "array" | |
10874 }, | |
10875 "timerCustomEvents": { | |
10876 "description": "List of timer events configured for the crea
tive. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from
clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_
MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is no
t HTML_IMAGE.", | |
10877 "items": { | |
10878 "$ref": "CreativeCustomEvent" | |
10879 }, | |
10880 "type": "array" | |
10881 }, | |
10882 "totalFileSize": { | |
10883 "description": "Combined size of all creative assets. This i
s a read-only field. Applicable to the following creative types: all RICH_MEDIA,
and all VPAID.", | |
10884 "format": "int64", | |
10885 "type": "string" | |
10886 }, | |
10887 "type": { | |
10888 "description": "Type of this creative.This is a required fie
ld. Applicable to all creative types.", | |
10889 "enum": [ | |
10890 "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO", | |
10891 "CUSTOM_INPAGE", | |
10892 "CUSTOM_INTERSTITIAL", | |
10893 "ENHANCED_BANNER", | |
10894 "ENHANCED_IMAGE", | |
10895 "FLASH_INPAGE", | |
10896 "HTML5_BANNER", | |
10897 "IMAGE", | |
10898 "INSTREAM_VIDEO", | |
10899 "INTERNAL_REDIRECT", | |
10900 "INTERSTITIAL_INTERNAL_REDIRECT", | |
10901 "REDIRECT", | |
10902 "RICH_MEDIA_EXPANDING", | |
10903 "RICH_MEDIA_IM_EXPAND", | |
10904 "RICH_MEDIA_INPAGE", | |
10905 "RICH_MEDIA_INPAGE_FLOATING", | |
10906 "RICH_MEDIA_INTERSTITIAL_FLOAT", | |
10907 "RICH_MEDIA_MOBILE_IN_APP", | |
10908 "RICH_MEDIA_MULTI_FLOATING", | |
10909 "RICH_MEDIA_PEEL_DOWN", | |
10910 "TRACKING_TEXT", | |
10911 "VAST_REDIRECT", | |
10912 "VPAID_LINEAR", | |
10913 "VPAID_NON_LINEAR" | |
10914 ], | |
10915 "enumDescriptions": [ | |
10916 "", | |
10917 "", | |
10918 "", | |
10919 "", | |
10920 "", | |
10921 "", | |
10922 "", | |
10923 "", | |
10924 "", | |
10925 "", | |
10926 "", | |
10927 "", | |
10928 "", | |
10929 "", | |
10930 "", | |
10931 "", | |
10932 "", | |
10933 "", | |
10934 "", | |
10935 "", | |
10936 "", | |
10937 "", | |
10938 "", | |
10939 "" | |
10940 ], | |
10941 "type": "string" | |
10942 }, | |
10943 "version": { | |
10944 "description": "The version number helps you keep track of m
ultiple versions of your creative in your reports. The version number will alway
s be auto-generated during insert operations to start at 1. For tracking creativ
es the version cannot be incremented and will always remain at 1. For all other
creative types the version can be incremented only by 1 during update operations
. In addition, the version will be automatically incremented by 1 when undergoin
g Rich Media creative merging. Applicable to all creative types.", | |
10945 "format": "int32", | |
10946 "type": "integer" | |
10947 }, | |
10948 "videoDescription": { | |
10949 "description": "Description of the video ad. Applicable to t
he following creative types: all INSTREAM_VIDEO and all VPAID.", | |
10950 "type": "string" | |
10951 }, | |
10952 "videoDuration": { | |
10953 "description": "Creative video duration in seconds. This is
a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, a
ll RICH_MEDIA, and all VPAID.", | |
10954 "format": "float", | |
10955 "type": "number" | |
10956 } | |
10957 }, | |
10958 "type": "object" | |
10959 }, | |
10960 "CreativeAsset": { | |
10961 "description": "Creative Asset.", | |
10962 "id": "CreativeAsset", | |
10963 "properties": { | |
10964 "actionScript3": { | |
10965 "description": "Whether ActionScript3 is enabled for the fla
sh asset. This is a read-only field. Applicable to the following creative type:
FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not H
TML_IMAGE.", | |
10966 "type": "boolean" | |
10967 }, | |
10968 "active": { | |
10969 "description": "Whether the video asset is active. This is a
read-only field for VPAID_NON_LINEAR assets. Applicable to the following creati
ve types: INSTREAM_VIDEO and all VPAID.", | |
10970 "type": "boolean" | |
10971 }, | |
10972 "alignment": { | |
10973 "description": "Possible alignments for an asset. This is a
read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FL
OATING.", | |
10974 "enum": [ | |
10975 "ALIGNMENT_BOTTOM", | |
10976 "ALIGNMENT_LEFT", | |
10977 "ALIGNMENT_RIGHT", | |
10978 "ALIGNMENT_TOP" | |
10979 ], | |
10980 "enumDescriptions": [ | |
10981 "", | |
10982 "", | |
10983 "", | |
10984 "" | |
10985 ], | |
10986 "type": "string" | |
10987 }, | |
10988 "artworkType": { | |
10989 "description": "Artwork type of rich media creative. This is
a read-only field. Applicable to the following creative types: all RICH_MEDIA."
, | |
10990 "enum": [ | |
10991 "ARTWORK_TYPE_FLASH", | |
10992 "ARTWORK_TYPE_HTML5", | |
10993 "ARTWORK_TYPE_IMAGE", | |
10994 "ARTWORK_TYPE_MIXED" | |
10995 ], | |
10996 "enumDescriptions": [ | |
10997 "", | |
10998 "", | |
10999 "", | |
11000 "" | |
11001 ], | |
11002 "type": "string" | |
11003 }, | |
11004 "assetIdentifier": { | |
11005 "$ref": "CreativeAssetId", | |
11006 "description": "Identifier of this asset. This is the same i
dentifier returned during creative asset insert operation. This is a required fi
eld. Applicable to all but the following creative types: all REDIRECT and TRACKI
NG_TEXT." | |
11007 }, | |
11008 "backupImageExit": { | |
11009 "$ref": "CreativeCustomEvent", | |
11010 "description": "Exit event configured for the backup image.
Applicable to the following creative types: all RICH_MEDIA." | |
11011 }, | |
11012 "bitRate": { | |
11013 "description": "Detected bit-rate for video asset. This is a
read-only field. Applicable to the following creative types: INSTREAM_VIDEO and
all VPAID.", | |
11014 "format": "int32", | |
11015 "type": "integer" | |
11016 }, | |
11017 "childAssetType": { | |
11018 "description": "Rich media child asset type. This is a read-
only field. Applicable to the following creative types: all VPAID.", | |
11019 "enum": [ | |
11020 "CHILD_ASSET_TYPE_DATA", | |
11021 "CHILD_ASSET_TYPE_FLASH", | |
11022 "CHILD_ASSET_TYPE_IMAGE", | |
11023 "CHILD_ASSET_TYPE_VIDEO" | |
11024 ], | |
11025 "enumDescriptions": [ | |
11026 "", | |
11027 "", | |
11028 "", | |
11029 "" | |
11030 ], | |
11031 "type": "string" | |
11032 }, | |
11033 "collapsedSize": { | |
11034 "$ref": "Size", | |
11035 "description": "Size of an asset when collapsed. This is a r
ead-only field. Applicable to the following creative types: all RICH_MEDIA and a
ll VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_
TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN." | |
11036 }, | |
11037 "customStartTimeValue": { | |
11038 "description": "Custom start time in seconds for making the
asset visible. Applicable to the following creative types: all RICH_MEDIA.", | |
11039 "format": "int32", | |
11040 "type": "integer" | |
11041 }, | |
11042 "detectedFeatures": { | |
11043 "description": "List of feature dependencies for the creativ
e asset that are detected by DCM. Feature dependencies are features that a brows
er must be able to support in order to render your HTML5 creative correctly. Thi
s is a read-only, auto-generated field. Applicable to the following creative typ
es: ENHANCED_BANNER and HTML5_BANNER.", | |
11044 "items": { | |
11045 "enum": [ | |
11046 "APPLICATION_CACHE", | |
11047 "AUDIO", | |
11048 "CANVAS", | |
11049 "CANVAS_TEXT", | |
11050 "CSS_ANIMATIONS", | |
11051 "CSS_BACKGROUND_SIZE", | |
11052 "CSS_BORDER_IMAGE", | |
11053 "CSS_BORDER_RADIUS", | |
11054 "CSS_BOX_SHADOW", | |
11055 "CSS_COLUMNS", | |
11056 "CSS_FLEX_BOX", | |
11057 "CSS_FONT_FACE", | |
11058 "CSS_GENERATED_CONTENT", | |
11059 "CSS_GRADIENTS", | |
11060 "CSS_HSLA", | |
11061 "CSS_MULTIPLE_BGS", | |
11062 "CSS_OPACITY", | |
11063 "CSS_REFLECTIONS", | |
11064 "CSS_RGBA", | |
11065 "CSS_TEXT_SHADOW", | |
11066 "CSS_TRANSFORMS", | |
11067 "CSS_TRANSFORMS3D", | |
11068 "CSS_TRANSITIONS", | |
11069 "DRAG_AND_DROP", | |
11070 "GEO_LOCATION", | |
11071 "HASH_CHANGE", | |
11072 "HISTORY", | |
11073 "INDEXED_DB", | |
11074 "INLINE_SVG", | |
11075 "INPUT_ATTR_AUTOCOMPLETE", | |
11076 "INPUT_ATTR_AUTOFOCUS", | |
11077 "INPUT_ATTR_LIST", | |
11078 "INPUT_ATTR_MAX", | |
11079 "INPUT_ATTR_MIN", | |
11080 "INPUT_ATTR_MULTIPLE", | |
11081 "INPUT_ATTR_PATTERN", | |
11082 "INPUT_ATTR_PLACEHOLDER", | |
11083 "INPUT_ATTR_REQUIRED", | |
11084 "INPUT_ATTR_STEP", | |
11085 "INPUT_TYPE_COLOR", | |
11086 "INPUT_TYPE_DATE", | |
11087 "INPUT_TYPE_DATETIME", | |
11088 "INPUT_TYPE_DATETIME_LOCAL", | |
11089 "INPUT_TYPE_EMAIL", | |
11090 "INPUT_TYPE_MONTH", | |
11091 "INPUT_TYPE_NUMBER", | |
11092 "INPUT_TYPE_RANGE", | |
11093 "INPUT_TYPE_SEARCH", | |
11094 "INPUT_TYPE_TEL", | |
11095 "INPUT_TYPE_TIME", | |
11096 "INPUT_TYPE_URL", | |
11097 "INPUT_TYPE_WEEK", | |
11098 "LOCAL_STORAGE", | |
11099 "POST_MESSAGE", | |
11100 "SESSION_STORAGE", | |
11101 "SMIL", | |
11102 "SVG_CLIP_PATHS", | |
11103 "SVG_FE_IMAGE", | |
11104 "SVG_FILTERS", | |
11105 "SVG_HREF", | |
11106 "TOUCH", | |
11107 "VIDEO", | |
11108 "WEBGL", | |
11109 "WEB_SOCKETS", | |
11110 "WEB_SQL_DATABASE", | |
11111 "WEB_WORKERS" | |
11112 ], | |
11113 "enumDescriptions": [ | |
11114 "", | |
11115 "", | |
11116 "", | |
11117 "", | |
11118 "", | |
11119 "", | |
11120 "", | |
11121 "", | |
11122 "", | |
11123 "", | |
11124 "", | |
11125 "", | |
11126 "", | |
11127 "", | |
11128 "", | |
11129 "", | |
11130 "", | |
11131 "", | |
11132 "", | |
11133 "", | |
11134 "", | |
11135 "", | |
11136 "", | |
11137 "", | |
11138 "", | |
11139 "", | |
11140 "", | |
11141 "", | |
11142 "", | |
11143 "", | |
11144 "", | |
11145 "", | |
11146 "", | |
11147 "", | |
11148 "", | |
11149 "", | |
11150 "", | |
11151 "", | |
11152 "", | |
11153 "", | |
11154 "", | |
11155 "", | |
11156 "", | |
11157 "", | |
11158 "", | |
11159 "", | |
11160 "", | |
11161 "", | |
11162 "", | |
11163 "", | |
11164 "", | |
11165 "", | |
11166 "", | |
11167 "", | |
11168 "", | |
11169 "", | |
11170 "", | |
11171 "", | |
11172 "", | |
11173 "", | |
11174 "", | |
11175 "", | |
11176 "", | |
11177 "", | |
11178 "", | |
11179 "" | |
11180 ], | |
11181 "type": "string" | |
11182 }, | |
11183 "type": "array" | |
11184 }, | |
11185 "displayType": { | |
11186 "description": "Type of rich media asset. This is a read-onl
y field. Applicable to the following creative types: all RICH_MEDIA.", | |
11187 "enum": [ | |
11188 "ASSET_DISPLAY_TYPE_BACKDROP", | |
11189 "ASSET_DISPLAY_TYPE_EXPANDING", | |
11190 "ASSET_DISPLAY_TYPE_FLASH_IN_FLASH", | |
11191 "ASSET_DISPLAY_TYPE_FLASH_IN_FLASH_EXPANDING", | |
11192 "ASSET_DISPLAY_TYPE_FLOATING", | |
11193 "ASSET_DISPLAY_TYPE_INPAGE", | |
11194 "ASSET_DISPLAY_TYPE_OVERLAY", | |
11195 "ASSET_DISPLAY_TYPE_PEEL_DOWN", | |
11196 "ASSET_DISPLAY_TYPE_VPAID_LINEAR", | |
11197 "ASSET_DISPLAY_TYPE_VPAID_NON_LINEAR" | |
11198 ], | |
11199 "enumDescriptions": [ | |
11200 "", | |
11201 "", | |
11202 "", | |
11203 "", | |
11204 "", | |
11205 "", | |
11206 "", | |
11207 "", | |
11208 "", | |
11209 "" | |
11210 ], | |
11211 "type": "string" | |
11212 }, | |
11213 "duration": { | |
11214 "description": "Duration in seconds for which an asset will
be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPA
ID_LINEAR.", | |
11215 "format": "int32", | |
11216 "type": "integer" | |
11217 }, | |
11218 "durationType": { | |
11219 "description": "Duration type for which an asset will be dis
played. Applicable to the following creative types: all RICH_MEDIA.", | |
11220 "enum": [ | |
11221 "ASSET_DURATION_TYPE_AUTO", | |
11222 "ASSET_DURATION_TYPE_CUSTOM", | |
11223 "ASSET_DURATION_TYPE_NONE" | |
11224 ], | |
11225 "enumDescriptions": [ | |
11226 "", | |
11227 "", | |
11228 "" | |
11229 ], | |
11230 "type": "string" | |
11231 }, | |
11232 "expandedDimension": { | |
11233 "$ref": "Size", | |
11234 "description": "Detected expanded dimension for video asset.
This is a read-only field. Applicable to the following creative types: INSTREAM
_VIDEO and all VPAID." | |
11235 }, | |
11236 "fileSize": { | |
11237 "description": "File size associated with this creative asse
t. This is a read-only field. Applicable to all but the following creative types
: all REDIRECT and TRACKING_TEXT.", | |
11238 "format": "int64", | |
11239 "type": "string" | |
11240 }, | |
11241 "flashVersion": { | |
11242 "description": "Flash version of the asset. This is a read-o
nly field. Applicable to the following creative types: FLASH_INPAGE, all RICH_ME
DIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset type is
not HTML_IMAGE.", | |
11243 "format": "int32", | |
11244 "type": "integer" | |
11245 }, | |
11246 "hideFlashObjects": { | |
11247 "description": "Whether to hide Flash objects flag for an as
set. Applicable to the following creative types: all RICH_MEDIA.", | |
11248 "type": "boolean" | |
11249 }, | |
11250 "hideSelectionBoxes": { | |
11251 "description": "Whether to hide selection boxes flag for an
asset. Applicable to the following creative types: all RICH_MEDIA.", | |
11252 "type": "boolean" | |
11253 }, | |
11254 "horizontallyLocked": { | |
11255 "description": "Whether the asset is horizontally locked. Th
is is a read-only field. Applicable to the following creative types: all RICH_ME
DIA.", | |
11256 "type": "boolean" | |
11257 }, | |
11258 "id": { | |
11259 "description": "Numeric ID of this creative asset. This is a
required field and should not be modified. Applicable to all but the following
creative types: all REDIRECT and TRACKING_TEXT.", | |
11260 "format": "int64", | |
11261 "type": "string" | |
11262 }, | |
11263 "mimeType": { | |
11264 "description": "Detected MIME type for video asset. This is
a read-only field. Applicable to the following creative types: INSTREAM_VIDEO an
d all VPAID.", | |
11265 "type": "string" | |
11266 }, | |
11267 "offset": { | |
11268 "$ref": "OffsetPosition", | |
11269 "description": "Offset position for an asset in collapsed mo
de. This is a read-only field. Applicable to the following creative types: all R
ICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayTy
pe is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN." | |
11270 }, | |
11271 "originalBackup": { | |
11272 "description": "Whether the backup asset is original or chan
ged by the user in DCM. Applicable to the following creative types: all RICH_MED
IA.", | |
11273 "type": "boolean" | |
11274 }, | |
11275 "position": { | |
11276 "$ref": "OffsetPosition", | |
11277 "description": "Offset position for an asset. Applicable to
the following creative types: all RICH_MEDIA." | |
11278 }, | |
11279 "positionLeftUnit": { | |
11280 "description": "Offset left unit for an asset. This is a rea
d-only field. Applicable to the following creative types: all RICH_MEDIA.", | |
11281 "enum": [ | |
11282 "OFFSET_UNIT_PERCENT", | |
11283 "OFFSET_UNIT_PIXEL", | |
11284 "OFFSET_UNIT_PIXEL_FROM_CENTER" | |
11285 ], | |
11286 "enumDescriptions": [ | |
11287 "", | |
11288 "", | |
11289 "" | |
11290 ], | |
11291 "type": "string" | |
11292 }, | |
11293 "positionTopUnit": { | |
11294 "description": "Offset top unit for an asset. This is a read
-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable t
o the following creative types: all RICH_MEDIA.", | |
11295 "enum": [ | |
11296 "OFFSET_UNIT_PERCENT", | |
11297 "OFFSET_UNIT_PIXEL", | |
11298 "OFFSET_UNIT_PIXEL_FROM_CENTER" | |
11299 ], | |
11300 "enumDescriptions": [ | |
11301 "", | |
11302 "", | |
11303 "" | |
11304 ], | |
11305 "type": "string" | |
11306 }, | |
11307 "progressiveServingUrl": { | |
11308 "description": "Progressive URL for video asset. This is a r
ead-only field. Applicable to the following creative types: INSTREAM_VIDEO and a
ll VPAID.", | |
11309 "type": "string" | |
11310 }, | |
11311 "pushdown": { | |
11312 "description": "Whether the asset pushes down other content.
Applicable to the following creative types: all RICH_MEDIA. Additionally, only
applicable when the asset offsets are 0, the collapsedSize.width matches size.wi
dth, and the collapsedSize.height is less than size.height.", | |
11313 "type": "boolean" | |
11314 }, | |
11315 "pushdownDuration": { | |
11316 "description": "Pushdown duration in seconds for an asset. M
ust be between 0 and 9.99. Applicable to the following creative types: all RICH_
MEDIA.Additionally, only applicable when the asset pushdown field is true, the o
ffsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.
height is less than size.height.", | |
11317 "format": "float", | |
11318 "type": "number" | |
11319 }, | |
11320 "role": { | |
11321 "description": "Role of the asset in relation to creative. A
pplicable to all but the following creative types: all REDIRECT and TRACKING_TEX
T. This is a required field.\nPRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE,
HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple p
rimary assets), and all VPAID creatives.\nBACKUP_IMAGE applies to ENHANCED_BANNE
R, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.\nADDITIO
NAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.\nOTHER refers to
assets from sources other than DCM, such as Studio uploaded assets, applicable
to all RICH_MEDIA and all VPAID creatives.\nPARENT_VIDEO refers to videos upload
ed by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creat
ives.\nTRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO ass
ets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.\nALTERNATE_V
IDEO refers to the DCM representation of child asset videos from Studio, and is
applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed wit
hin DCM.\nFor VPAID_LINEAR creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNA
TE_VIDEO assets that are marked active serve as backup in case the VPAID creativ
e cannot be served. Only PARENT_VIDEO assets can be added or removed for an INST
REAM_VIDEO or VPAID_LINEAR creative.", | |
11322 "enum": [ | |
11323 "ADDITIONAL_FLASH", | |
11324 "ADDITIONAL_IMAGE", | |
11325 "ALTERNATE_VIDEO", | |
11326 "BACKUP_IMAGE", | |
11327 "OTHER", | |
11328 "PARENT_VIDEO", | |
11329 "PRIMARY", | |
11330 "TRANSCODED_VIDEO" | |
11331 ], | |
11332 "enumDescriptions": [ | |
11333 "", | |
11334 "", | |
11335 "", | |
11336 "", | |
11337 "", | |
11338 "", | |
11339 "", | |
11340 "" | |
11341 ], | |
11342 "type": "string" | |
11343 }, | |
11344 "size": { | |
11345 "$ref": "Size", | |
11346 "description": "Size associated with this creative asset. Th
is is a required field when applicable; however for IMAGE and FLASH_INPAGE creat
ives, if left blank, this field will be automatically set using the actual size
of the associated image asset. Applicable to the following creative types: ENHAN
CED_IMAGE, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to
ENHANCED_BANNER when the primary asset type is not HTML_IMAGE." | |
11347 }, | |
11348 "sslCompliant": { | |
11349 "description": "Whether the asset is SSL-compliant. This is
a read-only field. Applicable to all but the following creative types: all REDIR
ECT and TRACKING_TEXT.", | |
11350 "type": "boolean" | |
11351 }, | |
11352 "startTimeType": { | |
11353 "description": "Initial wait time type before making the ass
et visible. Applicable to the following creative types: all RICH_MEDIA.", | |
11354 "enum": [ | |
11355 "ASSET_START_TIME_TYPE_CUSTOM", | |
11356 "ASSET_START_TIME_TYPE_NONE" | |
11357 ], | |
11358 "enumDescriptions": [ | |
11359 "", | |
11360 "" | |
11361 ], | |
11362 "type": "string" | |
11363 }, | |
11364 "streamingServingUrl": { | |
11365 "description": "Streaming URL for video asset. This is a rea
d-only field. Applicable to the following creative types: INSTREAM_VIDEO and all
VPAID.", | |
11366 "type": "string" | |
11367 }, | |
11368 "transparency": { | |
11369 "description": "Whether the asset is transparent. Applicable
to the following creative types: all RICH_MEDIA. Additionally, only applicable
to HTML5 assets.", | |
11370 "type": "boolean" | |
11371 }, | |
11372 "verticallyLocked": { | |
11373 "description": "Whether the asset is vertically locked. This
is a read-only field. Applicable to the following creative types: all RICH_MEDI
A.", | |
11374 "type": "boolean" | |
11375 }, | |
11376 "videoDuration": { | |
11377 "description": "Detected video duration for video asset. Thi
s is a read-only field. Applicable to the following creative types: INSTREAM_VID
EO and all VPAID.", | |
11378 "format": "float", | |
11379 "type": "number" | |
11380 }, | |
11381 "windowMode": { | |
11382 "description": "Window mode options for flash assets. Applic
able to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_M
EDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING.", | |
11383 "enum": [ | |
11384 "OPAQUE", | |
11385 "TRANSPARENT", | |
11386 "WINDOW" | |
11387 ], | |
11388 "enumDescriptions": [ | |
11389 "", | |
11390 "", | |
11391 "" | |
11392 ], | |
11393 "type": "string" | |
11394 }, | |
11395 "zIndex": { | |
11396 "description": "zIndex value of an asset. This is a read-onl
y field. Applicable to the following creative types: all RICH_MEDIA.Additionally
, only applicable to assets whose displayType is NOT one of the following types:
ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY.", | |
11397 "format": "int32", | |
11398 "type": "integer" | |
11399 }, | |
11400 "zipFilename": { | |
11401 "description": "File name of zip file. This is a read-only f
ield. Applicable to the following creative types: HTML5_BANNER.", | |
11402 "type": "string" | |
11403 }, | |
11404 "zipFilesize": { | |
11405 "description": "Size of zip file. This is a read-only field.
Applicable to the following creative types: HTML5_BANNER.", | |
11406 "type": "string" | |
11407 } | |
11408 }, | |
11409 "type": "object" | |
11410 }, | |
11411 "CreativeAssetId": { | |
11412 "description": "Creative Asset ID.", | |
11413 "id": "CreativeAssetId", | |
11414 "properties": { | |
11415 "name": { | |
11416 "description": "Name of the creative asset. This is a requir
ed field while inserting an asset. After insertion, this assetIdentifier is used
to identify the uploaded asset. Characters in the name must be alphanumeric or
one of the following: \".-_ \". Spaces are allowed.", | |
11417 "type": "string" | |
11418 }, | |
11419 "type": { | |
11420 "description": "Type of asset to upload. This is a required
field. IMAGE is solely used for IMAGE creatives. Other image assets should use H
TML_IMAGE.", | |
11421 "enum": [ | |
11422 "FLASH", | |
11423 "HTML", | |
11424 "HTML_IMAGE", | |
11425 "IMAGE", | |
11426 "VIDEO" | |
11427 ], | |
11428 "enumDescriptions": [ | |
11429 "", | |
11430 "", | |
11431 "", | |
11432 "", | |
11433 "" | |
11434 ], | |
11435 "type": "string" | |
11436 } | |
11437 }, | |
11438 "type": "object" | |
11439 }, | |
11440 "CreativeAssetMetadata": { | |
11441 "description": "CreativeAssets contains properties of a creative ass
et file which will be uploaded or has already been uploaded. Refer to the creati
ve sample code for how to upload assets and insert a creative.", | |
11442 "id": "CreativeAssetMetadata", | |
11443 "properties": { | |
11444 "assetIdentifier": { | |
11445 "$ref": "CreativeAssetId", | |
11446 "description": "ID of the creative asset. This is a required
field." | |
11447 }, | |
11448 "clickTags": { | |
11449 "description": "List of detected click tags for assets. This
is a read-only auto-generated field.", | |
11450 "items": { | |
11451 "$ref": "ClickTag" | |
11452 }, | |
11453 "type": "array" | |
11454 }, | |
11455 "detectedFeatures": { | |
11456 "description": "List of feature dependencies for the creativ
e asset that are detected by DCM. Feature dependencies are features that a brows
er must be able to support in order to render your HTML5 creative correctly. Thi
s is a read-only, auto-generated field.", | |
11457 "items": { | |
11458 "enum": [ | |
11459 "APPLICATION_CACHE", | |
11460 "AUDIO", | |
11461 "CANVAS", | |
11462 "CANVAS_TEXT", | |
11463 "CSS_ANIMATIONS", | |
11464 "CSS_BACKGROUND_SIZE", | |
11465 "CSS_BORDER_IMAGE", | |
11466 "CSS_BORDER_RADIUS", | |
11467 "CSS_BOX_SHADOW", | |
11468 "CSS_COLUMNS", | |
11469 "CSS_FLEX_BOX", | |
11470 "CSS_FONT_FACE", | |
11471 "CSS_GENERATED_CONTENT", | |
11472 "CSS_GRADIENTS", | |
11473 "CSS_HSLA", | |
11474 "CSS_MULTIPLE_BGS", | |
11475 "CSS_OPACITY", | |
11476 "CSS_REFLECTIONS", | |
11477 "CSS_RGBA", | |
11478 "CSS_TEXT_SHADOW", | |
11479 "CSS_TRANSFORMS", | |
11480 "CSS_TRANSFORMS3D", | |
11481 "CSS_TRANSITIONS", | |
11482 "DRAG_AND_DROP", | |
11483 "GEO_LOCATION", | |
11484 "HASH_CHANGE", | |
11485 "HISTORY", | |
11486 "INDEXED_DB", | |
11487 "INLINE_SVG", | |
11488 "INPUT_ATTR_AUTOCOMPLETE", | |
11489 "INPUT_ATTR_AUTOFOCUS", | |
11490 "INPUT_ATTR_LIST", | |
11491 "INPUT_ATTR_MAX", | |
11492 "INPUT_ATTR_MIN", | |
11493 "INPUT_ATTR_MULTIPLE", | |
11494 "INPUT_ATTR_PATTERN", | |
11495 "INPUT_ATTR_PLACEHOLDER", | |
11496 "INPUT_ATTR_REQUIRED", | |
11497 "INPUT_ATTR_STEP", | |
11498 "INPUT_TYPE_COLOR", | |
11499 "INPUT_TYPE_DATE", | |
11500 "INPUT_TYPE_DATETIME", | |
11501 "INPUT_TYPE_DATETIME_LOCAL", | |
11502 "INPUT_TYPE_EMAIL", | |
11503 "INPUT_TYPE_MONTH", | |
11504 "INPUT_TYPE_NUMBER", | |
11505 "INPUT_TYPE_RANGE", | |
11506 "INPUT_TYPE_SEARCH", | |
11507 "INPUT_TYPE_TEL", | |
11508 "INPUT_TYPE_TIME", | |
11509 "INPUT_TYPE_URL", | |
11510 "INPUT_TYPE_WEEK", | |
11511 "LOCAL_STORAGE", | |
11512 "POST_MESSAGE", | |
11513 "SESSION_STORAGE", | |
11514 "SMIL", | |
11515 "SVG_CLIP_PATHS", | |
11516 "SVG_FE_IMAGE", | |
11517 "SVG_FILTERS", | |
11518 "SVG_HREF", | |
11519 "TOUCH", | |
11520 "VIDEO", | |
11521 "WEBGL", | |
11522 "WEB_SOCKETS", | |
11523 "WEB_SQL_DATABASE", | |
11524 "WEB_WORKERS" | |
11525 ], | |
11526 "enumDescriptions": [ | |
11527 "", | |
11528 "", | |
11529 "", | |
11530 "", | |
11531 "", | |
11532 "", | |
11533 "", | |
11534 "", | |
11535 "", | |
11536 "", | |
11537 "", | |
11538 "", | |
11539 "", | |
11540 "", | |
11541 "", | |
11542 "", | |
11543 "", | |
11544 "", | |
11545 "", | |
11546 "", | |
11547 "", | |
11548 "", | |
11549 "", | |
11550 "", | |
11551 "", | |
11552 "", | |
11553 "", | |
11554 "", | |
11555 "", | |
11556 "", | |
11557 "", | |
11558 "", | |
11559 "", | |
11560 "", | |
11561 "", | |
11562 "", | |
11563 "", | |
11564 "", | |
11565 "", | |
11566 "", | |
11567 "", | |
11568 "", | |
11569 "", | |
11570 "", | |
11571 "", | |
11572 "", | |
11573 "", | |
11574 "", | |
11575 "", | |
11576 "", | |
11577 "", | |
11578 "", | |
11579 "", | |
11580 "", | |
11581 "", | |
11582 "", | |
11583 "", | |
11584 "", | |
11585 "", | |
11586 "", | |
11587 "", | |
11588 "", | |
11589 "", | |
11590 "", | |
11591 "", | |
11592 "" | |
11593 ], | |
11594 "type": "string" | |
11595 }, | |
11596 "type": "array" | |
11597 }, | |
11598 "kind": { | |
11599 "default": "dfareporting#creativeAssetMetadata", | |
11600 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#creativeAssetMetadata\".", | |
11601 "type": "string" | |
11602 }, | |
11603 "warnedValidationRules": { | |
11604 "description": "Rules validated during code generation that
generated a warning. This is a read-only, auto-generated field.\n\nPossible valu
es are:\n- \"ADMOB_REFERENCED\"\n- \"ASSET_FORMAT_UNSUPPORTED_DCM\"\n- \"ASSET_I
NVALID\"\n- \"CLICK_TAG_HARD_CODED\"\n- \"CLICK_TAG_INVALID\"\n- \"CLICK_TAG_IN_
GWD\"\n- \"CLICK_TAG_MISSING\"\n- \"CLICK_TAG_MORE_THAN_ONE\"\n- \"CLICK_TAG_NON
_TOP_LEVEL\"\n- \"COMPONENT_UNSUPPORTED_DCM\"\n- \"ENABLER_UNSUPPORTED_METHOD_DC
M\"\n- \"EXTERNAL_FILE_REFERENCED\"\n- \"FILE_DETAIL_EMPTY\"\n- \"FILE_TYPE_INVA
LID\"\n- \"GWD_PROPERTIES_INVALID\"\n- \"HTML5_FEATURE_UNSUPPORTED\"\n- \"LINKED
_FILE_NOT_FOUND\"\n- \"MAX_FLASH_VERSION_11\"\n- \"MRAID_REFERENCED\"\n- \"NOT_S
SL_COMPLIANT\"\n- \"ORPHANED_ASSET\"\n- \"PRIMARY_HTML_MISSING\"\n- \"SVG_INVALI
D\"\n- \"ZIP_INVALID\"", | |
11605 "items": { | |
11606 "enum": [ | |
11607 "ADMOB_REFERENCED", | |
11608 "ASSET_FORMAT_UNSUPPORTED_DCM", | |
11609 "ASSET_INVALID", | |
11610 "CLICK_TAG_HARD_CODED", | |
11611 "CLICK_TAG_INVALID", | |
11612 "CLICK_TAG_IN_GWD", | |
11613 "CLICK_TAG_MISSING", | |
11614 "CLICK_TAG_MORE_THAN_ONE", | |
11615 "CLICK_TAG_NON_TOP_LEVEL", | |
11616 "COMPONENT_UNSUPPORTED_DCM", | |
11617 "ENABLER_UNSUPPORTED_METHOD_DCM", | |
11618 "EXTERNAL_FILE_REFERENCED", | |
11619 "FILE_DETAIL_EMPTY", | |
11620 "FILE_TYPE_INVALID", | |
11621 "GWD_PROPERTIES_INVALID", | |
11622 "HTML5_FEATURE_UNSUPPORTED", | |
11623 "LINKED_FILE_NOT_FOUND", | |
11624 "MAX_FLASH_VERSION_11", | |
11625 "MRAID_REFERENCED", | |
11626 "NOT_SSL_COMPLIANT", | |
11627 "ORPHANED_ASSET", | |
11628 "PRIMARY_HTML_MISSING", | |
11629 "SVG_INVALID", | |
11630 "ZIP_INVALID" | |
11631 ], | |
11632 "enumDescriptions": [ | |
11633 "", | |
11634 "", | |
11635 "", | |
11636 "", | |
11637 "", | |
11638 "", | |
11639 "", | |
11640 "", | |
11641 "", | |
11642 "", | |
11643 "", | |
11644 "", | |
11645 "", | |
11646 "", | |
11647 "", | |
11648 "", | |
11649 "", | |
11650 "", | |
11651 "", | |
11652 "", | |
11653 "", | |
11654 "", | |
11655 "", | |
11656 "" | |
11657 ], | |
11658 "type": "string" | |
11659 }, | |
11660 "type": "array" | |
11661 } | |
11662 }, | |
11663 "type": "object" | |
11664 }, | |
11665 "CreativeAssignment": { | |
11666 "description": "Creative Assignment.", | |
11667 "id": "CreativeAssignment", | |
11668 "properties": { | |
11669 "active": { | |
11670 "description": "Whether this creative assignment is active.
When true, the creative will be included in the ad's rotation.", | |
11671 "type": "boolean" | |
11672 }, | |
11673 "applyEventTags": { | |
11674 "description": "Whether applicable event tags should fire wh
en this creative assignment is rendered. If this value is unset when the ad is i
nserted or updated, it will default to true for all creative types EXCEPT for IN
TERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.", | |
11675 "type": "boolean" | |
11676 }, | |
11677 "clickThroughUrl": { | |
11678 "$ref": "ClickThroughUrl", | |
11679 "description": "Click-through URL of the creative assignment
." | |
11680 }, | |
11681 "companionCreativeOverrides": { | |
11682 "description": "Companion creative overrides for this creati
ve assignment. Applicable to video ads.", | |
11683 "items": { | |
11684 "$ref": "CompanionClickThroughOverride" | |
11685 }, | |
11686 "type": "array" | |
11687 }, | |
11688 "creativeGroupAssignments": { | |
11689 "description": "Creative group assignments for this creative
assignment. Only one assignment per creative group number is allowed for a maxi
mum of two assignments.", | |
11690 "items": { | |
11691 "$ref": "CreativeGroupAssignment" | |
11692 }, | |
11693 "type": "array" | |
11694 }, | |
11695 "creativeId": { | |
11696 "description": "ID of the creative to be assigned. This is a
required field.", | |
11697 "format": "int64", | |
11698 "type": "string" | |
11699 }, | |
11700 "creativeIdDimensionValue": { | |
11701 "$ref": "DimensionValue", | |
11702 "description": "Dimension value for the ID of the creative.
This is a read-only, auto-generated field." | |
11703 }, | |
11704 "endTime": { | |
11705 "description": "Date and time that the assigned creative sho
uld stop serving. Must be later than the start time.", | |
11706 "format": "date-time", | |
11707 "type": "string" | |
11708 }, | |
11709 "richMediaExitOverrides": { | |
11710 "description": "Rich media exit overrides for this creative
assignment.\nApplicable when the creative type is any of the following: \n- RICH
_MEDIA_INPAGE\n- RICH_MEDIA_INPAGE_FLOATING\n- RICH_MEDIA_IM_EXPAND\n- RICH_MEDI
A_EXPANDING\n- RICH_MEDIA_INTERSTITIAL_FLOAT\n- RICH_MEDIA_MOBILE_IN_APP\n- RICH
_MEDIA_MULTI_FLOATING\n- RICH_MEDIA_PEEL_DOWN\n- ADVANCED_BANNER\n- VPAID_LINEAR
\n- VPAID_NON_LINEAR", | |
11711 "items": { | |
11712 "$ref": "RichMediaExitOverride" | |
11713 }, | |
11714 "type": "array" | |
11715 }, | |
11716 "sequence": { | |
11717 "description": "Sequence number of the creative assignment,
applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.", | |
11718 "format": "int32", | |
11719 "type": "integer" | |
11720 }, | |
11721 "sslCompliant": { | |
11722 "description": "Whether the creative to be assigned is SSL-c
ompliant. This is a read-only field that is auto-generated when the ad is insert
ed or updated.", | |
11723 "type": "boolean" | |
11724 }, | |
11725 "startTime": { | |
11726 "description": "Date and time that the assigned creative sho
uld start serving.", | |
11727 "format": "date-time", | |
11728 "type": "string" | |
11729 }, | |
11730 "weight": { | |
11731 "description": "Weight of the creative assignment, applicabl
e when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.", | |
11732 "format": "int32", | |
11733 "type": "integer" | |
11734 } | |
11735 }, | |
11736 "type": "object" | |
11737 }, | |
11738 "CreativeCustomEvent": { | |
11739 "description": "Creative Custom Event.", | |
11740 "id": "CreativeCustomEvent", | |
11741 "properties": { | |
11742 "advertiserCustomEventName": { | |
11743 "description": "User-entered name for the event.", | |
11744 "type": "string" | |
11745 }, | |
11746 "advertiserCustomEventType": { | |
11747 "description": "Type of the event. This is a read-only field
.", | |
11748 "enum": [ | |
11749 "ADVERTISER_EVENT_COUNTER", | |
11750 "ADVERTISER_EVENT_EXIT", | |
11751 "ADVERTISER_EVENT_TIMER" | |
11752 ], | |
11753 "enumDescriptions": [ | |
11754 "", | |
11755 "", | |
11756 "" | |
11757 ], | |
11758 "type": "string" | |
11759 }, | |
11760 "artworkLabel": { | |
11761 "description": "Artwork label column, used to link events in
DCM back to events in Studio. This is a required field and should not be modifi
ed after insertion.", | |
11762 "type": "string" | |
11763 }, | |
11764 "artworkType": { | |
11765 "description": "Artwork type used by the creative.This is a
read-only field.", | |
11766 "enum": [ | |
11767 "ARTWORK_TYPE_FLASH", | |
11768 "ARTWORK_TYPE_HTML5", | |
11769 "ARTWORK_TYPE_IMAGE", | |
11770 "ARTWORK_TYPE_MIXED" | |
11771 ], | |
11772 "enumDescriptions": [ | |
11773 "", | |
11774 "", | |
11775 "", | |
11776 "" | |
11777 ], | |
11778 "type": "string" | |
11779 }, | |
11780 "exitUrl": { | |
11781 "description": "Exit URL of the event. This field is used on
ly for exit events.", | |
11782 "type": "string" | |
11783 }, | |
11784 "id": { | |
11785 "description": "ID of this event. This is a required field a
nd should not be modified after insertion.", | |
11786 "format": "int64", | |
11787 "type": "string" | |
11788 }, | |
11789 "popupWindowProperties": { | |
11790 "$ref": "PopupWindowProperties", | |
11791 "description": "Properties for rich media popup windows. Thi
s field is used only for exit events." | |
11792 }, | |
11793 "targetType": { | |
11794 "description": "Target type used by the event.", | |
11795 "enum": [ | |
11796 "TARGET_BLANK", | |
11797 "TARGET_PARENT", | |
11798 "TARGET_POPUP", | |
11799 "TARGET_SELF", | |
11800 "TARGET_TOP" | |
11801 ], | |
11802 "enumDescriptions": [ | |
11803 "", | |
11804 "", | |
11805 "", | |
11806 "", | |
11807 "" | |
11808 ], | |
11809 "type": "string" | |
11810 }, | |
11811 "videoReportingId": { | |
11812 "description": "Video reporting ID, used to differentiate mu
ltiple videos in a single creative. This is a read-only field.", | |
11813 "type": "string" | |
11814 } | |
11815 }, | |
11816 "type": "object" | |
11817 }, | |
11818 "CreativeField": { | |
11819 "description": "Contains properties of a creative field.", | |
11820 "id": "CreativeField", | |
11821 "properties": { | |
11822 "accountId": { | |
11823 "description": "Account ID of this creative field. This is a
read-only field that can be left blank.", | |
11824 "format": "int64", | |
11825 "type": "string" | |
11826 }, | |
11827 "advertiserId": { | |
11828 "description": "Advertiser ID of this creative field. This i
s a required field on insertion.", | |
11829 "format": "int64", | |
11830 "type": "string" | |
11831 }, | |
11832 "advertiserIdDimensionValue": { | |
11833 "$ref": "DimensionValue", | |
11834 "description": "Dimension value for the ID of the advertiser
. This is a read-only, auto-generated field." | |
11835 }, | |
11836 "id": { | |
11837 "description": "ID of this creative field. This is a read-on
ly, auto-generated field.", | |
11838 "format": "int64", | |
11839 "type": "string" | |
11840 }, | |
11841 "kind": { | |
11842 "default": "dfareporting#creativeField", | |
11843 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#creativeField\".", | |
11844 "type": "string" | |
11845 }, | |
11846 "name": { | |
11847 "description": "Name of this creative field. This is a requi
red field and must be less than 256 characters long and unique among creative fi
elds of the same advertiser.", | |
11848 "type": "string" | |
11849 }, | |
11850 "subaccountId": { | |
11851 "description": "Subaccount ID of this creative field. This i
s a read-only field that can be left blank.", | |
11852 "format": "int64", | |
11853 "type": "string" | |
11854 } | |
11855 }, | |
11856 "type": "object" | |
11857 }, | |
11858 "CreativeFieldAssignment": { | |
11859 "description": "Creative Field Assignment.", | |
11860 "id": "CreativeFieldAssignment", | |
11861 "properties": { | |
11862 "creativeFieldId": { | |
11863 "description": "ID of the creative field.", | |
11864 "format": "int64", | |
11865 "type": "string" | |
11866 }, | |
11867 "creativeFieldValueId": { | |
11868 "description": "ID of the creative field value.", | |
11869 "format": "int64", | |
11870 "type": "string" | |
11871 } | |
11872 }, | |
11873 "type": "object" | |
11874 }, | |
11875 "CreativeFieldValue": { | |
11876 "description": "Contains properties of a creative field value.", | |
11877 "id": "CreativeFieldValue", | |
11878 "properties": { | |
11879 "id": { | |
11880 "description": "ID of this creative field value. This is a r
ead-only, auto-generated field.", | |
11881 "format": "int64", | |
11882 "type": "string" | |
11883 }, | |
11884 "kind": { | |
11885 "default": "dfareporting#creativeFieldValue", | |
11886 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#creativeFieldValue\".", | |
11887 "type": "string" | |
11888 }, | |
11889 "value": { | |
11890 "description": "Value of this creative field value. It needs
to be less than 256 characters in length and unique per creative field.", | |
11891 "type": "string" | |
11892 } | |
11893 }, | |
11894 "type": "object" | |
11895 }, | |
11896 "CreativeFieldValuesListResponse": { | |
11897 "description": "Creative Field Value List Response", | |
11898 "id": "CreativeFieldValuesListResponse", | |
11899 "properties": { | |
11900 "creativeFieldValues": { | |
11901 "description": "Creative field value collection.", | |
11902 "items": { | |
11903 "$ref": "CreativeFieldValue" | |
11904 }, | |
11905 "type": "array" | |
11906 }, | |
11907 "kind": { | |
11908 "default": "dfareporting#creativeFieldValuesListResponse", | |
11909 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#creativeFieldValuesListResponse\".", | |
11910 "type": "string" | |
11911 }, | |
11912 "nextPageToken": { | |
11913 "description": "Pagination token to be used for the next lis
t operation.", | |
11914 "type": "string" | |
11915 } | |
11916 }, | |
11917 "type": "object" | |
11918 }, | |
11919 "CreativeFieldsListResponse": { | |
11920 "description": "Creative Field List Response", | |
11921 "id": "CreativeFieldsListResponse", | |
11922 "properties": { | |
11923 "creativeFields": { | |
11924 "description": "Creative field collection.", | |
11925 "items": { | |
11926 "$ref": "CreativeField" | |
11927 }, | |
11928 "type": "array" | |
11929 }, | |
11930 "kind": { | |
11931 "default": "dfareporting#creativeFieldsListResponse", | |
11932 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#creativeFieldsListResponse\".", | |
11933 "type": "string" | |
11934 }, | |
11935 "nextPageToken": { | |
11936 "description": "Pagination token to be used for the next lis
t operation.", | |
11937 "type": "string" | |
11938 } | |
11939 }, | |
11940 "type": "object" | |
11941 }, | |
11942 "CreativeGroup": { | |
11943 "description": "Contains properties of a creative group.", | |
11944 "id": "CreativeGroup", | |
11945 "properties": { | |
11946 "accountId": { | |
11947 "description": "Account ID of this creative group. This is a
read-only field that can be left blank.", | |
11948 "format": "int64", | |
11949 "type": "string" | |
11950 }, | |
11951 "advertiserId": { | |
11952 "description": "Advertiser ID of this creative group. This i
s a required field on insertion.", | |
11953 "format": "int64", | |
11954 "type": "string" | |
11955 }, | |
11956 "advertiserIdDimensionValue": { | |
11957 "$ref": "DimensionValue", | |
11958 "description": "Dimension value for the ID of the advertiser
. This is a read-only, auto-generated field." | |
11959 }, | |
11960 "groupNumber": { | |
11961 "description": "Subgroup of the creative group. Assign your
creative groups to one of the following subgroups in order to filter or manage t
hem more easily. This field is required on insertion and is read-only after inse
rtion.\nAcceptable values are: \n- 1\n- 2", | |
11962 "format": "int32", | |
11963 "type": "integer" | |
11964 }, | |
11965 "id": { | |
11966 "description": "ID of this creative group. This is a read-on
ly, auto-generated field.", | |
11967 "format": "int64", | |
11968 "type": "string" | |
11969 }, | |
11970 "kind": { | |
11971 "default": "dfareporting#creativeGroup", | |
11972 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#creativeGroup\".", | |
11973 "type": "string" | |
11974 }, | |
11975 "name": { | |
11976 "description": "Name of this creative group. This is a requi
red field and must be less than 256 characters long and unique among creative gr
oups of the same advertiser.", | |
11977 "type": "string" | |
11978 }, | |
11979 "subaccountId": { | |
11980 "description": "Subaccount ID of this creative group. This i
s a read-only field that can be left blank.", | |
11981 "format": "int64", | |
11982 "type": "string" | |
11983 } | |
11984 }, | |
11985 "type": "object" | |
11986 }, | |
11987 "CreativeGroupAssignment": { | |
11988 "description": "Creative Group Assignment.", | |
11989 "id": "CreativeGroupAssignment", | |
11990 "properties": { | |
11991 "creativeGroupId": { | |
11992 "description": "ID of the creative group to be assigned.", | |
11993 "format": "int64", | |
11994 "type": "string" | |
11995 }, | |
11996 "creativeGroupNumber": { | |
11997 "description": "Creative group number of the creative group
assignment.", | |
11998 "enum": [ | |
11999 "CREATIVE_GROUP_ONE", | |
12000 "CREATIVE_GROUP_TWO" | |
12001 ], | |
12002 "enumDescriptions": [ | |
12003 "", | |
12004 "" | |
12005 ], | |
12006 "type": "string" | |
12007 } | |
12008 }, | |
12009 "type": "object" | |
12010 }, | |
12011 "CreativeGroupsListResponse": { | |
12012 "description": "Creative Group List Response", | |
12013 "id": "CreativeGroupsListResponse", | |
12014 "properties": { | |
12015 "creativeGroups": { | |
12016 "description": "Creative group collection.", | |
12017 "items": { | |
12018 "$ref": "CreativeGroup" | |
12019 }, | |
12020 "type": "array" | |
12021 }, | |
12022 "kind": { | |
12023 "default": "dfareporting#creativeGroupsListResponse", | |
12024 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#creativeGroupsListResponse\".", | |
12025 "type": "string" | |
12026 }, | |
12027 "nextPageToken": { | |
12028 "description": "Pagination token to be used for the next lis
t operation.", | |
12029 "type": "string" | |
12030 } | |
12031 }, | |
12032 "type": "object" | |
12033 }, | |
12034 "CreativeOptimizationConfiguration": { | |
12035 "description": "Creative optimization settings.", | |
12036 "id": "CreativeOptimizationConfiguration", | |
12037 "properties": { | |
12038 "id": { | |
12039 "description": "ID of this creative optimization config. Thi
s field is auto-generated when the campaign is inserted or updated. It can be nu
ll for existing campaigns.", | |
12040 "format": "int64", | |
12041 "type": "string" | |
12042 }, | |
12043 "name": { | |
12044 "description": "Name of this creative optimization config. T
his is a required field and must be less than 129 characters long.", | |
12045 "type": "string" | |
12046 }, | |
12047 "optimizationActivitys": { | |
12048 "description": "List of optimization activities associated w
ith this configuration.", | |
12049 "items": { | |
12050 "$ref": "OptimizationActivity" | |
12051 }, | |
12052 "type": "array" | |
12053 }, | |
12054 "optimizationModel": { | |
12055 "description": "Optimization model for this configuration.", | |
12056 "enum": [ | |
12057 "CLICK", | |
12058 "POST_CLICK", | |
12059 "POST_CLICK_AND_IMPRESSION", | |
12060 "POST_IMPRESSION", | |
12061 "VIDEO_COMPLETION" | |
12062 ], | |
12063 "enumDescriptions": [ | |
12064 "", | |
12065 "", | |
12066 "", | |
12067 "", | |
12068 "" | |
12069 ], | |
12070 "type": "string" | |
12071 } | |
12072 }, | |
12073 "type": "object" | |
12074 }, | |
12075 "CreativeRotation": { | |
12076 "description": "Creative Rotation.", | |
12077 "id": "CreativeRotation", | |
12078 "properties": { | |
12079 "creativeAssignments": { | |
12080 "description": "Creative assignments in this creative rotati
on.", | |
12081 "items": { | |
12082 "$ref": "CreativeAssignment" | |
12083 }, | |
12084 "type": "array" | |
12085 }, | |
12086 "creativeOptimizationConfigurationId": { | |
12087 "description": "Creative optimization configuration that is
used by this ad. It should refer to one of the existing optimization configurati
ons in the ad's campaign. If it is unset or set to 0, then the campaign's defaul
t optimization configuration will be used for this ad.", | |
12088 "format": "int64", | |
12089 "type": "string" | |
12090 }, | |
12091 "type": { | |
12092 "description": "Type of creative rotation. Can be used to sp
ecify whether to use sequential or random rotation.", | |
12093 "enum": [ | |
12094 "CREATIVE_ROTATION_TYPE_RANDOM", | |
12095 "CREATIVE_ROTATION_TYPE_SEQUENTIAL" | |
12096 ], | |
12097 "enumDescriptions": [ | |
12098 "", | |
12099 "" | |
12100 ], | |
12101 "type": "string" | |
12102 }, | |
12103 "weightCalculationStrategy": { | |
12104 "description": "Strategy for calculating weights. Used with
CREATIVE_ROTATION_TYPE_RANDOM.", | |
12105 "enum": [ | |
12106 "WEIGHT_STRATEGY_CUSTOM", | |
12107 "WEIGHT_STRATEGY_EQUAL", | |
12108 "WEIGHT_STRATEGY_HIGHEST_CTR", | |
12109 "WEIGHT_STRATEGY_OPTIMIZED" | |
12110 ], | |
12111 "enumDescriptions": [ | |
12112 "", | |
12113 "", | |
12114 "", | |
12115 "" | |
12116 ], | |
12117 "type": "string" | |
12118 } | |
12119 }, | |
12120 "type": "object" | |
12121 }, | |
12122 "CreativeSettings": { | |
12123 "description": "Creative Settings", | |
12124 "id": "CreativeSettings", | |
12125 "properties": { | |
12126 "iFrameFooter": { | |
12127 "description": "Header text for iFrames for this site. Must
be less than or equal to 2000 characters long.", | |
12128 "type": "string" | |
12129 }, | |
12130 "iFrameHeader": { | |
12131 "description": "Header text for iFrames for this site. Must
be less than or equal to 2000 characters long.", | |
12132 "type": "string" | |
12133 } | |
12134 }, | |
12135 "type": "object" | |
12136 }, | |
12137 "CreativesListResponse": { | |
12138 "description": "Creative List Response", | |
12139 "id": "CreativesListResponse", | |
12140 "properties": { | |
12141 "creatives": { | |
12142 "description": "Creative collection.", | |
12143 "items": { | |
12144 "$ref": "Creative" | |
12145 }, | |
12146 "type": "array" | |
12147 }, | |
12148 "kind": { | |
12149 "default": "dfareporting#creativesListResponse", | |
12150 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#creativesListResponse\".", | |
12151 "type": "string" | |
12152 }, | |
12153 "nextPageToken": { | |
12154 "description": "Pagination token to be used for the next lis
t operation.", | |
12155 "type": "string" | |
12156 } | |
12157 }, | |
12158 "type": "object" | |
12159 }, | |
12160 "CrossDimensionReachReportCompatibleFields": { | |
12161 "description": "Represents fields that are compatible to be selected
for a report of type \"CROSS_DIMENSION_REACH\".", | |
12162 "id": "CrossDimensionReachReportCompatibleFields", | |
12163 "properties": { | |
12164 "breakdown": { | |
12165 "description": "Dimensions which are compatible to be select
ed in the \"breakdown\" section of the report.", | |
12166 "items": { | |
12167 "$ref": "Dimension" | |
12168 }, | |
12169 "type": "array" | |
12170 }, | |
12171 "dimensionFilters": { | |
12172 "description": "Dimensions which are compatible to be select
ed in the \"dimensionFilters\" section of the report.", | |
12173 "items": { | |
12174 "$ref": "Dimension" | |
12175 }, | |
12176 "type": "array" | |
12177 }, | |
12178 "kind": { | |
12179 "default": "dfareporting#crossDimensionReachReportCompatible
Fields", | |
12180 "description": "The kind of resource this is, in this case d
fareporting#crossDimensionReachReportCompatibleFields.", | |
12181 "type": "string" | |
12182 }, | |
12183 "metrics": { | |
12184 "description": "Metrics which are compatible to be selected
in the \"metricNames\" section of the report.", | |
12185 "items": { | |
12186 "$ref": "Metric" | |
12187 }, | |
12188 "type": "array" | |
12189 }, | |
12190 "overlapMetrics": { | |
12191 "description": "Metrics which are compatible to be selected
in the \"overlapMetricNames\" section of the report.", | |
12192 "items": { | |
12193 "$ref": "Metric" | |
12194 }, | |
12195 "type": "array" | |
12196 } | |
12197 }, | |
12198 "type": "object" | |
12199 }, | |
12200 "CustomRichMediaEvents": { | |
12201 "description": "Represents a Custom Rich Media Events group.", | |
12202 "id": "CustomRichMediaEvents", | |
12203 "properties": { | |
12204 "filteredEventIds": { | |
12205 "description": "List of custom rich media event IDs. Dimensi
on values must be all of type dfa:richMediaEventTypeIdAndName.", | |
12206 "items": { | |
12207 "$ref": "DimensionValue" | |
12208 }, | |
12209 "type": "array" | |
12210 }, | |
12211 "kind": { | |
12212 "default": "dfareporting#customRichMediaEvents", | |
12213 "description": "The kind of resource this is, in this case d
fareporting#customRichMediaEvents.", | |
12214 "type": "string" | |
12215 } | |
12216 }, | |
12217 "type": "object" | |
12218 }, | |
12219 "DateRange": { | |
12220 "description": "Represents a date range.", | |
12221 "id": "DateRange", | |
12222 "properties": { | |
12223 "endDate": { | |
12224 "description": "The end date of the date range, inclusive. A
string of the format: \"yyyy-MM-dd\".", | |
12225 "format": "date", | |
12226 "type": "string" | |
12227 }, | |
12228 "kind": { | |
12229 "default": "dfareporting#dateRange", | |
12230 "description": "The kind of resource this is, in this case d
fareporting#dateRange.", | |
12231 "type": "string" | |
12232 }, | |
12233 "relativeDateRange": { | |
12234 "description": "The date range relative to the date of when
the report is run.", | |
12235 "enum": [ | |
12236 "LAST_24_MONTHS", | |
12237 "LAST_30_DAYS", | |
12238 "LAST_365_DAYS", | |
12239 "LAST_7_DAYS", | |
12240 "LAST_90_DAYS", | |
12241 "MONTH_TO_DATE", | |
12242 "PREVIOUS_MONTH", | |
12243 "PREVIOUS_QUARTER", | |
12244 "PREVIOUS_WEEK", | |
12245 "PREVIOUS_YEAR", | |
12246 "QUARTER_TO_DATE", | |
12247 "TODAY", | |
12248 "WEEK_TO_DATE", | |
12249 "YEAR_TO_DATE", | |
12250 "YESTERDAY" | |
12251 ], | |
12252 "enumDescriptions": [ | |
12253 "", | |
12254 "", | |
12255 "", | |
12256 "", | |
12257 "", | |
12258 "", | |
12259 "", | |
12260 "", | |
12261 "", | |
12262 "", | |
12263 "", | |
12264 "", | |
12265 "", | |
12266 "", | |
12267 "" | |
12268 ], | |
12269 "type": "string" | |
12270 }, | |
12271 "startDate": { | |
12272 "description": "The start date of the date range, inclusive.
A string of the format: \"yyyy-MM-dd\".", | |
12273 "format": "date", | |
12274 "type": "string" | |
12275 } | |
12276 }, | |
12277 "type": "object" | |
12278 }, | |
12279 "DayPartTargeting": { | |
12280 "description": "Day Part Targeting.", | |
12281 "id": "DayPartTargeting", | |
12282 "properties": { | |
12283 "daysOfWeek": { | |
12284 "description": "Days of the week when the ad will serve.\n\n
Acceptable values are:\n- \"SUNDAY\"\n- \"MONDAY\"\n- \"TUESDAY\"\n- \"WEDNESDAY
\"\n- \"THURSDAY\"\n- \"FRIDAY\"\n- \"SATURDAY\"", | |
12285 "items": { | |
12286 "enum": [ | |
12287 "FRIDAY", | |
12288 "MONDAY", | |
12289 "SATURDAY", | |
12290 "SUNDAY", | |
12291 "THURSDAY", | |
12292 "TUESDAY", | |
12293 "WEDNESDAY" | |
12294 ], | |
12295 "enumDescriptions": [ | |
12296 "", | |
12297 "", | |
12298 "", | |
12299 "", | |
12300 "", | |
12301 "", | |
12302 "" | |
12303 ], | |
12304 "type": "string" | |
12305 }, | |
12306 "type": "array" | |
12307 }, | |
12308 "hoursOfDay": { | |
12309 "description": "Hours of the day when the ad will serve. Mus
t be an integer between 0 and 23 (inclusive), where 0 is midnight to 1 AM, and 2
3 is 11 PM to midnight. Can be specified with days of week, in which case the ad
would serve during these hours on the specified days. For example, if Monday, W
ednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15,
and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10
am and 3-5pm.", | |
12310 "items": { | |
12311 "format": "int32", | |
12312 "type": "integer" | |
12313 }, | |
12314 "type": "array" | |
12315 }, | |
12316 "userLocalTime": { | |
12317 "description": "Whether or not to use the user's local time.
If false, the America/New York time zone applies.", | |
12318 "type": "boolean" | |
12319 } | |
12320 }, | |
12321 "type": "object" | |
12322 }, | |
12323 "DefaultClickThroughEventTagProperties": { | |
12324 "description": "Properties of inheriting and overriding the default
click-through event tag. A campaign may override the event tag defined at the ad
vertiser level, and an ad may also override the campaign's setting further.", | |
12325 "id": "DefaultClickThroughEventTagProperties", | |
12326 "properties": { | |
12327 "defaultClickThroughEventTagId": { | |
12328 "description": "ID of the click-through event tag to apply t
o all ads in this entity's scope.", | |
12329 "format": "int64", | |
12330 "type": "string" | |
12331 }, | |
12332 "overrideInheritedEventTag": { | |
12333 "description": "Whether this entity should override the inhe
rited default click-through event tag with its own defined value.", | |
12334 "type": "boolean" | |
12335 } | |
12336 }, | |
12337 "type": "object" | |
12338 }, | |
12339 "DeliverySchedule": { | |
12340 "description": "Delivery Schedule.", | |
12341 "id": "DeliverySchedule", | |
12342 "properties": { | |
12343 "frequencyCap": { | |
12344 "$ref": "FrequencyCap", | |
12345 "description": "Limit on the number of times an individual u
ser can be served the ad within a specified period of time." | |
12346 }, | |
12347 "hardCutoff": { | |
12348 "description": "Whether or not hard cutoff is enabled. If tr
ue, the ad will not serve after the end date and time. Otherwise the ad will con
tinue to be served until it has reached its delivery goals.", | |
12349 "type": "boolean" | |
12350 }, | |
12351 "impressionRatio": { | |
12352 "description": "Impression ratio for this ad. This ratio det
ermines how often each ad is served relative to the others. For example, if ad A
has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM wi
ll serve ad B three times as often as ad A. Must be between 1 and 10.", | |
12353 "format": "int64", | |
12354 "type": "string" | |
12355 }, | |
12356 "priority": { | |
12357 "description": "Serving priority of an ad, with respect to o
ther ads. The lower the priority number, the greater the priority with which it
is served.", | |
12358 "enum": [ | |
12359 "AD_PRIORITY_01", | |
12360 "AD_PRIORITY_02", | |
12361 "AD_PRIORITY_03", | |
12362 "AD_PRIORITY_04", | |
12363 "AD_PRIORITY_05", | |
12364 "AD_PRIORITY_06", | |
12365 "AD_PRIORITY_07", | |
12366 "AD_PRIORITY_08", | |
12367 "AD_PRIORITY_09", | |
12368 "AD_PRIORITY_10", | |
12369 "AD_PRIORITY_11", | |
12370 "AD_PRIORITY_12", | |
12371 "AD_PRIORITY_13", | |
12372 "AD_PRIORITY_14", | |
12373 "AD_PRIORITY_15", | |
12374 "AD_PRIORITY_16" | |
12375 ], | |
12376 "enumDescriptions": [ | |
12377 "", | |
12378 "", | |
12379 "", | |
12380 "", | |
12381 "", | |
12382 "", | |
12383 "", | |
12384 "", | |
12385 "", | |
12386 "", | |
12387 "", | |
12388 "", | |
12389 "", | |
12390 "", | |
12391 "", | |
12392 "" | |
12393 ], | |
12394 "type": "string" | |
12395 } | |
12396 }, | |
12397 "type": "object" | |
12398 }, | |
12399 "DfpSettings": { | |
12400 "description": "DFP Settings", | |
12401 "id": "DfpSettings", | |
12402 "properties": { | |
12403 "dfp_network_code": { | |
12404 "description": "DFP network code for this directory site.", | |
12405 "type": "string" | |
12406 }, | |
12407 "dfp_network_name": { | |
12408 "description": "DFP network name for this directory site.", | |
12409 "type": "string" | |
12410 }, | |
12411 "programmaticPlacementAccepted": { | |
12412 "description": "Whether this directory site accepts programm
atic placements.", | |
12413 "type": "boolean" | |
12414 }, | |
12415 "pubPaidPlacementAccepted": { | |
12416 "description": "Whether this directory site accepts publishe
r-paid tags.", | |
12417 "type": "boolean" | |
12418 }, | |
12419 "publisherPortalOnly": { | |
12420 "description": "Whether this directory site is available onl
y via DoubleClick Publisher Portal.", | |
12421 "type": "boolean" | |
12422 } | |
12423 }, | |
12424 "type": "object" | |
12425 }, | |
12426 "Dimension": { | |
12427 "description": "Represents a dimension.", | |
12428 "id": "Dimension", | |
12429 "properties": { | |
12430 "kind": { | |
12431 "default": "dfareporting#dimension", | |
12432 "description": "The kind of resource this is, in this case d
fareporting#dimension.", | |
12433 "type": "string" | |
12434 }, | |
12435 "name": { | |
12436 "description": "The dimension name, e.g. dfa:advertiser", | |
12437 "type": "string" | |
12438 } | |
12439 }, | |
12440 "type": "object" | |
12441 }, | |
12442 "DimensionFilter": { | |
12443 "description": "Represents a dimension filter.", | |
12444 "id": "DimensionFilter", | |
12445 "properties": { | |
12446 "dimensionName": { | |
12447 "description": "The name of the dimension to filter.", | |
12448 "type": "string" | |
12449 }, | |
12450 "kind": { | |
12451 "default": "dfareporting#dimensionFilter", | |
12452 "description": "The kind of resource this is, in this case d
fareporting#dimensionFilter.", | |
12453 "type": "string" | |
12454 }, | |
12455 "value": { | |
12456 "description": "The value of the dimension to filter.", | |
12457 "type": "string" | |
12458 } | |
12459 }, | |
12460 "type": "object" | |
12461 }, | |
12462 "DimensionValue": { | |
12463 "description": "Represents a DimensionValue resource.", | |
12464 "id": "DimensionValue", | |
12465 "properties": { | |
12466 "dimensionName": { | |
12467 "description": "The name of the dimension.", | |
12468 "type": "string" | |
12469 }, | |
12470 "etag": { | |
12471 "description": "The eTag of this response for caching purpos
es.", | |
12472 "type": "string" | |
12473 }, | |
12474 "id": { | |
12475 "description": "The ID associated with the value if availabl
e.", | |
12476 "type": "string" | |
12477 }, | |
12478 "kind": { | |
12479 "default": "dfareporting#dimensionValue", | |
12480 "description": "The kind of resource this is, in this case d
fareporting#dimensionValue.", | |
12481 "type": "string" | |
12482 }, | |
12483 "matchType": { | |
12484 "description": "Determines how the 'value' field is matched
when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSI
ON, '*' is allowed as a placeholder for variable length character sequences, and
it can be escaped with a backslash. Note, only paid search dimensions ('dfa:pai
dSearch*') allow a matchType other than EXACT.", | |
12485 "enum": [ | |
12486 "BEGINS_WITH", | |
12487 "CONTAINS", | |
12488 "EXACT", | |
12489 "WILDCARD_EXPRESSION" | |
12490 ], | |
12491 "enumDescriptions": [ | |
12492 "", | |
12493 "", | |
12494 "", | |
12495 "" | |
12496 ], | |
12497 "type": "string" | |
12498 }, | |
12499 "value": { | |
12500 "description": "The value of the dimension.", | |
12501 "type": "string" | |
12502 } | |
12503 }, | |
12504 "type": "object" | |
12505 }, | |
12506 "DimensionValueList": { | |
12507 "description": "Represents the list of DimensionValue resources.", | |
12508 "id": "DimensionValueList", | |
12509 "properties": { | |
12510 "etag": { | |
12511 "description": "The eTag of this response for caching purpos
es.", | |
12512 "type": "string" | |
12513 }, | |
12514 "items": { | |
12515 "description": "The dimension values returned in this respon
se.", | |
12516 "items": { | |
12517 "$ref": "DimensionValue" | |
12518 }, | |
12519 "type": "array" | |
12520 }, | |
12521 "kind": { | |
12522 "default": "dfareporting#dimensionValueList", | |
12523 "description": "The kind of list this is, in this case dfare
porting#dimensionValueList.", | |
12524 "type": "string" | |
12525 }, | |
12526 "nextPageToken": { | |
12527 "description": "Continuation token used to page through dime
nsion values. To retrieve the next page of results, set the next request's \"pag
eToken\" to the value of this field. The page token is only valid for a limited
amount of time and should not be persisted.", | |
12528 "type": "string" | |
12529 } | |
12530 }, | |
12531 "type": "object" | |
12532 }, | |
12533 "DimensionValueRequest": { | |
12534 "description": "Represents a DimensionValuesRequest.", | |
12535 "id": "DimensionValueRequest", | |
12536 "properties": { | |
12537 "dimensionName": { | |
12538 "annotations": { | |
12539 "required": [ | |
12540 "dfareporting.dimensionValues.query" | |
12541 ] | |
12542 }, | |
12543 "description": "The name of the dimension for which values s
hould be requested.", | |
12544 "type": "string" | |
12545 }, | |
12546 "endDate": { | |
12547 "annotations": { | |
12548 "required": [ | |
12549 "dfareporting.dimensionValues.query" | |
12550 ] | |
12551 }, | |
12552 "description": "The end date of the date range for which to
retrieve dimension values. A string of the format \"yyyy-MM-dd\".", | |
12553 "format": "date", | |
12554 "type": "string" | |
12555 }, | |
12556 "filters": { | |
12557 "description": "The list of filters by which to filter value
s. The filters are ANDed.", | |
12558 "items": { | |
12559 "$ref": "DimensionFilter" | |
12560 }, | |
12561 "type": "array" | |
12562 }, | |
12563 "kind": { | |
12564 "default": "dfareporting#dimensionValueRequest", | |
12565 "description": "The kind of request this is, in this case df
areporting#dimensionValueRequest.", | |
12566 "type": "string" | |
12567 }, | |
12568 "startDate": { | |
12569 "annotations": { | |
12570 "required": [ | |
12571 "dfareporting.dimensionValues.query" | |
12572 ] | |
12573 }, | |
12574 "description": "The start date of the date range for which t
o retrieve dimension values. A string of the format \"yyyy-MM-dd\".", | |
12575 "format": "date", | |
12576 "type": "string" | |
12577 } | |
12578 }, | |
12579 "type": "object" | |
12580 }, | |
12581 "DirectorySite": { | |
12582 "description": "DirectorySites contains properties of a website from
the Site Directory. Sites need to be added to an account via the Sites resource
before they can be assigned to a placement.", | |
12583 "id": "DirectorySite", | |
12584 "properties": { | |
12585 "active": { | |
12586 "description": "Whether this directory site is active.", | |
12587 "type": "boolean" | |
12588 }, | |
12589 "contactAssignments": { | |
12590 "description": "Directory site contacts.", | |
12591 "items": { | |
12592 "$ref": "DirectorySiteContactAssignment" | |
12593 }, | |
12594 "type": "array" | |
12595 }, | |
12596 "countryId": { | |
12597 "description": "Country ID of this directory site.", | |
12598 "format": "int64", | |
12599 "type": "string" | |
12600 }, | |
12601 "currencyId": { | |
12602 "description": "Currency ID of this directory site.\nPossibl
e values are: \n- \"1\" for USD \n- \"2\" for GBP \n- \"3\" for ESP \n- \"4\" fo
r SEK \n- \"5\" for CAD \n- \"6\" for JPY \n- \"7\" for DEM \n- \"8\" for AUD \n
- \"9\" for FRF \n- \"10\" for ITL \n- \"11\" for DKK \n- \"12\" for NOK \n- \"1
3\" for FIM \n- \"14\" for ZAR \n- \"15\" for IEP \n- \"16\" for NLG \n- \"17\"
for EUR \n- \"18\" for KRW \n- \"19\" for TWD \n- \"20\" for SGD \n- \"21\" for
CNY \n- \"22\" for HKD \n- \"23\" for NZD \n- \"24\" for MYR \n- \"25\" for BRL
\n- \"26\" for PTE \n- \"27\" for MXP \n- \"28\" for CLP \n- \"29\" for TRY \n-
\"30\" for ARS \n- \"31\" for PEN \n- \"32\" for ILS \n- \"33\" for CHF \n- \"34
\" for VEF \n- \"35\" for COP \n- \"36\" for GTQ \n- \"37\" for PLN \n- \"39\" f
or INR \n- \"40\" for THB \n- \"41\" for IDR \n- \"42\" for CZK \n- \"43\" for R
ON \n- \"44\" for HUF \n- \"45\" for RUB \n- \"46\" for AED \n- \"47\" for BGN \
n- \"48\" for HRK", | |
12603 "format": "int64", | |
12604 "type": "string" | |
12605 }, | |
12606 "description": { | |
12607 "description": "Description of this directory site.", | |
12608 "type": "string" | |
12609 }, | |
12610 "id": { | |
12611 "description": "ID of this directory site. This is a read-on
ly, auto-generated field.", | |
12612 "format": "int64", | |
12613 "type": "string" | |
12614 }, | |
12615 "idDimensionValue": { | |
12616 "$ref": "DimensionValue", | |
12617 "description": "Dimension value for the ID of this directory
site. This is a read-only, auto-generated field." | |
12618 }, | |
12619 "inpageTagFormats": { | |
12620 "description": "Tag types for regular placements.\n\nAccepta
ble values are:\n- \"STANDARD\"\n- \"IFRAME_JAVASCRIPT_INPAGE\"\n- \"INTERNAL_RE
DIRECT_INPAGE\"\n- \"JAVASCRIPT_INPAGE\"", | |
12621 "items": { | |
12622 "enum": [ | |
12623 "IFRAME_JAVASCRIPT_INPAGE", | |
12624 "INTERNAL_REDIRECT_INPAGE", | |
12625 "JAVASCRIPT_INPAGE", | |
12626 "STANDARD" | |
12627 ], | |
12628 "enumDescriptions": [ | |
12629 "", | |
12630 "", | |
12631 "", | |
12632 "" | |
12633 ], | |
12634 "type": "string" | |
12635 }, | |
12636 "type": "array" | |
12637 }, | |
12638 "interstitialTagFormats": { | |
12639 "description": "Tag types for interstitial placements.\n\nAc
ceptable values are:\n- \"IFRAME_JAVASCRIPT_INTERSTITIAL\"\n- \"INTERNAL_REDIREC
T_INTERSTITIAL\"\n- \"JAVASCRIPT_INTERSTITIAL\"", | |
12640 "items": { | |
12641 "enum": [ | |
12642 "IFRAME_JAVASCRIPT_INTERSTITIAL", | |
12643 "INTERNAL_REDIRECT_INTERSTITIAL", | |
12644 "JAVASCRIPT_INTERSTITIAL" | |
12645 ], | |
12646 "enumDescriptions": [ | |
12647 "", | |
12648 "", | |
12649 "" | |
12650 ], | |
12651 "type": "string" | |
12652 }, | |
12653 "type": "array" | |
12654 }, | |
12655 "kind": { | |
12656 "default": "dfareporting#directorySite", | |
12657 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#directorySite\".", | |
12658 "type": "string" | |
12659 }, | |
12660 "name": { | |
12661 "description": "Name of this directory site.", | |
12662 "type": "string" | |
12663 }, | |
12664 "parentId": { | |
12665 "description": "Parent directory site ID.", | |
12666 "format": "int64", | |
12667 "type": "string" | |
12668 }, | |
12669 "settings": { | |
12670 "$ref": "DirectorySiteSettings", | |
12671 "description": "Directory site settings." | |
12672 }, | |
12673 "url": { | |
12674 "description": "URL of this directory site.", | |
12675 "type": "string" | |
12676 } | |
12677 }, | |
12678 "type": "object" | |
12679 }, | |
12680 "DirectorySiteContact": { | |
12681 "description": "Contains properties of a Site Directory contact.", | |
12682 "id": "DirectorySiteContact", | |
12683 "properties": { | |
12684 "address": { | |
12685 "description": "Address of this directory site contact.", | |
12686 "type": "string" | |
12687 }, | |
12688 "email": { | |
12689 "description": "Email address of this directory site contact
.", | |
12690 "type": "string" | |
12691 }, | |
12692 "firstName": { | |
12693 "description": "First name of this directory site contact.", | |
12694 "type": "string" | |
12695 }, | |
12696 "id": { | |
12697 "description": "ID of this directory site contact. This is a
read-only, auto-generated field.", | |
12698 "format": "int64", | |
12699 "type": "string" | |
12700 }, | |
12701 "kind": { | |
12702 "default": "dfareporting#directorySiteContact", | |
12703 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#directorySiteContact\".", | |
12704 "type": "string" | |
12705 }, | |
12706 "lastName": { | |
12707 "description": "Last name of this directory site contact.", | |
12708 "type": "string" | |
12709 }, | |
12710 "phone": { | |
12711 "description": "Phone number of this directory site contact.
", | |
12712 "type": "string" | |
12713 }, | |
12714 "role": { | |
12715 "description": "Directory site contact role.", | |
12716 "enum": [ | |
12717 "ADMIN", | |
12718 "EDIT", | |
12719 "VIEW" | |
12720 ], | |
12721 "enumDescriptions": [ | |
12722 "", | |
12723 "", | |
12724 "" | |
12725 ], | |
12726 "type": "string" | |
12727 }, | |
12728 "title": { | |
12729 "description": "Title or designation of this directory site
contact.", | |
12730 "type": "string" | |
12731 }, | |
12732 "type": { | |
12733 "description": "Directory site contact type.", | |
12734 "enum": [ | |
12735 "BILLING", | |
12736 "OTHER", | |
12737 "SALES", | |
12738 "TECHNICAL" | |
12739 ], | |
12740 "enumDescriptions": [ | |
12741 "", | |
12742 "", | |
12743 "", | |
12744 "" | |
12745 ], | |
12746 "type": "string" | |
12747 } | |
12748 }, | |
12749 "type": "object" | |
12750 }, | |
12751 "DirectorySiteContactAssignment": { | |
12752 "description": "Directory Site Contact Assignment", | |
12753 "id": "DirectorySiteContactAssignment", | |
12754 "properties": { | |
12755 "contactId": { | |
12756 "description": "ID of this directory site contact. This is a
read-only, auto-generated field.", | |
12757 "format": "int64", | |
12758 "type": "string" | |
12759 }, | |
12760 "visibility": { | |
12761 "description": "Visibility of this directory site contact as
signment. When set to PUBLIC this contact assignment is visible to all account a
nd agency users; when set to PRIVATE it is visible only to the site.", | |
12762 "enum": [ | |
12763 "PRIVATE", | |
12764 "PUBLIC" | |
12765 ], | |
12766 "enumDescriptions": [ | |
12767 "", | |
12768 "" | |
12769 ], | |
12770 "type": "string" | |
12771 } | |
12772 }, | |
12773 "type": "object" | |
12774 }, | |
12775 "DirectorySiteContactsListResponse": { | |
12776 "description": "Directory Site Contact List Response", | |
12777 "id": "DirectorySiteContactsListResponse", | |
12778 "properties": { | |
12779 "directorySiteContacts": { | |
12780 "description": "Directory site contact collection", | |
12781 "items": { | |
12782 "$ref": "DirectorySiteContact" | |
12783 }, | |
12784 "type": "array" | |
12785 }, | |
12786 "kind": { | |
12787 "default": "dfareporting#directorySiteContactsListResponse", | |
12788 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#directorySiteContactsListResponse\".", | |
12789 "type": "string" | |
12790 }, | |
12791 "nextPageToken": { | |
12792 "description": "Pagination token to be used for the next lis
t operation.", | |
12793 "type": "string" | |
12794 } | |
12795 }, | |
12796 "type": "object" | |
12797 }, | |
12798 "DirectorySiteSettings": { | |
12799 "description": "Directory Site Settings", | |
12800 "id": "DirectorySiteSettings", | |
12801 "properties": { | |
12802 "activeViewOptOut": { | |
12803 "description": "Whether this directory site has disabled act
ive view creatives.", | |
12804 "type": "boolean" | |
12805 }, | |
12806 "dfp_settings": { | |
12807 "$ref": "DfpSettings", | |
12808 "description": "Directory site DFP settings." | |
12809 }, | |
12810 "instream_video_placement_accepted": { | |
12811 "description": "Whether this site accepts in-stream video ad
s.", | |
12812 "type": "boolean" | |
12813 }, | |
12814 "interstitialPlacementAccepted": { | |
12815 "description": "Whether this site accepts interstitial ads."
, | |
12816 "type": "boolean" | |
12817 }, | |
12818 "nielsenOcrOptOut": { | |
12819 "description": "Whether this directory site has disabled Nie
lsen OCR reach ratings.", | |
12820 "type": "boolean" | |
12821 }, | |
12822 "verificationTagOptOut": { | |
12823 "description": "Whether this directory site has disabled gen
eration of Verification ins tags.", | |
12824 "type": "boolean" | |
12825 }, | |
12826 "videoActiveViewOptOut": { | |
12827 "description": "Whether this directory site has disabled act
ive view for in-stream video creatives.", | |
12828 "type": "boolean" | |
12829 } | |
12830 }, | |
12831 "type": "object" | |
12832 }, | |
12833 "DirectorySitesListResponse": { | |
12834 "description": "Directory Site List Response", | |
12835 "id": "DirectorySitesListResponse", | |
12836 "properties": { | |
12837 "directorySites": { | |
12838 "description": "Directory site collection.", | |
12839 "items": { | |
12840 "$ref": "DirectorySite" | |
12841 }, | |
12842 "type": "array" | |
12843 }, | |
12844 "kind": { | |
12845 "default": "dfareporting#directorySitesListResponse", | |
12846 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#directorySitesListResponse\".", | |
12847 "type": "string" | |
12848 }, | |
12849 "nextPageToken": { | |
12850 "description": "Pagination token to be used for the next lis
t operation.", | |
12851 "type": "string" | |
12852 } | |
12853 }, | |
12854 "type": "object" | |
12855 }, | |
12856 "EventTag": { | |
12857 "description": "Contains properties of an event tag.", | |
12858 "id": "EventTag", | |
12859 "properties": { | |
12860 "accountId": { | |
12861 "description": "Account ID of this event tag. This is a read
-only field that can be left blank.", | |
12862 "format": "int64", | |
12863 "type": "string" | |
12864 }, | |
12865 "advertiserId": { | |
12866 "description": "Advertiser ID of this event tag. This field
or the campaignId field is required on insertion.", | |
12867 "format": "int64", | |
12868 "type": "string" | |
12869 }, | |
12870 "advertiserIdDimensionValue": { | |
12871 "$ref": "DimensionValue", | |
12872 "description": "Dimension value for the ID of the advertiser
. This is a read-only, auto-generated field." | |
12873 }, | |
12874 "campaignId": { | |
12875 "description": "Campaign ID of this event tag. This field or
the advertiserId field is required on insertion.", | |
12876 "format": "int64", | |
12877 "type": "string" | |
12878 }, | |
12879 "campaignIdDimensionValue": { | |
12880 "$ref": "DimensionValue", | |
12881 "description": "Dimension value for the ID of the campaign.
This is a read-only, auto-generated field." | |
12882 }, | |
12883 "enabledByDefault": { | |
12884 "description": "Whether this event tag should be automatical
ly enabled for all of the advertiser's campaigns and ads.", | |
12885 "type": "boolean" | |
12886 }, | |
12887 "excludeFromAdxRequests": { | |
12888 "description": "Whether to remove this event tag from ads th
at are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be us
eful if the event tag uses a pixel that is unapproved for Ad Exchange bids on on
e or more networks, such as the Google Display Network.", | |
12889 "type": "boolean" | |
12890 }, | |
12891 "id": { | |
12892 "description": "ID of this event tag. This is a read-only, a
uto-generated field.", | |
12893 "format": "int64", | |
12894 "type": "string" | |
12895 }, | |
12896 "kind": { | |
12897 "default": "dfareporting#eventTag", | |
12898 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#eventTag\".", | |
12899 "type": "string" | |
12900 }, | |
12901 "name": { | |
12902 "description": "Name of this event tag. This is a required f
ield and must be less than 256 characters long.", | |
12903 "type": "string" | |
12904 }, | |
12905 "siteFilterType": { | |
12906 "description": "Site filter type for this event tag. If no t
ype is specified then the event tag will be applied to all sites.", | |
12907 "enum": [ | |
12908 "BLACKLIST", | |
12909 "WHITELIST" | |
12910 ], | |
12911 "enumDescriptions": [ | |
12912 "", | |
12913 "" | |
12914 ], | |
12915 "type": "string" | |
12916 }, | |
12917 "siteIds": { | |
12918 "description": "Filter list of site IDs associated with this
event tag. The siteFilterType determines whether this is a whitelist or blackli
st filter.", | |
12919 "items": { | |
12920 "format": "int64", | |
12921 "type": "string" | |
12922 }, | |
12923 "type": "array" | |
12924 }, | |
12925 "sslCompliant": { | |
12926 "description": "Whether this tag is SSL-compliant or not. Th
is is a read-only field.", | |
12927 "type": "boolean" | |
12928 }, | |
12929 "status": { | |
12930 "description": "Status of this event tag. Must be ENABLED fo
r this event tag to fire. This is a required field.", | |
12931 "enum": [ | |
12932 "DISABLED", | |
12933 "ENABLED" | |
12934 ], | |
12935 "enumDescriptions": [ | |
12936 "", | |
12937 "" | |
12938 ], | |
12939 "type": "string" | |
12940 }, | |
12941 "subaccountId": { | |
12942 "description": "Subaccount ID of this event tag. This is a r
ead-only field that can be left blank.", | |
12943 "format": "int64", | |
12944 "type": "string" | |
12945 }, | |
12946 "type": { | |
12947 "description": "Event tag type. Can be used to specify wheth
er to use a third-party pixel, a third-party JavaScript URL, or a third-party cl
ick-through URL for either impression or click tracking. This is a required fiel
d.", | |
12948 "enum": [ | |
12949 "CLICK_THROUGH_EVENT_TAG", | |
12950 "IMPRESSION_IMAGE_EVENT_TAG", | |
12951 "IMPRESSION_JAVASCRIPT_EVENT_TAG" | |
12952 ], | |
12953 "enumDescriptions": [ | |
12954 "", | |
12955 "", | |
12956 "" | |
12957 ], | |
12958 "type": "string" | |
12959 }, | |
12960 "url": { | |
12961 "description": "Payload URL for this event tag. The URL on a
click-through event tag should have a landing page URL appended to the end of i
t. This field is required on insertion.", | |
12962 "type": "string" | |
12963 }, | |
12964 "urlEscapeLevels": { | |
12965 "description": "Number of times the landing page URL should
be URL-escaped before being appended to the click-through event tag URL. Only ap
plies to click-through event tags as specified by the event tag type.", | |
12966 "format": "int32", | |
12967 "type": "integer" | |
12968 } | |
12969 }, | |
12970 "type": "object" | |
12971 }, | |
12972 "EventTagOverride": { | |
12973 "description": "Event tag override information.", | |
12974 "id": "EventTagOverride", | |
12975 "properties": { | |
12976 "enabled": { | |
12977 "description": "Whether this override is enabled.", | |
12978 "type": "boolean" | |
12979 }, | |
12980 "id": { | |
12981 "description": "ID of this event tag override. This is a rea
d-only, auto-generated field.", | |
12982 "format": "int64", | |
12983 "type": "string" | |
12984 } | |
12985 }, | |
12986 "type": "object" | |
12987 }, | |
12988 "EventTagsListResponse": { | |
12989 "description": "Event Tag List Response", | |
12990 "id": "EventTagsListResponse", | |
12991 "properties": { | |
12992 "eventTags": { | |
12993 "description": "Event tag collection.", | |
12994 "items": { | |
12995 "$ref": "EventTag" | |
12996 }, | |
12997 "type": "array" | |
12998 }, | |
12999 "kind": { | |
13000 "default": "dfareporting#eventTagsListResponse", | |
13001 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#eventTagsListResponse\".", | |
13002 "type": "string" | |
13003 } | |
13004 }, | |
13005 "type": "object" | |
13006 }, | |
13007 "File": { | |
13008 "description": "Represents a File resource. A file contains the meta
data for a report run. It shows the status of the run and holds the URLs to the
generated report data if the run is finished and the status is \"REPORT_AVAILABL
E\".", | |
13009 "id": "File", | |
13010 "properties": { | |
13011 "dateRange": { | |
13012 "$ref": "DateRange", | |
13013 "description": "The date range for which the file has report
data. The date range will always be the absolute date range for which the repor
t is run." | |
13014 }, | |
13015 "etag": { | |
13016 "description": "The eTag of this response for caching purpos
es.", | |
13017 "type": "string" | |
13018 }, | |
13019 "fileName": { | |
13020 "description": "The filename of the file.", | |
13021 "type": "string" | |
13022 }, | |
13023 "format": { | |
13024 "description": "The output format of the report. Only availa
ble once the file is available.", | |
13025 "enum": [ | |
13026 "CSV", | |
13027 "EXCEL" | |
13028 ], | |
13029 "enumDescriptions": [ | |
13030 "", | |
13031 "" | |
13032 ], | |
13033 "type": "string" | |
13034 }, | |
13035 "id": { | |
13036 "description": "The unique ID of this report file.", | |
13037 "format": "int64", | |
13038 "type": "string" | |
13039 }, | |
13040 "kind": { | |
13041 "default": "dfareporting#file", | |
13042 "description": "The kind of resource this is, in this case d
fareporting#file.", | |
13043 "type": "string" | |
13044 }, | |
13045 "lastModifiedTime": { | |
13046 "description": "The timestamp in milliseconds since epoch wh
en this file was last modified.", | |
13047 "format": "int64", | |
13048 "type": "string" | |
13049 }, | |
13050 "reportId": { | |
13051 "description": "The ID of the report this file was generated
from.", | |
13052 "format": "int64", | |
13053 "type": "string" | |
13054 }, | |
13055 "status": { | |
13056 "description": "The status of the report file.", | |
13057 "enum": [ | |
13058 "CANCELLED", | |
13059 "FAILED", | |
13060 "PROCESSING", | |
13061 "REPORT_AVAILABLE" | |
13062 ], | |
13063 "enumDescriptions": [ | |
13064 "", | |
13065 "", | |
13066 "", | |
13067 "" | |
13068 ], | |
13069 "type": "string" | |
13070 }, | |
13071 "urls": { | |
13072 "description": "The URLs where the completed report file can
be downloaded.", | |
13073 "properties": { | |
13074 "apiUrl": { | |
13075 "description": "The URL for downloading the report d
ata through the API.", | |
13076 "type": "string" | |
13077 }, | |
13078 "browserUrl": { | |
13079 "description": "The URL for downloading the report d
ata through a browser.", | |
13080 "type": "string" | |
13081 } | |
13082 }, | |
13083 "type": "object" | |
13084 } | |
13085 }, | |
13086 "type": "object" | |
13087 }, | |
13088 "FileList": { | |
13089 "description": "Represents the list of File resources.", | |
13090 "id": "FileList", | |
13091 "properties": { | |
13092 "etag": { | |
13093 "description": "The eTag of this response for caching purpos
es.", | |
13094 "type": "string" | |
13095 }, | |
13096 "items": { | |
13097 "description": "The files returned in this response.", | |
13098 "items": { | |
13099 "$ref": "File" | |
13100 }, | |
13101 "type": "array" | |
13102 }, | |
13103 "kind": { | |
13104 "default": "dfareporting#fileList", | |
13105 "description": "The kind of list this is, in this case dfare
porting#fileList.", | |
13106 "type": "string" | |
13107 }, | |
13108 "nextPageToken": { | |
13109 "description": "Continuation token used to page through file
s. To retrieve the next page of results, set the next request's \"pageToken\" to
the value of this field. The page token is only valid for a limited amount of t
ime and should not be persisted.", | |
13110 "type": "string" | |
13111 } | |
13112 }, | |
13113 "type": "object" | |
13114 }, | |
13115 "Flight": { | |
13116 "description": "Flight", | |
13117 "id": "Flight", | |
13118 "properties": { | |
13119 "endDate": { | |
13120 "description": "Inventory item flight end date.", | |
13121 "format": "date", | |
13122 "type": "string" | |
13123 }, | |
13124 "rateOrCost": { | |
13125 "description": "Rate or cost of this flight.", | |
13126 "format": "int64", | |
13127 "type": "string" | |
13128 }, | |
13129 "startDate": { | |
13130 "description": "Inventory item flight start date.", | |
13131 "format": "date", | |
13132 "type": "string" | |
13133 }, | |
13134 "units": { | |
13135 "description": "Units of this flight.", | |
13136 "format": "int64", | |
13137 "type": "string" | |
13138 } | |
13139 }, | |
13140 "type": "object" | |
13141 }, | |
13142 "FloodlightActivitiesGenerateTagResponse": { | |
13143 "description": "Floodlight Activity GenerateTag Response", | |
13144 "id": "FloodlightActivitiesGenerateTagResponse", | |
13145 "properties": { | |
13146 "floodlightActivityTag": { | |
13147 "description": "Generated tag for this floodlight activity."
, | |
13148 "type": "string" | |
13149 }, | |
13150 "kind": { | |
13151 "default": "dfareporting#floodlightActivitiesGenerateTagResp
onse", | |
13152 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#floodlightActivitiesGenerateTagResponse\"."
, | |
13153 "type": "string" | |
13154 } | |
13155 }, | |
13156 "type": "object" | |
13157 }, | |
13158 "FloodlightActivitiesListResponse": { | |
13159 "description": "Floodlight Activity List Response", | |
13160 "id": "FloodlightActivitiesListResponse", | |
13161 "properties": { | |
13162 "floodlightActivities": { | |
13163 "description": "Floodlight activity collection.", | |
13164 "items": { | |
13165 "$ref": "FloodlightActivity" | |
13166 }, | |
13167 "type": "array" | |
13168 }, | |
13169 "kind": { | |
13170 "default": "dfareporting#floodlightActivitiesListResponse", | |
13171 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#floodlightActivitiesListResponse\".", | |
13172 "type": "string" | |
13173 }, | |
13174 "nextPageToken": { | |
13175 "description": "Pagination token to be used for the next lis
t operation.", | |
13176 "type": "string" | |
13177 } | |
13178 }, | |
13179 "type": "object" | |
13180 }, | |
13181 "FloodlightActivity": { | |
13182 "description": "Contains properties of a Floodlight activity.", | |
13183 "id": "FloodlightActivity", | |
13184 "properties": { | |
13185 "accountId": { | |
13186 "description": "Account ID of this floodlight activity. This
is a read-only field that can be left blank.", | |
13187 "format": "int64", | |
13188 "type": "string" | |
13189 }, | |
13190 "advertiserId": { | |
13191 "description": "Advertiser ID of this floodlight activity. I
f this field is left blank, the value will be copied over either from the activi
ty group's advertiser or the existing activity's advertiser.", | |
13192 "format": "int64", | |
13193 "type": "string" | |
13194 }, | |
13195 "advertiserIdDimensionValue": { | |
13196 "$ref": "DimensionValue", | |
13197 "description": "Dimension value for the ID of the advertiser
. This is a read-only, auto-generated field." | |
13198 }, | |
13199 "cacheBustingType": { | |
13200 "description": "Code type used for cache busting in the gene
rated tag.", | |
13201 "enum": [ | |
13202 "ACTIVE_SERVER_PAGE", | |
13203 "COLD_FUSION", | |
13204 "JAVASCRIPT", | |
13205 "JSP", | |
13206 "PHP" | |
13207 ], | |
13208 "enumDescriptions": [ | |
13209 "", | |
13210 "", | |
13211 "", | |
13212 "", | |
13213 "" | |
13214 ], | |
13215 "type": "string" | |
13216 }, | |
13217 "countingMethod": { | |
13218 "description": "Counting method for conversions for this flo
odlight activity. This is a required field.", | |
13219 "enum": [ | |
13220 "ITEMS_SOLD_COUNTING", | |
13221 "SESSION_COUNTING", | |
13222 "STANDARD_COUNTING", | |
13223 "TRANSACTIONS_COUNTING", | |
13224 "UNIQUE_COUNTING" | |
13225 ], | |
13226 "enumDescriptions": [ | |
13227 "", | |
13228 "", | |
13229 "", | |
13230 "", | |
13231 "" | |
13232 ], | |
13233 "type": "string" | |
13234 }, | |
13235 "defaultTags": { | |
13236 "description": "Dynamic floodlight tags.", | |
13237 "items": { | |
13238 "$ref": "FloodlightActivityDynamicTag" | |
13239 }, | |
13240 "type": "array" | |
13241 }, | |
13242 "expectedUrl": { | |
13243 "description": "URL where this tag will be deployed. If spec
ified, must be less than 256 characters long.", | |
13244 "type": "string" | |
13245 }, | |
13246 "floodlightActivityGroupId": { | |
13247 "description": "Floodlight activity group ID of this floodli
ght activity. This is a required field.", | |
13248 "format": "int64", | |
13249 "type": "string" | |
13250 }, | |
13251 "floodlightActivityGroupName": { | |
13252 "description": "Name of the associated floodlight activity g
roup. This is a read-only field.", | |
13253 "type": "string" | |
13254 }, | |
13255 "floodlightActivityGroupTagString": { | |
13256 "description": "Tag string of the associated floodlight acti
vity group. This is a read-only field.", | |
13257 "type": "string" | |
13258 }, | |
13259 "floodlightActivityGroupType": { | |
13260 "description": "Type of the associated floodlight activity g
roup. This is a read-only field.", | |
13261 "enum": [ | |
13262 "COUNTER", | |
13263 "SALE" | |
13264 ], | |
13265 "enumDescriptions": [ | |
13266 "", | |
13267 "" | |
13268 ], | |
13269 "type": "string" | |
13270 }, | |
13271 "floodlightConfigurationId": { | |
13272 "description": "Floodlight configuration ID of this floodlig
ht activity. If this field is left blank, the value will be copied over either f
rom the activity group's floodlight configuration or from the existing activity'
s floodlight configuration.", | |
13273 "format": "int64", | |
13274 "type": "string" | |
13275 }, | |
13276 "floodlightConfigurationIdDimensionValue": { | |
13277 "$ref": "DimensionValue", | |
13278 "description": "Dimension value for the ID of the floodlight
configuration. This is a read-only, auto-generated field." | |
13279 }, | |
13280 "hidden": { | |
13281 "description": "Whether this activity is archived.", | |
13282 "type": "boolean" | |
13283 }, | |
13284 "id": { | |
13285 "description": "ID of this floodlight activity. This is a re
ad-only, auto-generated field.", | |
13286 "format": "int64", | |
13287 "type": "string" | |
13288 }, | |
13289 "idDimensionValue": { | |
13290 "$ref": "DimensionValue", | |
13291 "description": "Dimension value for the ID of this floodligh
t activity. This is a read-only, auto-generated field." | |
13292 }, | |
13293 "imageTagEnabled": { | |
13294 "description": "Whether the image tag is enabled for this ac
tivity.", | |
13295 "type": "boolean" | |
13296 }, | |
13297 "kind": { | |
13298 "default": "dfareporting#floodlightActivity", | |
13299 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#floodlightActivity\".", | |
13300 "type": "string" | |
13301 }, | |
13302 "name": { | |
13303 "description": "Name of this floodlight activity. This is a
required field. Must be less than 129 characters long and cannot contain quotes.
", | |
13304 "type": "string" | |
13305 }, | |
13306 "notes": { | |
13307 "description": "General notes or implementation instructions
for the tag.", | |
13308 "type": "string" | |
13309 }, | |
13310 "publisherTags": { | |
13311 "description": "Publisher dynamic floodlight tags.", | |
13312 "items": { | |
13313 "$ref": "FloodlightActivityPublisherDynamicTag" | |
13314 }, | |
13315 "type": "array" | |
13316 }, | |
13317 "secure": { | |
13318 "description": "Whether this tag should use SSL.", | |
13319 "type": "boolean" | |
13320 }, | |
13321 "sslCompliant": { | |
13322 "description": "Whether the floodlight activity is SSL-compl
iant. This is a read-only field, its value detected by the system from the flood
light tags.", | |
13323 "type": "boolean" | |
13324 }, | |
13325 "sslRequired": { | |
13326 "description": "Whether this floodlight activity must be SSL
-compliant.", | |
13327 "type": "boolean" | |
13328 }, | |
13329 "subaccountId": { | |
13330 "description": "Subaccount ID of this floodlight activity. T
his is a read-only field that can be left blank.", | |
13331 "format": "int64", | |
13332 "type": "string" | |
13333 }, | |
13334 "tagFormat": { | |
13335 "description": "Tag format type for the floodlight activity.
If left blank, the tag format will default to HTML.", | |
13336 "enum": [ | |
13337 "HTML", | |
13338 "XHTML" | |
13339 ], | |
13340 "enumDescriptions": [ | |
13341 "", | |
13342 "" | |
13343 ], | |
13344 "type": "string" | |
13345 }, | |
13346 "tagString": { | |
13347 "description": "Value of the cat= paramter in the floodlight
tag, which the ad servers use to identify the activity. This is optional: if em
pty, a new tag string will be generated for you. This string must be 1 to 8 char
acters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag strin
g must also be unique among activities of the same activity group. This field is
read-only after insertion.", | |
13348 "type": "string" | |
13349 }, | |
13350 "userDefinedVariableTypes": { | |
13351 "description": "List of the user-defined variables used by t
his conversion tag. These map to the \"u[1-20]=\" in the tags. Each of these can
have a user defined type.\nAcceptable values are:\n- \"U1\"\n- \"U2\"\n- \"U3\"
\n- \"U4\"\n- \"U5\"\n- \"U6\"\n- \"U7\"\n- \"U8\"\n- \"U9\"\n- \"U10\"\n- \"U11
\"\n- \"U12\"\n- \"U13\"\n- \"U14\"\n- \"U15\"\n- \"U16\"\n- \"U17\"\n- \"U18\"\
n- \"U19\"\n- \"U20\"", | |
13352 "items": { | |
13353 "enum": [ | |
13354 "U1", | |
13355 "U10", | |
13356 "U100", | |
13357 "U11", | |
13358 "U12", | |
13359 "U13", | |
13360 "U14", | |
13361 "U15", | |
13362 "U16", | |
13363 "U17", | |
13364 "U18", | |
13365 "U19", | |
13366 "U2", | |
13367 "U20", | |
13368 "U21", | |
13369 "U22", | |
13370 "U23", | |
13371 "U24", | |
13372 "U25", | |
13373 "U26", | |
13374 "U27", | |
13375 "U28", | |
13376 "U29", | |
13377 "U3", | |
13378 "U30", | |
13379 "U31", | |
13380 "U32", | |
13381 "U33", | |
13382 "U34", | |
13383 "U35", | |
13384 "U36", | |
13385 "U37", | |
13386 "U38", | |
13387 "U39", | |
13388 "U4", | |
13389 "U40", | |
13390 "U41", | |
13391 "U42", | |
13392 "U43", | |
13393 "U44", | |
13394 "U45", | |
13395 "U46", | |
13396 "U47", | |
13397 "U48", | |
13398 "U49", | |
13399 "U5", | |
13400 "U50", | |
13401 "U51", | |
13402 "U52", | |
13403 "U53", | |
13404 "U54", | |
13405 "U55", | |
13406 "U56", | |
13407 "U57", | |
13408 "U58", | |
13409 "U59", | |
13410 "U6", | |
13411 "U60", | |
13412 "U61", | |
13413 "U62", | |
13414 "U63", | |
13415 "U64", | |
13416 "U65", | |
13417 "U66", | |
13418 "U67", | |
13419 "U68", | |
13420 "U69", | |
13421 "U7", | |
13422 "U70", | |
13423 "U71", | |
13424 "U72", | |
13425 "U73", | |
13426 "U74", | |
13427 "U75", | |
13428 "U76", | |
13429 "U77", | |
13430 "U78", | |
13431 "U79", | |
13432 "U8", | |
13433 "U80", | |
13434 "U81", | |
13435 "U82", | |
13436 "U83", | |
13437 "U84", | |
13438 "U85", | |
13439 "U86", | |
13440 "U87", | |
13441 "U88", | |
13442 "U89", | |
13443 "U9", | |
13444 "U90", | |
13445 "U91", | |
13446 "U92", | |
13447 "U93", | |
13448 "U94", | |
13449 "U95", | |
13450 "U96", | |
13451 "U97", | |
13452 "U98", | |
13453 "U99" | |
13454 ], | |
13455 "enumDescriptions": [ | |
13456 "", | |
13457 "", | |
13458 "", | |
13459 "", | |
13460 "", | |
13461 "", | |
13462 "", | |
13463 "", | |
13464 "", | |
13465 "", | |
13466 "", | |
13467 "", | |
13468 "", | |
13469 "", | |
13470 "", | |
13471 "", | |
13472 "", | |
13473 "", | |
13474 "", | |
13475 "", | |
13476 "", | |
13477 "", | |
13478 "", | |
13479 "", | |
13480 "", | |
13481 "", | |
13482 "", | |
13483 "", | |
13484 "", | |
13485 "", | |
13486 "", | |
13487 "", | |
13488 "", | |
13489 "", | |
13490 "", | |
13491 "", | |
13492 "", | |
13493 "", | |
13494 "", | |
13495 "", | |
13496 "", | |
13497 "", | |
13498 "", | |
13499 "", | |
13500 "", | |
13501 "", | |
13502 "", | |
13503 "", | |
13504 "", | |
13505 "", | |
13506 "", | |
13507 "", | |
13508 "", | |
13509 "", | |
13510 "", | |
13511 "", | |
13512 "", | |
13513 "", | |
13514 "", | |
13515 "", | |
13516 "", | |
13517 "", | |
13518 "", | |
13519 "", | |
13520 "", | |
13521 "", | |
13522 "", | |
13523 "", | |
13524 "", | |
13525 "", | |
13526 "", | |
13527 "", | |
13528 "", | |
13529 "", | |
13530 "", | |
13531 "", | |
13532 "", | |
13533 "", | |
13534 "", | |
13535 "", | |
13536 "", | |
13537 "", | |
13538 "", | |
13539 "", | |
13540 "", | |
13541 "", | |
13542 "", | |
13543 "", | |
13544 "", | |
13545 "", | |
13546 "", | |
13547 "", | |
13548 "", | |
13549 "", | |
13550 "", | |
13551 "", | |
13552 "", | |
13553 "", | |
13554 "", | |
13555 "" | |
13556 ], | |
13557 "type": "string" | |
13558 }, | |
13559 "type": "array" | |
13560 } | |
13561 }, | |
13562 "type": "object" | |
13563 }, | |
13564 "FloodlightActivityDynamicTag": { | |
13565 "description": "Dynamic Tag", | |
13566 "id": "FloodlightActivityDynamicTag", | |
13567 "properties": { | |
13568 "id": { | |
13569 "description": "ID of this dynamic tag. This is a read-only,
auto-generated field.", | |
13570 "format": "int64", | |
13571 "type": "string" | |
13572 }, | |
13573 "name": { | |
13574 "description": "Name of this tag.", | |
13575 "type": "string" | |
13576 }, | |
13577 "tag": { | |
13578 "description": "Tag code.", | |
13579 "type": "string" | |
13580 } | |
13581 }, | |
13582 "type": "object" | |
13583 }, | |
13584 "FloodlightActivityGroup": { | |
13585 "description": "Contains properties of a Floodlight activity group."
, | |
13586 "id": "FloodlightActivityGroup", | |
13587 "properties": { | |
13588 "accountId": { | |
13589 "description": "Account ID of this floodlight activity group
. This is a read-only field that can be left blank.", | |
13590 "format": "int64", | |
13591 "type": "string" | |
13592 }, | |
13593 "advertiserId": { | |
13594 "description": "Advertiser ID of this floodlight activity gr
oup. If this field is left blank, the value will be copied over either from the
floodlight configuration's advertiser or from the existing activity group's adve
rtiser.", | |
13595 "format": "int64", | |
13596 "type": "string" | |
13597 }, | |
13598 "advertiserIdDimensionValue": { | |
13599 "$ref": "DimensionValue", | |
13600 "description": "Dimension value for the ID of the advertiser
. This is a read-only, auto-generated field." | |
13601 }, | |
13602 "floodlightConfigurationId": { | |
13603 "description": "Floodlight configuration ID of this floodlig
ht activity group. This is a required field.", | |
13604 "format": "int64", | |
13605 "type": "string" | |
13606 }, | |
13607 "floodlightConfigurationIdDimensionValue": { | |
13608 "$ref": "DimensionValue", | |
13609 "description": "Dimension value for the ID of the floodlight
configuration. This is a read-only, auto-generated field." | |
13610 }, | |
13611 "id": { | |
13612 "description": "ID of this floodlight activity group. This i
s a read-only, auto-generated field.", | |
13613 "format": "int64", | |
13614 "type": "string" | |
13615 }, | |
13616 "idDimensionValue": { | |
13617 "$ref": "DimensionValue", | |
13618 "description": "Dimension value for the ID of this floodligh
t activity group. This is a read-only, auto-generated field." | |
13619 }, | |
13620 "kind": { | |
13621 "default": "dfareporting#floodlightActivityGroup", | |
13622 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#floodlightActivityGroup\".", | |
13623 "type": "string" | |
13624 }, | |
13625 "name": { | |
13626 "description": "Name of this floodlight activity group. This
is a required field. Must be less than 65 characters long and cannot contain qu
otes.", | |
13627 "type": "string" | |
13628 }, | |
13629 "subaccountId": { | |
13630 "description": "Subaccount ID of this floodlight activity gr
oup. This is a read-only field that can be left blank.", | |
13631 "format": "int64", | |
13632 "type": "string" | |
13633 }, | |
13634 "tagString": { | |
13635 "description": "Value of the type= parameter in the floodlig
ht tag, which the ad servers use to identify the activity group that the activit
y belongs to. This is optional: if empty, a new tag string will be generated for
you. This string must be 1 to 8 characters long, with valid characters being [a
-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups
of the same floodlight configuration. This field is read-only after insertion."
, | |
13636 "type": "string" | |
13637 }, | |
13638 "type": { | |
13639 "description": "Type of the floodlight activity group. This
is a required field that is read-only after insertion.", | |
13640 "enum": [ | |
13641 "COUNTER", | |
13642 "SALE" | |
13643 ], | |
13644 "enumDescriptions": [ | |
13645 "", | |
13646 "" | |
13647 ], | |
13648 "type": "string" | |
13649 } | |
13650 }, | |
13651 "type": "object" | |
13652 }, | |
13653 "FloodlightActivityGroupsListResponse": { | |
13654 "description": "Floodlight Activity Group List Response", | |
13655 "id": "FloodlightActivityGroupsListResponse", | |
13656 "properties": { | |
13657 "floodlightActivityGroups": { | |
13658 "description": "Floodlight activity group collection.", | |
13659 "items": { | |
13660 "$ref": "FloodlightActivityGroup" | |
13661 }, | |
13662 "type": "array" | |
13663 }, | |
13664 "kind": { | |
13665 "default": "dfareporting#floodlightActivityGroupsListRespons
e", | |
13666 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#floodlightActivityGroupsListResponse\".", | |
13667 "type": "string" | |
13668 }, | |
13669 "nextPageToken": { | |
13670 "description": "Pagination token to be used for the next lis
t operation.", | |
13671 "type": "string" | |
13672 } | |
13673 }, | |
13674 "type": "object" | |
13675 }, | |
13676 "FloodlightActivityPublisherDynamicTag": { | |
13677 "description": "Publisher Dynamic Tag", | |
13678 "id": "FloodlightActivityPublisherDynamicTag", | |
13679 "properties": { | |
13680 "clickThrough": { | |
13681 "description": "Whether this tag is applicable only for clic
k-throughs.", | |
13682 "type": "boolean" | |
13683 }, | |
13684 "directorySiteId": { | |
13685 "description": "Directory site ID of this dynamic tag. This
is a write-only field that can be used as an alternative to the siteId field. Wh
en this resource is retrieved, only the siteId field will be populated.", | |
13686 "format": "int64", | |
13687 "type": "string" | |
13688 }, | |
13689 "dynamicTag": { | |
13690 "$ref": "FloodlightActivityDynamicTag", | |
13691 "description": "Dynamic floodlight tag." | |
13692 }, | |
13693 "siteId": { | |
13694 "description": "Site ID of this dynamic tag.", | |
13695 "format": "int64", | |
13696 "type": "string" | |
13697 }, | |
13698 "siteIdDimensionValue": { | |
13699 "$ref": "DimensionValue", | |
13700 "description": "Dimension value for the ID of the site. This
is a read-only, auto-generated field." | |
13701 }, | |
13702 "viewThrough": { | |
13703 "description": "Whether this tag is applicable only for view
-throughs.", | |
13704 "type": "boolean" | |
13705 } | |
13706 }, | |
13707 "type": "object" | |
13708 }, | |
13709 "FloodlightConfiguration": { | |
13710 "description": "Contains properties of a Floodlight configuration.", | |
13711 "id": "FloodlightConfiguration", | |
13712 "properties": { | |
13713 "accountId": { | |
13714 "description": "Account ID of this floodlight configuration.
This is a read-only field that can be left blank.", | |
13715 "format": "int64", | |
13716 "type": "string" | |
13717 }, | |
13718 "advertiserId": { | |
13719 "description": "Advertiser ID of the parent advertiser of th
is floodlight configuration.", | |
13720 "format": "int64", | |
13721 "type": "string" | |
13722 }, | |
13723 "advertiserIdDimensionValue": { | |
13724 "$ref": "DimensionValue", | |
13725 "description": "Dimension value for the ID of the advertiser
. This is a read-only, auto-generated field." | |
13726 }, | |
13727 "analyticsDataSharingEnabled": { | |
13728 "description": "Whether advertiser data is shared with Googl
e Analytics.", | |
13729 "type": "boolean" | |
13730 }, | |
13731 "exposureToConversionEnabled": { | |
13732 "description": "Whether the exposure-to-conversion report is
enabled. This report shows detailed pathway information on up to 10 of the most
recent ad exposures seen by a user before converting.", | |
13733 "type": "boolean" | |
13734 }, | |
13735 "firstDayOfWeek": { | |
13736 "description": "Day that will be counted as the first day of
the week in reports. This is a required field.", | |
13737 "enum": [ | |
13738 "MONDAY", | |
13739 "SUNDAY" | |
13740 ], | |
13741 "enumDescriptions": [ | |
13742 "", | |
13743 "" | |
13744 ], | |
13745 "type": "string" | |
13746 }, | |
13747 "id": { | |
13748 "description": "ID of this floodlight configuration. This is
a read-only, auto-generated field.", | |
13749 "format": "int64", | |
13750 "type": "string" | |
13751 }, | |
13752 "idDimensionValue": { | |
13753 "$ref": "DimensionValue", | |
13754 "description": "Dimension value for the ID of this floodligh
t configuration. This is a read-only, auto-generated field." | |
13755 }, | |
13756 "inAppAttributionTrackingEnabled": { | |
13757 "description": "Whether in-app attribution tracking is enabl
ed.", | |
13758 "type": "boolean" | |
13759 }, | |
13760 "kind": { | |
13761 "default": "dfareporting#floodlightConfiguration", | |
13762 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#floodlightConfiguration\".", | |
13763 "type": "string" | |
13764 }, | |
13765 "lookbackConfiguration": { | |
13766 "$ref": "LookbackConfiguration", | |
13767 "description": "Lookback window settings for this floodlight
configuration." | |
13768 }, | |
13769 "naturalSearchConversionAttributionOption": { | |
13770 "description": "Types of attribution options for natural sea
rch conversions.", | |
13771 "enum": [ | |
13772 "EXCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION", | |
13773 "INCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION", | |
13774 "INCLUDE_NATURAL_SEARCH_TIERED_CONVERSION_ATTRIBUTION" | |
13775 ], | |
13776 "enumDescriptions": [ | |
13777 "", | |
13778 "", | |
13779 "" | |
13780 ], | |
13781 "type": "string" | |
13782 }, | |
13783 "omnitureSettings": { | |
13784 "$ref": "OmnitureSettings", | |
13785 "description": "Settings for DCM Omniture integration." | |
13786 }, | |
13787 "sslRequired": { | |
13788 "description": "Whether floodlight activities owned by this
configuration are required to be SSL-compliant.", | |
13789 "type": "boolean" | |
13790 }, | |
13791 "standardVariableTypes": { | |
13792 "description": "List of standard variables enabled for this
configuration.\n\nAcceptable values are:\n- \"ORD\"\n- \"NUM\"", | |
13793 "items": { | |
13794 "enum": [ | |
13795 "NUM", | |
13796 "ORD", | |
13797 "TRAN", | |
13798 "U" | |
13799 ], | |
13800 "enumDescriptions": [ | |
13801 "", | |
13802 "", | |
13803 "", | |
13804 "" | |
13805 ], | |
13806 "type": "string" | |
13807 }, | |
13808 "type": "array" | |
13809 }, | |
13810 "subaccountId": { | |
13811 "description": "Subaccount ID of this floodlight configurati
on. This is a read-only field that can be left blank.", | |
13812 "format": "int64", | |
13813 "type": "string" | |
13814 }, | |
13815 "tagSettings": { | |
13816 "$ref": "TagSettings", | |
13817 "description": "Configuration settings for dynamic and image
floodlight tags." | |
13818 }, | |
13819 "thirdPartyAuthenticationTokens": { | |
13820 "description": "List of third-party authentication tokens en
abled for this configuration.", | |
13821 "items": { | |
13822 "$ref": "ThirdPartyAuthenticationToken" | |
13823 }, | |
13824 "type": "array" | |
13825 }, | |
13826 "userDefinedVariableConfigurations": { | |
13827 "description": "List of user defined variables enabled for t
his configuration.", | |
13828 "items": { | |
13829 "$ref": "UserDefinedVariableConfiguration" | |
13830 }, | |
13831 "type": "array" | |
13832 } | |
13833 }, | |
13834 "type": "object" | |
13835 }, | |
13836 "FloodlightConfigurationsListResponse": { | |
13837 "description": "Floodlight Configuration List Response", | |
13838 "id": "FloodlightConfigurationsListResponse", | |
13839 "properties": { | |
13840 "floodlightConfigurations": { | |
13841 "description": "Floodlight configuration collection.", | |
13842 "items": { | |
13843 "$ref": "FloodlightConfiguration" | |
13844 }, | |
13845 "type": "array" | |
13846 }, | |
13847 "kind": { | |
13848 "default": "dfareporting#floodlightConfigurationsListRespons
e", | |
13849 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#floodlightConfigurationsListResponse\".", | |
13850 "type": "string" | |
13851 } | |
13852 }, | |
13853 "type": "object" | |
13854 }, | |
13855 "FloodlightReportCompatibleFields": { | |
13856 "description": "Represents fields that are compatible to be selected
for a report of type \"FlOODLIGHT\".", | |
13857 "id": "FloodlightReportCompatibleFields", | |
13858 "properties": { | |
13859 "dimensionFilters": { | |
13860 "description": "Dimensions which are compatible to be select
ed in the \"dimensionFilters\" section of the report.", | |
13861 "items": { | |
13862 "$ref": "Dimension" | |
13863 }, | |
13864 "type": "array" | |
13865 }, | |
13866 "dimensions": { | |
13867 "description": "Dimensions which are compatible to be select
ed in the \"dimensions\" section of the report.", | |
13868 "items": { | |
13869 "$ref": "Dimension" | |
13870 }, | |
13871 "type": "array" | |
13872 }, | |
13873 "kind": { | |
13874 "default": "dfareporting#floodlightReportCompatibleFields", | |
13875 "description": "The kind of resource this is, in this case d
fareporting#floodlightReportCompatibleFields.", | |
13876 "type": "string" | |
13877 }, | |
13878 "metrics": { | |
13879 "description": "Metrics which are compatible to be selected
in the \"metricNames\" section of the report.", | |
13880 "items": { | |
13881 "$ref": "Metric" | |
13882 }, | |
13883 "type": "array" | |
13884 } | |
13885 }, | |
13886 "type": "object" | |
13887 }, | |
13888 "FrequencyCap": { | |
13889 "description": "Frequency Cap.", | |
13890 "id": "FrequencyCap", | |
13891 "properties": { | |
13892 "duration": { | |
13893 "description": "Duration of time, in seconds, for this frequ
ency cap. The maximum duration is 90 days in seconds, or 7,776,000.", | |
13894 "format": "int64", | |
13895 "type": "string" | |
13896 }, | |
13897 "impressions": { | |
13898 "description": "Number of times an individual user can be se
rved the ad within the specified duration. The maximum allowed is 15.", | |
13899 "format": "int64", | |
13900 "type": "string" | |
13901 } | |
13902 }, | |
13903 "type": "object" | |
13904 }, | |
13905 "FsCommand": { | |
13906 "description": "FsCommand.", | |
13907 "id": "FsCommand", | |
13908 "properties": { | |
13909 "left": { | |
13910 "description": "Distance from the left of the browser.Applic
able when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.", | |
13911 "format": "int32", | |
13912 "type": "integer" | |
13913 }, | |
13914 "positionOption": { | |
13915 "description": "Position in the browser where the window wil
l open.", | |
13916 "enum": [ | |
13917 "CENTERED", | |
13918 "DISTANCE_FROM_TOP_LEFT_CORNER" | |
13919 ], | |
13920 "enumDescriptions": [ | |
13921 "", | |
13922 "" | |
13923 ], | |
13924 "type": "string" | |
13925 }, | |
13926 "top": { | |
13927 "description": "Distance from the top of the browser. Applic
able when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.", | |
13928 "format": "int32", | |
13929 "type": "integer" | |
13930 }, | |
13931 "windowHeight": { | |
13932 "description": "Height of the window.", | |
13933 "format": "int32", | |
13934 "type": "integer" | |
13935 }, | |
13936 "windowWidth": { | |
13937 "description": "Width of the window.", | |
13938 "format": "int32", | |
13939 "type": "integer" | |
13940 } | |
13941 }, | |
13942 "type": "object" | |
13943 }, | |
13944 "GeoTargeting": { | |
13945 "description": "Geographical Targeting.", | |
13946 "id": "GeoTargeting", | |
13947 "properties": { | |
13948 "cities": { | |
13949 "description": "Cities to be targeted. For each city only da
rtId is required. The other fields are populated automatically when the ad is in
serted or updated. If targeting a city, do not target or exclude the country of
the city, and do not target the metro or region of the city.", | |
13950 "items": { | |
13951 "$ref": "City" | |
13952 }, | |
13953 "type": "array" | |
13954 }, | |
13955 "countries": { | |
13956 "description": "Countries to be targeted or excluded from ta
rgeting, depending on the setting of the excludeCountries field. For each countr
y only dartId is required. The other fields are populated automatically when the
ad is inserted or updated. If targeting or excluding a country, do not target r
egions, cities, metros, or postal codes in the same country.", | |
13957 "items": { | |
13958 "$ref": "Country" | |
13959 }, | |
13960 "type": "array" | |
13961 }, | |
13962 "excludeCountries": { | |
13963 "description": "Whether or not to exclude the countries in t
he countries field from targeting. If false, the countries field refers to count
ries which will be targeted by the ad.", | |
13964 "type": "boolean" | |
13965 }, | |
13966 "metros": { | |
13967 "description": "Metros to be targeted. For each metro only d
maId is required. The other fields are populated automatically when the ad is in
serted or updated. If targeting a metro, do not target or exclude the country of
the metro.", | |
13968 "items": { | |
13969 "$ref": "Metro" | |
13970 }, | |
13971 "type": "array" | |
13972 }, | |
13973 "postalCodes": { | |
13974 "description": "Postal codes to be targeted. For each postal
code only id is required. The other fields are populated automatically when the
ad is inserted or updated. If targeting a postal code, do not target or exclude
the country of the postal code.", | |
13975 "items": { | |
13976 "$ref": "PostalCode" | |
13977 }, | |
13978 "type": "array" | |
13979 }, | |
13980 "regions": { | |
13981 "description": "Regions to be targeted. For each region only
dartId is required. The other fields are populated automatically when the ad is
inserted or updated. If targeting a region, do not target or exclude the countr
y of the region.", | |
13982 "items": { | |
13983 "$ref": "Region" | |
13984 }, | |
13985 "type": "array" | |
13986 } | |
13987 }, | |
13988 "type": "object" | |
13989 }, | |
13990 "InventoryItem": { | |
13991 "description": "Represents a buy from the DoubleClick Planning inven
tory store.", | |
13992 "id": "InventoryItem", | |
13993 "properties": { | |
13994 "accountId": { | |
13995 "description": "Account ID of this inventory item.", | |
13996 "format": "int64", | |
13997 "type": "string" | |
13998 }, | |
13999 "adSlots": { | |
14000 "description": "Ad slots of this inventory item. If this inv
entory item represents a standalone placement, there will be exactly one ad slot
. If this inventory item represents a placement group, there will be more than o
ne ad slot, each representing one child placement in that placement group.", | |
14001 "items": { | |
14002 "$ref": "AdSlot" | |
14003 }, | |
14004 "type": "array" | |
14005 }, | |
14006 "advertiserId": { | |
14007 "description": "Advertiser ID of this inventory item.", | |
14008 "format": "int64", | |
14009 "type": "string" | |
14010 }, | |
14011 "contentCategoryId": { | |
14012 "description": "Content category ID of this inventory item."
, | |
14013 "format": "int64", | |
14014 "type": "string" | |
14015 }, | |
14016 "estimatedClickThroughRate": { | |
14017 "description": "Estimated click-through rate of this invento
ry item.", | |
14018 "format": "int64", | |
14019 "type": "string" | |
14020 }, | |
14021 "estimatedConversionRate": { | |
14022 "description": "Estimated conversion rate of this inventory
item.", | |
14023 "format": "int64", | |
14024 "type": "string" | |
14025 }, | |
14026 "id": { | |
14027 "description": "ID of this inventory item.", | |
14028 "format": "int64", | |
14029 "type": "string" | |
14030 }, | |
14031 "inPlan": { | |
14032 "description": "Whether this inventory item is in plan.", | |
14033 "type": "boolean" | |
14034 }, | |
14035 "kind": { | |
14036 "default": "dfareporting#inventoryItem", | |
14037 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#inventoryItem\".", | |
14038 "type": "string" | |
14039 }, | |
14040 "lastModifiedInfo": { | |
14041 "$ref": "LastModifiedInfo", | |
14042 "description": "Information about the most recent modificati
on of this inventory item." | |
14043 }, | |
14044 "name": { | |
14045 "description": "Name of this inventory item. For standalone
inventory items, this is the same name as that of its only ad slot. For group in
ventory items, this can differ from the name of any of its ad slots.", | |
14046 "type": "string" | |
14047 }, | |
14048 "negotiationChannelId": { | |
14049 "description": "Negotiation channel ID of this inventory ite
m.", | |
14050 "format": "int64", | |
14051 "type": "string" | |
14052 }, | |
14053 "orderId": { | |
14054 "description": "Order ID of this inventory item.", | |
14055 "format": "int64", | |
14056 "type": "string" | |
14057 }, | |
14058 "placementStrategyId": { | |
14059 "description": "Placement strategy ID of this inventory item
.", | |
14060 "format": "int64", | |
14061 "type": "string" | |
14062 }, | |
14063 "pricing": { | |
14064 "$ref": "Pricing", | |
14065 "description": "Pricing of this inventory item." | |
14066 }, | |
14067 "projectId": { | |
14068 "description": "Project ID of this inventory item.", | |
14069 "format": "int64", | |
14070 "type": "string" | |
14071 }, | |
14072 "rfpId": { | |
14073 "description": "RFP ID of this inventory item.", | |
14074 "format": "int64", | |
14075 "type": "string" | |
14076 }, | |
14077 "siteId": { | |
14078 "description": "ID of the site this inventory item is associ
ated with.", | |
14079 "format": "int64", | |
14080 "type": "string" | |
14081 }, | |
14082 "subaccountId": { | |
14083 "description": "Subaccount ID of this inventory item.", | |
14084 "format": "int64", | |
14085 "type": "string" | |
14086 } | |
14087 }, | |
14088 "type": "object" | |
14089 }, | |
14090 "InventoryItemsListResponse": { | |
14091 "description": "Inventory item List Response", | |
14092 "id": "InventoryItemsListResponse", | |
14093 "properties": { | |
14094 "inventoryItems": { | |
14095 "description": "Inventory item collection", | |
14096 "items": { | |
14097 "$ref": "InventoryItem" | |
14098 }, | |
14099 "type": "array" | |
14100 }, | |
14101 "kind": { | |
14102 "default": "dfareporting#inventoryItemsListResponse", | |
14103 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#inventoryItemsListResponse\".", | |
14104 "type": "string" | |
14105 }, | |
14106 "nextPageToken": { | |
14107 "description": "Pagination token to be used for the next lis
t operation.", | |
14108 "type": "string" | |
14109 } | |
14110 }, | |
14111 "type": "object" | |
14112 }, | |
14113 "KeyValueTargetingExpression": { | |
14114 "description": "Key Value Targeting Expression.", | |
14115 "id": "KeyValueTargetingExpression", | |
14116 "properties": { | |
14117 "expression": { | |
14118 "description": "Keyword expression being targeted by the ad.
", | |
14119 "type": "string" | |
14120 } | |
14121 }, | |
14122 "type": "object" | |
14123 }, | |
14124 "LandingPage": { | |
14125 "description": "Contains information about where a user's browser is
taken after the user clicks an ad.", | |
14126 "id": "LandingPage", | |
14127 "properties": { | |
14128 "default": { | |
14129 "description": "Whether or not this landing page will be ass
igned to any ads or creatives that do not have a landing page assigned explicitl
y. Only one default landing page is allowed per campaign.", | |
14130 "type": "boolean" | |
14131 }, | |
14132 "id": { | |
14133 "description": "ID of this landing page. This is a read-only
, auto-generated field.", | |
14134 "format": "int64", | |
14135 "type": "string" | |
14136 }, | |
14137 "kind": { | |
14138 "default": "dfareporting#landingPage", | |
14139 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#landingPage\".", | |
14140 "type": "string" | |
14141 }, | |
14142 "name": { | |
14143 "description": "Name of this landing page. This is a require
d field. It must be less than 256 characters long, and must be unique among land
ing pages of the same campaign.", | |
14144 "type": "string" | |
14145 }, | |
14146 "url": { | |
14147 "description": "URL of this landing page. This is a required
field.", | |
14148 "type": "string" | |
14149 } | |
14150 }, | |
14151 "type": "object" | |
14152 }, | |
14153 "LandingPagesListResponse": { | |
14154 "description": "Landing Page List Response", | |
14155 "id": "LandingPagesListResponse", | |
14156 "properties": { | |
14157 "kind": { | |
14158 "default": "dfareporting#landingPagesListResponse", | |
14159 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#landingPagesListResponse\".", | |
14160 "type": "string" | |
14161 }, | |
14162 "landingPages": { | |
14163 "description": "Landing page collection", | |
14164 "items": { | |
14165 "$ref": "LandingPage" | |
14166 }, | |
14167 "type": "array" | |
14168 } | |
14169 }, | |
14170 "type": "object" | |
14171 }, | |
14172 "LastModifiedInfo": { | |
14173 "description": "Modification timestamp.", | |
14174 "id": "LastModifiedInfo", | |
14175 "properties": { | |
14176 "time": { | |
14177 "description": "Timestamp of the last change in milliseconds
since epoch.", | |
14178 "format": "int64", | |
14179 "type": "string" | |
14180 } | |
14181 }, | |
14182 "type": "object" | |
14183 }, | |
14184 "ListPopulationClause": { | |
14185 "description": "A group clause made up of list population terms repr
esenting constraints joined by ORs.", | |
14186 "id": "ListPopulationClause", | |
14187 "properties": { | |
14188 "terms": { | |
14189 "description": "Terms of this list population clause. Each c
lause is made up of list population terms representing constraints and are joine
d by ORs.", | |
14190 "items": { | |
14191 "$ref": "ListPopulationTerm" | |
14192 }, | |
14193 "type": "array" | |
14194 } | |
14195 }, | |
14196 "type": "object" | |
14197 }, | |
14198 "ListPopulationRule": { | |
14199 "description": "Remarketing List Population Rule.", | |
14200 "id": "ListPopulationRule", | |
14201 "properties": { | |
14202 "floodlightActivityId": { | |
14203 "description": "Floodlight activity ID associated with this
rule. This field can be left blank.", | |
14204 "format": "int64", | |
14205 "type": "string" | |
14206 }, | |
14207 "floodlightActivityName": { | |
14208 "description": "Name of floodlight activity associated with
this rule. This is a read-only, auto-generated field.", | |
14209 "type": "string" | |
14210 }, | |
14211 "listPopulationClauses": { | |
14212 "description": "Clauses that make up this list population ru
le. Clauses are joined by ANDs, and the clauses themselves are made up of list p
opulation terms which are joined by ORs.", | |
14213 "items": { | |
14214 "$ref": "ListPopulationClause" | |
14215 }, | |
14216 "type": "array" | |
14217 } | |
14218 }, | |
14219 "type": "object" | |
14220 }, | |
14221 "ListPopulationTerm": { | |
14222 "description": "Remarketing List Population Rule Term.", | |
14223 "id": "ListPopulationTerm", | |
14224 "properties": { | |
14225 "contains": { | |
14226 "description": "Will be true if the term should check if the
user is in the list and false if the term should check if the user is not in th
e list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. Fa
lse by default.", | |
14227 "type": "boolean" | |
14228 }, | |
14229 "negation": { | |
14230 "description": "Whether to negate the comparison result of t
his term during rule evaluation. This field is only relevant when type is left u
nset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.", | |
14231 "type": "boolean" | |
14232 }, | |
14233 "operator": { | |
14234 "description": "Comparison operator of this term. This field
is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFE
RRER_TERM.", | |
14235 "enum": [ | |
14236 "NUM_EQUALS", | |
14237 "NUM_GREATER_THAN", | |
14238 "NUM_GREATER_THAN_EQUAL", | |
14239 "NUM_LESS_THAN", | |
14240 "NUM_LESS_THAN_EQUAL", | |
14241 "STRING_CONTAINS", | |
14242 "STRING_EQUALS" | |
14243 ], | |
14244 "enumDescriptions": [ | |
14245 "", | |
14246 "", | |
14247 "", | |
14248 "", | |
14249 "", | |
14250 "", | |
14251 "" | |
14252 ], | |
14253 "type": "string" | |
14254 }, | |
14255 "remarketingListId": { | |
14256 "description": "ID of the list in question. This field is on
ly relevant when type is set to LIST_MEMBERSHIP_TERM.", | |
14257 "format": "int64", | |
14258 "type": "string" | |
14259 }, | |
14260 "type": { | |
14261 "description": "List population term type determines the app
licable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, the
n variableName, variableFriendlyName, operator, value, and negation are applicab
le. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are appli
cable. If set to REFERRER_TERM then operator, value, and negation are applicable
.", | |
14262 "enum": [ | |
14263 "CUSTOM_VARIABLE_TERM", | |
14264 "LIST_MEMBERSHIP_TERM", | |
14265 "REFERRER_TERM" | |
14266 ], | |
14267 "enumDescriptions": [ | |
14268 "", | |
14269 "", | |
14270 "" | |
14271 ], | |
14272 "type": "string" | |
14273 }, | |
14274 "value": { | |
14275 "description": "Literal to compare the variable to. This fie
ld is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or RE
FERRER_TERM.", | |
14276 "type": "string" | |
14277 }, | |
14278 "variableFriendlyName": { | |
14279 "description": "Friendly name of this term's variable. This
is a read-only, auto-generated field. This field is only relevant when type is l
eft unset or set to CUSTOM_VARIABLE_TERM.", | |
14280 "type": "string" | |
14281 }, | |
14282 "variableName": { | |
14283 "description": "Name of the variable (U1, U2, etc.) being co
mpared in this term. This field is only relevant when type is set to null, CUSTO
M_VARIABLE_TERM or REFERRER_TERM.", | |
14284 "type": "string" | |
14285 } | |
14286 }, | |
14287 "type": "object" | |
14288 }, | |
14289 "ListTargetingExpression": { | |
14290 "description": "Remarketing List Targeting Expression.", | |
14291 "id": "ListTargetingExpression", | |
14292 "properties": { | |
14293 "expression": { | |
14294 "description": "Expression describing which lists are being
targeted by the ad.", | |
14295 "type": "string" | |
14296 } | |
14297 }, | |
14298 "type": "object" | |
14299 }, | |
14300 "LookbackConfiguration": { | |
14301 "description": "Lookback configuration settings.", | |
14302 "id": "LookbackConfiguration", | |
14303 "properties": { | |
14304 "clickDuration": { | |
14305 "description": "Lookback window, in days, from the last time
a given user clicked on one of your ads. If you enter 0, clicks will not be con
sidered as triggering events for floodlight tracking. If you leave this field bl
ank, the default value for your account will be used.", | |
14306 "format": "int32", | |
14307 "type": "integer" | |
14308 }, | |
14309 "postImpressionActivitiesDuration": { | |
14310 "description": "Lookback window, in days, from the last time
a given user viewed one of your ads. If you enter 0, impressions will not be co
nsidered as triggering events for floodlight tracking. If you leave this field b
lank, the default value for your account will be used.", | |
14311 "format": "int32", | |
14312 "type": "integer" | |
14313 } | |
14314 }, | |
14315 "type": "object" | |
14316 }, | |
14317 "Metric": { | |
14318 "description": "Represents a metric.", | |
14319 "id": "Metric", | |
14320 "properties": { | |
14321 "kind": { | |
14322 "default": "dfareporting#metric", | |
14323 "description": "The kind of resource this is, in this case d
fareporting#metric.", | |
14324 "type": "string" | |
14325 }, | |
14326 "name": { | |
14327 "description": "The metric name, e.g. dfa:impressions", | |
14328 "type": "string" | |
14329 } | |
14330 }, | |
14331 "type": "object" | |
14332 }, | |
14333 "Metro": { | |
14334 "description": "Contains information about a metro region that can b
e targeted by ads.", | |
14335 "id": "Metro", | |
14336 "properties": { | |
14337 "countryCode": { | |
14338 "description": "Country code of the country to which this me
tro region belongs.", | |
14339 "type": "string" | |
14340 }, | |
14341 "countryDartId": { | |
14342 "description": "DART ID of the country to which this metro r
egion belongs.", | |
14343 "format": "int64", | |
14344 "type": "string" | |
14345 }, | |
14346 "dartId": { | |
14347 "description": "DART ID of this metro region.", | |
14348 "format": "int64", | |
14349 "type": "string" | |
14350 }, | |
14351 "dmaId": { | |
14352 "description": "DMA ID of this metro region. This is the ID
used for targeting and generating reports, and is equivalent to metro_code.", | |
14353 "format": "int64", | |
14354 "type": "string" | |
14355 }, | |
14356 "kind": { | |
14357 "default": "dfareporting#metro", | |
14358 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#metro\".", | |
14359 "type": "string" | |
14360 }, | |
14361 "metroCode": { | |
14362 "description": "Metro code of this metro region. This is equ
ivalent to dma_id.", | |
14363 "type": "string" | |
14364 }, | |
14365 "name": { | |
14366 "description": "Name of this metro region.", | |
14367 "type": "string" | |
14368 } | |
14369 }, | |
14370 "type": "object" | |
14371 }, | |
14372 "MetrosListResponse": { | |
14373 "description": "Metro List Response", | |
14374 "id": "MetrosListResponse", | |
14375 "properties": { | |
14376 "kind": { | |
14377 "default": "dfareporting#metrosListResponse", | |
14378 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#metrosListResponse\".", | |
14379 "type": "string" | |
14380 }, | |
14381 "metros": { | |
14382 "description": "Metro collection.", | |
14383 "items": { | |
14384 "$ref": "Metro" | |
14385 }, | |
14386 "type": "array" | |
14387 } | |
14388 }, | |
14389 "type": "object" | |
14390 }, | |
14391 "MobileCarrier": { | |
14392 "description": "Contains information about a mobile carrier that can
be targeted by ads.", | |
14393 "id": "MobileCarrier", | |
14394 "properties": { | |
14395 "countryCode": { | |
14396 "description": "Country code of the country to which this mo
bile carrier belongs.", | |
14397 "type": "string" | |
14398 }, | |
14399 "countryDartId": { | |
14400 "description": "DART ID of the country to which this mobile
carrier belongs.", | |
14401 "format": "int64", | |
14402 "type": "string" | |
14403 }, | |
14404 "id": { | |
14405 "description": "ID of this mobile carrier.", | |
14406 "format": "int64", | |
14407 "type": "string" | |
14408 }, | |
14409 "kind": { | |
14410 "default": "dfareporting#mobileCarrier", | |
14411 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#mobileCarrier\".", | |
14412 "type": "string" | |
14413 }, | |
14414 "name": { | |
14415 "description": "Name of this mobile carrier.", | |
14416 "type": "string" | |
14417 } | |
14418 }, | |
14419 "type": "object" | |
14420 }, | |
14421 "MobileCarriersListResponse": { | |
14422 "description": "Mobile Carrier List Response", | |
14423 "id": "MobileCarriersListResponse", | |
14424 "properties": { | |
14425 "kind": { | |
14426 "default": "dfareporting#mobileCarriersListResponse", | |
14427 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#mobileCarriersListResponse\".", | |
14428 "type": "string" | |
14429 }, | |
14430 "mobileCarriers": { | |
14431 "description": "Mobile carrier collection.", | |
14432 "items": { | |
14433 "$ref": "MobileCarrier" | |
14434 }, | |
14435 "type": "array" | |
14436 } | |
14437 }, | |
14438 "type": "object" | |
14439 }, | |
14440 "ObjectFilter": { | |
14441 "description": "Object Filter.", | |
14442 "id": "ObjectFilter", | |
14443 "properties": { | |
14444 "kind": { | |
14445 "default": "dfareporting#objectFilter", | |
14446 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#objectFilter\".", | |
14447 "type": "string" | |
14448 }, | |
14449 "objectIds": { | |
14450 "description": "Applicable when status is ASSIGNED. The user
has access to objects with these object IDs.", | |
14451 "items": { | |
14452 "format": "int64", | |
14453 "type": "string" | |
14454 }, | |
14455 "type": "array" | |
14456 }, | |
14457 "status": { | |
14458 "description": "Status of the filter. NONE means the user ha
s access to none of the objects. ALL means the user has access to all objects. A
SSIGNED means the user has access to the objects with IDs in the objectIds list.
", | |
14459 "enum": [ | |
14460 "ALL", | |
14461 "ASSIGNED", | |
14462 "NONE" | |
14463 ], | |
14464 "enumDescriptions": [ | |
14465 "", | |
14466 "", | |
14467 "" | |
14468 ], | |
14469 "type": "string" | |
14470 } | |
14471 }, | |
14472 "type": "object" | |
14473 }, | |
14474 "OffsetPosition": { | |
14475 "description": "Offset Position.", | |
14476 "id": "OffsetPosition", | |
14477 "properties": { | |
14478 "left": { | |
14479 "description": "Offset distance from left side of an asset o
r a window.", | |
14480 "format": "int32", | |
14481 "type": "integer" | |
14482 }, | |
14483 "top": { | |
14484 "description": "Offset distance from top side of an asset or
a window.", | |
14485 "format": "int32", | |
14486 "type": "integer" | |
14487 } | |
14488 }, | |
14489 "type": "object" | |
14490 }, | |
14491 "OmnitureSettings": { | |
14492 "description": "Omniture Integration Settings.", | |
14493 "id": "OmnitureSettings", | |
14494 "properties": { | |
14495 "omnitureCostDataEnabled": { | |
14496 "description": "Whether placement cost data will be sent to
Omniture. This property can be enabled only if omnitureIntegrationEnabled is tru
e.", | |
14497 "type": "boolean" | |
14498 }, | |
14499 "omnitureIntegrationEnabled": { | |
14500 "description": "Whether Omniture integration is enabled. Thi
s property can be enabled only when the \"Advanced Ad Serving\" account setting
is enabled.", | |
14501 "type": "boolean" | |
14502 } | |
14503 }, | |
14504 "type": "object" | |
14505 }, | |
14506 "OperatingSystem": { | |
14507 "description": "Contains information about an operating system that
can be targeted by ads.", | |
14508 "id": "OperatingSystem", | |
14509 "properties": { | |
14510 "dartId": { | |
14511 "description": "DART ID of this operating system. This is th
e ID used for targeting.", | |
14512 "format": "int64", | |
14513 "type": "string" | |
14514 }, | |
14515 "desktop": { | |
14516 "description": "Whether this operating system is for desktop
.", | |
14517 "type": "boolean" | |
14518 }, | |
14519 "kind": { | |
14520 "default": "dfareporting#operatingSystem", | |
14521 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#operatingSystem\".", | |
14522 "type": "string" | |
14523 }, | |
14524 "mobile": { | |
14525 "description": "Whether this operating system is for mobile.
", | |
14526 "type": "boolean" | |
14527 }, | |
14528 "name": { | |
14529 "description": "Name of this operating system.", | |
14530 "type": "string" | |
14531 } | |
14532 }, | |
14533 "type": "object" | |
14534 }, | |
14535 "OperatingSystemVersion": { | |
14536 "description": "Contains information about a particular version of a
n operating system that can be targeted by ads.", | |
14537 "id": "OperatingSystemVersion", | |
14538 "properties": { | |
14539 "id": { | |
14540 "description": "ID of this operating system version.", | |
14541 "format": "int64", | |
14542 "type": "string" | |
14543 }, | |
14544 "kind": { | |
14545 "default": "dfareporting#operatingSystemVersion", | |
14546 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#operatingSystemVersion\".", | |
14547 "type": "string" | |
14548 }, | |
14549 "majorVersion": { | |
14550 "description": "Major version (leftmost number) of this oper
ating system version.", | |
14551 "type": "string" | |
14552 }, | |
14553 "minorVersion": { | |
14554 "description": "Minor version (number after the first dot) o
f this operating system version.", | |
14555 "type": "string" | |
14556 }, | |
14557 "name": { | |
14558 "description": "Name of this operating system version.", | |
14559 "type": "string" | |
14560 }, | |
14561 "operatingSystem": { | |
14562 "$ref": "OperatingSystem", | |
14563 "description": "Operating system of this operating system ve
rsion." | |
14564 } | |
14565 }, | |
14566 "type": "object" | |
14567 }, | |
14568 "OperatingSystemVersionsListResponse": { | |
14569 "description": "Operating System Version List Response", | |
14570 "id": "OperatingSystemVersionsListResponse", | |
14571 "properties": { | |
14572 "kind": { | |
14573 "default": "dfareporting#operatingSystemVersionsListResponse
", | |
14574 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#operatingSystemVersionsListResponse\".", | |
14575 "type": "string" | |
14576 }, | |
14577 "operatingSystemVersions": { | |
14578 "description": "Operating system version collection.", | |
14579 "items": { | |
14580 "$ref": "OperatingSystemVersion" | |
14581 }, | |
14582 "type": "array" | |
14583 } | |
14584 }, | |
14585 "type": "object" | |
14586 }, | |
14587 "OperatingSystemsListResponse": { | |
14588 "description": "Operating System List Response", | |
14589 "id": "OperatingSystemsListResponse", | |
14590 "properties": { | |
14591 "kind": { | |
14592 "default": "dfareporting#operatingSystemsListResponse", | |
14593 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#operatingSystemsListResponse\".", | |
14594 "type": "string" | |
14595 }, | |
14596 "operatingSystems": { | |
14597 "description": "Operating system collection.", | |
14598 "items": { | |
14599 "$ref": "OperatingSystem" | |
14600 }, | |
14601 "type": "array" | |
14602 } | |
14603 }, | |
14604 "type": "object" | |
14605 }, | |
14606 "OptimizationActivity": { | |
14607 "description": "Creative optimization activity.", | |
14608 "id": "OptimizationActivity", | |
14609 "properties": { | |
14610 "floodlightActivityId": { | |
14611 "description": "Floodlight activity ID of this optimization
activity. This is a required field.", | |
14612 "format": "int64", | |
14613 "type": "string" | |
14614 }, | |
14615 "floodlightActivityIdDimensionValue": { | |
14616 "$ref": "DimensionValue", | |
14617 "description": "Dimension value for the ID of the floodlight
activity. This is a read-only, auto-generated field." | |
14618 }, | |
14619 "weight": { | |
14620 "description": "Weight associated with this optimization. Mu
st be greater than 1. The weight assigned will be understood in proportion to th
e weights assigned to the other optimization activities.", | |
14621 "format": "int32", | |
14622 "type": "integer" | |
14623 } | |
14624 }, | |
14625 "type": "object" | |
14626 }, | |
14627 "Order": { | |
14628 "description": "Describes properties of a DoubleClick Planning order
.", | |
14629 "id": "Order", | |
14630 "properties": { | |
14631 "accountId": { | |
14632 "description": "Account ID of this order.", | |
14633 "format": "int64", | |
14634 "type": "string" | |
14635 }, | |
14636 "advertiserId": { | |
14637 "description": "Advertiser ID of this order.", | |
14638 "format": "int64", | |
14639 "type": "string" | |
14640 }, | |
14641 "approverUserProfileIds": { | |
14642 "description": "IDs for users that have to approve documents
created for this order.", | |
14643 "items": { | |
14644 "format": "int64", | |
14645 "type": "string" | |
14646 }, | |
14647 "type": "array" | |
14648 }, | |
14649 "buyerInvoiceId": { | |
14650 "description": "Buyer invoice ID associated with this order.
", | |
14651 "type": "string" | |
14652 }, | |
14653 "buyerOrganizationName": { | |
14654 "description": "Name of the buyer organization.", | |
14655 "type": "string" | |
14656 }, | |
14657 "comments": { | |
14658 "description": "Comments in this order.", | |
14659 "type": "string" | |
14660 }, | |
14661 "contacts": { | |
14662 "description": "Contacts for this order.", | |
14663 "items": { | |
14664 "$ref": "OrderContact" | |
14665 }, | |
14666 "type": "array" | |
14667 }, | |
14668 "id": { | |
14669 "description": "ID of this order. This is a read-only, auto-
generated field.", | |
14670 "format": "int64", | |
14671 "type": "string" | |
14672 }, | |
14673 "kind": { | |
14674 "default": "dfareporting#order", | |
14675 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#order\".", | |
14676 "type": "string" | |
14677 }, | |
14678 "lastModifiedInfo": { | |
14679 "$ref": "LastModifiedInfo", | |
14680 "description": "Information about the most recent modificati
on of this order." | |
14681 }, | |
14682 "name": { | |
14683 "description": "Name of this order.", | |
14684 "type": "string" | |
14685 }, | |
14686 "notes": { | |
14687 "description": "Notes of this order.", | |
14688 "type": "string" | |
14689 }, | |
14690 "planningTermId": { | |
14691 "description": "ID of the terms and conditions template used
in this order.", | |
14692 "format": "int64", | |
14693 "type": "string" | |
14694 }, | |
14695 "projectId": { | |
14696 "description": "Project ID of this order.", | |
14697 "format": "int64", | |
14698 "type": "string" | |
14699 }, | |
14700 "sellerOrderId": { | |
14701 "description": "Seller order ID associated with this order."
, | |
14702 "type": "string" | |
14703 }, | |
14704 "sellerOrganizationName": { | |
14705 "description": "Name of the seller organization.", | |
14706 "type": "string" | |
14707 }, | |
14708 "siteId": { | |
14709 "description": "Site IDs this order is associated with.", | |
14710 "items": { | |
14711 "format": "int64", | |
14712 "type": "string" | |
14713 }, | |
14714 "type": "array" | |
14715 }, | |
14716 "siteNames": { | |
14717 "description": "Free-form site names this order is associate
d with.", | |
14718 "items": { | |
14719 "type": "string" | |
14720 }, | |
14721 "type": "array" | |
14722 }, | |
14723 "subaccountId": { | |
14724 "description": "Subaccount ID of this order.", | |
14725 "format": "int64", | |
14726 "type": "string" | |
14727 }, | |
14728 "termsAndConditions": { | |
14729 "description": "Terms and conditions of this order.", | |
14730 "type": "string" | |
14731 } | |
14732 }, | |
14733 "type": "object" | |
14734 }, | |
14735 "OrderContact": { | |
14736 "description": "Contact of an order.", | |
14737 "id": "OrderContact", | |
14738 "properties": { | |
14739 "contactInfo": { | |
14740 "description": "Free-form information about this contact. It
could be any information related to this contact in addition to type, title, na
me, and signature user profile ID.", | |
14741 "type": "string" | |
14742 }, | |
14743 "contactName": { | |
14744 "description": "Name of this contact.", | |
14745 "type": "string" | |
14746 }, | |
14747 "contactTitle": { | |
14748 "description": "Title of this contact.", | |
14749 "type": "string" | |
14750 }, | |
14751 "contactType": { | |
14752 "description": "Type of this contact.", | |
14753 "enum": [ | |
14754 "PLANNING_ORDER_CONTACT_BUYER_BILLING_CONTACT", | |
14755 "PLANNING_ORDER_CONTACT_BUYER_CONTACT", | |
14756 "PLANNING_ORDER_CONTACT_SELLER_CONTACT" | |
14757 ], | |
14758 "enumDescriptions": [ | |
14759 "", | |
14760 "", | |
14761 "" | |
14762 ], | |
14763 "type": "string" | |
14764 }, | |
14765 "signatureUserProfileId": { | |
14766 "description": "ID of the user profile containing the signat
ure that will be embedded into order documents.", | |
14767 "format": "int64", | |
14768 "type": "string" | |
14769 } | |
14770 }, | |
14771 "type": "object" | |
14772 }, | |
14773 "OrderDocument": { | |
14774 "description": "Contains properties of a DoubleClick Planning order
document.", | |
14775 "id": "OrderDocument", | |
14776 "properties": { | |
14777 "accountId": { | |
14778 "description": "Account ID of this order document.", | |
14779 "format": "int64", | |
14780 "type": "string" | |
14781 }, | |
14782 "advertiserId": { | |
14783 "description": "Advertiser ID of this order document.", | |
14784 "format": "int64", | |
14785 "type": "string" | |
14786 }, | |
14787 "amendedOrderDocumentId": { | |
14788 "description": "The amended order document ID of this order
document. An order document can be created by optionally amending another order
document so that the change history can be preserved.", | |
14789 "format": "int64", | |
14790 "type": "string" | |
14791 }, | |
14792 "approvedByUserProfileIds": { | |
14793 "description": "IDs of users who have approved this order do
cument.", | |
14794 "items": { | |
14795 "format": "int64", | |
14796 "type": "string" | |
14797 }, | |
14798 "type": "array" | |
14799 }, | |
14800 "cancelled": { | |
14801 "description": "Whether this order document is cancelled.", | |
14802 "type": "boolean" | |
14803 }, | |
14804 "createdInfo": { | |
14805 "$ref": "LastModifiedInfo", | |
14806 "description": "Information about the creation of this order
document." | |
14807 }, | |
14808 "effectiveDate": { | |
14809 "description": "Effective date of this order document.", | |
14810 "format": "date", | |
14811 "type": "string" | |
14812 }, | |
14813 "id": { | |
14814 "description": "ID of this order document.", | |
14815 "format": "int64", | |
14816 "type": "string" | |
14817 }, | |
14818 "kind": { | |
14819 "default": "dfareporting#orderDocument", | |
14820 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#orderDocument\".", | |
14821 "type": "string" | |
14822 }, | |
14823 "lastSentRecipients": { | |
14824 "description": "List of email addresses that received the la
st sent document.", | |
14825 "items": { | |
14826 "type": "string" | |
14827 }, | |
14828 "type": "array" | |
14829 }, | |
14830 "lastSentTime": { | |
14831 "description": "Timestamp of the last email sent with this o
rder document.", | |
14832 "format": "date-time", | |
14833 "type": "string" | |
14834 }, | |
14835 "orderId": { | |
14836 "description": "ID of the order from which this order docume
nt is created.", | |
14837 "format": "int64", | |
14838 "type": "string" | |
14839 }, | |
14840 "projectId": { | |
14841 "description": "Project ID of this order document.", | |
14842 "format": "int64", | |
14843 "type": "string" | |
14844 }, | |
14845 "signed": { | |
14846 "description": "Whether this order document has been signed.
", | |
14847 "type": "boolean" | |
14848 }, | |
14849 "subaccountId": { | |
14850 "description": "Subaccount ID of this order document.", | |
14851 "format": "int64", | |
14852 "type": "string" | |
14853 }, | |
14854 "title": { | |
14855 "description": "Title of this order document.", | |
14856 "type": "string" | |
14857 }, | |
14858 "type": { | |
14859 "description": "Type of this order document", | |
14860 "enum": [ | |
14861 "PLANNING_ORDER_TYPE_CHANGE_ORDER", | |
14862 "PLANNING_ORDER_TYPE_INSERTION_ORDER" | |
14863 ], | |
14864 "enumDescriptions": [ | |
14865 "", | |
14866 "" | |
14867 ], | |
14868 "type": "string" | |
14869 } | |
14870 }, | |
14871 "type": "object" | |
14872 }, | |
14873 "OrderDocumentsListResponse": { | |
14874 "description": "Order document List Response", | |
14875 "id": "OrderDocumentsListResponse", | |
14876 "properties": { | |
14877 "kind": { | |
14878 "default": "dfareporting#orderDocumentsListResponse", | |
14879 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#orderDocumentsListResponse\".", | |
14880 "type": "string" | |
14881 }, | |
14882 "nextPageToken": { | |
14883 "description": "Pagination token to be used for the next lis
t operation.", | |
14884 "type": "string" | |
14885 }, | |
14886 "orderDocuments": { | |
14887 "description": "Order document collection", | |
14888 "items": { | |
14889 "$ref": "OrderDocument" | |
14890 }, | |
14891 "type": "array" | |
14892 } | |
14893 }, | |
14894 "type": "object" | |
14895 }, | |
14896 "OrdersListResponse": { | |
14897 "description": "Order List Response", | |
14898 "id": "OrdersListResponse", | |
14899 "properties": { | |
14900 "kind": { | |
14901 "default": "dfareporting#ordersListResponse", | |
14902 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#ordersListResponse\".", | |
14903 "type": "string" | |
14904 }, | |
14905 "nextPageToken": { | |
14906 "description": "Pagination token to be used for the next lis
t operation.", | |
14907 "type": "string" | |
14908 }, | |
14909 "orders": { | |
14910 "description": "Order collection.", | |
14911 "items": { | |
14912 "$ref": "Order" | |
14913 }, | |
14914 "type": "array" | |
14915 } | |
14916 }, | |
14917 "type": "object" | |
14918 }, | |
14919 "PathToConversionReportCompatibleFields": { | |
14920 "description": "Represents fields that are compatible to be selected
for a report of type \"PATH_TO_CONVERSION\".", | |
14921 "id": "PathToConversionReportCompatibleFields", | |
14922 "properties": { | |
14923 "conversionDimensions": { | |
14924 "description": "Conversion dimensions which are compatible t
o be selected in the \"conversionDimensions\" section of the report.", | |
14925 "items": { | |
14926 "$ref": "Dimension" | |
14927 }, | |
14928 "type": "array" | |
14929 }, | |
14930 "customFloodlightVariables": { | |
14931 "description": "Custom floodlight variables which are compat
ible to be selected in the \"customFloodlightVariables\" section of the report."
, | |
14932 "items": { | |
14933 "$ref": "Dimension" | |
14934 }, | |
14935 "type": "array" | |
14936 }, | |
14937 "kind": { | |
14938 "default": "dfareporting#pathToConversionReportCompatibleFie
lds", | |
14939 "description": "The kind of resource this is, in this case d
fareporting#pathToConversionReportCompatibleFields.", | |
14940 "type": "string" | |
14941 }, | |
14942 "metrics": { | |
14943 "description": "Metrics which are compatible to be selected
in the \"metricNames\" section of the report.", | |
14944 "items": { | |
14945 "$ref": "Metric" | |
14946 }, | |
14947 "type": "array" | |
14948 }, | |
14949 "perInteractionDimensions": { | |
14950 "description": "Per-interaction dimensions which are compati
ble to be selected in the \"perInteractionDimensions\" section of the report.", | |
14951 "items": { | |
14952 "$ref": "Dimension" | |
14953 }, | |
14954 "type": "array" | |
14955 } | |
14956 }, | |
14957 "type": "object" | |
14958 }, | |
14959 "Placement": { | |
14960 "description": "Contains properties of a placement.", | |
14961 "id": "Placement", | |
14962 "properties": { | |
14963 "accountId": { | |
14964 "description": "Account ID of this placement. This field can
be left blank.", | |
14965 "format": "int64", | |
14966 "type": "string" | |
14967 }, | |
14968 "advertiserId": { | |
14969 "description": "Advertiser ID of this placement. This field
can be left blank.", | |
14970 "format": "int64", | |
14971 "type": "string" | |
14972 }, | |
14973 "advertiserIdDimensionValue": { | |
14974 "$ref": "DimensionValue", | |
14975 "description": "Dimension value for the ID of the advertiser
. This is a read-only, auto-generated field." | |
14976 }, | |
14977 "archived": { | |
14978 "description": "Whether this placement is archived.", | |
14979 "type": "boolean" | |
14980 }, | |
14981 "campaignId": { | |
14982 "description": "Campaign ID of this placement. This field is
a required field on insertion.", | |
14983 "format": "int64", | |
14984 "type": "string" | |
14985 }, | |
14986 "campaignIdDimensionValue": { | |
14987 "$ref": "DimensionValue", | |
14988 "description": "Dimension value for the ID of the campaign.
This is a read-only, auto-generated field." | |
14989 }, | |
14990 "comment": { | |
14991 "description": "Comments for this placement.", | |
14992 "type": "string" | |
14993 }, | |
14994 "compatibility": { | |
14995 "description": "Placement compatibility. WEB and WEB_INTERST
ITIAL refer to rendering either on desktop or on mobile devices for regular or i
nterstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mob
ile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed w
ith the VAST standard. This field is required on insertion.", | |
14996 "enum": [ | |
14997 "APP", | |
14998 "APP_INTERSTITIAL", | |
14999 "IN_STREAM_VIDEO", | |
15000 "WEB", | |
15001 "WEB_INTERSTITIAL" | |
15002 ], | |
15003 "enumDescriptions": [ | |
15004 "", | |
15005 "", | |
15006 "", | |
15007 "", | |
15008 "" | |
15009 ], | |
15010 "type": "string" | |
15011 }, | |
15012 "contentCategoryId": { | |
15013 "description": "ID of the content category assigned to this
placement.", | |
15014 "format": "int64", | |
15015 "type": "string" | |
15016 }, | |
15017 "createInfo": { | |
15018 "$ref": "LastModifiedInfo", | |
15019 "description": "Information about the creation of this place
ment. This is a read-only field." | |
15020 }, | |
15021 "directorySiteId": { | |
15022 "description": "Directory site ID of this placement. On inse
rt, you must set either this field or the siteId field to specify the site assoc
iated with this placement. This is a required field that is read-only after inse
rtion.", | |
15023 "format": "int64", | |
15024 "type": "string" | |
15025 }, | |
15026 "directorySiteIdDimensionValue": { | |
15027 "$ref": "DimensionValue", | |
15028 "description": "Dimension value for the ID of the directory
site. This is a read-only, auto-generated field." | |
15029 }, | |
15030 "externalId": { | |
15031 "description": "External ID for this placement.", | |
15032 "type": "string" | |
15033 }, | |
15034 "id": { | |
15035 "description": "ID of this placement. This is a read-only, a
uto-generated field.", | |
15036 "format": "int64", | |
15037 "type": "string" | |
15038 }, | |
15039 "idDimensionValue": { | |
15040 "$ref": "DimensionValue", | |
15041 "description": "Dimension value for the ID of this placement
. This is a read-only, auto-generated field." | |
15042 }, | |
15043 "keyName": { | |
15044 "description": "Key name of this placement. This is a read-o
nly, auto-generated field.", | |
15045 "type": "string" | |
15046 }, | |
15047 "kind": { | |
15048 "default": "dfareporting#placement", | |
15049 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#placement\".", | |
15050 "type": "string" | |
15051 }, | |
15052 "lastModifiedInfo": { | |
15053 "$ref": "LastModifiedInfo", | |
15054 "description": "Information about the most recent modificati
on of this placement. This is a read-only field." | |
15055 }, | |
15056 "lookbackConfiguration": { | |
15057 "$ref": "LookbackConfiguration", | |
15058 "description": "Lookback window settings for this placement.
" | |
15059 }, | |
15060 "name": { | |
15061 "description": "Name of this placement.This is a required fi
eld and must be less than 256 characters long.", | |
15062 "type": "string" | |
15063 }, | |
15064 "paymentApproved": { | |
15065 "description": "Whether payment was approved for this placem
ent. This is a read-only field relevant only to publisher-paid placements.", | |
15066 "type": "boolean" | |
15067 }, | |
15068 "paymentSource": { | |
15069 "description": "Payment source for this placement. This is a
required field that is read-only after insertion.", | |
15070 "enum": [ | |
15071 "PLACEMENT_AGENCY_PAID", | |
15072 "PLACEMENT_PUBLISHER_PAID" | |
15073 ], | |
15074 "enumDescriptions": [ | |
15075 "", | |
15076 "" | |
15077 ], | |
15078 "type": "string" | |
15079 }, | |
15080 "placementGroupId": { | |
15081 "description": "ID of this placement's group, if applicable.
", | |
15082 "format": "int64", | |
15083 "type": "string" | |
15084 }, | |
15085 "placementGroupIdDimensionValue": { | |
15086 "$ref": "DimensionValue", | |
15087 "description": "Dimension value for the ID of the placement
group. This is a read-only, auto-generated field." | |
15088 }, | |
15089 "placementStrategyId": { | |
15090 "description": "ID of the placement strategy assigned to thi
s placement.", | |
15091 "format": "int64", | |
15092 "type": "string" | |
15093 }, | |
15094 "pricingSchedule": { | |
15095 "$ref": "PricingSchedule", | |
15096 "description": "Pricing schedule of this placement. This fie
ld is required on insertion, specifically subfields startDate, endDate and prici
ngType." | |
15097 }, | |
15098 "primary": { | |
15099 "description": "Whether this placement is the primary placem
ent of a roadblock (placement group). You cannot change this field from true to
false. Setting this field to true will automatically set the primary field on th
e original primary placement of the roadblock to false, and it will automaticall
y set the roadblock's primaryPlacementId field to the ID of this placement.", | |
15100 "type": "boolean" | |
15101 }, | |
15102 "publisherUpdateInfo": { | |
15103 "$ref": "LastModifiedInfo", | |
15104 "description": "Information about the last publisher update.
This is a read-only field." | |
15105 }, | |
15106 "siteId": { | |
15107 "description": "Site ID associated with this placement. On i
nsert, you must set either this field or the directorySiteId field to specify th
e site associated with this placement. This is a required field that is read-onl
y after insertion.", | |
15108 "format": "int64", | |
15109 "type": "string" | |
15110 }, | |
15111 "siteIdDimensionValue": { | |
15112 "$ref": "DimensionValue", | |
15113 "description": "Dimension value for the ID of the site. This
is a read-only, auto-generated field." | |
15114 }, | |
15115 "size": { | |
15116 "$ref": "Size", | |
15117 "description": "Size associated with this placement. When in
serting or updating a placement, only the size ID field is used. This field is r
equired on insertion." | |
15118 }, | |
15119 "sslRequired": { | |
15120 "description": "Whether creatives assigned to this placement
must be SSL-compliant.", | |
15121 "type": "boolean" | |
15122 }, | |
15123 "status": { | |
15124 "description": "Third-party placement status.", | |
15125 "enum": [ | |
15126 "ACKNOWLEDGE_ACCEPTANCE", | |
15127 "ACKNOWLEDGE_REJECTION", | |
15128 "DRAFT", | |
15129 "PAYMENT_ACCEPTED", | |
15130 "PAYMENT_REJECTED", | |
15131 "PENDING_REVIEW" | |
15132 ], | |
15133 "enumDescriptions": [ | |
15134 "", | |
15135 "", | |
15136 "", | |
15137 "", | |
15138 "", | |
15139 "" | |
15140 ], | |
15141 "type": "string" | |
15142 }, | |
15143 "subaccountId": { | |
15144 "description": "Subaccount ID of this placement. This field
can be left blank.", | |
15145 "format": "int64", | |
15146 "type": "string" | |
15147 }, | |
15148 "tagFormats": { | |
15149 "description": "Tag formats to generate for this placement.
This field is required on insertion.\nAcceptable values are:\n- \"PLACEMENT_TAG_
STANDARD\"\n- \"PLACEMENT_TAG_IFRAME_JAVASCRIPT\"\n- \"PLACEMENT_TAG_IFRAME_ILAY
ER\"\n- \"PLACEMENT_TAG_INTERNAL_REDIRECT\"\n- \"PLACEMENT_TAG_JAVASCRIPT\"\n- \
"PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT\"\n- \"PLACEMENT_TAG_INTERSTITIAL_
INTERNAL_REDIRECT\"\n- \"PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT\"\n- \"PLACEMENT_
TAG_CLICK_COMMANDS\"\n- \"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH\"\n- \"PLACEMENT
_TAG_TRACKING\"\n- \"PLACEMENT_TAG_TRACKING_IFRAME\"\n- \"PLACEMENT_TAG_TRACKING
_JAVASCRIPT\"", | |
15150 "items": { | |
15151 "enum": [ | |
15152 "PLACEMENT_TAG_CLICK_COMMANDS", | |
15153 "PLACEMENT_TAG_IFRAME_ILAYER", | |
15154 "PLACEMENT_TAG_IFRAME_JAVASCRIPT", | |
15155 "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY", | |
15156 "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH", | |
15157 "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3", | |
15158 "PLACEMENT_TAG_INTERNAL_REDIRECT", | |
15159 "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT", | |
15160 "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY
", | |
15161 "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT", | |
15162 "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT", | |
15163 "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY", | |
15164 "PLACEMENT_TAG_JAVASCRIPT", | |
15165 "PLACEMENT_TAG_JAVASCRIPT_LEGACY", | |
15166 "PLACEMENT_TAG_STANDARD", | |
15167 "PLACEMENT_TAG_TRACKING", | |
15168 "PLACEMENT_TAG_TRACKING_IFRAME", | |
15169 "PLACEMENT_TAG_TRACKING_JAVASCRIPT" | |
15170 ], | |
15171 "enumDescriptions": [ | |
15172 "", | |
15173 "", | |
15174 "", | |
15175 "", | |
15176 "", | |
15177 "", | |
15178 "", | |
15179 "", | |
15180 "", | |
15181 "", | |
15182 "", | |
15183 "", | |
15184 "", | |
15185 "", | |
15186 "", | |
15187 "", | |
15188 "", | |
15189 "" | |
15190 ], | |
15191 "type": "string" | |
15192 }, | |
15193 "type": "array" | |
15194 }, | |
15195 "tagSetting": { | |
15196 "$ref": "TagSetting", | |
15197 "description": "Tag settings for this placement." | |
15198 } | |
15199 }, | |
15200 "type": "object" | |
15201 }, | |
15202 "PlacementAssignment": { | |
15203 "description": "Placement Assignment.", | |
15204 "id": "PlacementAssignment", | |
15205 "properties": { | |
15206 "active": { | |
15207 "description": "Whether this placement assignment is active.
When true, the placement will be included in the ad's rotation.", | |
15208 "type": "boolean" | |
15209 }, | |
15210 "placementId": { | |
15211 "description": "ID of the placement to be assigned. This is
a required field.", | |
15212 "format": "int64", | |
15213 "type": "string" | |
15214 }, | |
15215 "placementIdDimensionValue": { | |
15216 "$ref": "DimensionValue", | |
15217 "description": "Dimension value for the ID of the placement.
This is a read-only, auto-generated field." | |
15218 }, | |
15219 "sslRequired": { | |
15220 "description": "Whether the placement to be assigned require
s SSL. This is a read-only field that is auto-generated when the ad is inserted
or updated.", | |
15221 "type": "boolean" | |
15222 } | |
15223 }, | |
15224 "type": "object" | |
15225 }, | |
15226 "PlacementGroup": { | |
15227 "description": "Contains properties of a package or roadblock.", | |
15228 "id": "PlacementGroup", | |
15229 "properties": { | |
15230 "accountId": { | |
15231 "description": "Account ID of this placement group. This is
a read-only field that can be left blank.", | |
15232 "format": "int64", | |
15233 "type": "string" | |
15234 }, | |
15235 "advertiserId": { | |
15236 "description": "Advertiser ID of this placement group. This
is a required field on insertion.", | |
15237 "format": "int64", | |
15238 "type": "string" | |
15239 }, | |
15240 "advertiserIdDimensionValue": { | |
15241 "$ref": "DimensionValue", | |
15242 "description": "Dimension value for the ID of the advertiser
. This is a read-only, auto-generated field." | |
15243 }, | |
15244 "archived": { | |
15245 "description": "Whether this placement group is archived.", | |
15246 "type": "boolean" | |
15247 }, | |
15248 "campaignId": { | |
15249 "description": "Campaign ID of this placement group. This fi
eld is required on insertion.", | |
15250 "format": "int64", | |
15251 "type": "string" | |
15252 }, | |
15253 "campaignIdDimensionValue": { | |
15254 "$ref": "DimensionValue", | |
15255 "description": "Dimension value for the ID of the campaign.
This is a read-only, auto-generated field." | |
15256 }, | |
15257 "childPlacementIds": { | |
15258 "description": "IDs of placements which are assigned to this
placement group. This is a read-only, auto-generated field.", | |
15259 "items": { | |
15260 "format": "int64", | |
15261 "type": "string" | |
15262 }, | |
15263 "type": "array" | |
15264 }, | |
15265 "comment": { | |
15266 "description": "Comments for this placement group.", | |
15267 "type": "string" | |
15268 }, | |
15269 "contentCategoryId": { | |
15270 "description": "ID of the content category assigned to this
placement group.", | |
15271 "format": "int64", | |
15272 "type": "string" | |
15273 }, | |
15274 "createInfo": { | |
15275 "$ref": "LastModifiedInfo", | |
15276 "description": "Information about the creation of this place
ment group. This is a read-only field." | |
15277 }, | |
15278 "directorySiteId": { | |
15279 "description": "Directory site ID associated with this place
ment group. On insert, you must set either this field or the site_id field to sp
ecify the site associated with this placement group. This is a required field th
at is read-only after insertion.", | |
15280 "format": "int64", | |
15281 "type": "string" | |
15282 }, | |
15283 "directorySiteIdDimensionValue": { | |
15284 "$ref": "DimensionValue", | |
15285 "description": "Dimension value for the ID of the directory
site. This is a read-only, auto-generated field." | |
15286 }, | |
15287 "externalId": { | |
15288 "description": "External ID for this placement.", | |
15289 "type": "string" | |
15290 }, | |
15291 "id": { | |
15292 "description": "ID of this placement group. This is a read-o
nly, auto-generated field.", | |
15293 "format": "int64", | |
15294 "type": "string" | |
15295 }, | |
15296 "idDimensionValue": { | |
15297 "$ref": "DimensionValue", | |
15298 "description": "Dimension value for the ID of this placement
group. This is a read-only, auto-generated field." | |
15299 }, | |
15300 "kind": { | |
15301 "default": "dfareporting#placementGroup", | |
15302 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#placementGroup\".", | |
15303 "type": "string" | |
15304 }, | |
15305 "lastModifiedInfo": { | |
15306 "$ref": "LastModifiedInfo", | |
15307 "description": "Information about the most recent modificati
on of this placement group. This is a read-only field." | |
15308 }, | |
15309 "name": { | |
15310 "description": "Name of this placement group. This is a requ
ired field and must be less than 256 characters long.", | |
15311 "type": "string" | |
15312 }, | |
15313 "placementGroupType": { | |
15314 "description": "Type of this placement group. A package is a
simple group of placements that acts as a single pricing point for a group of t
ags. A roadblock is a group of placements that not only acts as a single pricing
point, but also assumes that all the tags in it will be served at the same time
. A roadblock requires one of its assigned placements to be marked as primary fo
r reporting. This field is required on insertion.", | |
15315 "enum": [ | |
15316 "PLACEMENT_PACKAGE", | |
15317 "PLACEMENT_ROADBLOCK" | |
15318 ], | |
15319 "enumDescriptions": [ | |
15320 "", | |
15321 "" | |
15322 ], | |
15323 "type": "string" | |
15324 }, | |
15325 "placementStrategyId": { | |
15326 "description": "ID of the placement strategy assigned to thi
s placement group.", | |
15327 "format": "int64", | |
15328 "type": "string" | |
15329 }, | |
15330 "pricingSchedule": { | |
15331 "$ref": "PricingSchedule", | |
15332 "description": "Pricing schedule of this placement group. Th
is field is required on insertion." | |
15333 }, | |
15334 "primaryPlacementId": { | |
15335 "description": "ID of the primary placement, used to calcula
te the media cost of a roadblock (placement group). Modifying this field will au
tomatically modify the primary field on all affected roadblock child placements.
", | |
15336 "format": "int64", | |
15337 "type": "string" | |
15338 }, | |
15339 "primaryPlacementIdDimensionValue": { | |
15340 "$ref": "DimensionValue", | |
15341 "description": "Dimension value for the ID of the primary pl
acement. This is a read-only, auto-generated field." | |
15342 }, | |
15343 "siteId": { | |
15344 "description": "Site ID associated with this placement group
. On insert, you must set either this field or the directorySiteId field to spec
ify the site associated with this placement group. This is a required field that
is read-only after insertion.", | |
15345 "format": "int64", | |
15346 "type": "string" | |
15347 }, | |
15348 "siteIdDimensionValue": { | |
15349 "$ref": "DimensionValue", | |
15350 "description": "Dimension value for the ID of the site. This
is a read-only, auto-generated field." | |
15351 }, | |
15352 "subaccountId": { | |
15353 "description": "Subaccount ID of this placement group. This
is a read-only field that can be left blank.", | |
15354 "format": "int64", | |
15355 "type": "string" | |
15356 } | |
15357 }, | |
15358 "type": "object" | |
15359 }, | |
15360 "PlacementGroupsListResponse": { | |
15361 "description": "Placement Group List Response", | |
15362 "id": "PlacementGroupsListResponse", | |
15363 "properties": { | |
15364 "kind": { | |
15365 "default": "dfareporting#placementGroupsListResponse", | |
15366 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#placementGroupsListResponse\".", | |
15367 "type": "string" | |
15368 }, | |
15369 "nextPageToken": { | |
15370 "description": "Pagination token to be used for the next lis
t operation.", | |
15371 "type": "string" | |
15372 }, | |
15373 "placementGroups": { | |
15374 "description": "Placement group collection.", | |
15375 "items": { | |
15376 "$ref": "PlacementGroup" | |
15377 }, | |
15378 "type": "array" | |
15379 } | |
15380 }, | |
15381 "type": "object" | |
15382 }, | |
15383 "PlacementStrategiesListResponse": { | |
15384 "description": "Placement Strategy List Response", | |
15385 "id": "PlacementStrategiesListResponse", | |
15386 "properties": { | |
15387 "kind": { | |
15388 "default": "dfareporting#placementStrategiesListResponse", | |
15389 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#placementStrategiesListResponse\".", | |
15390 "type": "string" | |
15391 }, | |
15392 "nextPageToken": { | |
15393 "description": "Pagination token to be used for the next lis
t operation.", | |
15394 "type": "string" | |
15395 }, | |
15396 "placementStrategies": { | |
15397 "description": "Placement strategy collection.", | |
15398 "items": { | |
15399 "$ref": "PlacementStrategy" | |
15400 }, | |
15401 "type": "array" | |
15402 } | |
15403 }, | |
15404 "type": "object" | |
15405 }, | |
15406 "PlacementStrategy": { | |
15407 "description": "Contains properties of a placement strategy.", | |
15408 "id": "PlacementStrategy", | |
15409 "properties": { | |
15410 "accountId": { | |
15411 "description": "Account ID of this placement strategy.This i
s a read-only field that can be left blank.", | |
15412 "format": "int64", | |
15413 "type": "string" | |
15414 }, | |
15415 "id": { | |
15416 "description": "ID of this placement strategy. This is a rea
d-only, auto-generated field.", | |
15417 "format": "int64", | |
15418 "type": "string" | |
15419 }, | |
15420 "kind": { | |
15421 "default": "dfareporting#placementStrategy", | |
15422 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#placementStrategy\".", | |
15423 "type": "string" | |
15424 }, | |
15425 "name": { | |
15426 "description": "Name of this placement strategy. This is a r
equired field. It must be less than 256 characters long and unique among placeme
nt strategies of the same account.", | |
15427 "type": "string" | |
15428 } | |
15429 }, | |
15430 "type": "object" | |
15431 }, | |
15432 "PlacementTag": { | |
15433 "description": "Placement Tag", | |
15434 "id": "PlacementTag", | |
15435 "properties": { | |
15436 "placementId": { | |
15437 "description": "Placement ID", | |
15438 "format": "int64", | |
15439 "type": "string" | |
15440 }, | |
15441 "tagDatas": { | |
15442 "description": "Tags generated for this placement.", | |
15443 "items": { | |
15444 "$ref": "TagData" | |
15445 }, | |
15446 "type": "array" | |
15447 } | |
15448 }, | |
15449 "type": "object" | |
15450 }, | |
15451 "PlacementsGenerateTagsResponse": { | |
15452 "description": "Placement GenerateTags Response", | |
15453 "id": "PlacementsGenerateTagsResponse", | |
15454 "properties": { | |
15455 "kind": { | |
15456 "default": "dfareporting#placementsGenerateTagsResponse", | |
15457 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#placementsGenerateTagsResponse\".", | |
15458 "type": "string" | |
15459 }, | |
15460 "placementTags": { | |
15461 "description": "Set of generated tags for the specified plac
ements.", | |
15462 "items": { | |
15463 "$ref": "PlacementTag" | |
15464 }, | |
15465 "type": "array" | |
15466 } | |
15467 }, | |
15468 "type": "object" | |
15469 }, | |
15470 "PlacementsListResponse": { | |
15471 "description": "Placement List Response", | |
15472 "id": "PlacementsListResponse", | |
15473 "properties": { | |
15474 "kind": { | |
15475 "default": "dfareporting#placementsListResponse", | |
15476 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#placementsListResponse\".", | |
15477 "type": "string" | |
15478 }, | |
15479 "nextPageToken": { | |
15480 "description": "Pagination token to be used for the next lis
t operation.", | |
15481 "type": "string" | |
15482 }, | |
15483 "placements": { | |
15484 "description": "Placement collection.", | |
15485 "items": { | |
15486 "$ref": "Placement" | |
15487 }, | |
15488 "type": "array" | |
15489 } | |
15490 }, | |
15491 "type": "object" | |
15492 }, | |
15493 "PlatformType": { | |
15494 "description": "Contains information about a platform type that can
be targeted by ads.", | |
15495 "id": "PlatformType", | |
15496 "properties": { | |
15497 "id": { | |
15498 "description": "ID of this platform type.", | |
15499 "format": "int64", | |
15500 "type": "string" | |
15501 }, | |
15502 "kind": { | |
15503 "default": "dfareporting#platformType", | |
15504 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#platformType\".", | |
15505 "type": "string" | |
15506 }, | |
15507 "name": { | |
15508 "description": "Name of this platform type.", | |
15509 "type": "string" | |
15510 } | |
15511 }, | |
15512 "type": "object" | |
15513 }, | |
15514 "PlatformTypesListResponse": { | |
15515 "description": "Platform Type List Response", | |
15516 "id": "PlatformTypesListResponse", | |
15517 "properties": { | |
15518 "kind": { | |
15519 "default": "dfareporting#platformTypesListResponse", | |
15520 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#platformTypesListResponse\".", | |
15521 "type": "string" | |
15522 }, | |
15523 "platformTypes": { | |
15524 "description": "Platform type collection.", | |
15525 "items": { | |
15526 "$ref": "PlatformType" | |
15527 }, | |
15528 "type": "array" | |
15529 } | |
15530 }, | |
15531 "type": "object" | |
15532 }, | |
15533 "PopupWindowProperties": { | |
15534 "description": "Popup Window Properties.", | |
15535 "id": "PopupWindowProperties", | |
15536 "properties": { | |
15537 "dimension": { | |
15538 "$ref": "Size", | |
15539 "description": "Popup dimension for a creative. This is a re
ad-only field. Applicable to the following creative types: all RICH_MEDIA and al
l VPAID" | |
15540 }, | |
15541 "offset": { | |
15542 "$ref": "OffsetPosition", | |
15543 "description": "Upper-left corner coordinates of the popup w
indow. Applicable if positionType is COORDINATES." | |
15544 }, | |
15545 "positionType": { | |
15546 "description": "Popup window position either centered or at
specific coordinate.", | |
15547 "enum": [ | |
15548 "CENTER", | |
15549 "COORDINATES" | |
15550 ], | |
15551 "enumDescriptions": [ | |
15552 "", | |
15553 "" | |
15554 ], | |
15555 "type": "string" | |
15556 }, | |
15557 "showAddressBar": { | |
15558 "description": "Whether to display the browser address bar."
, | |
15559 "type": "boolean" | |
15560 }, | |
15561 "showMenuBar": { | |
15562 "description": "Whether to display the browser menu bar.", | |
15563 "type": "boolean" | |
15564 }, | |
15565 "showScrollBar": { | |
15566 "description": "Whether to display the browser scroll bar.", | |
15567 "type": "boolean" | |
15568 }, | |
15569 "showStatusBar": { | |
15570 "description": "Whether to display the browser status bar.", | |
15571 "type": "boolean" | |
15572 }, | |
15573 "showToolBar": { | |
15574 "description": "Whether to display the browser tool bar.", | |
15575 "type": "boolean" | |
15576 }, | |
15577 "title": { | |
15578 "description": "Title of popup window.", | |
15579 "type": "string" | |
15580 } | |
15581 }, | |
15582 "type": "object" | |
15583 }, | |
15584 "PostalCode": { | |
15585 "description": "Contains information about a postal code that can be
targeted by ads.", | |
15586 "id": "PostalCode", | |
15587 "properties": { | |
15588 "code": { | |
15589 "description": "Postal code. This is equivalent to the id fi
eld.", | |
15590 "type": "string" | |
15591 }, | |
15592 "countryCode": { | |
15593 "description": "Country code of the country to which this po
stal code belongs.", | |
15594 "type": "string" | |
15595 }, | |
15596 "countryDartId": { | |
15597 "description": "DART ID of the country to which this postal
code belongs.", | |
15598 "format": "int64", | |
15599 "type": "string" | |
15600 }, | |
15601 "id": { | |
15602 "description": "ID of this postal code.", | |
15603 "type": "string" | |
15604 }, | |
15605 "kind": { | |
15606 "default": "dfareporting#postalCode", | |
15607 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#postalCode\".", | |
15608 "type": "string" | |
15609 } | |
15610 }, | |
15611 "type": "object" | |
15612 }, | |
15613 "PostalCodesListResponse": { | |
15614 "description": "Postal Code List Response", | |
15615 "id": "PostalCodesListResponse", | |
15616 "properties": { | |
15617 "kind": { | |
15618 "default": "dfareporting#postalCodesListResponse", | |
15619 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#postalCodesListResponse\".", | |
15620 "type": "string" | |
15621 }, | |
15622 "postalCodes": { | |
15623 "description": "Postal code collection.", | |
15624 "items": { | |
15625 "$ref": "PostalCode" | |
15626 }, | |
15627 "type": "array" | |
15628 } | |
15629 }, | |
15630 "type": "object" | |
15631 }, | |
15632 "Pricing": { | |
15633 "description": "Pricing Information", | |
15634 "id": "Pricing", | |
15635 "properties": { | |
15636 "capCostType": { | |
15637 "description": "Cap cost type of this inventory item.", | |
15638 "enum": [ | |
15639 "PLANNING_PLACEMENT_CAP_COST_TYPE_CUMULATIVE", | |
15640 "PLANNING_PLACEMENT_CAP_COST_TYPE_MONTHLY", | |
15641 "PLANNING_PLACEMENT_CAP_COST_TYPE_NONE" | |
15642 ], | |
15643 "enumDescriptions": [ | |
15644 "", | |
15645 "", | |
15646 "" | |
15647 ], | |
15648 "type": "string" | |
15649 }, | |
15650 "endDate": { | |
15651 "description": "End date of this inventory item.", | |
15652 "format": "date", | |
15653 "type": "string" | |
15654 }, | |
15655 "flights": { | |
15656 "description": "Flights of this inventory item. A flight (a.
k.a. pricing period) represents the inventory item pricing information for a spe
cific period of time.", | |
15657 "items": { | |
15658 "$ref": "Flight" | |
15659 }, | |
15660 "type": "array" | |
15661 }, | |
15662 "groupType": { | |
15663 "description": "Group type of this inventory item if it repr
esents a placement group. Is null otherwise. There are two type of placement gro
ups: PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items
that acts as a single pricing point for a group of tags. PLANNING_PLACEMENT_GROU
P_TYPE_ROADBLOCK is a group of inventory items that not only acts as a single pr
icing point, but also assumes that all the tags in it will be served at the same
time. A roadblock requires one of its assigned inventory items to be marked as
primary.", | |
15664 "enum": [ | |
15665 "PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE", | |
15666 "PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK" | |
15667 ], | |
15668 "enumDescriptions": [ | |
15669 "", | |
15670 "" | |
15671 ], | |
15672 "type": "string" | |
15673 }, | |
15674 "pricingType": { | |
15675 "description": "Pricing type of this inventory item.", | |
15676 "enum": [ | |
15677 "PLANNING_PLACEMENT_PRICING_TYPE_CLICKS", | |
15678 "PLANNING_PLACEMENT_PRICING_TYPE_CPA", | |
15679 "PLANNING_PLACEMENT_PRICING_TYPE_CPC", | |
15680 "PLANNING_PLACEMENT_PRICING_TYPE_CPM", | |
15681 "PLANNING_PLACEMENT_PRICING_TYPE_CPM_ACTIVEVIEW", | |
15682 "PLANNING_PLACEMENT_PRICING_TYPE_FLAT_RATE_CLICKS", | |
15683 "PLANNING_PLACEMENT_PRICING_TYPE_FLAT_RATE_IMPRESSIONS", | |
15684 "PLANNING_PLACEMENT_PRICING_TYPE_IMPRESSIONS" | |
15685 ], | |
15686 "enumDescriptions": [ | |
15687 "", | |
15688 "", | |
15689 "", | |
15690 "", | |
15691 "", | |
15692 "", | |
15693 "", | |
15694 "" | |
15695 ], | |
15696 "type": "string" | |
15697 }, | |
15698 "startDate": { | |
15699 "description": "Start date of this inventory item.", | |
15700 "format": "date", | |
15701 "type": "string" | |
15702 } | |
15703 }, | |
15704 "type": "object" | |
15705 }, | |
15706 "PricingSchedule": { | |
15707 "description": "Pricing Schedule", | |
15708 "id": "PricingSchedule", | |
15709 "properties": { | |
15710 "capCostOption": { | |
15711 "description": "Placement cap cost option.", | |
15712 "enum": [ | |
15713 "CAP_COST_CUMULATIVE", | |
15714 "CAP_COST_MONTHLY", | |
15715 "CAP_COST_NONE" | |
15716 ], | |
15717 "enumDescriptions": [ | |
15718 "", | |
15719 "", | |
15720 "" | |
15721 ], | |
15722 "type": "string" | |
15723 }, | |
15724 "disregardOverdelivery": { | |
15725 "description": "Whether cap costs are ignored by ad serving.
", | |
15726 "type": "boolean" | |
15727 }, | |
15728 "endDate": { | |
15729 "description": "Placement end date. This date must be later
than, or the same day as, the placement start date, but not later than the campa
ign end date. If, for example, you set 6/25/2015 as both the start and end dates
, the effective placement date is just that day only, 6/25/2015. The hours, minu
tes, and seconds of the end date should not be set, as doing so will result in a
n error. This field is required on insertion.", | |
15730 "format": "date", | |
15731 "type": "string" | |
15732 }, | |
15733 "flighted": { | |
15734 "description": "Whether this placement is flighted. If true,
pricing periods will be computed automatically.", | |
15735 "type": "boolean" | |
15736 }, | |
15737 "floodlightActivityId": { | |
15738 "description": "Floodlight activity ID associated with this
placement. This field should be set when placement pricing type is set to PRICIN
G_TYPE_CPA.", | |
15739 "format": "int64", | |
15740 "type": "string" | |
15741 }, | |
15742 "pricingPeriods": { | |
15743 "description": "Pricing periods for this placement.", | |
15744 "items": { | |
15745 "$ref": "PricingSchedulePricingPeriod" | |
15746 }, | |
15747 "type": "array" | |
15748 }, | |
15749 "pricingType": { | |
15750 "description": "Placement pricing type. This field is requir
ed on insertion.", | |
15751 "enum": [ | |
15752 "PRICING_TYPE_CPA", | |
15753 "PRICING_TYPE_CPC", | |
15754 "PRICING_TYPE_CPM", | |
15755 "PRICING_TYPE_CPM_ACTIVEVIEW", | |
15756 "PRICING_TYPE_FLAT_RATE_CLICKS", | |
15757 "PRICING_TYPE_FLAT_RATE_IMPRESSIONS" | |
15758 ], | |
15759 "enumDescriptions": [ | |
15760 "", | |
15761 "", | |
15762 "", | |
15763 "", | |
15764 "", | |
15765 "" | |
15766 ], | |
15767 "type": "string" | |
15768 }, | |
15769 "startDate": { | |
15770 "description": "Placement start date. This date must be late
r than, or the same day as, the campaign start date. The hours, minutes, and sec
onds of the start date should not be set, as doing so will result in an error. T
his field is required on insertion.", | |
15771 "format": "date", | |
15772 "type": "string" | |
15773 }, | |
15774 "testingStartDate": { | |
15775 "description": "Testing start date of this placement. The ho
urs, minutes, and seconds of the start date should not be set, as doing so will
result in an error.", | |
15776 "format": "date", | |
15777 "type": "string" | |
15778 } | |
15779 }, | |
15780 "type": "object" | |
15781 }, | |
15782 "PricingSchedulePricingPeriod": { | |
15783 "description": "Pricing Period", | |
15784 "id": "PricingSchedulePricingPeriod", | |
15785 "properties": { | |
15786 "endDate": { | |
15787 "description": "Pricing period end date. This date must be l
ater than, or the same day as, the pricing period start date, but not later than
the placement end date. The period end date can be the same date as the period
start date. If, for example, you set 6/25/2015 as both the start and end dates,
the effective pricing period date is just that day only, 6/25/2015. The hours, m
inutes, and seconds of the end date should not be set, as doing so will result i
n an error.", | |
15788 "format": "date", | |
15789 "type": "string" | |
15790 }, | |
15791 "pricingComment": { | |
15792 "description": "Comments for this pricing period.", | |
15793 "type": "string" | |
15794 }, | |
15795 "rateOrCostNanos": { | |
15796 "description": "Rate or cost of this pricing period.", | |
15797 "format": "int64", | |
15798 "type": "string" | |
15799 }, | |
15800 "startDate": { | |
15801 "description": "Pricing period start date. This date must be
later than, or the same day as, the placement start date. The hours, minutes, a
nd seconds of the start date should not be set, as doing so will result in an er
ror.", | |
15802 "format": "date", | |
15803 "type": "string" | |
15804 }, | |
15805 "units": { | |
15806 "description": "Units of this pricing period.", | |
15807 "format": "int64", | |
15808 "type": "string" | |
15809 } | |
15810 }, | |
15811 "type": "object" | |
15812 }, | |
15813 "Project": { | |
15814 "description": "Contains properties of a DoubleClick Planning projec
t.", | |
15815 "id": "Project", | |
15816 "properties": { | |
15817 "accountId": { | |
15818 "description": "Account ID of this project.", | |
15819 "format": "int64", | |
15820 "type": "string" | |
15821 }, | |
15822 "advertiserId": { | |
15823 "description": "Advertiser ID of this project.", | |
15824 "format": "int64", | |
15825 "type": "string" | |
15826 }, | |
15827 "audienceAgeGroup": { | |
15828 "description": "Audience age group of this project.", | |
15829 "enum": [ | |
15830 "PLANNING_AUDIENCE_AGE_18_24", | |
15831 "PLANNING_AUDIENCE_AGE_25_34", | |
15832 "PLANNING_AUDIENCE_AGE_35_44", | |
15833 "PLANNING_AUDIENCE_AGE_45_54", | |
15834 "PLANNING_AUDIENCE_AGE_55_64", | |
15835 "PLANNING_AUDIENCE_AGE_65_OR_MORE", | |
15836 "PLANNING_AUDIENCE_AGE_UNKNOWN" | |
15837 ], | |
15838 "enumDescriptions": [ | |
15839 "", | |
15840 "", | |
15841 "", | |
15842 "", | |
15843 "", | |
15844 "", | |
15845 "" | |
15846 ], | |
15847 "type": "string" | |
15848 }, | |
15849 "audienceGender": { | |
15850 "description": "Audience gender of this project.", | |
15851 "enum": [ | |
15852 "PLANNING_AUDIENCE_GENDER_FEMALE", | |
15853 "PLANNING_AUDIENCE_GENDER_MALE" | |
15854 ], | |
15855 "enumDescriptions": [ | |
15856 "", | |
15857 "" | |
15858 ], | |
15859 "type": "string" | |
15860 }, | |
15861 "budget": { | |
15862 "description": "Budget of this project in the currency speci
fied by the current account. The value stored in this field represents only the
non-fractional amount. For example, for USD, the smallest value that can be repr
esented by this field is 1 US dollar.", | |
15863 "format": "int64", | |
15864 "type": "string" | |
15865 }, | |
15866 "clientBillingCode": { | |
15867 "description": "Client billing code of this project.", | |
15868 "type": "string" | |
15869 }, | |
15870 "clientName": { | |
15871 "description": "Name of the project client.", | |
15872 "type": "string" | |
15873 }, | |
15874 "endDate": { | |
15875 "description": "End date of the project.", | |
15876 "format": "date", | |
15877 "type": "string" | |
15878 }, | |
15879 "id": { | |
15880 "description": "ID of this project. This is a read-only, aut
o-generated field.", | |
15881 "format": "int64", | |
15882 "type": "string" | |
15883 }, | |
15884 "kind": { | |
15885 "default": "dfareporting#project", | |
15886 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#project\".", | |
15887 "type": "string" | |
15888 }, | |
15889 "lastModifiedInfo": { | |
15890 "$ref": "LastModifiedInfo", | |
15891 "description": "Information about the most recent modificati
on of this project." | |
15892 }, | |
15893 "name": { | |
15894 "description": "Name of this project.", | |
15895 "type": "string" | |
15896 }, | |
15897 "overview": { | |
15898 "description": "Overview of this project.", | |
15899 "type": "string" | |
15900 }, | |
15901 "startDate": { | |
15902 "description": "Start date of the project.", | |
15903 "format": "date", | |
15904 "type": "string" | |
15905 }, | |
15906 "subaccountId": { | |
15907 "description": "Subaccount ID of this project.", | |
15908 "format": "int64", | |
15909 "type": "string" | |
15910 }, | |
15911 "targetClicks": { | |
15912 "description": "Number of clicks that the advertiser is targ
eting.", | |
15913 "format": "int64", | |
15914 "type": "string" | |
15915 }, | |
15916 "targetConversions": { | |
15917 "description": "Number of conversions that the advertiser is
targeting.", | |
15918 "format": "int64", | |
15919 "type": "string" | |
15920 }, | |
15921 "targetCpaNanos": { | |
15922 "description": "CPA that the advertiser is targeting.", | |
15923 "format": "int64", | |
15924 "type": "string" | |
15925 }, | |
15926 "targetCpcNanos": { | |
15927 "description": "CPC that the advertiser is targeting.", | |
15928 "format": "int64", | |
15929 "type": "string" | |
15930 }, | |
15931 "targetCpmNanos": { | |
15932 "description": "CPM that the advertiser is targeting.", | |
15933 "format": "int64", | |
15934 "type": "string" | |
15935 }, | |
15936 "targetImpressions": { | |
15937 "description": "Number of impressions that the advertiser is
targeting.", | |
15938 "format": "int64", | |
15939 "type": "string" | |
15940 } | |
15941 }, | |
15942 "type": "object" | |
15943 }, | |
15944 "ProjectsListResponse": { | |
15945 "description": "Project List Response", | |
15946 "id": "ProjectsListResponse", | |
15947 "properties": { | |
15948 "kind": { | |
15949 "default": "dfareporting#projectsListResponse", | |
15950 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#projectsListResponse\".", | |
15951 "type": "string" | |
15952 }, | |
15953 "nextPageToken": { | |
15954 "description": "Pagination token to be used for the next lis
t operation.", | |
15955 "type": "string" | |
15956 }, | |
15957 "projects": { | |
15958 "description": "Project collection.", | |
15959 "items": { | |
15960 "$ref": "Project" | |
15961 }, | |
15962 "type": "array" | |
15963 } | |
15964 }, | |
15965 "type": "object" | |
15966 }, | |
15967 "ReachReportCompatibleFields": { | |
15968 "description": "Represents fields that are compatible to be selected
for a report of type \"REACH\".", | |
15969 "id": "ReachReportCompatibleFields", | |
15970 "properties": { | |
15971 "dimensionFilters": { | |
15972 "description": "Dimensions which are compatible to be select
ed in the \"dimensionFilters\" section of the report.", | |
15973 "items": { | |
15974 "$ref": "Dimension" | |
15975 }, | |
15976 "type": "array" | |
15977 }, | |
15978 "dimensions": { | |
15979 "description": "Dimensions which are compatible to be select
ed in the \"dimensions\" section of the report.", | |
15980 "items": { | |
15981 "$ref": "Dimension" | |
15982 }, | |
15983 "type": "array" | |
15984 }, | |
15985 "kind": { | |
15986 "default": "dfareporting#reachReportCompatibleFields", | |
15987 "description": "The kind of resource this is, in this case d
fareporting#reachReportCompatibleFields.", | |
15988 "type": "string" | |
15989 }, | |
15990 "metrics": { | |
15991 "description": "Metrics which are compatible to be selected
in the \"metricNames\" section of the report.", | |
15992 "items": { | |
15993 "$ref": "Metric" | |
15994 }, | |
15995 "type": "array" | |
15996 }, | |
15997 "pivotedActivityMetrics": { | |
15998 "description": "Metrics which are compatible to be selected
as activity metrics to pivot on in the \"activities\" section of the report.", | |
15999 "items": { | |
16000 "$ref": "Metric" | |
16001 }, | |
16002 "type": "array" | |
16003 }, | |
16004 "reachByFrequencyMetrics": { | |
16005 "description": "Metrics which are compatible to be selected
in the \"reachByFrequencyMetricNames\" section of the report.", | |
16006 "items": { | |
16007 "$ref": "Metric" | |
16008 }, | |
16009 "type": "array" | |
16010 } | |
16011 }, | |
16012 "type": "object" | |
16013 }, | |
16014 "Recipient": { | |
16015 "description": "Represents a recipient.", | |
16016 "id": "Recipient", | |
16017 "properties": { | |
16018 "deliveryType": { | |
16019 "annotations": { | |
16020 "required": [ | |
16021 "dfareporting.reports.insert", | |
16022 "dfareporting.reports.update" | |
16023 ] | |
16024 }, | |
16025 "description": "The delivery type for the recipient.", | |
16026 "enum": [ | |
16027 "ATTACHMENT", | |
16028 "LINK" | |
16029 ], | |
16030 "enumDescriptions": [ | |
16031 "", | |
16032 "" | |
16033 ], | |
16034 "type": "string" | |
16035 }, | |
16036 "email": { | |
16037 "annotations": { | |
16038 "required": [ | |
16039 "dfareporting.reports.insert", | |
16040 "dfareporting.reports.update" | |
16041 ] | |
16042 }, | |
16043 "description": "The email address of the recipient.", | |
16044 "type": "string" | |
16045 }, | |
16046 "kind": { | |
16047 "default": "dfareporting#recipient", | |
16048 "description": "The kind of resource this is, in this case d
fareporting#recipient.", | |
16049 "type": "string" | |
16050 } | |
16051 }, | |
16052 "type": "object" | |
16053 }, | |
16054 "Region": { | |
16055 "description": "Contains information about a region that can be targ
eted by ads.", | |
16056 "id": "Region", | |
16057 "properties": { | |
16058 "countryCode": { | |
16059 "description": "Country code of the country to which this re
gion belongs.", | |
16060 "type": "string" | |
16061 }, | |
16062 "countryDartId": { | |
16063 "description": "DART ID of the country to which this region
belongs.", | |
16064 "format": "int64", | |
16065 "type": "string" | |
16066 }, | |
16067 "dartId": { | |
16068 "description": "DART ID of this region.", | |
16069 "format": "int64", | |
16070 "type": "string" | |
16071 }, | |
16072 "kind": { | |
16073 "default": "dfareporting#region", | |
16074 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#region\".", | |
16075 "type": "string" | |
16076 }, | |
16077 "name": { | |
16078 "description": "Name of this region.", | |
16079 "type": "string" | |
16080 }, | |
16081 "regionCode": { | |
16082 "description": "Region code.", | |
16083 "type": "string" | |
16084 } | |
16085 }, | |
16086 "type": "object" | |
16087 }, | |
16088 "RegionsListResponse": { | |
16089 "description": "Region List Response", | |
16090 "id": "RegionsListResponse", | |
16091 "properties": { | |
16092 "kind": { | |
16093 "default": "dfareporting#regionsListResponse", | |
16094 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#regionsListResponse\".", | |
16095 "type": "string" | |
16096 }, | |
16097 "regions": { | |
16098 "description": "Region collection.", | |
16099 "items": { | |
16100 "$ref": "Region" | |
16101 }, | |
16102 "type": "array" | |
16103 } | |
16104 }, | |
16105 "type": "object" | |
16106 }, | |
16107 "RemarketingList": { | |
16108 "description": "Contains properties of a remarketing list. Remarketi
ng enables you to create lists of users who have performed specific actions on a
site, then target ads to members of those lists. This resource can be used to m
anage remarketing lists that are owned by your advertisers. To see all remarketi
ng lists that are visible to your advertisers, including those that are shared t
o your advertiser or account, use the TargetableRemarketingLists resource.", | |
16109 "id": "RemarketingList", | |
16110 "properties": { | |
16111 "accountId": { | |
16112 "description": "Account ID of this remarketing list. This is
a read-only, auto-generated field that is only returned in GET requests.", | |
16113 "format": "int64", | |
16114 "type": "string" | |
16115 }, | |
16116 "active": { | |
16117 "description": "Whether this remarketing list is active.", | |
16118 "type": "boolean" | |
16119 }, | |
16120 "advertiserId": { | |
16121 "description": "Dimension value for the advertiser ID that o
wns this remarketing list. This is a required field.", | |
16122 "format": "int64", | |
16123 "type": "string" | |
16124 }, | |
16125 "advertiserIdDimensionValue": { | |
16126 "$ref": "DimensionValue", | |
16127 "description": "Dimension value for the ID of the advertiser
. This is a read-only, auto-generated field." | |
16128 }, | |
16129 "description": { | |
16130 "description": "Remarketing list description.", | |
16131 "type": "string" | |
16132 }, | |
16133 "id": { | |
16134 "description": "Remarketing list ID. This is a read-only, au
to-generated field.", | |
16135 "format": "int64", | |
16136 "type": "string" | |
16137 }, | |
16138 "kind": { | |
16139 "default": "dfareporting#remarketingList", | |
16140 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#remarketingList\".", | |
16141 "type": "string" | |
16142 }, | |
16143 "lifeSpan": { | |
16144 "description": "Number of days that a user should remain in
the remarketing list without an impression.", | |
16145 "format": "int64", | |
16146 "type": "string" | |
16147 }, | |
16148 "listPopulationRule": { | |
16149 "$ref": "ListPopulationRule", | |
16150 "description": "Rule used to populate the remarketing list w
ith users." | |
16151 }, | |
16152 "listSize": { | |
16153 "description": "Number of users currently in the list. This
is a read-only field.", | |
16154 "format": "int64", | |
16155 "type": "string" | |
16156 }, | |
16157 "listSource": { | |
16158 "description": "Product from which this remarketing list was
originated.", | |
16159 "enum": [ | |
16160 "REMARKETING_LIST_SOURCE_ADX", | |
16161 "REMARKETING_LIST_SOURCE_DBM", | |
16162 "REMARKETING_LIST_SOURCE_DFA", | |
16163 "REMARKETING_LIST_SOURCE_DFP", | |
16164 "REMARKETING_LIST_SOURCE_DMP", | |
16165 "REMARKETING_LIST_SOURCE_GA", | |
16166 "REMARKETING_LIST_SOURCE_GPLUS", | |
16167 "REMARKETING_LIST_SOURCE_OTHER", | |
16168 "REMARKETING_LIST_SOURCE_PLAY_STORE", | |
16169 "REMARKETING_LIST_SOURCE_XFP", | |
16170 "REMARKETING_LIST_SOURCE_YOUTUBE" | |
16171 ], | |
16172 "enumDescriptions": [ | |
16173 "", | |
16174 "", | |
16175 "", | |
16176 "", | |
16177 "", | |
16178 "", | |
16179 "", | |
16180 "", | |
16181 "", | |
16182 "", | |
16183 "" | |
16184 ], | |
16185 "type": "string" | |
16186 }, | |
16187 "name": { | |
16188 "description": "Name of the remarketing list. This is a requ
ired field. Must be no greater than 128 characters long.", | |
16189 "type": "string" | |
16190 }, | |
16191 "subaccountId": { | |
16192 "description": "Subaccount ID of this remarketing list. This
is a read-only, auto-generated field that is only returned in GET requests.", | |
16193 "format": "int64", | |
16194 "type": "string" | |
16195 } | |
16196 }, | |
16197 "type": "object" | |
16198 }, | |
16199 "RemarketingListShare": { | |
16200 "description": "Contains properties of a remarketing list's sharing
information. Sharing allows other accounts or advertisers to target to your rema
rketing lists. This resource can be used to manage remarketing list sharing to o
ther accounts and advertisers.", | |
16201 "id": "RemarketingListShare", | |
16202 "properties": { | |
16203 "kind": { | |
16204 "default": "dfareporting#remarketingListShare", | |
16205 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#remarketingListShare\".", | |
16206 "type": "string" | |
16207 }, | |
16208 "remarketingListId": { | |
16209 "description": "Remarketing list ID. This is a read-only, au
to-generated field.", | |
16210 "format": "int64", | |
16211 "type": "string" | |
16212 }, | |
16213 "sharedAccountIds": { | |
16214 "description": "Accounts that the remarketing list is shared
with.", | |
16215 "items": { | |
16216 "format": "int64", | |
16217 "type": "string" | |
16218 }, | |
16219 "type": "array" | |
16220 }, | |
16221 "sharedAdvertiserIds": { | |
16222 "description": "Advertisers that the remarketing list is sha
red with.", | |
16223 "items": { | |
16224 "format": "int64", | |
16225 "type": "string" | |
16226 }, | |
16227 "type": "array" | |
16228 } | |
16229 }, | |
16230 "type": "object" | |
16231 }, | |
16232 "RemarketingListsListResponse": { | |
16233 "description": "Remarketing list response", | |
16234 "id": "RemarketingListsListResponse", | |
16235 "properties": { | |
16236 "kind": { | |
16237 "default": "dfareporting#remarketingListsListResponse", | |
16238 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#remarketingListsListResponse\".", | |
16239 "type": "string" | |
16240 }, | |
16241 "nextPageToken": { | |
16242 "description": "Pagination token to be used for the next lis
t operation.", | |
16243 "type": "string" | |
16244 }, | |
16245 "remarketingLists": { | |
16246 "description": "Remarketing list collection.", | |
16247 "items": { | |
16248 "$ref": "RemarketingList" | |
16249 }, | |
16250 "type": "array" | |
16251 } | |
16252 }, | |
16253 "type": "object" | |
16254 }, | |
16255 "Report": { | |
16256 "description": "Represents a Report resource.", | |
16257 "id": "Report", | |
16258 "properties": { | |
16259 "accountId": { | |
16260 "annotations": { | |
16261 "required": [ | |
16262 "dfareporting.reports.update" | |
16263 ] | |
16264 }, | |
16265 "description": "The account ID to which this report belongs.
", | |
16266 "format": "int64", | |
16267 "type": "string" | |
16268 }, | |
16269 "criteria": { | |
16270 "description": "The report criteria for a report of type \"S
TANDARD\".", | |
16271 "properties": { | |
16272 "activities": { | |
16273 "$ref": "Activities", | |
16274 "description": "Activity group." | |
16275 }, | |
16276 "customRichMediaEvents": { | |
16277 "$ref": "CustomRichMediaEvents", | |
16278 "description": "Custom Rich Media Events group." | |
16279 }, | |
16280 "dateRange": { | |
16281 "$ref": "DateRange", | |
16282 "description": "The date range for which this report
should be run." | |
16283 }, | |
16284 "dimensionFilters": { | |
16285 "description": "The list of filters on which dimensi
ons are filtered.\nFilters for different dimensions are ANDed, filters for the s
ame dimension are grouped together and ORed.", | |
16286 "items": { | |
16287 "$ref": "DimensionValue" | |
16288 }, | |
16289 "type": "array" | |
16290 }, | |
16291 "dimensions": { | |
16292 "description": "The list of standard dimensions the
report should include.", | |
16293 "items": { | |
16294 "$ref": "SortedDimension" | |
16295 }, | |
16296 "type": "array" | |
16297 }, | |
16298 "metricNames": { | |
16299 "description": "The list of names of metrics the rep
ort should include.", | |
16300 "items": { | |
16301 "type": "string" | |
16302 }, | |
16303 "type": "array" | |
16304 } | |
16305 }, | |
16306 "type": "object" | |
16307 }, | |
16308 "crossDimensionReachCriteria": { | |
16309 "description": "The report criteria for a report of type \"C
ROSS_DIMENSION_REACH\".", | |
16310 "properties": { | |
16311 "breakdown": { | |
16312 "description": "The list of dimensions the report sh
ould include.", | |
16313 "items": { | |
16314 "$ref": "SortedDimension" | |
16315 }, | |
16316 "type": "array" | |
16317 }, | |
16318 "dateRange": { | |
16319 "$ref": "DateRange", | |
16320 "description": "The date range this report should be
run for." | |
16321 }, | |
16322 "dimension": { | |
16323 "description": "The dimension option.", | |
16324 "enum": [ | |
16325 "ADVERTISER", | |
16326 "CAMPAIGN", | |
16327 "SITE_BY_ADVERTISER", | |
16328 "SITE_BY_CAMPAIGN" | |
16329 ], | |
16330 "enumDescriptions": [ | |
16331 "", | |
16332 "", | |
16333 "", | |
16334 "" | |
16335 ], | |
16336 "type": "string" | |
16337 }, | |
16338 "dimensionFilters": { | |
16339 "description": "The list of filters on which dimensi
ons are filtered.", | |
16340 "items": { | |
16341 "$ref": "DimensionValue" | |
16342 }, | |
16343 "type": "array" | |
16344 }, | |
16345 "metricNames": { | |
16346 "description": "The list of names of metrics the rep
ort should include.", | |
16347 "items": { | |
16348 "type": "string" | |
16349 }, | |
16350 "type": "array" | |
16351 }, | |
16352 "overlapMetricNames": { | |
16353 "description": "The list of names of overlap metrics
the report should include.", | |
16354 "items": { | |
16355 "type": "string" | |
16356 }, | |
16357 "type": "array" | |
16358 }, | |
16359 "pivoted": { | |
16360 "description": "Whether the report is pivoted or not
. Defaults to true.", | |
16361 "type": "boolean" | |
16362 } | |
16363 }, | |
16364 "type": "object" | |
16365 }, | |
16366 "delivery": { | |
16367 "description": "The report's email delivery settings.", | |
16368 "properties": { | |
16369 "emailOwner": { | |
16370 "description": "Whether the report should be emailed
to the report owner.", | |
16371 "type": "boolean" | |
16372 }, | |
16373 "emailOwnerDeliveryType": { | |
16374 "description": "The type of delivery for the owner t
o receive, if enabled.", | |
16375 "enum": [ | |
16376 "ATTACHMENT", | |
16377 "LINK" | |
16378 ], | |
16379 "enumDescriptions": [ | |
16380 "", | |
16381 "" | |
16382 ], | |
16383 "type": "string" | |
16384 }, | |
16385 "message": { | |
16386 "description": "The message to be sent with each ema
il.", | |
16387 "type": "string" | |
16388 }, | |
16389 "recipients": { | |
16390 "description": "The list of recipients to which to e
mail the report.", | |
16391 "items": { | |
16392 "$ref": "Recipient" | |
16393 }, | |
16394 "type": "array" | |
16395 } | |
16396 }, | |
16397 "type": "object" | |
16398 }, | |
16399 "etag": { | |
16400 "description": "The eTag of this response for caching purpos
es.", | |
16401 "type": "string" | |
16402 }, | |
16403 "fileName": { | |
16404 "description": "The filename used when generating report fil
es for this report.", | |
16405 "type": "string" | |
16406 }, | |
16407 "floodlightCriteria": { | |
16408 "description": "The report criteria for a report of type \"F
LOODLIGHT\".", | |
16409 "properties": { | |
16410 "customRichMediaEvents": { | |
16411 "description": "The list of custom rich media events
to include.", | |
16412 "items": { | |
16413 "$ref": "DimensionValue" | |
16414 }, | |
16415 "type": "array" | |
16416 }, | |
16417 "dateRange": { | |
16418 "$ref": "DateRange", | |
16419 "description": "The date range this report should be
run for." | |
16420 }, | |
16421 "dimensionFilters": { | |
16422 "description": "The list of filters on which dimensi
ons are filtered.\nFilters for different dimensions are ANDed, filters for the s
ame dimension are grouped together and ORed.", | |
16423 "items": { | |
16424 "$ref": "DimensionValue" | |
16425 }, | |
16426 "type": "array" | |
16427 }, | |
16428 "dimensions": { | |
16429 "description": "The list of dimensions the report sh
ould include.", | |
16430 "items": { | |
16431 "$ref": "SortedDimension" | |
16432 }, | |
16433 "type": "array" | |
16434 }, | |
16435 "floodlightConfigId": { | |
16436 "$ref": "DimensionValue", | |
16437 "description": "The floodlight ID for which to show
data in this report. All advertisers associated with that ID will automatically
be added. The dimension of the value needs to be 'dfa:floodlightConfigId'." | |
16438 }, | |
16439 "metricNames": { | |
16440 "description": "The list of names of metrics the rep
ort should include.", | |
16441 "items": { | |
16442 "type": "string" | |
16443 }, | |
16444 "type": "array" | |
16445 }, | |
16446 "reportProperties": { | |
16447 "description": "The properties of the report.", | |
16448 "properties": { | |
16449 "includeAttributedIPConversions": { | |
16450 "description": "Include conversions that hav
e no cookie, but do have an exposure path.", | |
16451 "type": "boolean" | |
16452 }, | |
16453 "includeUnattributedCookieConversions": { | |
16454 "description": "Include conversions of users
with a DoubleClick cookie but without an exposure. That means the user did not
click or see an ad from the advertiser within the Floodlight group, or that the
interaction happened outside the lookback window.", | |
16455 "type": "boolean" | |
16456 }, | |
16457 "includeUnattributedIPConversions": { | |
16458 "description": "Include conversions that hav
e no associated cookies and no exposures. It’s therefore impossible to know how
the user was exposed to your ads during the lookback window prior to a conversio
n.", | |
16459 "type": "boolean" | |
16460 } | |
16461 }, | |
16462 "type": "object" | |
16463 } | |
16464 }, | |
16465 "type": "object" | |
16466 }, | |
16467 "format": { | |
16468 "description": "The output format of the report. If not spec
ified, default format is \"CSV\". Note that the actual format in the completed r
eport file might differ if for instance the report's size exceeds the format's c
apabilities. \"CSV\" will then be the fallback format.", | |
16469 "enum": [ | |
16470 "CSV", | |
16471 "EXCEL" | |
16472 ], | |
16473 "enumDescriptions": [ | |
16474 "", | |
16475 "" | |
16476 ], | |
16477 "type": "string" | |
16478 }, | |
16479 "id": { | |
16480 "annotations": { | |
16481 "required": [ | |
16482 "dfareporting.reports.update" | |
16483 ] | |
16484 }, | |
16485 "description": "The unique ID identifying this report resour
ce.", | |
16486 "format": "int64", | |
16487 "type": "string" | |
16488 }, | |
16489 "kind": { | |
16490 "default": "dfareporting#report", | |
16491 "description": "The kind of resource this is, in this case d
fareporting#report.", | |
16492 "type": "string" | |
16493 }, | |
16494 "lastModifiedTime": { | |
16495 "annotations": { | |
16496 "required": [ | |
16497 "dfareporting.reports.update" | |
16498 ] | |
16499 }, | |
16500 "description": "The timestamp (in milliseconds since epoch)
of when this report was last modified.", | |
16501 "format": "uint64", | |
16502 "type": "string" | |
16503 }, | |
16504 "name": { | |
16505 "annotations": { | |
16506 "required": [ | |
16507 "dfareporting.reports.insert", | |
16508 "dfareporting.reports.update" | |
16509 ] | |
16510 }, | |
16511 "description": "The name of the report.", | |
16512 "type": "string" | |
16513 }, | |
16514 "ownerProfileId": { | |
16515 "annotations": { | |
16516 "required": [ | |
16517 "dfareporting.reports.update" | |
16518 ] | |
16519 }, | |
16520 "description": "The user profile id of the owner of this rep
ort.", | |
16521 "format": "int64", | |
16522 "type": "string" | |
16523 }, | |
16524 "pathToConversionCriteria": { | |
16525 "description": "The report criteria for a report of type \"P
ATH_TO_CONVERSION\".", | |
16526 "properties": { | |
16527 "activityFilters": { | |
16528 "description": "The list of 'dfa:activity' values to
filter on.", | |
16529 "items": { | |
16530 "$ref": "DimensionValue" | |
16531 }, | |
16532 "type": "array" | |
16533 }, | |
16534 "conversionDimensions": { | |
16535 "description": "The list of conversion dimensions th
e report should include.", | |
16536 "items": { | |
16537 "$ref": "SortedDimension" | |
16538 }, | |
16539 "type": "array" | |
16540 }, | |
16541 "customFloodlightVariables": { | |
16542 "description": "The list of custom floodlight variab
les the report should include.", | |
16543 "items": { | |
16544 "$ref": "SortedDimension" | |
16545 }, | |
16546 "type": "array" | |
16547 }, | |
16548 "customRichMediaEvents": { | |
16549 "description": "The list of custom rich media events
to include.", | |
16550 "items": { | |
16551 "$ref": "DimensionValue" | |
16552 }, | |
16553 "type": "array" | |
16554 }, | |
16555 "dateRange": { | |
16556 "$ref": "DateRange", | |
16557 "description": "The date range this report should be
run for." | |
16558 }, | |
16559 "floodlightConfigId": { | |
16560 "$ref": "DimensionValue", | |
16561 "description": "The floodlight ID for which to show
data in this report. All advertisers associated with that ID will automatically
be added. The dimension of the value needs to be 'dfa:floodlightConfigId'." | |
16562 }, | |
16563 "metricNames": { | |
16564 "description": "The list of names of metrics the rep
ort should include.", | |
16565 "items": { | |
16566 "type": "string" | |
16567 }, | |
16568 "type": "array" | |
16569 }, | |
16570 "perInteractionDimensions": { | |
16571 "description": "The list of per interaction dimensio
ns the report should include.", | |
16572 "items": { | |
16573 "$ref": "SortedDimension" | |
16574 }, | |
16575 "type": "array" | |
16576 }, | |
16577 "reportProperties": { | |
16578 "description": "The properties of the report.", | |
16579 "properties": { | |
16580 "clicksLookbackWindow": { | |
16581 "description": "DFA checks to see if a click
interaction occurred within the specified period of time before a conversion. B
y default the value is pulled from Floodlight or you can manually enter a custom
value. Valid values: 1-90.", | |
16582 "format": "int32", | |
16583 "type": "integer" | |
16584 }, | |
16585 "impressionsLookbackWindow": { | |
16586 "description": "DFA checks to see if an impr
ession interaction occurred within the specified period of time before a convers
ion. By default the value is pulled from Floodlight or you can manually enter a
custom value. Valid values: 1-90.", | |
16587 "format": "int32", | |
16588 "type": "integer" | |
16589 }, | |
16590 "includeAttributedIPConversions": { | |
16591 "description": "Deprecated: has no effect.", | |
16592 "type": "boolean" | |
16593 }, | |
16594 "includeUnattributedCookieConversions": { | |
16595 "description": "Include conversions of users
with a DoubleClick cookie but without an exposure. That means the user did not
click or see an ad from the advertiser within the Floodlight group, or that the
interaction happened outside the lookback window.", | |
16596 "type": "boolean" | |
16597 }, | |
16598 "includeUnattributedIPConversions": { | |
16599 "description": "Include conversions that hav
e no associated cookies and no exposures. It’s therefore impossible to know how
the user was exposed to your ads during the lookback window prior to a conversio
n.", | |
16600 "type": "boolean" | |
16601 }, | |
16602 "maximumClickInteractions": { | |
16603 "description": "The maximum number of click
interactions to include in the report. Advertisers currently paying for E2C repo
rts get up to 200 (100 clicks, 100 impressions). If another advertiser in your n
etwork is paying for E2C, you can have up to 5 total exposures per report.", | |
16604 "format": "int32", | |
16605 "type": "integer" | |
16606 }, | |
16607 "maximumImpressionInteractions": { | |
16608 "description": "The maximum number of click
interactions to include in the report. Advertisers currently paying for E2C repo
rts get up to 200 (100 clicks, 100 impressions). If another advertiser in your n
etwork is paying for E2C, you can have up to 5 total exposures per report.", | |
16609 "format": "int32", | |
16610 "type": "integer" | |
16611 }, | |
16612 "maximumInteractionGap": { | |
16613 "description": "The maximum amount of time t
hat can take place between interactions (clicks or impressions) by the same user
. Valid values: 1-90.", | |
16614 "format": "int32", | |
16615 "type": "integer" | |
16616 }, | |
16617 "pivotOnInteractionPath": { | |
16618 "description": "Enable pivoting on interacti
on path.", | |
16619 "type": "boolean" | |
16620 } | |
16621 }, | |
16622 "type": "object" | |
16623 } | |
16624 }, | |
16625 "type": "object" | |
16626 }, | |
16627 "reachCriteria": { | |
16628 "description": "The report criteria for a report of type \"R
EACH\".", | |
16629 "properties": { | |
16630 "activities": { | |
16631 "$ref": "Activities", | |
16632 "description": "Activity group." | |
16633 }, | |
16634 "customRichMediaEvents": { | |
16635 "$ref": "CustomRichMediaEvents", | |
16636 "description": "Custom Rich Media Events group." | |
16637 }, | |
16638 "dateRange": { | |
16639 "$ref": "DateRange", | |
16640 "description": "The date range this report should be
run for." | |
16641 }, | |
16642 "dimensionFilters": { | |
16643 "description": "The list of filters on which dimensi
ons are filtered.\nFilters for different dimensions are ANDed, filters for the s
ame dimension are grouped together and ORed.", | |
16644 "items": { | |
16645 "$ref": "DimensionValue" | |
16646 }, | |
16647 "type": "array" | |
16648 }, | |
16649 "dimensions": { | |
16650 "description": "The list of dimensions the report sh
ould include.", | |
16651 "items": { | |
16652 "$ref": "SortedDimension" | |
16653 }, | |
16654 "type": "array" | |
16655 }, | |
16656 "enableAllDimensionCombinations": { | |
16657 "description": "Whether to enable all reach dimensio
n combinations in the report. Defaults to false. If enabled, the date range of t
he report should be within the last three months.", | |
16658 "type": "boolean" | |
16659 }, | |
16660 "metricNames": { | |
16661 "description": "The list of names of metrics the rep
ort should include.", | |
16662 "items": { | |
16663 "type": "string" | |
16664 }, | |
16665 "type": "array" | |
16666 }, | |
16667 "reachByFrequencyMetricNames": { | |
16668 "description": "The list of names of Reach By Frequ
ency metrics the report should include.", | |
16669 "items": { | |
16670 "type": "string" | |
16671 }, | |
16672 "type": "array" | |
16673 } | |
16674 }, | |
16675 "type": "object" | |
16676 }, | |
16677 "schedule": { | |
16678 "description": "The report's schedule. Can only be set if th
e report's 'dateRange' is a relative date range and the relative date range is n
ot \"TODAY\".", | |
16679 "properties": { | |
16680 "active": { | |
16681 "annotations": { | |
16682 "required": [ | |
16683 "dfareporting.reports.insert", | |
16684 "dfareporting.reports.update" | |
16685 ] | |
16686 }, | |
16687 "description": "Whether the schedule is active or no
t. Must be set to either true or false.", | |
16688 "type": "boolean" | |
16689 }, | |
16690 "every": { | |
16691 "description": "Defines every how many days, weeks o
r months the report should be run. Needs to be set when \"repeats\" is either \"
DAILY\", \"WEEKLY\" or \"MONTHLY\".", | |
16692 "format": "int32", | |
16693 "type": "integer" | |
16694 }, | |
16695 "expirationDate": { | |
16696 "annotations": { | |
16697 "required": [ | |
16698 "dfareporting.reports.insert", | |
16699 "dfareporting.reports.update" | |
16700 ] | |
16701 }, | |
16702 "description": "The expiration date when the schedul
ed report stops running.", | |
16703 "format": "date", | |
16704 "type": "string" | |
16705 }, | |
16706 "repeats": { | |
16707 "annotations": { | |
16708 "required": [ | |
16709 "dfareporting.reports.insert", | |
16710 "dfareporting.reports.update" | |
16711 ] | |
16712 }, | |
16713 "description": "The interval for which the report is
repeated. Note: \n- \"DAILY\" also requires field \"every\" to be set. \n- \"W
EEKLY\" also requires fields \"every\" and \"repeatsOnWeekDays\" to be set. \n-
\"MONTHLY\" also requires fields \"every\" and \"runsOnDayOfMonth\" to be set.", | |
16714 "type": "string" | |
16715 }, | |
16716 "repeatsOnWeekDays": { | |
16717 "description": "List of week days \"WEEKLY\" on whic
h scheduled reports should run.", | |
16718 "items": { | |
16719 "enum": [ | |
16720 "FRIDAY", | |
16721 "MONDAY", | |
16722 "SATURDAY", | |
16723 "SUNDAY", | |
16724 "THURSDAY", | |
16725 "TUESDAY", | |
16726 "WEDNESDAY" | |
16727 ], | |
16728 "enumDescriptions": [ | |
16729 "", | |
16730 "", | |
16731 "", | |
16732 "", | |
16733 "", | |
16734 "", | |
16735 "" | |
16736 ], | |
16737 "type": "string" | |
16738 }, | |
16739 "type": "array" | |
16740 }, | |
16741 "runsOnDayOfMonth": { | |
16742 "description": "Enum to define for \"MONTHLY\" sched
uled reports whether reports should be repeated on the same day of the month as
\"startDate\" or the same day of the week of the month.\nExample: If 'startDate'
is Monday, April 2nd 2012 (2012-04-02), \"DAY_OF_MONTH\" would run subsequent r
eports on the 2nd of every Month, and \"WEEK_OF_MONTH\" would run subsequent rep
orts on the first Monday of the month.", | |
16743 "enum": [ | |
16744 "DAY_OF_MONTH", | |
16745 "WEEK_OF_MONTH" | |
16746 ], | |
16747 "enumDescriptions": [ | |
16748 "", | |
16749 "" | |
16750 ], | |
16751 "type": "string" | |
16752 }, | |
16753 "startDate": { | |
16754 "annotations": { | |
16755 "required": [ | |
16756 "dfareporting.reports.insert", | |
16757 "dfareporting.reports.update" | |
16758 ] | |
16759 }, | |
16760 "description": "Start date of date range for which s
cheduled reports should be run.", | |
16761 "format": "date", | |
16762 "type": "string" | |
16763 } | |
16764 }, | |
16765 "type": "object" | |
16766 }, | |
16767 "subAccountId": { | |
16768 "description": "The subaccount ID to which this report belon
gs if applicable.", | |
16769 "format": "int64", | |
16770 "type": "string" | |
16771 }, | |
16772 "type": { | |
16773 "annotations": { | |
16774 "required": [ | |
16775 "dfareporting.reports.insert", | |
16776 "dfareporting.reports.update" | |
16777 ] | |
16778 }, | |
16779 "description": "The type of the report.", | |
16780 "enum": [ | |
16781 "CROSS_DIMENSION_REACH", | |
16782 "FLOODLIGHT", | |
16783 "PATH_TO_CONVERSION", | |
16784 "REACH", | |
16785 "STANDARD" | |
16786 ], | |
16787 "enumDescriptions": [ | |
16788 "", | |
16789 "", | |
16790 "", | |
16791 "", | |
16792 "" | |
16793 ], | |
16794 "type": "string" | |
16795 } | |
16796 }, | |
16797 "type": "object" | |
16798 }, | |
16799 "ReportCompatibleFields": { | |
16800 "description": "Represents fields that are compatible to be selected
for a report of type \"STANDARD\".", | |
16801 "id": "ReportCompatibleFields", | |
16802 "properties": { | |
16803 "dimensionFilters": { | |
16804 "description": "Dimensions which are compatible to be select
ed in the \"dimensionFilters\" section of the report.", | |
16805 "items": { | |
16806 "$ref": "Dimension" | |
16807 }, | |
16808 "type": "array" | |
16809 }, | |
16810 "dimensions": { | |
16811 "description": "Dimensions which are compatible to be select
ed in the \"dimensions\" section of the report.", | |
16812 "items": { | |
16813 "$ref": "Dimension" | |
16814 }, | |
16815 "type": "array" | |
16816 }, | |
16817 "kind": { | |
16818 "default": "dfareporting#reportCompatibleFields", | |
16819 "description": "The kind of resource this is, in this case d
fareporting#reportCompatibleFields.", | |
16820 "type": "string" | |
16821 }, | |
16822 "metrics": { | |
16823 "description": "Metrics which are compatible to be selected
in the \"metricNames\" section of the report.", | |
16824 "items": { | |
16825 "$ref": "Metric" | |
16826 }, | |
16827 "type": "array" | |
16828 }, | |
16829 "pivotedActivityMetrics": { | |
16830 "description": "Metrics which are compatible to be selected
as activity metrics to pivot on in the \"activities\" section of the report.", | |
16831 "items": { | |
16832 "$ref": "Metric" | |
16833 }, | |
16834 "type": "array" | |
16835 } | |
16836 }, | |
16837 "type": "object" | |
16838 }, | |
16839 "ReportList": { | |
16840 "description": "Represents the list of reports.", | |
16841 "id": "ReportList", | |
16842 "properties": { | |
16843 "etag": { | |
16844 "description": "The eTag of this response for caching purpos
es.", | |
16845 "type": "string" | |
16846 }, | |
16847 "items": { | |
16848 "description": "The reports returned in this response.", | |
16849 "items": { | |
16850 "$ref": "Report" | |
16851 }, | |
16852 "type": "array" | |
16853 }, | |
16854 "kind": { | |
16855 "default": "dfareporting#reportList", | |
16856 "description": "The kind of list this is, in this case dfare
porting#reportList.", | |
16857 "type": "string" | |
16858 }, | |
16859 "nextPageToken": { | |
16860 "description": "Continuation token used to page through repo
rts. To retrieve the next page of results, set the next request's \"pageToken\"
to the value of this field. The page token is only valid for a limited amount of
time and should not be persisted.", | |
16861 "type": "string" | |
16862 } | |
16863 }, | |
16864 "type": "object" | |
16865 }, | |
16866 "ReportsConfiguration": { | |
16867 "description": "Reporting Configuration", | |
16868 "id": "ReportsConfiguration", | |
16869 "properties": { | |
16870 "exposureToConversionEnabled": { | |
16871 "description": "Whether the exposure to conversion report is
enabled. This report shows detailed pathway information on up to 10 of the most
recent ad exposures seen by a user before converting.", | |
16872 "type": "boolean" | |
16873 }, | |
16874 "lookbackConfiguration": { | |
16875 "$ref": "LookbackConfiguration", | |
16876 "description": "Default lookback windows for new advertisers
in this account." | |
16877 }, | |
16878 "reportGenerationTimeZoneId": { | |
16879 "description": "Report generation time zone ID of this accou
nt. This is a required field that can only be changed by a superuser.\nAcceptabl
e values are:\n\n- \"1\" for \"America/New_York\" \n- \"2\" for \"Europe/London\
" \n- \"3\" for \"Europe/Paris\" \n- \"4\" for \"Africa/Johannesburg\" \n- \"5\"
for \"Asia/Jerusalem\" \n- \"6\" for \"Asia/Shanghai\" \n- \"7\" for \"Asia/Hon
g_Kong\" \n- \"8\" for \"Asia/Tokyo\" \n- \"9\" for \"Australia/Sydney\" \n- \"1
0\" for \"Asia/Dubai\" \n- \"11\" for \"America/Los_Angeles\" \n- \"12\" for \"P
acific/Auckland\" \n- \"13\" for \"America/Sao_Paulo\"", | |
16880 "format": "int64", | |
16881 "type": "string" | |
16882 } | |
16883 }, | |
16884 "type": "object" | |
16885 }, | |
16886 "RichMediaExitOverride": { | |
16887 "description": "Rich Media Exit Override.", | |
16888 "id": "RichMediaExitOverride", | |
16889 "properties": { | |
16890 "customExitUrl": { | |
16891 "description": "Click-through URL to override the default ex
it URL. Applicable if the useCustomExitUrl field is set to true.", | |
16892 "type": "string" | |
16893 }, | |
16894 "exitId": { | |
16895 "description": "ID for the override to refer to a specific e
xit in the creative.", | |
16896 "format": "int64", | |
16897 "type": "string" | |
16898 }, | |
16899 "useCustomExitUrl": { | |
16900 "description": "Whether to use the custom exit URL.", | |
16901 "type": "boolean" | |
16902 } | |
16903 }, | |
16904 "type": "object" | |
16905 }, | |
16906 "Site": { | |
16907 "description": "Contains properties of a site.", | |
16908 "id": "Site", | |
16909 "properties": { | |
16910 "accountId": { | |
16911 "description": "Account ID of this site. This is a read-only
field that can be left blank.", | |
16912 "format": "int64", | |
16913 "type": "string" | |
16914 }, | |
16915 "approved": { | |
16916 "description": "Whether this site is approved.", | |
16917 "type": "boolean" | |
16918 }, | |
16919 "directorySiteId": { | |
16920 "description": "Directory site associated with this site. Th
is is a required field that is read-only after insertion.", | |
16921 "format": "int64", | |
16922 "type": "string" | |
16923 }, | |
16924 "directorySiteIdDimensionValue": { | |
16925 "$ref": "DimensionValue", | |
16926 "description": "Dimension value for the ID of the directory
site. This is a read-only, auto-generated field." | |
16927 }, | |
16928 "id": { | |
16929 "description": "ID of this site. This is a read-only, auto-g
enerated field.", | |
16930 "format": "int64", | |
16931 "type": "string" | |
16932 }, | |
16933 "idDimensionValue": { | |
16934 "$ref": "DimensionValue", | |
16935 "description": "Dimension value for the ID of this site. Thi
s is a read-only, auto-generated field." | |
16936 }, | |
16937 "keyName": { | |
16938 "description": "Key name of this site. This is a read-only,
auto-generated field.", | |
16939 "type": "string" | |
16940 }, | |
16941 "kind": { | |
16942 "default": "dfareporting#site", | |
16943 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#site\".", | |
16944 "type": "string" | |
16945 }, | |
16946 "name": { | |
16947 "description": "Name of this site.This is a required field.
Must be less than 128 characters long. If this site is under a subaccount, the n
ame must be unique among sites of the same subaccount. Otherwise, this site is a
top-level site, and the name must be unique among top-level sites of the same a
ccount.", | |
16948 "type": "string" | |
16949 }, | |
16950 "siteContacts": { | |
16951 "description": "Site contacts.", | |
16952 "items": { | |
16953 "$ref": "SiteContact" | |
16954 }, | |
16955 "type": "array" | |
16956 }, | |
16957 "siteSettings": { | |
16958 "$ref": "SiteSettings", | |
16959 "description": "Site-wide settings." | |
16960 }, | |
16961 "subaccountId": { | |
16962 "description": "Subaccount ID of this site. This is a read-o
nly field that can be left blank.", | |
16963 "format": "int64", | |
16964 "type": "string" | |
16965 } | |
16966 }, | |
16967 "type": "object" | |
16968 }, | |
16969 "SiteContact": { | |
16970 "description": "Site Contact", | |
16971 "id": "SiteContact", | |
16972 "properties": { | |
16973 "address": { | |
16974 "description": "Address of this site contact.", | |
16975 "type": "string" | |
16976 }, | |
16977 "contactType": { | |
16978 "description": "Site contact type.", | |
16979 "enum": [ | |
16980 "SALES_PERSON", | |
16981 "TRAFFICKER" | |
16982 ], | |
16983 "enumDescriptions": [ | |
16984 "", | |
16985 "" | |
16986 ], | |
16987 "type": "string" | |
16988 }, | |
16989 "email": { | |
16990 "description": "Email address of this site contact. This is
a required field.", | |
16991 "type": "string" | |
16992 }, | |
16993 "firstName": { | |
16994 "description": "First name of this site contact.", | |
16995 "type": "string" | |
16996 }, | |
16997 "id": { | |
16998 "description": "ID of this site contact. This is a read-only
, auto-generated field.", | |
16999 "format": "int64", | |
17000 "type": "string" | |
17001 }, | |
17002 "lastName": { | |
17003 "description": "Last name of this site contact.", | |
17004 "type": "string" | |
17005 }, | |
17006 "phone": { | |
17007 "description": "Primary phone number of this site contact.", | |
17008 "type": "string" | |
17009 }, | |
17010 "title": { | |
17011 "description": "Title or designation of this site contact.", | |
17012 "type": "string" | |
17013 } | |
17014 }, | |
17015 "type": "object" | |
17016 }, | |
17017 "SiteSettings": { | |
17018 "description": "Site Settings", | |
17019 "id": "SiteSettings", | |
17020 "properties": { | |
17021 "activeViewOptOut": { | |
17022 "description": "Whether active view creatives are disabled f
or this site.", | |
17023 "type": "boolean" | |
17024 }, | |
17025 "creativeSettings": { | |
17026 "$ref": "CreativeSettings", | |
17027 "description": "Site-wide creative settings." | |
17028 }, | |
17029 "disableBrandSafeAds": { | |
17030 "description": "Whether brand safe ads are disabled for this
site.", | |
17031 "type": "boolean" | |
17032 }, | |
17033 "disableNewCookie": { | |
17034 "description": "Whether new cookies are disabled for this si
te.", | |
17035 "type": "boolean" | |
17036 }, | |
17037 "lookbackConfiguration": { | |
17038 "$ref": "LookbackConfiguration", | |
17039 "description": "Lookback window settings for this site." | |
17040 }, | |
17041 "tagSetting": { | |
17042 "$ref": "TagSetting", | |
17043 "description": "Configuration settings for dynamic and image
floodlight tags." | |
17044 } | |
17045 }, | |
17046 "type": "object" | |
17047 }, | |
17048 "SitesListResponse": { | |
17049 "description": "Site List Response", | |
17050 "id": "SitesListResponse", | |
17051 "properties": { | |
17052 "kind": { | |
17053 "default": "dfareporting#sitesListResponse", | |
17054 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#sitesListResponse\".", | |
17055 "type": "string" | |
17056 }, | |
17057 "nextPageToken": { | |
17058 "description": "Pagination token to be used for the next lis
t operation.", | |
17059 "type": "string" | |
17060 }, | |
17061 "sites": { | |
17062 "description": "Site collection.", | |
17063 "items": { | |
17064 "$ref": "Site" | |
17065 }, | |
17066 "type": "array" | |
17067 } | |
17068 }, | |
17069 "type": "object" | |
17070 }, | |
17071 "Size": { | |
17072 "description": "Represents the dimensions of ads, placements, creati
ves, or creative assets.", | |
17073 "id": "Size", | |
17074 "properties": { | |
17075 "height": { | |
17076 "description": "Height of this size.", | |
17077 "format": "int32", | |
17078 "type": "integer" | |
17079 }, | |
17080 "iab": { | |
17081 "description": "IAB standard size. This is a read-only, auto
-generated field.", | |
17082 "type": "boolean" | |
17083 }, | |
17084 "id": { | |
17085 "description": "ID of this size. This is a read-only, auto-g
enerated field.", | |
17086 "format": "int64", | |
17087 "type": "string" | |
17088 }, | |
17089 "kind": { | |
17090 "default": "dfareporting#size", | |
17091 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#size\".", | |
17092 "type": "string" | |
17093 }, | |
17094 "width": { | |
17095 "description": "Width of this size.", | |
17096 "format": "int32", | |
17097 "type": "integer" | |
17098 } | |
17099 }, | |
17100 "type": "object" | |
17101 }, | |
17102 "SizesListResponse": { | |
17103 "description": "Size List Response", | |
17104 "id": "SizesListResponse", | |
17105 "properties": { | |
17106 "kind": { | |
17107 "default": "dfareporting#sizesListResponse", | |
17108 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#sizesListResponse\".", | |
17109 "type": "string" | |
17110 }, | |
17111 "sizes": { | |
17112 "description": "Size collection.", | |
17113 "items": { | |
17114 "$ref": "Size" | |
17115 }, | |
17116 "type": "array" | |
17117 } | |
17118 }, | |
17119 "type": "object" | |
17120 }, | |
17121 "SortedDimension": { | |
17122 "description": "Represents a sorted dimension.", | |
17123 "id": "SortedDimension", | |
17124 "properties": { | |
17125 "kind": { | |
17126 "default": "dfareporting#sortedDimension", | |
17127 "description": "The kind of resource this is, in this case d
fareporting#sortedDimension.", | |
17128 "type": "string" | |
17129 }, | |
17130 "name": { | |
17131 "description": "The name of the dimension.", | |
17132 "type": "string" | |
17133 }, | |
17134 "sortOrder": { | |
17135 "description": "An optional sort order for the dimension col
umn.", | |
17136 "enum": [ | |
17137 "ASCENDING", | |
17138 "DESCENDING" | |
17139 ], | |
17140 "enumDescriptions": [ | |
17141 "", | |
17142 "" | |
17143 ], | |
17144 "type": "string" | |
17145 } | |
17146 }, | |
17147 "type": "object" | |
17148 }, | |
17149 "Subaccount": { | |
17150 "description": "Contains properties of a DCM subaccount.", | |
17151 "id": "Subaccount", | |
17152 "properties": { | |
17153 "accountId": { | |
17154 "description": "ID of the account that contains this subacco
unt. This is a read-only field that can be left blank.", | |
17155 "format": "int64", | |
17156 "type": "string" | |
17157 }, | |
17158 "availablePermissionIds": { | |
17159 "description": "IDs of the available user role permissions f
or this subaccount.", | |
17160 "items": { | |
17161 "format": "int64", | |
17162 "type": "string" | |
17163 }, | |
17164 "type": "array" | |
17165 }, | |
17166 "id": { | |
17167 "description": "ID of this subaccount. This is a read-only,
auto-generated field.", | |
17168 "format": "int64", | |
17169 "type": "string" | |
17170 }, | |
17171 "kind": { | |
17172 "default": "dfareporting#subaccount", | |
17173 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#subaccount\".", | |
17174 "type": "string" | |
17175 }, | |
17176 "name": { | |
17177 "description": "Name of this subaccount. This is a required
field. Must be less than 128 characters long and be unique among subaccounts of
the same account.", | |
17178 "type": "string" | |
17179 } | |
17180 }, | |
17181 "type": "object" | |
17182 }, | |
17183 "SubaccountsListResponse": { | |
17184 "description": "Subaccount List Response", | |
17185 "id": "SubaccountsListResponse", | |
17186 "properties": { | |
17187 "kind": { | |
17188 "default": "dfareporting#subaccountsListResponse", | |
17189 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#subaccountsListResponse\".", | |
17190 "type": "string" | |
17191 }, | |
17192 "nextPageToken": { | |
17193 "description": "Pagination token to be used for the next lis
t operation.", | |
17194 "type": "string" | |
17195 }, | |
17196 "subaccounts": { | |
17197 "description": "Subaccount collection.", | |
17198 "items": { | |
17199 "$ref": "Subaccount" | |
17200 }, | |
17201 "type": "array" | |
17202 } | |
17203 }, | |
17204 "type": "object" | |
17205 }, | |
17206 "TagData": { | |
17207 "description": "Placement Tag Data", | |
17208 "id": "TagData", | |
17209 "properties": { | |
17210 "adId": { | |
17211 "description": "Ad associated with this placement tag.", | |
17212 "format": "int64", | |
17213 "type": "string" | |
17214 }, | |
17215 "clickTag": { | |
17216 "description": "Tag string to record a click.", | |
17217 "type": "string" | |
17218 }, | |
17219 "creativeId": { | |
17220 "description": "Creative associated with this placement tag.
", | |
17221 "format": "int64", | |
17222 "type": "string" | |
17223 }, | |
17224 "format": { | |
17225 "description": "TagData tag format of this tag.", | |
17226 "enum": [ | |
17227 "PLACEMENT_TAG_CLICK_COMMANDS", | |
17228 "PLACEMENT_TAG_IFRAME_ILAYER", | |
17229 "PLACEMENT_TAG_IFRAME_JAVASCRIPT", | |
17230 "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY", | |
17231 "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH", | |
17232 "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3", | |
17233 "PLACEMENT_TAG_INTERNAL_REDIRECT", | |
17234 "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT", | |
17235 "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY", | |
17236 "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT", | |
17237 "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT", | |
17238 "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY", | |
17239 "PLACEMENT_TAG_JAVASCRIPT", | |
17240 "PLACEMENT_TAG_JAVASCRIPT_LEGACY", | |
17241 "PLACEMENT_TAG_STANDARD", | |
17242 "PLACEMENT_TAG_TRACKING", | |
17243 "PLACEMENT_TAG_TRACKING_IFRAME", | |
17244 "PLACEMENT_TAG_TRACKING_JAVASCRIPT" | |
17245 ], | |
17246 "enumDescriptions": [ | |
17247 "", | |
17248 "", | |
17249 "", | |
17250 "", | |
17251 "", | |
17252 "", | |
17253 "", | |
17254 "", | |
17255 "", | |
17256 "", | |
17257 "", | |
17258 "", | |
17259 "", | |
17260 "", | |
17261 "", | |
17262 "", | |
17263 "", | |
17264 "" | |
17265 ], | |
17266 "type": "string" | |
17267 }, | |
17268 "impressionTag": { | |
17269 "description": "Tag string for serving an ad.", | |
17270 "type": "string" | |
17271 } | |
17272 }, | |
17273 "type": "object" | |
17274 }, | |
17275 "TagSetting": { | |
17276 "description": "Tag Settings", | |
17277 "id": "TagSetting", | |
17278 "properties": { | |
17279 "additionalKeyValues": { | |
17280 "description": "Additional key-values to be included in tags
. Each key-value pair must be of the form key=value, and pairs must be separated
by a semicolon (;). Keys and values must not contain commas. For example, id=2;
color=red is a valid value for this field.", | |
17281 "type": "string" | |
17282 }, | |
17283 "includeClickThroughUrls": { | |
17284 "description": "Whether static landing page URLs should be i
ncluded in the tags. This setting applies only to placements.", | |
17285 "type": "boolean" | |
17286 }, | |
17287 "includeClickTracking": { | |
17288 "description": "Whether click-tracking string should be incl
uded in the tags.", | |
17289 "type": "boolean" | |
17290 }, | |
17291 "keywordOption": { | |
17292 "description": "Option specifying how keywords are embedded
in ad tags. This setting can be used to specify whether keyword placeholders are
inserted in placement tags for this site. Publishers can then add keywords to t
hose placeholders.", | |
17293 "enum": [ | |
17294 "GENERATE_SEPARATE_TAG_FOR_EACH_KEYWORD", | |
17295 "IGNORE", | |
17296 "PLACEHOLDER_WITH_LIST_OF_KEYWORDS" | |
17297 ], | |
17298 "enumDescriptions": [ | |
17299 "", | |
17300 "", | |
17301 "" | |
17302 ], | |
17303 "type": "string" | |
17304 } | |
17305 }, | |
17306 "type": "object" | |
17307 }, | |
17308 "TagSettings": { | |
17309 "description": "Dynamic and Image Tag Settings.", | |
17310 "id": "TagSettings", | |
17311 "properties": { | |
17312 "dynamicTagEnabled": { | |
17313 "description": "Whether dynamic floodlight tags are enabled.
", | |
17314 "type": "boolean" | |
17315 }, | |
17316 "imageTagEnabled": { | |
17317 "description": "Whether image tags are enabled.", | |
17318 "type": "boolean" | |
17319 } | |
17320 }, | |
17321 "type": "object" | |
17322 }, | |
17323 "TargetWindow": { | |
17324 "description": "Target Window.", | |
17325 "id": "TargetWindow", | |
17326 "properties": { | |
17327 "customHtml": { | |
17328 "description": "User-entered value.", | |
17329 "type": "string" | |
17330 }, | |
17331 "targetWindowOption": { | |
17332 "description": "Type of browser window for which the backup
image of the flash creative can be displayed.", | |
17333 "enum": [ | |
17334 "CURRENT_WINDOW", | |
17335 "CUSTOM", | |
17336 "NEW_WINDOW" | |
17337 ], | |
17338 "enumDescriptions": [ | |
17339 "", | |
17340 "", | |
17341 "" | |
17342 ], | |
17343 "type": "string" | |
17344 } | |
17345 }, | |
17346 "type": "object" | |
17347 }, | |
17348 "TargetableRemarketingList": { | |
17349 "description": "Contains properties of a targetable remarketing list
. Remarketing enables you to create lists of users who have performed specific a
ctions on a site, then target ads to members of those lists. This resource is a
read-only view of a remarketing list to be used to faciliate targeting ads to sp
ecific lists. Remarketing lists that are owned by your advertisers and those tha
t are shared to your advertisers or account are accessible via this resource. To
manage remarketing lists that are owned by your advertisers, use the Remarketin
gLists resource.", | |
17350 "id": "TargetableRemarketingList", | |
17351 "properties": { | |
17352 "accountId": { | |
17353 "description": "Account ID of this remarketing list. This is
a read-only, auto-generated field that is only returned in GET requests.", | |
17354 "format": "int64", | |
17355 "type": "string" | |
17356 }, | |
17357 "active": { | |
17358 "description": "Whether this targetable remarketing list is
active.", | |
17359 "type": "boolean" | |
17360 }, | |
17361 "advertiserId": { | |
17362 "description": "Dimension value for the advertiser ID that o
wns this targetable remarketing list.", | |
17363 "format": "int64", | |
17364 "type": "string" | |
17365 }, | |
17366 "advertiserIdDimensionValue": { | |
17367 "$ref": "DimensionValue", | |
17368 "description": "Dimension value for the ID of the advertiser
." | |
17369 }, | |
17370 "description": { | |
17371 "description": "Targetable remarketing list description.", | |
17372 "type": "string" | |
17373 }, | |
17374 "id": { | |
17375 "description": "Targetable remarketing list ID.", | |
17376 "format": "int64", | |
17377 "type": "string" | |
17378 }, | |
17379 "kind": { | |
17380 "default": "dfareporting#targetableRemarketingList", | |
17381 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#targetableRemarketingList\".", | |
17382 "type": "string" | |
17383 }, | |
17384 "lifeSpan": { | |
17385 "description": "Number of days that a user should remain in
the targetable remarketing list without an impression.", | |
17386 "format": "int64", | |
17387 "type": "string" | |
17388 }, | |
17389 "listSize": { | |
17390 "description": "Number of users currently in the list. This
is a read-only field.", | |
17391 "format": "int64", | |
17392 "type": "string" | |
17393 }, | |
17394 "listSource": { | |
17395 "description": "Product from which this targetable remarketi
ng list was originated.", | |
17396 "enum": [ | |
17397 "REMARKETING_LIST_SOURCE_ADX", | |
17398 "REMARKETING_LIST_SOURCE_DBM", | |
17399 "REMARKETING_LIST_SOURCE_DFA", | |
17400 "REMARKETING_LIST_SOURCE_DFP", | |
17401 "REMARKETING_LIST_SOURCE_DMP", | |
17402 "REMARKETING_LIST_SOURCE_GA", | |
17403 "REMARKETING_LIST_SOURCE_GPLUS", | |
17404 "REMARKETING_LIST_SOURCE_OTHER", | |
17405 "REMARKETING_LIST_SOURCE_PLAY_STORE", | |
17406 "REMARKETING_LIST_SOURCE_XFP", | |
17407 "REMARKETING_LIST_SOURCE_YOUTUBE" | |
17408 ], | |
17409 "enumDescriptions": [ | |
17410 "", | |
17411 "", | |
17412 "", | |
17413 "", | |
17414 "", | |
17415 "", | |
17416 "", | |
17417 "", | |
17418 "", | |
17419 "", | |
17420 "" | |
17421 ], | |
17422 "type": "string" | |
17423 }, | |
17424 "name": { | |
17425 "description": "Name of the targetable remarketing list. Is
no greater than 128 characters long.", | |
17426 "type": "string" | |
17427 }, | |
17428 "subaccountId": { | |
17429 "description": "Subaccount ID of this remarketing list. This
is a read-only, auto-generated field that is only returned in GET requests.", | |
17430 "format": "int64", | |
17431 "type": "string" | |
17432 } | |
17433 }, | |
17434 "type": "object" | |
17435 }, | |
17436 "TargetableRemarketingListsListResponse": { | |
17437 "description": "Targetable remarketing list response", | |
17438 "id": "TargetableRemarketingListsListResponse", | |
17439 "properties": { | |
17440 "kind": { | |
17441 "default": "dfareporting#targetableRemarketingListsListRespo
nse", | |
17442 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#targetableRemarketingListsListResponse\".", | |
17443 "type": "string" | |
17444 }, | |
17445 "nextPageToken": { | |
17446 "description": "Pagination token to be used for the next lis
t operation.", | |
17447 "type": "string" | |
17448 }, | |
17449 "targetableRemarketingLists": { | |
17450 "description": "Targetable remarketing list collection.", | |
17451 "items": { | |
17452 "$ref": "TargetableRemarketingList" | |
17453 }, | |
17454 "type": "array" | |
17455 } | |
17456 }, | |
17457 "type": "object" | |
17458 }, | |
17459 "TechnologyTargeting": { | |
17460 "description": "Technology Targeting.", | |
17461 "id": "TechnologyTargeting", | |
17462 "properties": { | |
17463 "browsers": { | |
17464 "description": "Browsers that this ad targets. For each brow
ser either set browserVersionId or dartId along with the version numbers. If bot
h are specified, only browserVersionId will be used. The other fields are popula
ted automatically when the ad is inserted or updated.", | |
17465 "items": { | |
17466 "$ref": "Browser" | |
17467 }, | |
17468 "type": "array" | |
17469 }, | |
17470 "connectionTypes": { | |
17471 "description": "Connection types that this ad targets. For e
ach connection type only id is required. The other fields are populated automati
cally when the ad is inserted or updated.", | |
17472 "items": { | |
17473 "$ref": "ConnectionType" | |
17474 }, | |
17475 "type": "array" | |
17476 }, | |
17477 "mobileCarriers": { | |
17478 "description": "Mobile carriers that this ad targets. For ea
ch mobile carrier only id is required, and the other fields are populated automa
tically when the ad is inserted or updated. If targeting a mobile carrier, do no
t set targeting for any zip codes.", | |
17479 "items": { | |
17480 "$ref": "MobileCarrier" | |
17481 }, | |
17482 "type": "array" | |
17483 }, | |
17484 "operatingSystemVersions": { | |
17485 "description": "Operating system versions that this ad targe
ts. To target all versions, use operatingSystems. For each operating system vers
ion, only id is required. The other fields are populated automatically when the
ad is inserted or updated. If targeting an operating system version, do not set
targeting for the corresponding operating system in operatingSystems.", | |
17486 "items": { | |
17487 "$ref": "OperatingSystemVersion" | |
17488 }, | |
17489 "type": "array" | |
17490 }, | |
17491 "operatingSystems": { | |
17492 "description": "Operating systems that this ad targets. To t
arget specific versions, use operatingSystemVersions. For each operating system
only dartId is required. The other fields are populated automatically when the a
d is inserted or updated. If targeting an operating system, do not set targeting
for operating system versions for the same operating system.", | |
17493 "items": { | |
17494 "$ref": "OperatingSystem" | |
17495 }, | |
17496 "type": "array" | |
17497 }, | |
17498 "platformTypes": { | |
17499 "description": "Platform types that this ad targets. For exa
mple, desktop, mobile, or tablet. For each platform type, only id is required, a
nd the other fields are populated automatically when the ad is inserted or updat
ed.", | |
17500 "items": { | |
17501 "$ref": "PlatformType" | |
17502 }, | |
17503 "type": "array" | |
17504 } | |
17505 }, | |
17506 "type": "object" | |
17507 }, | |
17508 "ThirdPartyAuthenticationToken": { | |
17509 "description": "Third Party Authentication Token", | |
17510 "id": "ThirdPartyAuthenticationToken", | |
17511 "properties": { | |
17512 "name": { | |
17513 "description": "Name of the third-party authentication token
.", | |
17514 "type": "string" | |
17515 }, | |
17516 "value": { | |
17517 "description": "Value of the third-party authentication toke
n. This is a read-only, auto-generated field.", | |
17518 "type": "string" | |
17519 } | |
17520 }, | |
17521 "type": "object" | |
17522 }, | |
17523 "ThirdPartyTrackingUrl": { | |
17524 "description": "Third-party Tracking URL.", | |
17525 "id": "ThirdPartyTrackingUrl", | |
17526 "properties": { | |
17527 "thirdPartyUrlType": { | |
17528 "description": "Third-party URL type for in-stream video cre
atives.", | |
17529 "enum": [ | |
17530 "CLICK_TRACKING", | |
17531 "IMPRESSION", | |
17532 "RICH_MEDIA_BACKUP_IMPRESSION", | |
17533 "RICH_MEDIA_IMPRESSION", | |
17534 "RICH_MEDIA_RM_IMPRESSION", | |
17535 "SURVEY", | |
17536 "VIDEO_COMPLETE", | |
17537 "VIDEO_CUSTOM", | |
17538 "VIDEO_FIRST_QUARTILE", | |
17539 "VIDEO_FULLSCREEN", | |
17540 "VIDEO_MIDPOINT", | |
17541 "VIDEO_MUTE", | |
17542 "VIDEO_PAUSE", | |
17543 "VIDEO_PROGRESS", | |
17544 "VIDEO_REWIND", | |
17545 "VIDEO_SKIP", | |
17546 "VIDEO_START", | |
17547 "VIDEO_STOP", | |
17548 "VIDEO_THIRD_QUARTILE" | |
17549 ], | |
17550 "enumDescriptions": [ | |
17551 "", | |
17552 "", | |
17553 "", | |
17554 "", | |
17555 "", | |
17556 "", | |
17557 "", | |
17558 "", | |
17559 "", | |
17560 "", | |
17561 "", | |
17562 "", | |
17563 "", | |
17564 "", | |
17565 "", | |
17566 "", | |
17567 "", | |
17568 "", | |
17569 "" | |
17570 ], | |
17571 "type": "string" | |
17572 }, | |
17573 "url": { | |
17574 "description": "URL for the specified third-party URL type."
, | |
17575 "type": "string" | |
17576 } | |
17577 }, | |
17578 "type": "object" | |
17579 }, | |
17580 "UserDefinedVariableConfiguration": { | |
17581 "description": "User Defined Variable configuration.", | |
17582 "id": "UserDefinedVariableConfiguration", | |
17583 "properties": { | |
17584 "dataType": { | |
17585 "description": "Data type for the variable. This is a requir
ed field.", | |
17586 "enum": [ | |
17587 "NUMBER", | |
17588 "STRING" | |
17589 ], | |
17590 "enumDescriptions": [ | |
17591 "", | |
17592 "" | |
17593 ], | |
17594 "type": "string" | |
17595 }, | |
17596 "reportName": { | |
17597 "description": "User-friendly name for the variable which wi
ll appear in reports. This is a required field, must be less than 64 characters
long, and cannot contain the following characters: \"\"<>\".", | |
17598 "type": "string" | |
17599 }, | |
17600 "variableType": { | |
17601 "description": "Variable name in the tag. This is a required
field.", | |
17602 "enum": [ | |
17603 "U1", | |
17604 "U10", | |
17605 "U100", | |
17606 "U11", | |
17607 "U12", | |
17608 "U13", | |
17609 "U14", | |
17610 "U15", | |
17611 "U16", | |
17612 "U17", | |
17613 "U18", | |
17614 "U19", | |
17615 "U2", | |
17616 "U20", | |
17617 "U21", | |
17618 "U22", | |
17619 "U23", | |
17620 "U24", | |
17621 "U25", | |
17622 "U26", | |
17623 "U27", | |
17624 "U28", | |
17625 "U29", | |
17626 "U3", | |
17627 "U30", | |
17628 "U31", | |
17629 "U32", | |
17630 "U33", | |
17631 "U34", | |
17632 "U35", | |
17633 "U36", | |
17634 "U37", | |
17635 "U38", | |
17636 "U39", | |
17637 "U4", | |
17638 "U40", | |
17639 "U41", | |
17640 "U42", | |
17641 "U43", | |
17642 "U44", | |
17643 "U45", | |
17644 "U46", | |
17645 "U47", | |
17646 "U48", | |
17647 "U49", | |
17648 "U5", | |
17649 "U50", | |
17650 "U51", | |
17651 "U52", | |
17652 "U53", | |
17653 "U54", | |
17654 "U55", | |
17655 "U56", | |
17656 "U57", | |
17657 "U58", | |
17658 "U59", | |
17659 "U6", | |
17660 "U60", | |
17661 "U61", | |
17662 "U62", | |
17663 "U63", | |
17664 "U64", | |
17665 "U65", | |
17666 "U66", | |
17667 "U67", | |
17668 "U68", | |
17669 "U69", | |
17670 "U7", | |
17671 "U70", | |
17672 "U71", | |
17673 "U72", | |
17674 "U73", | |
17675 "U74", | |
17676 "U75", | |
17677 "U76", | |
17678 "U77", | |
17679 "U78", | |
17680 "U79", | |
17681 "U8", | |
17682 "U80", | |
17683 "U81", | |
17684 "U82", | |
17685 "U83", | |
17686 "U84", | |
17687 "U85", | |
17688 "U86", | |
17689 "U87", | |
17690 "U88", | |
17691 "U89", | |
17692 "U9", | |
17693 "U90", | |
17694 "U91", | |
17695 "U92", | |
17696 "U93", | |
17697 "U94", | |
17698 "U95", | |
17699 "U96", | |
17700 "U97", | |
17701 "U98", | |
17702 "U99" | |
17703 ], | |
17704 "enumDescriptions": [ | |
17705 "", | |
17706 "", | |
17707 "", | |
17708 "", | |
17709 "", | |
17710 "", | |
17711 "", | |
17712 "", | |
17713 "", | |
17714 "", | |
17715 "", | |
17716 "", | |
17717 "", | |
17718 "", | |
17719 "", | |
17720 "", | |
17721 "", | |
17722 "", | |
17723 "", | |
17724 "", | |
17725 "", | |
17726 "", | |
17727 "", | |
17728 "", | |
17729 "", | |
17730 "", | |
17731 "", | |
17732 "", | |
17733 "", | |
17734 "", | |
17735 "", | |
17736 "", | |
17737 "", | |
17738 "", | |
17739 "", | |
17740 "", | |
17741 "", | |
17742 "", | |
17743 "", | |
17744 "", | |
17745 "", | |
17746 "", | |
17747 "", | |
17748 "", | |
17749 "", | |
17750 "", | |
17751 "", | |
17752 "", | |
17753 "", | |
17754 "", | |
17755 "", | |
17756 "", | |
17757 "", | |
17758 "", | |
17759 "", | |
17760 "", | |
17761 "", | |
17762 "", | |
17763 "", | |
17764 "", | |
17765 "", | |
17766 "", | |
17767 "", | |
17768 "", | |
17769 "", | |
17770 "", | |
17771 "", | |
17772 "", | |
17773 "", | |
17774 "", | |
17775 "", | |
17776 "", | |
17777 "", | |
17778 "", | |
17779 "", | |
17780 "", | |
17781 "", | |
17782 "", | |
17783 "", | |
17784 "", | |
17785 "", | |
17786 "", | |
17787 "", | |
17788 "", | |
17789 "", | |
17790 "", | |
17791 "", | |
17792 "", | |
17793 "", | |
17794 "", | |
17795 "", | |
17796 "", | |
17797 "", | |
17798 "", | |
17799 "", | |
17800 "", | |
17801 "", | |
17802 "", | |
17803 "", | |
17804 "" | |
17805 ], | |
17806 "type": "string" | |
17807 } | |
17808 }, | |
17809 "type": "object" | |
17810 }, | |
17811 "UserProfile": { | |
17812 "description": "Represents a UserProfile resource.", | |
17813 "id": "UserProfile", | |
17814 "properties": { | |
17815 "accountId": { | |
17816 "description": "The account ID to which this profile belongs
.", | |
17817 "format": "int64", | |
17818 "type": "string" | |
17819 }, | |
17820 "accountName": { | |
17821 "description": "The account name this profile belongs to.", | |
17822 "type": "string" | |
17823 }, | |
17824 "etag": { | |
17825 "description": "The eTag of this response for caching purpos
es.", | |
17826 "type": "string" | |
17827 }, | |
17828 "kind": { | |
17829 "default": "dfareporting#userProfile", | |
17830 "description": "The kind of resource this is, in this case d
fareporting#userProfile.", | |
17831 "type": "string" | |
17832 }, | |
17833 "profileId": { | |
17834 "description": "The unique ID of the user profile.", | |
17835 "format": "int64", | |
17836 "type": "string" | |
17837 }, | |
17838 "subAccountId": { | |
17839 "description": "The sub account ID this profile belongs to i
f applicable.", | |
17840 "format": "int64", | |
17841 "type": "string" | |
17842 }, | |
17843 "subAccountName": { | |
17844 "description": "The sub account name this profile belongs to
if applicable.", | |
17845 "type": "string" | |
17846 }, | |
17847 "userName": { | |
17848 "description": "The user name.", | |
17849 "type": "string" | |
17850 } | |
17851 }, | |
17852 "type": "object" | |
17853 }, | |
17854 "UserProfileList": { | |
17855 "description": "Represents the list of user profiles.", | |
17856 "id": "UserProfileList", | |
17857 "properties": { | |
17858 "etag": { | |
17859 "description": "The eTag of this response for caching purpos
es.", | |
17860 "type": "string" | |
17861 }, | |
17862 "items": { | |
17863 "description": "The user profiles returned in this response.
", | |
17864 "items": { | |
17865 "$ref": "UserProfile" | |
17866 }, | |
17867 "type": "array" | |
17868 }, | |
17869 "kind": { | |
17870 "default": "dfareporting#userProfileList", | |
17871 "description": "The kind of list this is, in this case dfare
porting#userProfileList.", | |
17872 "type": "string" | |
17873 } | |
17874 }, | |
17875 "type": "object" | |
17876 }, | |
17877 "UserRole": { | |
17878 "description": "Contains properties of auser role, which is used to
manage user access.", | |
17879 "id": "UserRole", | |
17880 "properties": { | |
17881 "accountId": { | |
17882 "description": "Account ID of this user role. This is a read
-only field that can be left blank.", | |
17883 "format": "int64", | |
17884 "type": "string" | |
17885 }, | |
17886 "defaultUserRole": { | |
17887 "description": "Whether this is a default user role. Default
user roles are created by the system for the account/subaccount and cannot be m
odified or deleted. Each default user role comes with a basic set of preassigned
permissions.", | |
17888 "type": "boolean" | |
17889 }, | |
17890 "id": { | |
17891 "description": "ID of this user role. This is a read-only, a
uto-generated field.", | |
17892 "format": "int64", | |
17893 "type": "string" | |
17894 }, | |
17895 "kind": { | |
17896 "default": "dfareporting#userRole", | |
17897 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#userRole\".", | |
17898 "type": "string" | |
17899 }, | |
17900 "name": { | |
17901 "description": "Name of this user role. This is a required f
ield. Must be less than 256 characters long. If this user role is under a subacc
ount, the name must be unique among sites of the same subaccount. Otherwise, thi
s user role is a top-level user role, and the name must be unique among top-leve
l user roles of the same account.", | |
17902 "type": "string" | |
17903 }, | |
17904 "parentUserRoleId": { | |
17905 "description": "ID of the user role that this user role is b
ased on or copied from. This is a required field.", | |
17906 "format": "int64", | |
17907 "type": "string" | |
17908 }, | |
17909 "permissions": { | |
17910 "description": "List of permissions associated with this use
r role.", | |
17911 "items": { | |
17912 "$ref": "UserRolePermission" | |
17913 }, | |
17914 "type": "array" | |
17915 }, | |
17916 "subaccountId": { | |
17917 "description": "Subaccount ID of this user role. This is a r
ead-only field that can be left blank.", | |
17918 "format": "int64", | |
17919 "type": "string" | |
17920 } | |
17921 }, | |
17922 "type": "object" | |
17923 }, | |
17924 "UserRolePermission": { | |
17925 "description": "Contains properties of a user role permission.", | |
17926 "id": "UserRolePermission", | |
17927 "properties": { | |
17928 "availability": { | |
17929 "description": "Levels of availability for a user role permi
ssion.", | |
17930 "enum": [ | |
17931 "ACCOUNT_ALWAYS", | |
17932 "ACCOUNT_BY_DEFAULT", | |
17933 "NOT_AVAILABLE_BY_DEFAULT", | |
17934 "SUBACCOUNT_AND_ACCOUNT_ALWAYS", | |
17935 "SUBACCOUNT_AND_ACCOUNT_BY_DEFAULT" | |
17936 ], | |
17937 "enumDescriptions": [ | |
17938 "", | |
17939 "", | |
17940 "", | |
17941 "", | |
17942 "" | |
17943 ], | |
17944 "type": "string" | |
17945 }, | |
17946 "id": { | |
17947 "description": "ID of this user role permission.", | |
17948 "format": "int64", | |
17949 "type": "string" | |
17950 }, | |
17951 "kind": { | |
17952 "default": "dfareporting#userRolePermission", | |
17953 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#userRolePermission\".", | |
17954 "type": "string" | |
17955 }, | |
17956 "name": { | |
17957 "description": "Name of this user role permission.", | |
17958 "type": "string" | |
17959 }, | |
17960 "permissionGroupId": { | |
17961 "description": "ID of the permission group that this user ro
le permission belongs to.", | |
17962 "format": "int64", | |
17963 "type": "string" | |
17964 } | |
17965 }, | |
17966 "type": "object" | |
17967 }, | |
17968 "UserRolePermissionGroup": { | |
17969 "description": "Represents a grouping of related user role permissio
ns.", | |
17970 "id": "UserRolePermissionGroup", | |
17971 "properties": { | |
17972 "id": { | |
17973 "description": "ID of this user role permission.", | |
17974 "format": "int64", | |
17975 "type": "string" | |
17976 }, | |
17977 "kind": { | |
17978 "default": "dfareporting#userRolePermissionGroup", | |
17979 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#userRolePermissionGroup\".", | |
17980 "type": "string" | |
17981 }, | |
17982 "name": { | |
17983 "description": "Name of this user role permission group.", | |
17984 "type": "string" | |
17985 } | |
17986 }, | |
17987 "type": "object" | |
17988 }, | |
17989 "UserRolePermissionGroupsListResponse": { | |
17990 "description": "User Role Permission Group List Response", | |
17991 "id": "UserRolePermissionGroupsListResponse", | |
17992 "properties": { | |
17993 "kind": { | |
17994 "default": "dfareporting#userRolePermissionGroupsListRespons
e", | |
17995 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#userRolePermissionGroupsListResponse\".", | |
17996 "type": "string" | |
17997 }, | |
17998 "userRolePermissionGroups": { | |
17999 "description": "User role permission group collection.", | |
18000 "items": { | |
18001 "$ref": "UserRolePermissionGroup" | |
18002 }, | |
18003 "type": "array" | |
18004 } | |
18005 }, | |
18006 "type": "object" | |
18007 }, | |
18008 "UserRolePermissionsListResponse": { | |
18009 "description": "User Role Permission List Response", | |
18010 "id": "UserRolePermissionsListResponse", | |
18011 "properties": { | |
18012 "kind": { | |
18013 "default": "dfareporting#userRolePermissionsListResponse", | |
18014 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#userRolePermissionsListResponse\".", | |
18015 "type": "string" | |
18016 }, | |
18017 "userRolePermissions": { | |
18018 "description": "User role permission collection.", | |
18019 "items": { | |
18020 "$ref": "UserRolePermission" | |
18021 }, | |
18022 "type": "array" | |
18023 } | |
18024 }, | |
18025 "type": "object" | |
18026 }, | |
18027 "UserRolesListResponse": { | |
18028 "description": "User Role List Response", | |
18029 "id": "UserRolesListResponse", | |
18030 "properties": { | |
18031 "kind": { | |
18032 "default": "dfareporting#userRolesListResponse", | |
18033 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"dfareporting#userRolesListResponse\".", | |
18034 "type": "string" | |
18035 }, | |
18036 "nextPageToken": { | |
18037 "description": "Pagination token to be used for the next lis
t operation.", | |
18038 "type": "string" | |
18039 }, | |
18040 "userRoles": { | |
18041 "description": "User role collection.", | |
18042 "items": { | |
18043 "$ref": "UserRole" | |
18044 }, | |
18045 "type": "array" | |
18046 } | |
18047 }, | |
18048 "type": "object" | |
18049 } | |
18050 }, | |
18051 "servicePath": "dfareporting/v2.2/", | |
18052 "title": "DCM/DFA Reporting And Trafficking API", | |
18053 "version": "v2.2" | |
18054 } | |
OLD | NEW |