Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(706)

Side by Side Diff: discovery/googleapis/dfareporting__v1.3.json

Issue 559053002: Generate 0.1.0 version of googleapis/googleapis_beta (Closed) Base URL: git@github.com:dart-lang/googleapis.git@master
Patch Set: Created 6 years, 3 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
OLDNEW
(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 }
9 }
10 },
11 "basePath": "/dfareporting/v1.3/",
12 "baseUrl": "https://www.googleapis.com/dfareporting/v1.3/",
13 "batchPath": "batch",
14 "description": "Lets you create, run and download reports.",
15 "discoveryVersion": "v1",
16 "documentationLink": "https://developers.google.com/doubleclick-advertisers/ reporting/",
17 "etag": "\"uUWyYHXmEn-ab7WLvo8qNz2S8ws/DksHEtiLa6AYCFbemQxikIlHU8s\"",
18 "icons": {
19 "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
20 "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
21 },
22 "id": "dfareporting:v1.3",
23 "kind": "discovery#restDescription",
24 "name": "dfareporting",
25 "ownerDomain": "google.com",
26 "ownerName": "Google",
27 "parameters": {
28 "alt": {
29 "default": "json",
30 "description": "Data format for the response.",
31 "enum": [
32 "json"
33 ],
34 "enumDescriptions": [
35 "Responses with Content-Type of application/json"
36 ],
37 "location": "query",
38 "type": "string"
39 },
40 "fields": {
41 "description": "Selector specifying which fields to include in a par tial response.",
42 "location": "query",
43 "type": "string"
44 },
45 "key": {
46 "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.",
47 "location": "query",
48 "type": "string"
49 },
50 "oauth_token": {
51 "description": "OAuth 2.0 token for the current user.",
52 "location": "query",
53 "type": "string"
54 },
55 "prettyPrint": {
56 "default": "true",
57 "description": "Returns response with indentations and line breaks." ,
58 "location": "query",
59 "type": "boolean"
60 },
61 "quotaUser": {
62 "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.",
63 "location": "query",
64 "type": "string"
65 },
66 "userIp": {
67 "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
68 "location": "query",
69 "type": "string"
70 }
71 },
72 "protocol": "rest",
73 "resources": {
74 "dimensionValues": {
75 "methods": {
76 "query": {
77 "description": "Retrieves list of report dimension values fo r a list of filters.",
78 "httpMethod": "POST",
79 "id": "dfareporting.dimensionValues.query",
80 "parameterOrder": [
81 "profileId"
82 ],
83 "parameters": {
84 "maxResults": {
85 "description": "Maximum number of results to return. ",
86 "format": "int32",
87 "location": "query",
88 "maximum": "100",
89 "minimum": "0",
90 "type": "integer"
91 },
92 "pageToken": {
93 "description": "The value of the nextToken from the previous result page.",
94 "location": "query",
95 "type": "string"
96 },
97 "profileId": {
98 "description": "The DFA user profile ID.",
99 "format": "int64",
100 "location": "path",
101 "required": true,
102 "type": "string"
103 }
104 },
105 "path": "userprofiles/{profileId}/dimensionvalues/query",
106 "request": {
107 "$ref": "DimensionValueRequest"
108 },
109 "response": {
110 "$ref": "DimensionValueList"
111 },
112 "scopes": [
113 "https://www.googleapis.com/auth/dfareporting"
114 ]
115 }
116 }
117 },
118 "files": {
119 "methods": {
120 "get": {
121 "description": "Retrieves a report file by its report ID and file ID.",
122 "httpMethod": "GET",
123 "id": "dfareporting.files.get",
124 "parameterOrder": [
125 "reportId",
126 "fileId"
127 ],
128 "parameters": {
129 "fileId": {
130 "description": "The ID of the report file.",
131 "format": "int64",
132 "location": "path",
133 "required": true,
134 "type": "string"
135 },
136 "reportId": {
137 "description": "The ID of the report.",
138 "format": "int64",
139 "location": "path",
140 "required": true,
141 "type": "string"
142 }
143 },
144 "path": "reports/{reportId}/files/{fileId}",
145 "response": {
146 "$ref": "File"
147 },
148 "scopes": [
149 "https://www.googleapis.com/auth/dfareporting"
150 ],
151 "supportsMediaDownload": true
152 },
153 "list": {
154 "description": "Lists files for a user profile.",
155 "httpMethod": "GET",
156 "id": "dfareporting.files.list",
157 "parameterOrder": [
158 "profileId"
159 ],
160 "parameters": {
161 "maxResults": {
162 "description": "Maximum number of results to return. ",
163 "format": "int32",
164 "location": "query",
165 "maximum": "10",
166 "minimum": "0",
167 "type": "integer"
168 },
169 "pageToken": {
170 "description": "The value of the nextToken from the previous result page.",
171 "location": "query",
172 "type": "string"
173 },
174 "profileId": {
175 "description": "The DFA profile ID.",
176 "format": "int64",
177 "location": "path",
178 "required": true,
179 "type": "string"
180 },
181 "scope": {
182 "default": "MINE",
183 "description": "The scope that defines which results are returned, default is 'MINE'.",
184 "enum": [
185 "ALL",
186 "MINE",
187 "SHARED_WITH_ME"
188 ],
189 "enumDescriptions": [
190 "All files in account.",
191 "My files.",
192 "Files shared with me."
193 ],
194 "location": "query",
195 "type": "string"
196 },
197 "sortField": {
198 "default": "LAST_MODIFIED_TIME",
199 "description": "The field by which to sort the list. ",
200 "enum": [
201 "ID",
202 "LAST_MODIFIED_TIME"
203 ],
204 "enumDescriptions": [
205 "Sort by file ID.",
206 "Sort by 'lastmodifiedAt' field."
207 ],
208 "location": "query",
209 "type": "string"
210 },
211 "sortOrder": {
212 "default": "DESCENDING",
213 "description": "Order of sorted results, default is 'DESCENDING'.",
214 "enum": [
215 "ASCENDING",
216 "DESCENDING"
217 ],
218 "enumDescriptions": [
219 "Ascending order.",
220 "Descending order."
221 ],
222 "location": "query",
223 "type": "string"
224 }
225 },
226 "path": "userprofiles/{profileId}/files",
227 "response": {
228 "$ref": "FileList"
229 },
230 "scopes": [
231 "https://www.googleapis.com/auth/dfareporting"
232 ]
233 }
234 }
235 },
236 "reports": {
237 "methods": {
238 "delete": {
239 "description": "Deletes a report by its ID.",
240 "httpMethod": "DELETE",
241 "id": "dfareporting.reports.delete",
242 "parameterOrder": [
243 "profileId",
244 "reportId"
245 ],
246 "parameters": {
247 "profileId": {
248 "description": "The DFA user profile ID.",
249 "format": "int64",
250 "location": "path",
251 "required": true,
252 "type": "string"
253 },
254 "reportId": {
255 "description": "The ID of the report.",
256 "format": "int64",
257 "location": "path",
258 "required": true,
259 "type": "string"
260 }
261 },
262 "path": "userprofiles/{profileId}/reports/{reportId}",
263 "scopes": [
264 "https://www.googleapis.com/auth/dfareporting"
265 ]
266 },
267 "get": {
268 "description": "Retrieves a report by its ID.",
269 "httpMethod": "GET",
270 "id": "dfareporting.reports.get",
271 "parameterOrder": [
272 "profileId",
273 "reportId"
274 ],
275 "parameters": {
276 "profileId": {
277 "description": "The DFA user profile ID.",
278 "format": "int64",
279 "location": "path",
280 "required": true,
281 "type": "string"
282 },
283 "reportId": {
284 "description": "The ID of the report.",
285 "format": "int64",
286 "location": "path",
287 "required": true,
288 "type": "string"
289 }
290 },
291 "path": "userprofiles/{profileId}/reports/{reportId}",
292 "response": {
293 "$ref": "Report"
294 },
295 "scopes": [
296 "https://www.googleapis.com/auth/dfareporting"
297 ]
298 },
299 "insert": {
300 "description": "Creates a report.",
301 "httpMethod": "POST",
302 "id": "dfareporting.reports.insert",
303 "parameterOrder": [
304 "profileId"
305 ],
306 "parameters": {
307 "profileId": {
308 "description": "The DFA user profile ID.",
309 "format": "int64",
310 "location": "path",
311 "required": true,
312 "type": "string"
313 }
314 },
315 "path": "userprofiles/{profileId}/reports",
316 "request": {
317 "$ref": "Report"
318 },
319 "response": {
320 "$ref": "Report"
321 },
322 "scopes": [
323 "https://www.googleapis.com/auth/dfareporting"
324 ]
325 },
326 "list": {
327 "description": "Retrieves list of reports.",
328 "httpMethod": "GET",
329 "id": "dfareporting.reports.list",
330 "parameterOrder": [
331 "profileId"
332 ],
333 "parameters": {
334 "maxResults": {
335 "description": "Maximum number of results to return. ",
336 "format": "int32",
337 "location": "query",
338 "maximum": "10",
339 "minimum": "0",
340 "type": "integer"
341 },
342 "pageToken": {
343 "description": "The value of the nextToken from the previous result page.",
344 "location": "query",
345 "type": "string"
346 },
347 "profileId": {
348 "description": "The DFA user profile ID.",
349 "format": "int64",
350 "location": "path",
351 "required": true,
352 "type": "string"
353 },
354 "scope": {
355 "default": "MINE",
356 "description": "The scope that defines which results are returned, default is 'MINE'.",
357 "enum": [
358 "ALL",
359 "MINE"
360 ],
361 "enumDescriptions": [
362 "All reports in account.",
363 "My reports."
364 ],
365 "location": "query",
366 "type": "string"
367 },
368 "sortField": {
369 "default": "LAST_MODIFIED_TIME",
370 "description": "The field by which to sort the list. ",
371 "enum": [
372 "ID",
373 "LAST_MODIFIED_TIME",
374 "NAME"
375 ],
376 "enumDescriptions": [
377 "Sort by report ID.",
378 "Sort by 'lastModifiedTime' field.",
379 "Sort by name of reports."
380 ],
381 "location": "query",
382 "type": "string"
383 },
384 "sortOrder": {
385 "default": "DESCENDING",
386 "description": "Order of sorted results, default is 'DESCENDING'.",
387 "enum": [
388 "ASCENDING",
389 "DESCENDING"
390 ],
391 "enumDescriptions": [
392 "Ascending order.",
393 "Descending order."
394 ],
395 "location": "query",
396 "type": "string"
397 }
398 },
399 "path": "userprofiles/{profileId}/reports",
400 "response": {
401 "$ref": "ReportList"
402 },
403 "scopes": [
404 "https://www.googleapis.com/auth/dfareporting"
405 ]
406 },
407 "patch": {
408 "description": "Updates a report. This method supports patch semantics.",
409 "httpMethod": "PATCH",
410 "id": "dfareporting.reports.patch",
411 "parameterOrder": [
412 "profileId",
413 "reportId"
414 ],
415 "parameters": {
416 "profileId": {
417 "description": "The DFA user profile ID.",
418 "format": "int64",
419 "location": "path",
420 "required": true,
421 "type": "string"
422 },
423 "reportId": {
424 "description": "The ID of the report.",
425 "format": "int64",
426 "location": "path",
427 "required": true,
428 "type": "string"
429 }
430 },
431 "path": "userprofiles/{profileId}/reports/{reportId}",
432 "request": {
433 "$ref": "Report"
434 },
435 "response": {
436 "$ref": "Report"
437 },
438 "scopes": [
439 "https://www.googleapis.com/auth/dfareporting"
440 ]
441 },
442 "run": {
443 "description": "Runs a report.",
444 "httpMethod": "POST",
445 "id": "dfareporting.reports.run",
446 "parameterOrder": [
447 "profileId",
448 "reportId"
449 ],
450 "parameters": {
451 "profileId": {
452 "description": "The DFA profile ID.",
453 "format": "int64",
454 "location": "path",
455 "required": true,
456 "type": "string"
457 },
458 "reportId": {
459 "description": "The ID of the report.",
460 "format": "int64",
461 "location": "path",
462 "required": true,
463 "type": "string"
464 },
465 "synchronous": {
466 "description": "If set and true, tries to run the re port synchronously.",
467 "location": "query",
468 "type": "boolean"
469 }
470 },
471 "path": "userprofiles/{profileId}/reports/{reportId}/run",
472 "response": {
473 "$ref": "File"
474 },
475 "scopes": [
476 "https://www.googleapis.com/auth/dfareporting"
477 ]
478 },
479 "update": {
480 "description": "Updates a report.",
481 "httpMethod": "PUT",
482 "id": "dfareporting.reports.update",
483 "parameterOrder": [
484 "profileId",
485 "reportId"
486 ],
487 "parameters": {
488 "profileId": {
489 "description": "The DFA user profile ID.",
490 "format": "int64",
491 "location": "path",
492 "required": true,
493 "type": "string"
494 },
495 "reportId": {
496 "description": "The ID of the report.",
497 "format": "int64",
498 "location": "path",
499 "required": true,
500 "type": "string"
501 }
502 },
503 "path": "userprofiles/{profileId}/reports/{reportId}",
504 "request": {
505 "$ref": "Report"
506 },
507 "response": {
508 "$ref": "Report"
509 },
510 "scopes": [
511 "https://www.googleapis.com/auth/dfareporting"
512 ]
513 }
514 },
515 "resources": {
516 "compatibleFields": {
517 "methods": {
518 "query": {
519 "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.",
520 "httpMethod": "POST",
521 "id": "dfareporting.reports.compatibleFields.query",
522 "parameterOrder": [
523 "profileId"
524 ],
525 "parameters": {
526 "profileId": {
527 "description": "The DFA user profile ID.",
528 "format": "int64",
529 "location": "path",
530 "required": true,
531 "type": "string"
532 }
533 },
534 "path": "userprofiles/{profileId}/reports/compatible fields/query",
535 "request": {
536 "$ref": "Report"
537 },
538 "response": {
539 "$ref": "CompatibleFields"
540 },
541 "scopes": [
542 "https://www.googleapis.com/auth/dfareporting"
543 ]
544 }
545 }
546 },
547 "files": {
548 "methods": {
549 "get": {
550 "description": "Retrieves a report file.",
551 "httpMethod": "GET",
552 "id": "dfareporting.reports.files.get",
553 "parameterOrder": [
554 "profileId",
555 "reportId",
556 "fileId"
557 ],
558 "parameters": {
559 "fileId": {
560 "description": "The ID of the report file.",
561 "format": "int64",
562 "location": "path",
563 "required": true,
564 "type": "string"
565 },
566 "profileId": {
567 "description": "The DFA profile ID.",
568 "format": "int64",
569 "location": "path",
570 "required": true,
571 "type": "string"
572 },
573 "reportId": {
574 "description": "The ID of the report.",
575 "format": "int64",
576 "location": "path",
577 "required": true,
578 "type": "string"
579 }
580 },
581 "path": "userprofiles/{profileId}/reports/{reportId} /files/{fileId}",
582 "response": {
583 "$ref": "File"
584 },
585 "scopes": [
586 "https://www.googleapis.com/auth/dfareporting"
587 ],
588 "supportsMediaDownload": true
589 },
590 "list": {
591 "description": "Lists files for a report.",
592 "httpMethod": "GET",
593 "id": "dfareporting.reports.files.list",
594 "parameterOrder": [
595 "profileId",
596 "reportId"
597 ],
598 "parameters": {
599 "maxResults": {
600 "description": "Maximum number of results to return.",
601 "format": "int32",
602 "location": "query",
603 "maximum": "10",
604 "minimum": "0",
605 "type": "integer"
606 },
607 "pageToken": {
608 "description": "The value of the nextToken f rom the previous result page.",
609 "location": "query",
610 "type": "string"
611 },
612 "profileId": {
613 "description": "The DFA profile ID.",
614 "format": "int64",
615 "location": "path",
616 "required": true,
617 "type": "string"
618 },
619 "reportId": {
620 "description": "The ID of the parent report. ",
621 "format": "int64",
622 "location": "path",
623 "required": true,
624 "type": "string"
625 },
626 "sortField": {
627 "default": "LAST_MODIFIED_TIME",
628 "description": "The field by which to sort t he list.",
629 "enum": [
630 "ID",
631 "LAST_MODIFIED_TIME"
632 ],
633 "enumDescriptions": [
634 "Sort by file ID.",
635 "Sort by 'lastmodifiedAt' field."
636 ],
637 "location": "query",
638 "type": "string"
639 },
640 "sortOrder": {
641 "default": "DESCENDING",
642 "description": "Order of sorted results, def ault is 'DESCENDING'.",
643 "enum": [
644 "ASCENDING",
645 "DESCENDING"
646 ],
647 "enumDescriptions": [
648 "Ascending order.",
649 "Descending order."
650 ],
651 "location": "query",
652 "type": "string"
653 }
654 },
655 "path": "userprofiles/{profileId}/reports/{reportId} /files",
656 "response": {
657 "$ref": "FileList"
658 },
659 "scopes": [
660 "https://www.googleapis.com/auth/dfareporting"
661 ]
662 }
663 }
664 }
665 }
666 },
667 "userProfiles": {
668 "methods": {
669 "get": {
670 "description": "Gets one user profile by ID.",
671 "httpMethod": "GET",
672 "id": "dfareporting.userProfiles.get",
673 "parameterOrder": [
674 "profileId"
675 ],
676 "parameters": {
677 "profileId": {
678 "description": "The user profile ID.",
679 "format": "int64",
680 "location": "path",
681 "required": true,
682 "type": "string"
683 }
684 },
685 "path": "userprofiles/{profileId}",
686 "response": {
687 "$ref": "UserProfile"
688 },
689 "scopes": [
690 "https://www.googleapis.com/auth/dfareporting"
691 ]
692 },
693 "list": {
694 "description": "Retrieves list of user profiles for a user." ,
695 "httpMethod": "GET",
696 "id": "dfareporting.userProfiles.list",
697 "path": "userprofiles",
698 "response": {
699 "$ref": "UserProfileList"
700 },
701 "scopes": [
702 "https://www.googleapis.com/auth/dfareporting"
703 ]
704 }
705 }
706 }
707 },
708 "revision": "20140903",
709 "rootUrl": "https://www.googleapis.com/",
710 "schemas": {
711 "Activities": {
712 "description": "Represents an activity group.",
713 "id": "Activities",
714 "properties": {
715 "filters": {
716 "description": "List of activity filters. The dimension valu es need to be all either of type \"dfa:activity\" or \"dfa:activityGroup\".",
717 "items": {
718 "$ref": "DimensionValue"
719 },
720 "type": "array"
721 },
722 "kind": {
723 "default": "dfareporting#activities",
724 "description": "The kind of resource this is, in this case d fareporting#activities.",
725 "type": "string"
726 },
727 "metricNames": {
728 "description": "List of names of floodlight activity metrics .",
729 "items": {
730 "type": "string"
731 },
732 "type": "array"
733 }
734 },
735 "type": "object"
736 },
737 "CompatibleFields": {
738 "description": "Represents a response to the queryCompatibleFields m ethod.",
739 "id": "CompatibleFields",
740 "properties": {
741 "crossDimensionReachReportCompatibleFields": {
742 "$ref": "CrossDimensionReachReportCompatibleFields",
743 "description": "Contains items that are compatible to be sel ected for a report of type \"CROSS_DIMENSION_REACH\"."
744 },
745 "floodlightReportCompatibleFields": {
746 "$ref": "FloodlightReportCompatibleFields",
747 "description": "Contains items that are compatible to be sel ected for a report of type \"FLOODLIGHT\"."
748 },
749 "kind": {
750 "default": "dfareporting#compatibleFields",
751 "description": "The kind of resource this is, in this case d fareporting#compatibleFields.",
752 "type": "string"
753 },
754 "pathToConversionReportCompatibleFields": {
755 "$ref": "PathToConversionReportCompatibleFields",
756 "description": "Contains items that are compatible to be sel ected for a report of type \"PATH_TO_CONVERSION\"."
757 },
758 "reachReportCompatibleFields": {
759 "$ref": "ReachReportCompatibleFields",
760 "description": "Contains items that are compatible to be sel ected for a report of type \"REACH\"."
761 },
762 "reportCompatibleFields": {
763 "$ref": "ReportCompatibleFields",
764 "description": "Contains items that are compatible to be sel ected for a report of type \"STANDARD\"."
765 }
766 },
767 "type": "object"
768 },
769 "CrossDimensionReachReportCompatibleFields": {
770 "description": "Represents fields that are compatible to be selected for a report of type \"CROSS_DIMENSION_REACH\".",
771 "id": "CrossDimensionReachReportCompatibleFields",
772 "properties": {
773 "breakdown": {
774 "description": "Dimensions which are compatible to be select ed in the \"breakdown\" section of the report.",
775 "items": {
776 "$ref": "Dimension"
777 },
778 "type": "array"
779 },
780 "dimensionFilters": {
781 "description": "Dimensions which are compatible to be select ed in the \"dimensionFilters\" section of the report.",
782 "items": {
783 "$ref": "Dimension"
784 },
785 "type": "array"
786 },
787 "kind": {
788 "default": "dfareporting#crossDimensionReachReportCompatible Fields",
789 "description": "The kind of resource this is, in this case d fareporting#crossDimensionReachReportCompatibleFields.",
790 "type": "string"
791 },
792 "metrics": {
793 "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
794 "items": {
795 "$ref": "Metric"
796 },
797 "type": "array"
798 },
799 "overlapMetrics": {
800 "description": "Metrics which are compatible to be selected in the \"overlapMetricNames\" section of the report.",
801 "items": {
802 "$ref": "Metric"
803 },
804 "type": "array"
805 }
806 },
807 "type": "object"
808 },
809 "CustomRichMediaEvents": {
810 "description": "Represents a Custom Rich Media Events group.",
811 "id": "CustomRichMediaEvents",
812 "properties": {
813 "filteredEventIds": {
814 "description": "List of custom rich media event IDs. Dimensi on values must be all of type dfa:richMediaEventTypeIdAndName.",
815 "items": {
816 "$ref": "DimensionValue"
817 },
818 "type": "array"
819 },
820 "kind": {
821 "default": "dfareporting#customRichMediaEvents",
822 "description": "The kind of resource this is, in this case d fareporting#customRichMediaEvents.",
823 "type": "string"
824 }
825 },
826 "type": "object"
827 },
828 "DateRange": {
829 "description": "Represents a date range.",
830 "id": "DateRange",
831 "properties": {
832 "endDate": {
833 "description": "The end date of the date range, inclusive. A string of the format: \"yyyy-MM-dd\".",
834 "format": "date",
835 "type": "string"
836 },
837 "kind": {
838 "default": "dfareporting#dateRange",
839 "description": "The kind of resource this is, in this case d fareporting#dateRange.",
840 "type": "string"
841 },
842 "relativeDateRange": {
843 "description": "The date range relative to the date of when the report is run, one of: \n- \"TODAY\" \n- \"YESTERDAY\" \n- \"WEEK_TO_DATE\" \n- \"MONTH_TO_DATE\" \n- \"QUARTER_TO_DATE\" \n- \"YEAR_TO_DATE\" \n- \"PREVIO US_WEEK\" \n- \"PREVIOUS_MONTH\" \n- \"PREVIOUS_QUARTER\" \n- \"PREVIOUS_YEAR\" \n- \"LAST_7_DAYS\" \n- \"LAST_30_DAYS\" \n- \"LAST_90_DAYS\" \n- \"LAST_365_DAY S\" \n- \"LAST_24_MONTHS\"",
844 "type": "string"
845 },
846 "startDate": {
847 "description": "The start date of the date range, inclusive. A string of the format: \"yyyy-MM-dd\".",
848 "format": "date",
849 "type": "string"
850 }
851 },
852 "type": "object"
853 },
854 "Dimension": {
855 "description": "Represents a dimension.",
856 "id": "Dimension",
857 "properties": {
858 "kind": {
859 "default": "dfareporting#dimension",
860 "description": "The kind of resource this is, in this case d fareporting#dimension.",
861 "type": "string"
862 },
863 "name": {
864 "description": "The dimension name, e.g. dfa:advertiser",
865 "type": "string"
866 }
867 },
868 "type": "object"
869 },
870 "DimensionFilter": {
871 "description": "Represents a dimension filter.",
872 "id": "DimensionFilter",
873 "properties": {
874 "dimensionName": {
875 "description": "The name of the dimension to filter.",
876 "type": "string"
877 },
878 "kind": {
879 "default": "dfareporting#dimensionFilter",
880 "description": "The kind of resource this is, in this case d fareporting#dimensionFilter.",
881 "type": "string"
882 },
883 "value": {
884 "description": "The value of the dimension to filter.",
885 "type": "string"
886 }
887 },
888 "type": "object"
889 },
890 "DimensionValue": {
891 "description": "Represents a DimensionValue resource.",
892 "id": "DimensionValue",
893 "properties": {
894 "dimensionName": {
895 "description": "The name of the dimension.",
896 "type": "string"
897 },
898 "etag": {
899 "description": "The eTag of this response for caching purpos es.",
900 "type": "string"
901 },
902 "id": {
903 "description": "The ID associated with the value if availabl e.",
904 "type": "string"
905 },
906 "kind": {
907 "default": "dfareporting#dimensionValue",
908 "description": "The kind of resource this is, in this case d fareporting#dimensionValue.",
909 "type": "string"
910 },
911 "matchType": {
912 "description": "Determines how the 'value' field is matched when filtering. One of: \n- EXACT (default if not specified) \n- CONTAINS \n- B EGINS_WITH \n- WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable l ength character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.",
913 "type": "string"
914 },
915 "value": {
916 "description": "The value of the dimension.",
917 "type": "string"
918 }
919 },
920 "type": "object"
921 },
922 "DimensionValueList": {
923 "description": "Represents the list of DimensionValue resources.",
924 "id": "DimensionValueList",
925 "properties": {
926 "etag": {
927 "description": "The eTag of this response for caching purpos es.",
928 "type": "string"
929 },
930 "items": {
931 "description": "The dimension values returned in this respon se.",
932 "items": {
933 "$ref": "DimensionValue"
934 },
935 "type": "array"
936 },
937 "kind": {
938 "default": "dfareporting#dimensionValueList",
939 "description": "The kind of list this is, in this case dfare porting#dimensionValueList.",
940 "type": "string"
941 },
942 "nextPageToken": {
943 "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.",
944 "type": "string"
945 }
946 },
947 "type": "object"
948 },
949 "DimensionValueRequest": {
950 "description": "Represents a DimensionValuesRequest.",
951 "id": "DimensionValueRequest",
952 "properties": {
953 "dimensionName": {
954 "annotations": {
955 "required": [
956 "dfareporting.dimensionValues.query"
957 ]
958 },
959 "description": "The name of the dimension for which values s hould be requested.",
960 "type": "string"
961 },
962 "endDate": {
963 "annotations": {
964 "required": [
965 "dfareporting.dimensionValues.query"
966 ]
967 },
968 "description": "The end date of the date range for which to retrieve dimension values. A string of the format: \"yyyy-MM-dd\".",
969 "format": "date",
970 "type": "string"
971 },
972 "filters": {
973 "description": "The list of filters by which to filter value s. The filters are ANDed.",
974 "items": {
975 "$ref": "DimensionFilter"
976 },
977 "type": "array"
978 },
979 "kind": {
980 "default": "dfareporting#dimensionValueRequest",
981 "description": "The kind of request this is, in this case df areporting#dimensionValueRequest.",
982 "type": "string"
983 },
984 "startDate": {
985 "annotations": {
986 "required": [
987 "dfareporting.dimensionValues.query"
988 ]
989 },
990 "description": "The start date of the date range for which t o retrieve dimension values. A string of the format: \"yyyy-MM-dd\".",
991 "format": "date",
992 "type": "string"
993 }
994 },
995 "type": "object"
996 },
997 "File": {
998 "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_AVAILAB LE\".",
999 "id": "File",
1000 "properties": {
1001 "dateRange": {
1002 "$ref": "DateRange",
1003 "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."
1004 },
1005 "etag": {
1006 "description": "The eTag of this response for caching purpos es.",
1007 "type": "string"
1008 },
1009 "fileName": {
1010 "description": "The file name of the file.",
1011 "type": "string"
1012 },
1013 "format": {
1014 "description": "The output format of the report. Only availa ble once the file is available.",
1015 "type": "string"
1016 },
1017 "id": {
1018 "description": "The unique ID of this report file.",
1019 "format": "int64",
1020 "type": "string"
1021 },
1022 "kind": {
1023 "default": "dfareporting#file",
1024 "description": "The kind of resource this is, in this case d fareporting#file.",
1025 "type": "string"
1026 },
1027 "lastModifiedTime": {
1028 "description": "The timestamp in milliseconds since epoch wh en this file was last modified.",
1029 "format": "int64",
1030 "type": "string"
1031 },
1032 "reportId": {
1033 "description": "The ID of the report this file was generated from.",
1034 "format": "int64",
1035 "type": "string"
1036 },
1037 "status": {
1038 "description": "The status of the report file, one of: \n- \"PROCESSING\" \n- \"REPORT_AVAILABLE\" \n- \"FAILED\" \n- \"CANCELLED\"",
1039 "type": "string"
1040 },
1041 "urls": {
1042 "description": "The urls where the completed report file can be downloaded.",
1043 "properties": {
1044 "apiUrl": {
1045 "description": "The url for downloading the report d ata through the API.",
1046 "type": "string"
1047 },
1048 "browserUrl": {
1049 "description": "The url for downloading the report d ata through a browser.",
1050 "type": "string"
1051 }
1052 },
1053 "type": "object"
1054 }
1055 },
1056 "type": "object"
1057 },
1058 "FileList": {
1059 "description": "Represents the list of File resources.",
1060 "id": "FileList",
1061 "properties": {
1062 "etag": {
1063 "description": "The eTag of this response for caching purpos es.",
1064 "type": "string"
1065 },
1066 "items": {
1067 "description": "The files returned in this response.",
1068 "items": {
1069 "$ref": "File"
1070 },
1071 "type": "array"
1072 },
1073 "kind": {
1074 "default": "dfareporting#fileList",
1075 "description": "The kind of list this is, in this case dfare porting#fileList.",
1076 "type": "string"
1077 },
1078 "nextPageToken": {
1079 "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.",
1080 "type": "string"
1081 }
1082 },
1083 "type": "object"
1084 },
1085 "FloodlightReportCompatibleFields": {
1086 "description": "Represents fields that are compatible to be selected for a report of type \"FlOODLIGHT\".",
1087 "id": "FloodlightReportCompatibleFields",
1088 "properties": {
1089 "dimensionFilters": {
1090 "description": "Dimensions which are compatible to be select ed in the \"dimensionFilters\" section of the report.",
1091 "items": {
1092 "$ref": "Dimension"
1093 },
1094 "type": "array"
1095 },
1096 "dimensions": {
1097 "description": "Dimensions which are compatible to be select ed in the \"dimensions\" section of the report.",
1098 "items": {
1099 "$ref": "Dimension"
1100 },
1101 "type": "array"
1102 },
1103 "kind": {
1104 "default": "dfareporting#floodlightReportCompatibleFields",
1105 "description": "The kind of resource this is, in this case d fareporting#floodlightReportCompatibleFields.",
1106 "type": "string"
1107 },
1108 "metrics": {
1109 "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
1110 "items": {
1111 "$ref": "Metric"
1112 },
1113 "type": "array"
1114 }
1115 },
1116 "type": "object"
1117 },
1118 "Metric": {
1119 "description": "Represents a metric.",
1120 "id": "Metric",
1121 "properties": {
1122 "kind": {
1123 "default": "dfareporting#metric",
1124 "description": "The kind of resource this is, in this case d fareporting#metric.",
1125 "type": "string"
1126 },
1127 "name": {
1128 "description": "The metric name, e.g. dfa:impressions",
1129 "type": "string"
1130 }
1131 },
1132 "type": "object"
1133 },
1134 "PathToConversionReportCompatibleFields": {
1135 "description": "Represents fields that are compatible to be selected for a report of type \"PATH_TO_CONVERSION\".",
1136 "id": "PathToConversionReportCompatibleFields",
1137 "properties": {
1138 "conversionDimensions": {
1139 "description": "Conversion dimensions which are compatible t o be selected in the \"conversionDimensions\" section of the report.",
1140 "items": {
1141 "$ref": "Dimension"
1142 },
1143 "type": "array"
1144 },
1145 "customFloodlightVariables": {
1146 "description": "Custom floodlight variables which are compat ible to be selected in the \"customFloodlightVariables\" section of the report." ,
1147 "items": {
1148 "$ref": "Dimension"
1149 },
1150 "type": "array"
1151 },
1152 "kind": {
1153 "default": "dfareporting#pathToConversionReportCompatibleFie lds",
1154 "description": "The kind of resource this is, in this case d fareporting#pathToConversionReportCompatibleFields.",
1155 "type": "string"
1156 },
1157 "metrics": {
1158 "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
1159 "items": {
1160 "$ref": "Metric"
1161 },
1162 "type": "array"
1163 },
1164 "perInteractionDimensions": {
1165 "description": "Per-interaction dimensions which are compati ble to be selected in the \"perInteractionDimensions\" section of the report.",
1166 "items": {
1167 "$ref": "Dimension"
1168 },
1169 "type": "array"
1170 }
1171 },
1172 "type": "object"
1173 },
1174 "ReachReportCompatibleFields": {
1175 "description": "Represents fields that are compatible to be selected for a report of type \"REACH\".",
1176 "id": "ReachReportCompatibleFields",
1177 "properties": {
1178 "dimensionFilters": {
1179 "description": "Dimensions which are compatible to be select ed in the \"dimensionFilters\" section of the report.",
1180 "items": {
1181 "$ref": "Dimension"
1182 },
1183 "type": "array"
1184 },
1185 "dimensions": {
1186 "description": "Dimensions which are compatible to be select ed in the \"dimensions\" section of the report.",
1187 "items": {
1188 "$ref": "Dimension"
1189 },
1190 "type": "array"
1191 },
1192 "kind": {
1193 "default": "dfareporting#reachReportCompatibleFields",
1194 "description": "The kind of resource this is, in this case d fareporting#reachReportCompatibleFields.",
1195 "type": "string"
1196 },
1197 "metrics": {
1198 "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
1199 "items": {
1200 "$ref": "Metric"
1201 },
1202 "type": "array"
1203 },
1204 "pivotedActivityMetrics": {
1205 "description": "Metrics which are compatible to be selected as activity metrics to pivot on in the \"activities\" section of the report.",
1206 "items": {
1207 "$ref": "Metric"
1208 },
1209 "type": "array"
1210 },
1211 "reachByFrequencyMetrics": {
1212 "description": "Metrics which are compatible to be selected in the \"reachByFrequencyMetricNames\" section of the report.",
1213 "items": {
1214 "$ref": "Metric"
1215 },
1216 "type": "array"
1217 }
1218 },
1219 "type": "object"
1220 },
1221 "Recipient": {
1222 "description": "Represents a recipient.",
1223 "id": "Recipient",
1224 "properties": {
1225 "deliveryType": {
1226 "annotations": {
1227 "required": [
1228 "dfareporting.reports.insert",
1229 "dfareporting.reports.update"
1230 ]
1231 },
1232 "description": "The delivery type for the recipient, one of: \n- \"ATTACHMENT\" \n- \"LINK\"",
1233 "type": "string"
1234 },
1235 "email": {
1236 "annotations": {
1237 "required": [
1238 "dfareporting.reports.insert",
1239 "dfareporting.reports.update"
1240 ]
1241 },
1242 "description": "The email address of the recipient.",
1243 "type": "string"
1244 },
1245 "kind": {
1246 "default": "dfareporting#recipient",
1247 "description": "The kind of resource this is, in this case d fareporting#recipient.",
1248 "type": "string"
1249 }
1250 },
1251 "type": "object"
1252 },
1253 "Report": {
1254 "description": "Represents a Report resource.",
1255 "id": "Report",
1256 "properties": {
1257 "accountId": {
1258 "annotations": {
1259 "required": [
1260 "dfareporting.reports.update"
1261 ]
1262 },
1263 "description": "The account ID to which this report belongs. ",
1264 "format": "int64",
1265 "type": "string"
1266 },
1267 "activeGrpCriteria": {
1268 "description": "The report criteria for a report of type \"A CTIVE_GRP\".",
1269 "properties": {
1270 "dateRange": {
1271 "$ref": "DateRange",
1272 "description": "The date range this report should be run for."
1273 },
1274 "dimensionFilters": {
1275 "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.\nA valid active GRP report needs to have exactly one DimensionValue for the United States in addition to any advert iser or campaign dimension values.",
1276 "items": {
1277 "$ref": "DimensionValue"
1278 },
1279 "type": "array"
1280 },
1281 "dimensions": {
1282 "description": "The list of dimensions the report sh ould include.",
1283 "items": {
1284 "$ref": "SortedDimension"
1285 },
1286 "type": "array"
1287 },
1288 "metricNames": {
1289 "description": "The list of names of metrics the rep ort should include.",
1290 "items": {
1291 "type": "string"
1292 },
1293 "type": "array"
1294 }
1295 },
1296 "type": "object"
1297 },
1298 "criteria": {
1299 "description": "The report criteria for a report of type \"S TANDARD\".",
1300 "properties": {
1301 "activities": {
1302 "$ref": "Activities",
1303 "description": "Activity group."
1304 },
1305 "customRichMediaEvents": {
1306 "$ref": "CustomRichMediaEvents",
1307 "description": "Custom Rich Media Events group."
1308 },
1309 "dateRange": {
1310 "$ref": "DateRange",
1311 "description": "The date range for which this report should be run."
1312 },
1313 "dimensionFilters": {
1314 "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.",
1315 "items": {
1316 "$ref": "DimensionValue"
1317 },
1318 "type": "array"
1319 },
1320 "dimensions": {
1321 "description": "The list of standard dimensions the report should include.",
1322 "items": {
1323 "$ref": "SortedDimension"
1324 },
1325 "type": "array"
1326 },
1327 "metricNames": {
1328 "description": "The list of names of metrics the rep ort should include.",
1329 "items": {
1330 "type": "string"
1331 },
1332 "type": "array"
1333 }
1334 },
1335 "type": "object"
1336 },
1337 "crossDimensionReachCriteria": {
1338 "description": "The report criteria for a report of type \"C ROSS_DIMENSION_REACH\".",
1339 "properties": {
1340 "breakdown": {
1341 "description": "The list of dimensions the report sh ould include.",
1342 "items": {
1343 "$ref": "SortedDimension"
1344 },
1345 "type": "array"
1346 },
1347 "dateRange": {
1348 "$ref": "DateRange",
1349 "description": "The date range this report should be run for."
1350 },
1351 "dimension": {
1352 "description": "The dimension option, one of: \n- \ "ADVERTISER\" \n- \"CAMPAIGN\" \n- \"SITE_BY_ADVERTISER\" \n- \"SITE_BY_CAMPAIGN \"",
1353 "type": "string"
1354 },
1355 "dimensionFilters": {
1356 "description": "The list of filters on which dimensi ons are filtered.",
1357 "items": {
1358 "$ref": "DimensionValue"
1359 },
1360 "type": "array"
1361 },
1362 "metricNames": {
1363 "description": "The list of names of metrics the rep ort should include.",
1364 "items": {
1365 "type": "string"
1366 },
1367 "type": "array"
1368 },
1369 "overlapMetricNames": {
1370 "description": "The list of names of overlap metrics the report should include.",
1371 "items": {
1372 "type": "string"
1373 },
1374 "type": "array"
1375 },
1376 "pivoted": {
1377 "description": "Whether the report is pivoted or not . Defaults to true.",
1378 "type": "boolean"
1379 }
1380 },
1381 "type": "object"
1382 },
1383 "delivery": {
1384 "description": "The report's email delivery settings.",
1385 "properties": {
1386 "emailOwner": {
1387 "description": "Whether the report should be emailed to the report owner.",
1388 "type": "boolean"
1389 },
1390 "emailOwnerDeliveryType": {
1391 "description": "The type of delivery for the owner t o receive, if enabled. One of: \n- \"ATTACHMENT\" \n- \"LINK\"",
1392 "type": "string"
1393 },
1394 "message": {
1395 "description": "The message to be sent with each ema il.",
1396 "type": "string"
1397 },
1398 "recipients": {
1399 "description": "The list of recipients to which to e mail the report.",
1400 "items": {
1401 "$ref": "Recipient"
1402 },
1403 "type": "array"
1404 }
1405 },
1406 "type": "object"
1407 },
1408 "etag": {
1409 "description": "The eTag of this response for caching purpos es.",
1410 "type": "string"
1411 },
1412 "fileName": {
1413 "description": "The file name used when generating report fi les for this report.",
1414 "type": "string"
1415 },
1416 "floodlightCriteria": {
1417 "description": "The report criteria for a report of type \"F LOODLIGHT\".",
1418 "properties": {
1419 "customRichMediaEvents": {
1420 "description": "The list of custom rich media events to include.",
1421 "items": {
1422 "$ref": "DimensionValue"
1423 },
1424 "type": "array"
1425 },
1426 "dateRange": {
1427 "$ref": "DateRange",
1428 "description": "The date range this report should be run for."
1429 },
1430 "dimensionFilters": {
1431 "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.",
1432 "items": {
1433 "$ref": "DimensionValue"
1434 },
1435 "type": "array"
1436 },
1437 "dimensions": {
1438 "description": "The list of dimensions the report sh ould include.",
1439 "items": {
1440 "$ref": "SortedDimension"
1441 },
1442 "type": "array"
1443 },
1444 "floodlightConfigId": {
1445 "$ref": "DimensionValue",
1446 "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'."
1447 },
1448 "metricNames": {
1449 "description": "The list of names of metrics the rep ort should include.",
1450 "items": {
1451 "type": "string"
1452 },
1453 "type": "array"
1454 },
1455 "reportProperties": {
1456 "description": "The properties of the report.",
1457 "properties": {
1458 "includeAttributedIPConversions": {
1459 "description": "Include conversions that hav e no cookie, but do have an exposure path.",
1460 "type": "boolean"
1461 },
1462 "includeUnattributedCookieConversions": {
1463 "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.",
1464 "type": "boolean"
1465 },
1466 "includeUnattributedIPConversions": {
1467 "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.",
1468 "type": "boolean"
1469 }
1470 },
1471 "type": "object"
1472 }
1473 },
1474 "type": "object"
1475 },
1476 "format": {
1477 "description": "The output format of the report, one of: \n - \"CSV\" \n- \"EXCEL\" If not specified, default format is \"CSV\". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. \"CSV\" will then be the fallba ck format.",
1478 "type": "string"
1479 },
1480 "id": {
1481 "annotations": {
1482 "required": [
1483 "dfareporting.reports.update"
1484 ]
1485 },
1486 "description": "The unique ID identifying this report resour ce.",
1487 "format": "int64",
1488 "type": "string"
1489 },
1490 "kind": {
1491 "default": "dfareporting#report",
1492 "description": "The kind of resource this is, in this case d fareporting#report.",
1493 "type": "string"
1494 },
1495 "lastModifiedTime": {
1496 "annotations": {
1497 "required": [
1498 "dfareporting.reports.update"
1499 ]
1500 },
1501 "description": "The timestamp (in milliseconds since epoch) of when this report was last modified.",
1502 "format": "uint64",
1503 "type": "string"
1504 },
1505 "name": {
1506 "annotations": {
1507 "required": [
1508 "dfareporting.reports.insert",
1509 "dfareporting.reports.update"
1510 ]
1511 },
1512 "description": "The name of the report.",
1513 "type": "string"
1514 },
1515 "ownerProfileId": {
1516 "annotations": {
1517 "required": [
1518 "dfareporting.reports.update"
1519 ]
1520 },
1521 "description": "The user profile id of the owner of this rep ort.",
1522 "format": "int64",
1523 "type": "string"
1524 },
1525 "pathToConversionCriteria": {
1526 "description": "The report criteria for a report of type \"P ATH_TO_CONVERSION\".",
1527 "properties": {
1528 "activityFilters": {
1529 "description": "The list of 'dfa:activity' values to filter on.",
1530 "items": {
1531 "$ref": "DimensionValue"
1532 },
1533 "type": "array"
1534 },
1535 "conversionDimensions": {
1536 "description": "The list of conversion dimensions th e report should include.",
1537 "items": {
1538 "$ref": "SortedDimension"
1539 },
1540 "type": "array"
1541 },
1542 "customFloodlightVariables": {
1543 "description": "The list of custom floodlight variab les the report should include.",
1544 "items": {
1545 "$ref": "SortedDimension"
1546 },
1547 "type": "array"
1548 },
1549 "customRichMediaEvents": {
1550 "description": "The list of custom rich media events to include.",
1551 "items": {
1552 "$ref": "DimensionValue"
1553 },
1554 "type": "array"
1555 },
1556 "dateRange": {
1557 "$ref": "DateRange",
1558 "description": "The date range this report should be run for."
1559 },
1560 "floodlightConfigId": {
1561 "$ref": "DimensionValue",
1562 "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'."
1563 },
1564 "metricNames": {
1565 "description": "The list of names of metrics the rep ort should include.",
1566 "items": {
1567 "type": "string"
1568 },
1569 "type": "array"
1570 },
1571 "perInteractionDimensions": {
1572 "description": "The list of per interaction dimensio ns the report should include.",
1573 "items": {
1574 "$ref": "SortedDimension"
1575 },
1576 "type": "array"
1577 },
1578 "reportProperties": {
1579 "description": "The properties of the report.",
1580 "properties": {
1581 "clicksLookbackWindow": {
1582 "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.",
1583 "format": "int32",
1584 "type": "integer"
1585 },
1586 "impressionsLookbackWindow": {
1587 "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.",
1588 "format": "int32",
1589 "type": "integer"
1590 },
1591 "includeAttributedIPConversions": {
1592 "description": "Deprecated: has no effect.",
1593 "type": "boolean"
1594 },
1595 "includeUnattributedCookieConversions": {
1596 "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.",
1597 "type": "boolean"
1598 },
1599 "includeUnattributedIPConversions": {
1600 "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.",
1601 "type": "boolean"
1602 },
1603 "maximumClickInteractions": {
1604 "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.",
1605 "format": "int32",
1606 "type": "integer"
1607 },
1608 "maximumImpressionInteractions": {
1609 "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.",
1610 "format": "int32",
1611 "type": "integer"
1612 },
1613 "maximumInteractionGap": {
1614 "description": "The maximum amount of time t hat can take place between interactions (clicks or impressions) by the same user . Valid values: 1-90.",
1615 "format": "int32",
1616 "type": "integer"
1617 },
1618 "pivotOnInteractionPath": {
1619 "description": "Enable pivoting on interacti on path.",
1620 "type": "boolean"
1621 }
1622 },
1623 "type": "object"
1624 }
1625 },
1626 "type": "object"
1627 },
1628 "reachCriteria": {
1629 "description": "The report criteria for a report of type \"R EACH\".",
1630 "properties": {
1631 "activities": {
1632 "$ref": "Activities",
1633 "description": "Activity group."
1634 },
1635 "customRichMediaEvents": {
1636 "$ref": "CustomRichMediaEvents",
1637 "description": "Custom Rich Media Events group."
1638 },
1639 "dateRange": {
1640 "$ref": "DateRange",
1641 "description": "The date range this report should be run for."
1642 },
1643 "dimensionFilters": {
1644 "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.",
1645 "items": {
1646 "$ref": "DimensionValue"
1647 },
1648 "type": "array"
1649 },
1650 "dimensions": {
1651 "description": "The list of dimensions the report sh ould include.",
1652 "items": {
1653 "$ref": "SortedDimension"
1654 },
1655 "type": "array"
1656 },
1657 "metricNames": {
1658 "description": "The list of names of metrics the rep ort should include.",
1659 "items": {
1660 "type": "string"
1661 },
1662 "type": "array"
1663 },
1664 "reachByFrequencyMetricNames": {
1665 "description": "The list of names of Reach By Frequ ency metrics the report should include.",
1666 "items": {
1667 "type": "string"
1668 },
1669 "type": "array"
1670 }
1671 },
1672 "type": "object"
1673 },
1674 "schedule": {
1675 "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\".",
1676 "properties": {
1677 "active": {
1678 "annotations": {
1679 "required": [
1680 "dfareporting.reports.insert",
1681 "dfareporting.reports.update"
1682 ]
1683 },
1684 "description": "Whether the schedule is active or no t. Must be set to either true or false.",
1685 "type": "boolean"
1686 },
1687 "every": {
1688 "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\".",
1689 "format": "int32",
1690 "type": "integer"
1691 },
1692 "expirationDate": {
1693 "annotations": {
1694 "required": [
1695 "dfareporting.reports.insert",
1696 "dfareporting.reports.update"
1697 ]
1698 },
1699 "description": "The expiration date when the schedul ed report stops running.",
1700 "format": "date",
1701 "type": "string"
1702 },
1703 "repeats": {
1704 "annotations": {
1705 "required": [
1706 "dfareporting.reports.insert",
1707 "dfareporting.reports.update"
1708 ]
1709 },
1710 "description": "The interval for which the report is repeated, one of: \n- \"DAILY\", also requires field \"every\" to be set. \n- \"WEEKLY\", also requires fields \"every\" and \"repeatsOnWeekDays\" to be set. \n- \"TWICE_A_MONTH\" \n- \"MONTHLY\", also requires fields \"every\" and \"runs OnDayOfMonth\" to be set. \n- \"QUARTERLY\" \n- \"YEARLY\"",
1711 "type": "string"
1712 },
1713 "repeatsOnWeekDays": {
1714 "description": "List of week days \"WEEKLY\" on whic h scheduled reports should run.",
1715 "items": {
1716 "type": "string"
1717 },
1718 "type": "array"
1719 },
1720 "runsOnDayOfMonth": {
1721 "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. Possible values are: \n - DAY_OF_MONTH \n- WEEK_OF_MONTH \nExample: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), \"DAY_OF_MONTH\" would run subsequent reports on the 2nd of every Month, and \"WEEK_OF_MONTH\" would run subsequent reports on the first Mon day of the month.",
1722 "type": "string"
1723 },
1724 "startDate": {
1725 "annotations": {
1726 "required": [
1727 "dfareporting.reports.insert",
1728 "dfareporting.reports.update"
1729 ]
1730 },
1731 "description": "Start date of date range for which s cheduled reports should be run.",
1732 "format": "date",
1733 "type": "string"
1734 }
1735 },
1736 "type": "object"
1737 },
1738 "subAccountId": {
1739 "description": "The subbaccount ID to which this report belo ngs if applicable.",
1740 "format": "int64",
1741 "type": "string"
1742 },
1743 "type": {
1744 "annotations": {
1745 "required": [
1746 "dfareporting.reports.insert",
1747 "dfareporting.reports.update"
1748 ]
1749 },
1750 "description": "The type of the report, one of: \n- STANDAR D \n- REACH \n- ACTIVE_GRP \n- PATH_TO_CONVERSION \n- FLOODLIGHT \n- CROSS_DIMEN SION_REACH",
1751 "type": "string"
1752 }
1753 },
1754 "type": "object"
1755 },
1756 "ReportCompatibleFields": {
1757 "description": "Represents fields that are compatible to be selected for a report of type \"STANDARD\".",
1758 "id": "ReportCompatibleFields",
1759 "properties": {
1760 "dimensionFilters": {
1761 "description": "Dimensions which are compatible to be select ed in the \"dimensionFilters\" section of the report.",
1762 "items": {
1763 "$ref": "Dimension"
1764 },
1765 "type": "array"
1766 },
1767 "dimensions": {
1768 "description": "Dimensions which are compatible to be select ed in the \"dimensions\" section of the report.",
1769 "items": {
1770 "$ref": "Dimension"
1771 },
1772 "type": "array"
1773 },
1774 "kind": {
1775 "default": "dfareporting#reportCompatibleFields",
1776 "description": "The kind of resource this is, in this case d fareporting#reportCompatibleFields.",
1777 "type": "string"
1778 },
1779 "metrics": {
1780 "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
1781 "items": {
1782 "$ref": "Metric"
1783 },
1784 "type": "array"
1785 },
1786 "pivotedActivityMetrics": {
1787 "description": "Metrics which are compatible to be selected as activity metrics to pivot on in the \"activities\" section of the report.",
1788 "items": {
1789 "$ref": "Metric"
1790 },
1791 "type": "array"
1792 }
1793 },
1794 "type": "object"
1795 },
1796 "ReportList": {
1797 "description": "Represents the list of reports.",
1798 "id": "ReportList",
1799 "properties": {
1800 "etag": {
1801 "description": "The eTag of this response for caching purpos es.",
1802 "type": "string"
1803 },
1804 "items": {
1805 "description": "The reports returned in this response.",
1806 "items": {
1807 "$ref": "Report"
1808 },
1809 "type": "array"
1810 },
1811 "kind": {
1812 "default": "dfareporting#reportList",
1813 "description": "The kind of list this is, in this case dfare porting#reportList.",
1814 "type": "string"
1815 },
1816 "nextPageToken": {
1817 "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.",
1818 "type": "string"
1819 }
1820 },
1821 "type": "object"
1822 },
1823 "SortedDimension": {
1824 "description": "Represents a sorted dimension.",
1825 "id": "SortedDimension",
1826 "properties": {
1827 "kind": {
1828 "default": "dfareporting#sortedDimension",
1829 "description": "The kind of resource this is, in this case d fareporting#sortedDimension.",
1830 "type": "string"
1831 },
1832 "name": {
1833 "description": "The name of the dimension.",
1834 "type": "string"
1835 },
1836 "sortOrder": {
1837 "description": "An optional sort order for the dimension col umn, one of: \n- \"ASCENDING\" \n- \"DESCENDING\"",
1838 "type": "string"
1839 }
1840 },
1841 "type": "object"
1842 },
1843 "UserProfile": {
1844 "description": "Represents a UserProfile resource.",
1845 "id": "UserProfile",
1846 "properties": {
1847 "accountId": {
1848 "description": "The account ID to which this profile belongs .",
1849 "format": "int64",
1850 "type": "string"
1851 },
1852 "accountName": {
1853 "description": "The account name this profile belongs to.",
1854 "type": "string"
1855 },
1856 "etag": {
1857 "description": "The eTag of this response for caching purpos es.",
1858 "type": "string"
1859 },
1860 "kind": {
1861 "default": "dfareporting#userProfile",
1862 "description": "The kind of resource this is, in this case d fareporting#userProfile.",
1863 "type": "string"
1864 },
1865 "profileId": {
1866 "description": "The unique ID of the user profile.",
1867 "format": "int64",
1868 "type": "string"
1869 },
1870 "subAccountId": {
1871 "description": "The sub account ID this profile belongs to i f applicable.",
1872 "format": "int64",
1873 "type": "string"
1874 },
1875 "subAccountName": {
1876 "description": "The sub account name this profile belongs to if applicable.",
1877 "type": "string"
1878 },
1879 "userName": {
1880 "description": "The user name.",
1881 "type": "string"
1882 }
1883 },
1884 "type": "object"
1885 },
1886 "UserProfileList": {
1887 "description": "Represents the list of user profiles.",
1888 "id": "UserProfileList",
1889 "properties": {
1890 "etag": {
1891 "description": "The eTag of this response for caching purpos es.",
1892 "type": "string"
1893 },
1894 "items": {
1895 "description": "The user profiles returned in this response. ",
1896 "items": {
1897 "$ref": "UserProfile"
1898 },
1899 "type": "array"
1900 },
1901 "kind": {
1902 "default": "dfareporting#userProfileList",
1903 "description": "The kind of list this is, in this case dfare porting#userProfileList.",
1904 "type": "string"
1905 }
1906 },
1907 "type": "object"
1908 }
1909 },
1910 "servicePath": "dfareporting/v1.3/",
1911 "title": "DFA Reporting API",
1912 "version": "v1.3"
1913 }
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698