25개 이상의 토픽을 선택하실 수 없습니다. Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 

2173 lines
64 KiB

  1. {
  2. "auth": {
  3. "oauth2": {
  4. "scopes": {
  5. "https://www.googleapis.com/auth/doubleclickbidmanager": {
  6. "description": "View and manage your reports in DoubleClick Bid Manager"
  7. }
  8. }
  9. }
  10. },
  11. "basePath": "/doubleclickbidmanager/v1/",
  12. "baseUrl": "https://www.googleapis.com/doubleclickbidmanager/v1/",
  13. "batchPath": "batch/doubleclickbidmanager/v1",
  14. "canonicalName": "DoubleClick Bid Manager",
  15. "description": "API for viewing and managing your reports in DoubleClick Bid Manager.",
  16. "discoveryVersion": "v1",
  17. "documentationLink": "https://developers.google.com/bid-manager/",
  18. "etag": "\"Zkyw9ACJZUvcYmlFaKGChzhmtnE/aeqE65OvZZ6FdXY2G_0kVB4zmis\"",
  19. "icons": {
  20. "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
  21. "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
  22. },
  23. "id": "doubleclickbidmanager:v1",
  24. "kind": "discovery#restDescription",
  25. "labels": [
  26. "limited_availability"
  27. ],
  28. "name": "doubleclickbidmanager",
  29. "ownerDomain": "google.com",
  30. "ownerName": "Google",
  31. "parameters": {
  32. "alt": {
  33. "default": "json",
  34. "description": "Data format for the response.",
  35. "enum": [
  36. "json"
  37. ],
  38. "enumDescriptions": [
  39. "Responses with Content-Type of application/json"
  40. ],
  41. "location": "query",
  42. "type": "string"
  43. },
  44. "fields": {
  45. "description": "Selector specifying which fields to include in a partial response.",
  46. "location": "query",
  47. "type": "string"
  48. },
  49. "key": {
  50. "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
  51. "location": "query",
  52. "type": "string"
  53. },
  54. "oauth_token": {
  55. "description": "OAuth 2.0 token for the current user.",
  56. "location": "query",
  57. "type": "string"
  58. },
  59. "prettyPrint": {
  60. "default": "true",
  61. "description": "Returns response with indentations and line breaks.",
  62. "location": "query",
  63. "type": "boolean"
  64. },
  65. "quotaUser": {
  66. "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
  67. "location": "query",
  68. "type": "string"
  69. },
  70. "userIp": {
  71. "description": "Deprecated. Please use quotaUser instead.",
  72. "location": "query",
  73. "type": "string"
  74. }
  75. },
  76. "protocol": "rest",
  77. "resources": {
  78. "lineitems": {
  79. "methods": {
  80. "downloadlineitems": {
  81. "description": "Retrieves line items in CSV format. TrueView line items are not supported.",
  82. "httpMethod": "POST",
  83. "id": "doubleclickbidmanager.lineitems.downloadlineitems",
  84. "path": "lineitems/downloadlineitems",
  85. "request": {
  86. "$ref": "DownloadLineItemsRequest"
  87. },
  88. "response": {
  89. "$ref": "DownloadLineItemsResponse"
  90. },
  91. "scopes": [
  92. "https://www.googleapis.com/auth/doubleclickbidmanager"
  93. ]
  94. },
  95. "uploadlineitems": {
  96. "description": "Uploads line items in CSV format. TrueView line items are not supported.",
  97. "httpMethod": "POST",
  98. "id": "doubleclickbidmanager.lineitems.uploadlineitems",
  99. "path": "lineitems/uploadlineitems",
  100. "request": {
  101. "$ref": "UploadLineItemsRequest"
  102. },
  103. "response": {
  104. "$ref": "UploadLineItemsResponse"
  105. },
  106. "scopes": [
  107. "https://www.googleapis.com/auth/doubleclickbidmanager"
  108. ]
  109. }
  110. }
  111. },
  112. "queries": {
  113. "methods": {
  114. "createquery": {
  115. "description": "Creates a query.",
  116. "httpMethod": "POST",
  117. "id": "doubleclickbidmanager.queries.createquery",
  118. "path": "query",
  119. "request": {
  120. "$ref": "Query"
  121. },
  122. "response": {
  123. "$ref": "Query"
  124. },
  125. "scopes": [
  126. "https://www.googleapis.com/auth/doubleclickbidmanager"
  127. ]
  128. },
  129. "deletequery": {
  130. "description": "Deletes a stored query as well as the associated stored reports.",
  131. "httpMethod": "DELETE",
  132. "id": "doubleclickbidmanager.queries.deletequery",
  133. "parameterOrder": [
  134. "queryId"
  135. ],
  136. "parameters": {
  137. "queryId": {
  138. "description": "Query ID to delete.",
  139. "format": "int64",
  140. "location": "path",
  141. "required": true,
  142. "type": "string"
  143. }
  144. },
  145. "path": "query/{queryId}",
  146. "scopes": [
  147. "https://www.googleapis.com/auth/doubleclickbidmanager"
  148. ]
  149. },
  150. "getquery": {
  151. "description": "Retrieves a stored query.",
  152. "httpMethod": "GET",
  153. "id": "doubleclickbidmanager.queries.getquery",
  154. "parameterOrder": [
  155. "queryId"
  156. ],
  157. "parameters": {
  158. "queryId": {
  159. "description": "Query ID to retrieve.",
  160. "format": "int64",
  161. "location": "path",
  162. "required": true,
  163. "type": "string"
  164. }
  165. },
  166. "path": "query/{queryId}",
  167. "response": {
  168. "$ref": "Query"
  169. },
  170. "scopes": [
  171. "https://www.googleapis.com/auth/doubleclickbidmanager"
  172. ]
  173. },
  174. "listqueries": {
  175. "description": "Retrieves stored queries.",
  176. "httpMethod": "GET",
  177. "id": "doubleclickbidmanager.queries.listqueries",
  178. "path": "queries",
  179. "response": {
  180. "$ref": "ListQueriesResponse"
  181. },
  182. "scopes": [
  183. "https://www.googleapis.com/auth/doubleclickbidmanager"
  184. ]
  185. },
  186. "runquery": {
  187. "description": "Runs a stored query to generate a report.",
  188. "httpMethod": "POST",
  189. "id": "doubleclickbidmanager.queries.runquery",
  190. "parameterOrder": [
  191. "queryId"
  192. ],
  193. "parameters": {
  194. "queryId": {
  195. "description": "Query ID to run.",
  196. "format": "int64",
  197. "location": "path",
  198. "required": true,
  199. "type": "string"
  200. }
  201. },
  202. "path": "query/{queryId}",
  203. "request": {
  204. "$ref": "RunQueryRequest"
  205. },
  206. "scopes": [
  207. "https://www.googleapis.com/auth/doubleclickbidmanager"
  208. ]
  209. }
  210. }
  211. },
  212. "reports": {
  213. "methods": {
  214. "listreports": {
  215. "description": "Retrieves stored reports.",
  216. "httpMethod": "GET",
  217. "id": "doubleclickbidmanager.reports.listreports",
  218. "parameterOrder": [
  219. "queryId"
  220. ],
  221. "parameters": {
  222. "queryId": {
  223. "description": "Query ID with which the reports are associated.",
  224. "format": "int64",
  225. "location": "path",
  226. "required": true,
  227. "type": "string"
  228. }
  229. },
  230. "path": "queries/{queryId}/reports",
  231. "response": {
  232. "$ref": "ListReportsResponse"
  233. },
  234. "scopes": [
  235. "https://www.googleapis.com/auth/doubleclickbidmanager"
  236. ]
  237. }
  238. }
  239. },
  240. "sdf": {
  241. "methods": {
  242. "download": {
  243. "description": "Retrieves entities in SDF format.",
  244. "httpMethod": "POST",
  245. "id": "doubleclickbidmanager.sdf.download",
  246. "path": "sdf/download",
  247. "request": {
  248. "$ref": "DownloadRequest"
  249. },
  250. "response": {
  251. "$ref": "DownloadResponse"
  252. },
  253. "scopes": [
  254. "https://www.googleapis.com/auth/doubleclickbidmanager"
  255. ]
  256. }
  257. }
  258. }
  259. },
  260. "revision": "20180215",
  261. "rootUrl": "https://www.googleapis.com/",
  262. "schemas": {
  263. "DownloadLineItemsRequest": {
  264. "description": "Request to fetch stored line items.",
  265. "id": "DownloadLineItemsRequest",
  266. "properties": {
  267. "fileSpec": {
  268. "description": "File specification (column names, types, order) in which the line items will be returned. Default to EWF.",
  269. "enum": [
  270. "EWF"
  271. ],
  272. "enumDescriptions": [
  273. ""
  274. ],
  275. "type": "string"
  276. },
  277. "filterIds": {
  278. "description": "Ids of the specified filter type used to filter line items to fetch. If omitted, all the line items will be returned.",
  279. "items": {
  280. "format": "int64",
  281. "type": "string"
  282. },
  283. "type": "array"
  284. },
  285. "filterType": {
  286. "description": "Filter type used to filter line items to fetch.",
  287. "enum": [
  288. "ADVERTISER_ID",
  289. "INSERTION_ORDER_ID",
  290. "LINE_ITEM_ID"
  291. ],
  292. "enumDescriptions": [
  293. "",
  294. "",
  295. ""
  296. ],
  297. "type": "string"
  298. },
  299. "format": {
  300. "description": "Format in which the line items will be returned. Default to CSV.",
  301. "enum": [
  302. "CSV"
  303. ],
  304. "enumDescriptions": [
  305. ""
  306. ],
  307. "type": "string"
  308. }
  309. },
  310. "type": "object"
  311. },
  312. "DownloadLineItemsResponse": {
  313. "description": "Download line items response.",
  314. "id": "DownloadLineItemsResponse",
  315. "properties": {
  316. "lineItems": {
  317. "description": "Retrieved line items in CSV format. For more information about file formats, see Entity Write File Format.",
  318. "type": "string"
  319. }
  320. },
  321. "type": "object"
  322. },
  323. "DownloadRequest": {
  324. "description": "Request to fetch stored insertion orders, line items, TrueView ad groups and ads.",
  325. "id": "DownloadRequest",
  326. "properties": {
  327. "fileTypes": {
  328. "description": "File types that will be returned.",
  329. "items": {
  330. "enum": [
  331. "AD",
  332. "AD_GROUP",
  333. "CAMPAIGN",
  334. "INSERTION_ORDER",
  335. "LINE_ITEM"
  336. ],
  337. "enumDescriptions": [
  338. "",
  339. "",
  340. "",
  341. "",
  342. ""
  343. ],
  344. "type": "string"
  345. },
  346. "type": "array"
  347. },
  348. "filterIds": {
  349. "description": "The IDs of the specified filter type. This is used to filter entities to fetch. At least one ID must be specified. Only one ID is allowed for the ADVERTISER_ID filter type. For INSERTION_ORDER_ID or LINE_ITEM_ID filter types, all IDs must be from the same Advertiser.",
  350. "items": {
  351. "format": "int64",
  352. "type": "string"
  353. },
  354. "type": "array"
  355. },
  356. "filterType": {
  357. "description": "Filter type used to filter line items to fetch.",
  358. "enum": [
  359. "ADVERTISER_ID",
  360. "CAMPAIGN_ID",
  361. "INSERTION_ORDER_ID",
  362. "LINE_ITEM_ID"
  363. ],
  364. "enumDescriptions": [
  365. "",
  366. "",
  367. "",
  368. ""
  369. ],
  370. "type": "string"
  371. },
  372. "version": {
  373. "description": "SDF Version (column names, types, order) in which the entities will be returned. Default to 3.",
  374. "type": "string"
  375. }
  376. },
  377. "type": "object"
  378. },
  379. "DownloadResponse": {
  380. "description": "Download response.",
  381. "id": "DownloadResponse",
  382. "properties": {
  383. "adGroups": {
  384. "description": "Retrieved ad groups in SDF format.",
  385. "type": "string"
  386. },
  387. "ads": {
  388. "description": "Retrieved ads in SDF format.",
  389. "type": "string"
  390. },
  391. "campaigns": {
  392. "description": "Retrieved campaigns in SDF format.",
  393. "type": "string"
  394. },
  395. "insertionOrders": {
  396. "description": "Retrieved insertion orders in SDF format.",
  397. "type": "string"
  398. },
  399. "lineItems": {
  400. "description": "Retrieved line items in SDF format.",
  401. "type": "string"
  402. }
  403. },
  404. "type": "object"
  405. },
  406. "FilterPair": {
  407. "description": "Filter used to match traffic data in your report.",
  408. "id": "FilterPair",
  409. "properties": {
  410. "type": {
  411. "description": "Filter type.",
  412. "enum": [
  413. "FILTER_ACTIVE_VIEW_EXPECTED_VIEWABILITY",
  414. "FILTER_ACTIVITY_ID",
  415. "FILTER_ADVERTISER",
  416. "FILTER_ADVERTISER_CURRENCY",
  417. "FILTER_ADVERTISER_TIMEZONE",
  418. "FILTER_AD_POSITION",
  419. "FILTER_AGE",
  420. "FILTER_BRANDSAFE_CHANNEL_ID",
  421. "FILTER_BROWSER",
  422. "FILTER_BUDGET_SEGMENT_DESCRIPTION",
  423. "FILTER_CAMPAIGN_DAILY_FREQUENCY",
  424. "FILTER_CARRIER",
  425. "FILTER_CHANNEL_ID",
  426. "FILTER_CITY",
  427. "FILTER_COMPANION_CREATIVE_ID",
  428. "FILTER_CONVERSION_DELAY",
  429. "FILTER_COUNTRY",
  430. "FILTER_CREATIVE_HEIGHT",
  431. "FILTER_CREATIVE_ID",
  432. "FILTER_CREATIVE_SIZE",
  433. "FILTER_CREATIVE_TYPE",
  434. "FILTER_CREATIVE_WIDTH",
  435. "FILTER_DATA_PROVIDER",
  436. "FILTER_DATE",
  437. "FILTER_DAY_OF_WEEK",
  438. "FILTER_DFP_ORDER_ID",
  439. "FILTER_DMA",
  440. "FILTER_EXCHANGE_ID",
  441. "FILTER_FLOODLIGHT_PIXEL_ID",
  442. "FILTER_GENDER",
  443. "FILTER_INSERTION_ORDER",
  444. "FILTER_INVENTORY_FORMAT",
  445. "FILTER_INVENTORY_SOURCE",
  446. "FILTER_INVENTORY_SOURCE_TYPE",
  447. "FILTER_KEYWORD",
  448. "FILTER_LINE_ITEM",
  449. "FILTER_LINE_ITEM_DAILY_FREQUENCY",
  450. "FILTER_LINE_ITEM_LIFETIME_FREQUENCY",
  451. "FILTER_LINE_ITEM_TYPE",
  452. "FILTER_MEDIA_PLAN",
  453. "FILTER_MOBILE_DEVICE_MAKE",
  454. "FILTER_MOBILE_DEVICE_MAKE_MODEL",
  455. "FILTER_MOBILE_DEVICE_TYPE",
  456. "FILTER_MOBILE_GEO",
  457. "FILTER_MONTH",
  458. "FILTER_MRAID_SUPPORT",
  459. "FILTER_NIELSEN_AGE",
  460. "FILTER_NIELSEN_COUNTRY_CODE",
  461. "FILTER_NIELSEN_DEVICE_ID",
  462. "FILTER_NIELSEN_GENDER",
  463. "FILTER_NOT_SUPPORTED",
  464. "FILTER_ORDER_ID",
  465. "FILTER_OS",
  466. "FILTER_PAGE_CATEGORY",
  467. "FILTER_PAGE_LAYOUT",
  468. "FILTER_PARTNER",
  469. "FILTER_PARTNER_CURRENCY",
  470. "FILTER_PUBLIC_INVENTORY",
  471. "FILTER_QUARTER",
  472. "FILTER_REGION",
  473. "FILTER_REGULAR_CHANNEL_ID",
  474. "FILTER_SITE_ID",
  475. "FILTER_SITE_LANGUAGE",
  476. "FILTER_SKIPPABLE_SUPPORT",
  477. "FILTER_TARGETED_USER_LIST",
  478. "FILTER_TIME_OF_DAY",
  479. "FILTER_TRUEVIEW_AD_GROUP_AD_ID",
  480. "FILTER_TRUEVIEW_AD_GROUP_ID",
  481. "FILTER_TRUEVIEW_AGE",
  482. "FILTER_TRUEVIEW_CATEGORY",
  483. "FILTER_TRUEVIEW_CITY",
  484. "FILTER_TRUEVIEW_CONVERSION_TYPE",
  485. "FILTER_TRUEVIEW_COUNTRY",
  486. "FILTER_TRUEVIEW_CUSTOM_AFFINITY",
  487. "FILTER_TRUEVIEW_DMA",
  488. "FILTER_TRUEVIEW_GENDER",
  489. "FILTER_TRUEVIEW_IAR_AGE",
  490. "FILTER_TRUEVIEW_IAR_CATEGORY",
  491. "FILTER_TRUEVIEW_IAR_CITY",
  492. "FILTER_TRUEVIEW_IAR_COUNTRY",
  493. "FILTER_TRUEVIEW_IAR_GENDER",
  494. "FILTER_TRUEVIEW_IAR_INTEREST",
  495. "FILTER_TRUEVIEW_IAR_LANGUAGE",
  496. "FILTER_TRUEVIEW_IAR_PARENTAL_STATUS",
  497. "FILTER_TRUEVIEW_IAR_REGION",
  498. "FILTER_TRUEVIEW_IAR_REMARKETING_LIST",
  499. "FILTER_TRUEVIEW_IAR_TIME_OF_DAY",
  500. "FILTER_TRUEVIEW_IAR_YOUTUBE_CHANNEL",
  501. "FILTER_TRUEVIEW_IAR_YOUTUBE_VIDEO",
  502. "FILTER_TRUEVIEW_IAR_ZIPCODE",
  503. "FILTER_TRUEVIEW_INTEREST",
  504. "FILTER_TRUEVIEW_KEYWORD",
  505. "FILTER_TRUEVIEW_PARENTAL_STATUS",
  506. "FILTER_TRUEVIEW_PLACEMENT",
  507. "FILTER_TRUEVIEW_REGION",
  508. "FILTER_TRUEVIEW_REMARKETING_LIST",
  509. "FILTER_TRUEVIEW_URL",
  510. "FILTER_TRUEVIEW_ZIPCODE",
  511. "FILTER_UNKNOWN",
  512. "FILTER_USER_LIST",
  513. "FILTER_USER_LIST_FIRST_PARTY",
  514. "FILTER_USER_LIST_THIRD_PARTY",
  515. "FILTER_VIDEO_AD_POSITION_IN_STREAM",
  516. "FILTER_VIDEO_COMPANION_SIZE",
  517. "FILTER_VIDEO_COMPANION_TYPE",
  518. "FILTER_VIDEO_CREATIVE_DURATION",
  519. "FILTER_VIDEO_CREATIVE_DURATION_SKIPPABLE",
  520. "FILTER_VIDEO_DURATION_SECONDS",
  521. "FILTER_VIDEO_FORMAT_SUPPORT",
  522. "FILTER_VIDEO_INVENTORY_TYPE",
  523. "FILTER_VIDEO_PLAYER_SIZE",
  524. "FILTER_VIDEO_RATING_TIER",
  525. "FILTER_VIDEO_SKIPPABLE_SUPPORT",
  526. "FILTER_VIDEO_VPAID_SUPPORT",
  527. "FILTER_WEEK",
  528. "FILTER_YEAR",
  529. "FILTER_YOUTUBE_VERTICAL",
  530. "FILTER_ZIP_CODE"
  531. ],
  532. "enumDescriptions": [
  533. "",
  534. "",
  535. "",
  536. "",
  537. "",
  538. "",
  539. "",
  540. "",
  541. "",
  542. "",
  543. "",
  544. "",
  545. "",
  546. "",
  547. "",
  548. "",
  549. "",
  550. "",
  551. "",
  552. "",
  553. "",
  554. "",
  555. "",
  556. "",
  557. "",
  558. "",
  559. "",
  560. "",
  561. "",
  562. "",
  563. "",
  564. "",
  565. "",
  566. "",
  567. "",
  568. "",
  569. "",
  570. "",
  571. "",
  572. "",
  573. "",
  574. "",
  575. "",
  576. "",
  577. "",
  578. "",
  579. "",
  580. "",
  581. "",
  582. "",
  583. "",
  584. "",
  585. "",
  586. "",
  587. "",
  588. "",
  589. "",
  590. "",
  591. "",
  592. "",
  593. "",
  594. "",
  595. "",
  596. "",
  597. "",
  598. "",
  599. "",
  600. "",
  601. "",
  602. "",
  603. "",
  604. "",
  605. "",
  606. "",
  607. "",
  608. "",
  609. "",
  610. "",
  611. "",
  612. "",
  613. "",
  614. "",
  615. "",
  616. "",
  617. "",
  618. "",
  619. "",
  620. "",
  621. "",
  622. "",
  623. "",
  624. "",
  625. "",
  626. "",
  627. "",
  628. "",
  629. "",
  630. "",
  631. "",
  632. "",
  633. "",
  634. "",
  635. "",
  636. "",
  637. "",
  638. "",
  639. "",
  640. "",
  641. "",
  642. "",
  643. "",
  644. "",
  645. "",
  646. "",
  647. "",
  648. "",
  649. "",
  650. ""
  651. ],
  652. "type": "string"
  653. },
  654. "value": {
  655. "description": "Filter value.",
  656. "type": "string"
  657. }
  658. },
  659. "type": "object"
  660. },
  661. "ListQueriesResponse": {
  662. "description": "List queries response.",
  663. "id": "ListQueriesResponse",
  664. "properties": {
  665. "kind": {
  666. "default": "doubleclickbidmanager#listQueriesResponse",
  667. "description": "Identifies what kind of resource this is. Value: the fixed string \"doubleclickbidmanager#listQueriesResponse\".",
  668. "type": "string"
  669. },
  670. "queries": {
  671. "description": "Retrieved queries.",
  672. "items": {
  673. "$ref": "Query"
  674. },
  675. "type": "array"
  676. }
  677. },
  678. "type": "object"
  679. },
  680. "ListReportsResponse": {
  681. "description": "List reports response.",
  682. "id": "ListReportsResponse",
  683. "properties": {
  684. "kind": {
  685. "default": "doubleclickbidmanager#listReportsResponse",
  686. "description": "Identifies what kind of resource this is. Value: the fixed string \"doubleclickbidmanager#listReportsResponse\".",
  687. "type": "string"
  688. },
  689. "reports": {
  690. "description": "Retrieved reports.",
  691. "items": {
  692. "$ref": "Report"
  693. },
  694. "type": "array"
  695. }
  696. },
  697. "type": "object"
  698. },
  699. "Parameters": {
  700. "description": "Parameters of a query or report.",
  701. "id": "Parameters",
  702. "properties": {
  703. "filters": {
  704. "description": "Filters used to match traffic data in your report.",
  705. "items": {
  706. "$ref": "FilterPair"
  707. },
  708. "type": "array"
  709. },
  710. "groupBys": {
  711. "description": "Data is grouped by the filters listed in this field.",
  712. "items": {
  713. "enum": [
  714. "FILTER_ACTIVE_VIEW_EXPECTED_VIEWABILITY",
  715. "FILTER_ACTIVITY_ID",
  716. "FILTER_ADVERTISER",
  717. "FILTER_ADVERTISER_CURRENCY",
  718. "FILTER_ADVERTISER_TIMEZONE",
  719. "FILTER_AD_POSITION",
  720. "FILTER_AGE",
  721. "FILTER_BRANDSAFE_CHANNEL_ID",
  722. "FILTER_BROWSER",
  723. "FILTER_BUDGET_SEGMENT_DESCRIPTION",
  724. "FILTER_CAMPAIGN_DAILY_FREQUENCY",
  725. "FILTER_CARRIER",
  726. "FILTER_CHANNEL_ID",
  727. "FILTER_CITY",
  728. "FILTER_COMPANION_CREATIVE_ID",
  729. "FILTER_CONVERSION_DELAY",
  730. "FILTER_COUNTRY",
  731. "FILTER_CREATIVE_HEIGHT",
  732. "FILTER_CREATIVE_ID",
  733. "FILTER_CREATIVE_SIZE",
  734. "FILTER_CREATIVE_TYPE",
  735. "FILTER_CREATIVE_WIDTH",
  736. "FILTER_DATA_PROVIDER",
  737. "FILTER_DATE",
  738. "FILTER_DAY_OF_WEEK",
  739. "FILTER_DFP_ORDER_ID",
  740. "FILTER_DMA",
  741. "FILTER_EXCHANGE_ID",
  742. "FILTER_FLOODLIGHT_PIXEL_ID",
  743. "FILTER_GENDER",
  744. "FILTER_INSERTION_ORDER",
  745. "FILTER_INVENTORY_FORMAT",
  746. "FILTER_INVENTORY_SOURCE",
  747. "FILTER_INVENTORY_SOURCE_TYPE",
  748. "FILTER_KEYWORD",
  749. "FILTER_LINE_ITEM",
  750. "FILTER_LINE_ITEM_DAILY_FREQUENCY",
  751. "FILTER_LINE_ITEM_LIFETIME_FREQUENCY",
  752. "FILTER_LINE_ITEM_TYPE",
  753. "FILTER_MEDIA_PLAN",
  754. "FILTER_MOBILE_DEVICE_MAKE",
  755. "FILTER_MOBILE_DEVICE_MAKE_MODEL",
  756. "FILTER_MOBILE_DEVICE_TYPE",
  757. "FILTER_MOBILE_GEO",
  758. "FILTER_MONTH",
  759. "FILTER_MRAID_SUPPORT",
  760. "FILTER_NIELSEN_AGE",
  761. "FILTER_NIELSEN_COUNTRY_CODE",
  762. "FILTER_NIELSEN_DEVICE_ID",
  763. "FILTER_NIELSEN_GENDER",
  764. "FILTER_NOT_SUPPORTED",
  765. "FILTER_ORDER_ID",
  766. "FILTER_OS",
  767. "FILTER_PAGE_CATEGORY",
  768. "FILTER_PAGE_LAYOUT",
  769. "FILTER_PARTNER",
  770. "FILTER_PARTNER_CURRENCY",
  771. "FILTER_PUBLIC_INVENTORY",
  772. "FILTER_QUARTER",
  773. "FILTER_REGION",
  774. "FILTER_REGULAR_CHANNEL_ID",
  775. "FILTER_SITE_ID",
  776. "FILTER_SITE_LANGUAGE",
  777. "FILTER_SKIPPABLE_SUPPORT",
  778. "FILTER_TARGETED_USER_LIST",
  779. "FILTER_TIME_OF_DAY",
  780. "FILTER_TRUEVIEW_AD_GROUP_AD_ID",
  781. "FILTER_TRUEVIEW_AD_GROUP_ID",
  782. "FILTER_TRUEVIEW_AGE",
  783. "FILTER_TRUEVIEW_CATEGORY",
  784. "FILTER_TRUEVIEW_CITY",
  785. "FILTER_TRUEVIEW_CONVERSION_TYPE",
  786. "FILTER_TRUEVIEW_COUNTRY",
  787. "FILTER_TRUEVIEW_CUSTOM_AFFINITY",
  788. "FILTER_TRUEVIEW_DMA",
  789. "FILTER_TRUEVIEW_GENDER",
  790. "FILTER_TRUEVIEW_IAR_AGE",
  791. "FILTER_TRUEVIEW_IAR_CATEGORY",
  792. "FILTER_TRUEVIEW_IAR_CITY",
  793. "FILTER_TRUEVIEW_IAR_COUNTRY",
  794. "FILTER_TRUEVIEW_IAR_GENDER",
  795. "FILTER_TRUEVIEW_IAR_INTEREST",
  796. "FILTER_TRUEVIEW_IAR_LANGUAGE",
  797. "FILTER_TRUEVIEW_IAR_PARENTAL_STATUS",
  798. "FILTER_TRUEVIEW_IAR_REGION",
  799. "FILTER_TRUEVIEW_IAR_REMARKETING_LIST",
  800. "FILTER_TRUEVIEW_IAR_TIME_OF_DAY",
  801. "FILTER_TRUEVIEW_IAR_YOUTUBE_CHANNEL",
  802. "FILTER_TRUEVIEW_IAR_YOUTUBE_VIDEO",
  803. "FILTER_TRUEVIEW_IAR_ZIPCODE",
  804. "FILTER_TRUEVIEW_INTEREST",
  805. "FILTER_TRUEVIEW_KEYWORD",
  806. "FILTER_TRUEVIEW_PARENTAL_STATUS",
  807. "FILTER_TRUEVIEW_PLACEMENT",
  808. "FILTER_TRUEVIEW_REGION",
  809. "FILTER_TRUEVIEW_REMARKETING_LIST",
  810. "FILTER_TRUEVIEW_URL",
  811. "FILTER_TRUEVIEW_ZIPCODE",
  812. "FILTER_UNKNOWN",
  813. "FILTER_USER_LIST",
  814. "FILTER_USER_LIST_FIRST_PARTY",
  815. "FILTER_USER_LIST_THIRD_PARTY",
  816. "FILTER_VIDEO_AD_POSITION_IN_STREAM",
  817. "FILTER_VIDEO_COMPANION_SIZE",
  818. "FILTER_VIDEO_COMPANION_TYPE",
  819. "FILTER_VIDEO_CREATIVE_DURATION",
  820. "FILTER_VIDEO_CREATIVE_DURATION_SKIPPABLE",
  821. "FILTER_VIDEO_DURATION_SECONDS",
  822. "FILTER_VIDEO_FORMAT_SUPPORT",
  823. "FILTER_VIDEO_INVENTORY_TYPE",
  824. "FILTER_VIDEO_PLAYER_SIZE",
  825. "FILTER_VIDEO_RATING_TIER",
  826. "FILTER_VIDEO_SKIPPABLE_SUPPORT",
  827. "FILTER_VIDEO_VPAID_SUPPORT",
  828. "FILTER_WEEK",
  829. "FILTER_YEAR",
  830. "FILTER_YOUTUBE_VERTICAL",
  831. "FILTER_ZIP_CODE"
  832. ],
  833. "enumDescriptions": [
  834. "",
  835. "",
  836. "",
  837. "",
  838. "",
  839. "",
  840. "",
  841. "",
  842. "",
  843. "",
  844. "",
  845. "",
  846. "",
  847. "",
  848. "",
  849. "",
  850. "",
  851. "",
  852. "",
  853. "",
  854. "",
  855. "",
  856. "",
  857. "",
  858. "",
  859. "",
  860. "",
  861. "",
  862. "",
  863. "",
  864. "",
  865. "",
  866. "",
  867. "",
  868. "",
  869. "",
  870. "",
  871. "",
  872. "",
  873. "",
  874. "",
  875. "",
  876. "",
  877. "",
  878. "",
  879. "",
  880. "",
  881. "",
  882. "",
  883. "",
  884. "",
  885. "",
  886. "",
  887. "",
  888. "",
  889. "",
  890. "",
  891. "",
  892. "",
  893. "",
  894. "",
  895. "",
  896. "",
  897. "",
  898. "",
  899. "",
  900. "",
  901. "",
  902. "",
  903. "",
  904. "",
  905. "",
  906. "",
  907. "",
  908. "",
  909. "",
  910. "",
  911. "",
  912. "",
  913. "",
  914. "",
  915. "",
  916. "",
  917. "",
  918. "",
  919. "",
  920. "",
  921. "",
  922. "",
  923. "",
  924. "",
  925. "",
  926. "",
  927. "",
  928. "",
  929. "",
  930. "",
  931. "",
  932. "",
  933. "",
  934. "",
  935. "",
  936. "",
  937. "",
  938. "",
  939. "",
  940. "",
  941. "",
  942. "",
  943. "",
  944. "",
  945. "",
  946. "",
  947. "",
  948. "",
  949. "",
  950. "",
  951. ""
  952. ],
  953. "type": "string"
  954. },
  955. "type": "array"
  956. },
  957. "includeInviteData": {
  958. "description": "Whether to include data from Invite Media.",
  959. "type": "boolean"
  960. },
  961. "metrics": {
  962. "description": "Metrics to include as columns in your report.",
  963. "items": {
  964. "enum": [
  965. "METRIC_ACTIVE_VIEW_AUDIBLE_VISIBLE_ON_COMPLETE_IMPRESSIONS",
  966. "METRIC_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME",
  967. "METRIC_ACTIVE_VIEW_DISTRIBUTION_UNMEASURABLE",
  968. "METRIC_ACTIVE_VIEW_DISTRIBUTION_UNVIEWABLE",
  969. "METRIC_ACTIVE_VIEW_DISTRIBUTION_VIEWABLE",
  970. "METRIC_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS",
  971. "METRIC_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS",
  972. "METRIC_ACTIVE_VIEW_PCT_MEASURABLE_IMPRESSIONS",
  973. "METRIC_ACTIVE_VIEW_PCT_VIEWABLE_IMPRESSIONS",
  974. "METRIC_ACTIVE_VIEW_PERCENT_AUDIBLE_VISIBLE_AT_START",
  975. "METRIC_ACTIVE_VIEW_PERCENT_AUDIBLE_VISIBLE_FIRST_QUAR",
  976. "METRIC_ACTIVE_VIEW_PERCENT_AUDIBLE_VISIBLE_ON_COMPLETE",
  977. "METRIC_ACTIVE_VIEW_PERCENT_AUDIBLE_VISIBLE_SECOND_QUAR",
  978. "METRIC_ACTIVE_VIEW_PERCENT_AUDIBLE_VISIBLE_THIRD_QUAR",
  979. "METRIC_ACTIVE_VIEW_PERCENT_VIEWABLE_FOR_TIME_THRESHOLD",
  980. "METRIC_ACTIVE_VIEW_PERCENT_VISIBLE_AT_START",
  981. "METRIC_ACTIVE_VIEW_PERCENT_VISIBLE_FIRST_QUAR",
  982. "METRIC_ACTIVE_VIEW_PERCENT_VISIBLE_ON_COMPLETE",
  983. "METRIC_ACTIVE_VIEW_PERCENT_VISIBLE_SECOND_QUAR",
  984. "METRIC_ACTIVE_VIEW_PERCENT_VISIBLE_THIRD_QUAR",
  985. "METRIC_ACTIVE_VIEW_UNMEASURABLE_IMPRESSIONS",
  986. "METRIC_ACTIVE_VIEW_UNVIEWABLE_IMPRESSIONS",
  987. "METRIC_ACTIVE_VIEW_VIEWABLE_FOR_TIME_THRESHOLD",
  988. "METRIC_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS",
  989. "METRIC_BID_REQUESTS",
  990. "METRIC_BILLABLE_COST_ADVERTISER",
  991. "METRIC_BILLABLE_COST_PARTNER",
  992. "METRIC_BILLABLE_COST_USD",
  993. "METRIC_CLICKS",
  994. "METRIC_CLICK_TO_POST_CLICK_CONVERSION_RATE",
  995. "METRIC_COMSCORE_VCE_AUDIENCE_AVG_FREQUENCY",
  996. "METRIC_COMSCORE_VCE_AUDIENCE_IMPRESSIONS",
  997. "METRIC_COMSCORE_VCE_AUDIENCE_IMPRESSIONS_SHARE",
  998. "METRIC_COMSCORE_VCE_AUDIENCE_REACH_PCT",
  999. "METRIC_COMSCORE_VCE_AUDIENCE_SHARE_PCT",
  1000. "METRIC_COMSCORE_VCE_GROSS_RATING_POINTS",
  1001. "METRIC_COMSCORE_VCE_POPULATION",
  1002. "METRIC_COMSCORE_VCE_UNIQUE_AUDIENCE",
  1003. "METRIC_CONVERSIONS_PER_MILLE",
  1004. "METRIC_COOKIE_REACH_AVERAGE_IMPRESSION_FREQUENCY",
  1005. "METRIC_COOKIE_REACH_IMPRESSION_REACH",
  1006. "METRIC_CPM_FEE1_ADVERTISER",
  1007. "METRIC_CPM_FEE1_PARTNER",
  1008. "METRIC_CPM_FEE1_USD",
  1009. "METRIC_CPM_FEE2_ADVERTISER",
  1010. "METRIC_CPM_FEE2_PARTNER",
  1011. "METRIC_CPM_FEE2_USD",
  1012. "METRIC_CPM_FEE3_ADVERTISER",
  1013. "METRIC_CPM_FEE3_PARTNER",
  1014. "METRIC_CPM_FEE3_USD",
  1015. "METRIC_CPM_FEE4_ADVERTISER",
  1016. "METRIC_CPM_FEE4_PARTNER",
  1017. "METRIC_CPM_FEE4_USD",
  1018. "METRIC_CPM_FEE5_ADVERTISER",
  1019. "METRIC_CPM_FEE5_PARTNER",
  1020. "METRIC_CPM_FEE5_USD",
  1021. "METRIC_CTR",
  1022. "METRIC_DATA_COST_ADVERTISER",
  1023. "METRIC_DATA_COST_PARTNER",
  1024. "METRIC_DATA_COST_USD",
  1025. "METRIC_FEE10_ADVERTISER",
  1026. "METRIC_FEE10_PARTNER",
  1027. "METRIC_FEE10_USD",
  1028. "METRIC_FEE11_ADVERTISER",
  1029. "METRIC_FEE11_PARTNER",
  1030. "METRIC_FEE11_USD",
  1031. "METRIC_FEE12_ADVERTISER",
  1032. "METRIC_FEE12_PARTNER",
  1033. "METRIC_FEE12_USD",
  1034. "METRIC_FEE13_ADVERTISER",
  1035. "METRIC_FEE13_PARTNER",
  1036. "METRIC_FEE13_USD",
  1037. "METRIC_FEE14_ADVERTISER",
  1038. "METRIC_FEE14_PARTNER",
  1039. "METRIC_FEE14_USD",
  1040. "METRIC_FEE15_ADVERTISER",
  1041. "METRIC_FEE15_PARTNER",
  1042. "METRIC_FEE15_USD",
  1043. "METRIC_FEE16_ADVERTISER",
  1044. "METRIC_FEE16_PARTNER",
  1045. "METRIC_FEE16_USD",
  1046. "METRIC_FEE17_ADVERTISER",
  1047. "METRIC_FEE17_PARTNER",
  1048. "METRIC_FEE17_USD",
  1049. "METRIC_FEE18_ADVERTISER",
  1050. "METRIC_FEE18_PARTNER",
  1051. "METRIC_FEE18_USD",
  1052. "METRIC_FEE19_ADVERTISER",
  1053. "METRIC_FEE19_PARTNER",
  1054. "METRIC_FEE19_USD",
  1055. "METRIC_FEE20_ADVERTISER",
  1056. "METRIC_FEE20_PARTNER",
  1057. "METRIC_FEE20_USD",
  1058. "METRIC_FEE21_ADVERTISER",
  1059. "METRIC_FEE21_PARTNER",
  1060. "METRIC_FEE21_USD",
  1061. "METRIC_FEE22_ADVERTISER",
  1062. "METRIC_FEE22_PARTNER",
  1063. "METRIC_FEE22_USD",
  1064. "METRIC_FEE2_ADVERTISER",
  1065. "METRIC_FEE2_PARTNER",
  1066. "METRIC_FEE2_USD",
  1067. "METRIC_FEE3_ADVERTISER",
  1068. "METRIC_FEE3_PARTNER",
  1069. "METRIC_FEE3_USD",
  1070. "METRIC_FEE4_ADVERTISER",
  1071. "METRIC_FEE4_PARTNER",
  1072. "METRIC_FEE4_USD",
  1073. "METRIC_FEE5_ADVERTISER",
  1074. "METRIC_FEE5_PARTNER",
  1075. "METRIC_FEE5_USD",
  1076. "METRIC_FEE6_ADVERTISER",
  1077. "METRIC_FEE6_PARTNER",
  1078. "METRIC_FEE6_USD",
  1079. "METRIC_FEE7_ADVERTISER",
  1080. "METRIC_FEE7_PARTNER",
  1081. "METRIC_FEE7_USD",
  1082. "METRIC_FEE8_ADVERTISER",
  1083. "METRIC_FEE8_PARTNER",
  1084. "METRIC_FEE8_USD",
  1085. "METRIC_FEE9_ADVERTISER",
  1086. "METRIC_FEE9_PARTNER",
  1087. "METRIC_FEE9_USD",
  1088. "METRIC_IMPRESSIONS",
  1089. "METRIC_IMPRESSIONS_TO_CONVERSION_RATE",
  1090. "METRIC_LAST_CLICKS",
  1091. "METRIC_LAST_IMPRESSIONS",
  1092. "METRIC_MEDIA_COST_ADVERTISER",
  1093. "METRIC_MEDIA_COST_ECPAPC_ADVERTISER",
  1094. "METRIC_MEDIA_COST_ECPAPC_PARTNER",
  1095. "METRIC_MEDIA_COST_ECPAPC_USD",
  1096. "METRIC_MEDIA_COST_ECPAPV_ADVERTISER",
  1097. "METRIC_MEDIA_COST_ECPAPV_PARTNER",
  1098. "METRIC_MEDIA_COST_ECPAPV_USD",
  1099. "METRIC_MEDIA_COST_ECPA_ADVERTISER",
  1100. "METRIC_MEDIA_COST_ECPA_PARTNER",
  1101. "METRIC_MEDIA_COST_ECPA_USD",
  1102. "METRIC_MEDIA_COST_ECPCV_ADVERTISER",
  1103. "METRIC_MEDIA_COST_ECPCV_PARTNER",
  1104. "METRIC_MEDIA_COST_ECPCV_USD",
  1105. "METRIC_MEDIA_COST_ECPC_ADVERTISER",
  1106. "METRIC_MEDIA_COST_ECPC_PARTNER",
  1107. "METRIC_MEDIA_COST_ECPC_USD",
  1108. "METRIC_MEDIA_COST_ECPM_ADVERTISER",
  1109. "METRIC_MEDIA_COST_ECPM_PARTNER",
  1110. "METRIC_MEDIA_COST_ECPM_USD",
  1111. "METRIC_MEDIA_COST_PARTNER",
  1112. "METRIC_MEDIA_COST_USD",
  1113. "METRIC_MEDIA_COST_VIEWABLE_ECPM_ADVERTISER",
  1114. "METRIC_MEDIA_COST_VIEWABLE_ECPM_PARTNER",
  1115. "METRIC_MEDIA_COST_VIEWABLE_ECPM_USD",
  1116. "METRIC_MEDIA_FEE1_ADVERTISER",
  1117. "METRIC_MEDIA_FEE1_PARTNER",
  1118. "METRIC_MEDIA_FEE1_USD",
  1119. "METRIC_MEDIA_FEE2_ADVERTISER",
  1120. "METRIC_MEDIA_FEE2_PARTNER",
  1121. "METRIC_MEDIA_FEE2_USD",
  1122. "METRIC_MEDIA_FEE3_ADVERTISER",
  1123. "METRIC_MEDIA_FEE3_PARTNER",
  1124. "METRIC_MEDIA_FEE3_USD",
  1125. "METRIC_MEDIA_FEE4_ADVERTISER",
  1126. "METRIC_MEDIA_FEE4_PARTNER",
  1127. "METRIC_MEDIA_FEE4_USD",
  1128. "METRIC_MEDIA_FEE5_ADVERTISER",
  1129. "METRIC_MEDIA_FEE5_PARTNER",
  1130. "METRIC_MEDIA_FEE5_USD",
  1131. "METRIC_PIXEL_LOADS",
  1132. "METRIC_PLATFORM_FEE_ADVERTISER",
  1133. "METRIC_PLATFORM_FEE_PARTNER",
  1134. "METRIC_PLATFORM_FEE_USD",
  1135. "METRIC_POST_CLICK_DFA_REVENUE",
  1136. "METRIC_POST_VIEW_DFA_REVENUE",
  1137. "METRIC_PROFIT_ADVERTISER",
  1138. "METRIC_PROFIT_ECPAPC_ADVERTISER",
  1139. "METRIC_PROFIT_ECPAPC_PARTNER",
  1140. "METRIC_PROFIT_ECPAPC_USD",
  1141. "METRIC_PROFIT_ECPAPV_ADVERTISER",
  1142. "METRIC_PROFIT_ECPAPV_PARTNER",
  1143. "METRIC_PROFIT_ECPAPV_USD",
  1144. "METRIC_PROFIT_ECPA_ADVERTISER",
  1145. "METRIC_PROFIT_ECPA_PARTNER",
  1146. "METRIC_PROFIT_ECPA_USD",
  1147. "METRIC_PROFIT_ECPC_ADVERTISER",
  1148. "METRIC_PROFIT_ECPC_PARTNER",
  1149. "METRIC_PROFIT_ECPC_USD",
  1150. "METRIC_PROFIT_ECPM_ADVERTISER",
  1151. "METRIC_PROFIT_ECPM_PARTNER",
  1152. "METRIC_PROFIT_ECPM_USD",
  1153. "METRIC_PROFIT_MARGIN",
  1154. "METRIC_PROFIT_PARTNER",
  1155. "METRIC_PROFIT_USD",
  1156. "METRIC_PROFIT_VIEWABLE_ECPM_ADVERTISER",
  1157. "METRIC_PROFIT_VIEWABLE_ECPM_PARTNER",
  1158. "METRIC_PROFIT_VIEWABLE_ECPM_USD",
  1159. "METRIC_REACH_COOKIE_FREQUENCY",
  1160. "METRIC_REACH_COOKIE_REACH",
  1161. "METRIC_REVENUE_ADVERTISER",
  1162. "METRIC_REVENUE_ECPAPC_ADVERTISER",
  1163. "METRIC_REVENUE_ECPAPC_PARTNER",
  1164. "METRIC_REVENUE_ECPAPC_USD",
  1165. "METRIC_REVENUE_ECPAPV_ADVERTISER",
  1166. "METRIC_REVENUE_ECPAPV_PARTNER",
  1167. "METRIC_REVENUE_ECPAPV_USD",
  1168. "METRIC_REVENUE_ECPA_ADVERTISER",
  1169. "METRIC_REVENUE_ECPA_PARTNER",
  1170. "METRIC_REVENUE_ECPA_USD",
  1171. "METRIC_REVENUE_ECPCV_ADVERTISER",
  1172. "METRIC_REVENUE_ECPCV_PARTNER",
  1173. "METRIC_REVENUE_ECPCV_USD",
  1174. "METRIC_REVENUE_ECPC_ADVERTISER",
  1175. "METRIC_REVENUE_ECPC_PARTNER",
  1176. "METRIC_REVENUE_ECPC_USD",
  1177. "METRIC_REVENUE_ECPIAVC_ADVERTISER",
  1178. "METRIC_REVENUE_ECPM_ADVERTISER",
  1179. "METRIC_REVENUE_ECPM_PARTNER",
  1180. "METRIC_REVENUE_ECPM_USD",
  1181. "METRIC_REVENUE_PARTNER",
  1182. "METRIC_REVENUE_USD",
  1183. "METRIC_REVENUE_VIEWABLE_ECPM_ADVERTISER",
  1184. "METRIC_REVENUE_VIEWABLE_ECPM_PARTNER",
  1185. "METRIC_REVENUE_VIEWABLE_ECPM_USD",
  1186. "METRIC_RICH_MEDIA_VIDEO_COMPLETIONS",
  1187. "METRIC_RICH_MEDIA_VIDEO_FIRST_QUARTILE_COMPLETES",
  1188. "METRIC_RICH_MEDIA_VIDEO_FULL_SCREENS",
  1189. "METRIC_RICH_MEDIA_VIDEO_MIDPOINTS",
  1190. "METRIC_RICH_MEDIA_VIDEO_MUTES",
  1191. "METRIC_RICH_MEDIA_VIDEO_PAUSES",
  1192. "METRIC_RICH_MEDIA_VIDEO_PLAYS",
  1193. "METRIC_RICH_MEDIA_VIDEO_SKIPS",
  1194. "METRIC_RICH_MEDIA_VIDEO_THIRD_QUARTILE_COMPLETES",
  1195. "METRIC_TEA_TRUEVIEW_IMPRESSIONS",
  1196. "METRIC_TEA_TRUEVIEW_UNIQUE_COOKIES",
  1197. "METRIC_TEA_TRUEVIEW_UNIQUE_PEOPLE",
  1198. "METRIC_TOTAL_CONVERSIONS",
  1199. "METRIC_TOTAL_MEDIA_COST_ADVERTISER",
  1200. "METRIC_TOTAL_MEDIA_COST_ECPAPC_ADVERTISER",
  1201. "METRIC_TOTAL_MEDIA_COST_ECPAPC_PARTNER",
  1202. "METRIC_TOTAL_MEDIA_COST_ECPAPC_USD",
  1203. "METRIC_TOTAL_MEDIA_COST_ECPAPV_ADVERTISER",
  1204. "METRIC_TOTAL_MEDIA_COST_ECPAPV_PARTNER",
  1205. "METRIC_TOTAL_MEDIA_COST_ECPAPV_USD",
  1206. "METRIC_TOTAL_MEDIA_COST_ECPA_ADVERTISER",
  1207. "METRIC_TOTAL_MEDIA_COST_ECPA_PARTNER",
  1208. "METRIC_TOTAL_MEDIA_COST_ECPA_USD",
  1209. "METRIC_TOTAL_MEDIA_COST_ECPCV_ADVERTISER",
  1210. "METRIC_TOTAL_MEDIA_COST_ECPCV_PARTNER",
  1211. "METRIC_TOTAL_MEDIA_COST_ECPCV_USD",
  1212. "METRIC_TOTAL_MEDIA_COST_ECPC_ADVERTISER",
  1213. "METRIC_TOTAL_MEDIA_COST_ECPC_PARTNER",
  1214. "METRIC_TOTAL_MEDIA_COST_ECPC_USD",
  1215. "METRIC_TOTAL_MEDIA_COST_ECPM_ADVERTISER",
  1216. "METRIC_TOTAL_MEDIA_COST_ECPM_PARTNER",
  1217. "METRIC_TOTAL_MEDIA_COST_ECPM_USD",
  1218. "METRIC_TOTAL_MEDIA_COST_PARTNER",
  1219. "METRIC_TOTAL_MEDIA_COST_USD",
  1220. "METRIC_TOTAL_MEDIA_COST_VIEWABLE_ECPM_ADVERTISER",
  1221. "METRIC_TOTAL_MEDIA_COST_VIEWABLE_ECPM_PARTNER",
  1222. "METRIC_TOTAL_MEDIA_COST_VIEWABLE_ECPM_USD",
  1223. "METRIC_TRUEVIEW_AVERAGE_CPE_ADVERTISER",
  1224. "METRIC_TRUEVIEW_AVERAGE_CPE_PARTNER",
  1225. "METRIC_TRUEVIEW_AVERAGE_CPE_USD",
  1226. "METRIC_TRUEVIEW_CONVERSION_COST_MANY_PER_VIEW_ADVERTISER",
  1227. "METRIC_TRUEVIEW_CONVERSION_COST_MANY_PER_VIEW_PARTNER",
  1228. "METRIC_TRUEVIEW_CONVERSION_COST_MANY_PER_VIEW_USD",
  1229. "METRIC_TRUEVIEW_CONVERSION_COST_ONE_PER_VIEW_ADVERTISER",
  1230. "METRIC_TRUEVIEW_CONVERSION_COST_ONE_PER_VIEW_PARTNER",
  1231. "METRIC_TRUEVIEW_CONVERSION_COST_ONE_PER_VIEW_USD",
  1232. "METRIC_TRUEVIEW_CONVERSION_MANY_PER_VIEW",
  1233. "METRIC_TRUEVIEW_CONVERSION_ONE_PER_VIEW",
  1234. "METRIC_TRUEVIEW_CONVERSION_RATE_ONE_PER_VIEW",
  1235. "METRIC_TRUEVIEW_CONVERSION_VALUE_MANY_PER_VIEW_ADVERTISER",
  1236. "METRIC_TRUEVIEW_CONVERSION_VALUE_MANY_PER_VIEW_PARTNER",
  1237. "METRIC_TRUEVIEW_CONVERSION_VALUE_MANY_PER_VIEW_USD",
  1238. "METRIC_TRUEVIEW_CONVERSION_VALUE_ONE_PER_VIEW_ADVERTISER",
  1239. "METRIC_TRUEVIEW_CONVERSION_VALUE_ONE_PER_VIEW_PARTNER",
  1240. "METRIC_TRUEVIEW_CONVERSION_VALUE_ONE_PER_VIEW_USD",
  1241. "METRIC_TRUEVIEW_COST_CONVERSION_MANY_PER_VIEW_RATIO",
  1242. "METRIC_TRUEVIEW_COST_CONVERSION_ONE_PER_VIEW_RATIO",
  1243. "METRIC_TRUEVIEW_CPV_ADVERTISER",
  1244. "METRIC_TRUEVIEW_CPV_PARTNER",
  1245. "METRIC_TRUEVIEW_CPV_USD",
  1246. "METRIC_TRUEVIEW_EARNED_LIKES",
  1247. "METRIC_TRUEVIEW_EARNED_PLAYLIST_ADDITIONS",
  1248. "METRIC_TRUEVIEW_EARNED_SHARES",
  1249. "METRIC_TRUEVIEW_EARNED_SUBSCRIBERS",
  1250. "METRIC_TRUEVIEW_EARNED_VIEWS",
  1251. "METRIC_TRUEVIEW_ENGAGEMENTS",
  1252. "METRIC_TRUEVIEW_ENGAGEMENT_RATE",
  1253. "METRIC_TRUEVIEW_IMPRESSION_SHARE",
  1254. "METRIC_TRUEVIEW_LOST_IS_BUDGET",
  1255. "METRIC_TRUEVIEW_LOST_IS_RANK",
  1256. "METRIC_TRUEVIEW_TOTAL_CONVERSION_VALUE",
  1257. "METRIC_TRUEVIEW_TOTAL_CONVERSION_VALUES_ADVERTISER",
  1258. "METRIC_TRUEVIEW_TOTAL_CONVERSION_VALUES_PARTNER",
  1259. "METRIC_TRUEVIEW_TOTAL_CONVERSION_VALUES_USD",
  1260. "METRIC_TRUEVIEW_UNIQUE_VIEWERS",
  1261. "METRIC_TRUEVIEW_VALUE_CONVERSION_MANY_PER_VIEW_RATIO",
  1262. "METRIC_TRUEVIEW_VALUE_CONVERSION_ONE_PER_VIEW_RATIO",
  1263. "METRIC_TRUEVIEW_VIEWS",
  1264. "METRIC_TRUEVIEW_VIEW_RATE",
  1265. "METRIC_TRUEVIEW_VIEW_THROUGH_CONVERSION",
  1266. "METRIC_UNIQUE_VISITORS_COOKIES",
  1267. "METRIC_UNKNOWN",
  1268. "METRIC_VIDEO_COMPANION_CLICKS",
  1269. "METRIC_VIDEO_COMPANION_IMPRESSIONS",
  1270. "METRIC_VIDEO_COMPLETION_RATE",
  1271. "METRIC_VIEWABLE_BID_REQUESTS"
  1272. ],
  1273. "enumDescriptions": [
  1274. "",
  1275. "",
  1276. "",
  1277. "",
  1278. "",
  1279. "",
  1280. "",
  1281. "",
  1282. "",
  1283. "",
  1284. "",
  1285. "",
  1286. "",
  1287. "",
  1288. "",
  1289. "",
  1290. "",
  1291. "",
  1292. "",
  1293. "",
  1294. "",
  1295. "",
  1296. "",
  1297. "",
  1298. "",
  1299. "",
  1300. "",
  1301. "",
  1302. "",
  1303. "",
  1304. "",
  1305. "",
  1306. "",
  1307. "",
  1308. "",
  1309. "",
  1310. "",
  1311. "",
  1312. "",
  1313. "",
  1314. "",
  1315. "",
  1316. "",
  1317. "",
  1318. "",
  1319. "",
  1320. "",
  1321. "",
  1322. "",
  1323. "",
  1324. "",
  1325. "",
  1326. "",
  1327. "",
  1328. "",
  1329. "",
  1330. "",
  1331. "",
  1332. "",
  1333. "",
  1334. "",
  1335. "",
  1336. "",
  1337. "",
  1338. "",
  1339. "",
  1340. "",
  1341. "",
  1342. "",
  1343. "",
  1344. "",
  1345. "",
  1346. "",
  1347. "",
  1348. "",
  1349. "",
  1350. "",
  1351. "",
  1352. "",
  1353. "",
  1354. "",
  1355. "",
  1356. "",
  1357. "",
  1358. "",
  1359. "",
  1360. "",
  1361. "",
  1362. "",
  1363. "",
  1364. "",
  1365. "",
  1366. "",
  1367. "",
  1368. "",
  1369. "",
  1370. "",
  1371. "",
  1372. "",
  1373. "",
  1374. "",
  1375. "",
  1376. "",
  1377. "",
  1378. "",
  1379. "",
  1380. "",
  1381. "",
  1382. "",
  1383. "",
  1384. "",
  1385. "",
  1386. "",
  1387. "",
  1388. "",
  1389. "",
  1390. "",
  1391. "",
  1392. "",
  1393. "",
  1394. "",
  1395. "",
  1396. "",
  1397. "",
  1398. "",
  1399. "",
  1400. "",
  1401. "",
  1402. "",
  1403. "",
  1404. "",
  1405. "",
  1406. "",
  1407. "",
  1408. "",
  1409. "",
  1410. "",
  1411. "",
  1412. "",
  1413. "",
  1414. "",
  1415. "",
  1416. "",
  1417. "",
  1418. "",
  1419. "",
  1420. "",
  1421. "",
  1422. "",
  1423. "",
  1424. "",
  1425. "",
  1426. "",
  1427. "",
  1428. "",
  1429. "",
  1430. "",
  1431. "",
  1432. "",
  1433. "",
  1434. "",
  1435. "",
  1436. "",
  1437. "",
  1438. "",
  1439. "",
  1440. "",
  1441. "",
  1442. "",
  1443. "",
  1444. "",
  1445. "",
  1446. "",
  1447. "",
  1448. "",
  1449. "",
  1450. "",
  1451. "",
  1452. "",
  1453. "",
  1454. "",
  1455. "",
  1456. "",
  1457. "",
  1458. "",
  1459. "",
  1460. "",
  1461. "",
  1462. "",
  1463. "",
  1464. "",
  1465. "",
  1466. "",
  1467. "",
  1468. "",
  1469. "",
  1470. "",
  1471. "",
  1472. "",
  1473. "",
  1474. "",
  1475. "",
  1476. "",
  1477. "",
  1478. "",
  1479. "",
  1480. "",
  1481. "",
  1482. "",
  1483. "",
  1484. "",
  1485. "",
  1486. "",
  1487. "",
  1488. "",
  1489. "",
  1490. "",
  1491. "",
  1492. "",
  1493. "",
  1494. "",
  1495. "",
  1496. "",
  1497. "",
  1498. "",
  1499. "",
  1500. "",
  1501. "",
  1502. "",
  1503. "",
  1504. "",
  1505. "",
  1506. "",
  1507. "",
  1508. "",
  1509. "",
  1510. "",
  1511. "",
  1512. "",
  1513. "",
  1514. "",
  1515. "",
  1516. "",
  1517. "",
  1518. "",
  1519. "",
  1520. "",
  1521. "",
  1522. "",
  1523. "",
  1524. "",
  1525. "",
  1526. "",
  1527. "",
  1528. "",
  1529. "",
  1530. "",
  1531. "",
  1532. "",
  1533. "",
  1534. "",
  1535. "",
  1536. "",
  1537. "",
  1538. "",
  1539. "",
  1540. "",
  1541. "",
  1542. "",
  1543. "",
  1544. "",
  1545. "",
  1546. "",
  1547. "",
  1548. "",
  1549. "",
  1550. "",
  1551. "",
  1552. "",
  1553. "",
  1554. "",
  1555. "",
  1556. "",
  1557. "",
  1558. "",
  1559. "",
  1560. "",
  1561. "",
  1562. "",
  1563. "",
  1564. "",
  1565. "",
  1566. "",
  1567. "",
  1568. "",
  1569. "",
  1570. "",
  1571. "",
  1572. "",
  1573. "",
  1574. "",
  1575. "",
  1576. "",
  1577. "",
  1578. "",
  1579. "",
  1580. ""
  1581. ],
  1582. "type": "string"
  1583. },
  1584. "type": "array"
  1585. },
  1586. "type": {
  1587. "description": "Report type.",
  1588. "enum": [
  1589. "TYPE_ACTIVE_GRP",
  1590. "TYPE_AUDIENCE_COMPOSITION",
  1591. "TYPE_AUDIENCE_PERFORMANCE",
  1592. "TYPE_CLIENT_SAFE",
  1593. "TYPE_COMSCORE_VCE",
  1594. "TYPE_CROSS_FEE",
  1595. "TYPE_CROSS_PARTNER",
  1596. "TYPE_CROSS_PARTNER_THIRD_PARTY_DATA_PROVIDER",
  1597. "TYPE_ESTIMATED_CONVERSION",
  1598. "TYPE_FEE",
  1599. "TYPE_GENERAL",
  1600. "TYPE_INVENTORY_AVAILABILITY",
  1601. "TYPE_KEYWORD",
  1602. "TYPE_LINEAR_TV_SEARCH_LIFT",
  1603. "TYPE_NIELSEN_AUDIENCE_PROFILE",
  1604. "TYPE_NIELSEN_DAILY_REACH_BUILD",
  1605. "TYPE_NIELSEN_ONLINE_GLOBAL_MARKET",
  1606. "TYPE_NIELSEN_SITE",
  1607. "TYPE_NOT_SUPPORTED",
  1608. "TYPE_ORDER_ID",
  1609. "TYPE_PAGE_CATEGORY",
  1610. "TYPE_PETRA_NIELSEN_AUDIENCE_PROFILE",
  1611. "TYPE_PETRA_NIELSEN_DAILY_REACH_BUILD",
  1612. "TYPE_PETRA_NIELSEN_ONLINE_GLOBAL_MARKET",
  1613. "TYPE_PIXEL_LOAD",
  1614. "TYPE_REACH_AND_FREQUENCY",
  1615. "TYPE_REACH_AUDIENCE",
  1616. "TYPE_THIRD_PARTY_DATA_PROVIDER",
  1617. "TYPE_TRUEVIEW",
  1618. "TYPE_TRUEVIEW_IAR",
  1619. "TYPE_VERIFICATION",
  1620. "TYPE_YOUTUBE_VERTICAL"
  1621. ],
  1622. "enumDescriptions": [
  1623. "",
  1624. "",
  1625. "",
  1626. "",
  1627. "",
  1628. "",
  1629. "",
  1630. "",
  1631. "",
  1632. "",
  1633. "",
  1634. "",
  1635. "",
  1636. "",
  1637. "",
  1638. "",
  1639. "",
  1640. "",
  1641. "",
  1642. "",
  1643. "",
  1644. "",
  1645. "",
  1646. "",
  1647. "",
  1648. "",
  1649. "",
  1650. "",
  1651. "",
  1652. "",
  1653. "",
  1654. ""
  1655. ],
  1656. "type": "string"
  1657. }
  1658. },
  1659. "type": "object"
  1660. },
  1661. "Query": {
  1662. "description": "Represents a query.",
  1663. "id": "Query",
  1664. "properties": {
  1665. "kind": {
  1666. "default": "doubleclickbidmanager#query",
  1667. "description": "Identifies what kind of resource this is. Value: the fixed string \"doubleclickbidmanager#query\".",
  1668. "type": "string"
  1669. },
  1670. "metadata": {
  1671. "$ref": "QueryMetadata",
  1672. "description": "Query metadata."
  1673. },
  1674. "params": {
  1675. "$ref": "Parameters",
  1676. "description": "Query parameters."
  1677. },
  1678. "queryId": {
  1679. "description": "Query ID.",
  1680. "format": "int64",
  1681. "type": "string"
  1682. },
  1683. "reportDataEndTimeMs": {
  1684. "description": "The ending time for the data that is shown in the report. Note, reportDataEndTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise.",
  1685. "format": "int64",
  1686. "type": "string"
  1687. },
  1688. "reportDataStartTimeMs": {
  1689. "description": "The starting time for the data that is shown in the report. Note, reportDataStartTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise.",
  1690. "format": "int64",
  1691. "type": "string"
  1692. },
  1693. "schedule": {
  1694. "$ref": "QuerySchedule",
  1695. "description": "Information on how often and when to run a query."
  1696. },
  1697. "timezoneCode": {
  1698. "description": "Canonical timezone code for report data time. Defaults to America/New_York.",
  1699. "type": "string"
  1700. }
  1701. },
  1702. "type": "object"
  1703. },
  1704. "QueryMetadata": {
  1705. "description": "Query metadata.",
  1706. "id": "QueryMetadata",
  1707. "properties": {
  1708. "dataRange": {
  1709. "description": "Range of report data.",
  1710. "enum": [
  1711. "ALL_TIME",
  1712. "CURRENT_DAY",
  1713. "CUSTOM_DATES",
  1714. "LAST_14_DAYS",
  1715. "LAST_30_DAYS",
  1716. "LAST_365_DAYS",
  1717. "LAST_7_DAYS",
  1718. "LAST_90_DAYS",
  1719. "MONTH_TO_DATE",
  1720. "PREVIOUS_DAY",
  1721. "PREVIOUS_HALF_MONTH",
  1722. "PREVIOUS_MONTH",
  1723. "PREVIOUS_QUARTER",
  1724. "PREVIOUS_WEEK",
  1725. "PREVIOUS_YEAR",
  1726. "QUARTER_TO_DATE",
  1727. "TYPE_NOT_SUPPORTED",
  1728. "WEEK_TO_DATE",
  1729. "YEAR_TO_DATE"
  1730. ],
  1731. "enumDescriptions": [
  1732. "",
  1733. "",
  1734. "",
  1735. "",
  1736. "",
  1737. "",
  1738. "",
  1739. "",
  1740. "",
  1741. "",
  1742. "",
  1743. "",
  1744. "",
  1745. "",
  1746. "",
  1747. "",
  1748. "",
  1749. "",
  1750. ""
  1751. ],
  1752. "type": "string"
  1753. },
  1754. "format": {
  1755. "description": "Format of the generated report.",
  1756. "enum": [
  1757. "CSV",
  1758. "EXCEL_CSV",
  1759. "XLSX"
  1760. ],
  1761. "enumDescriptions": [
  1762. "",
  1763. "",
  1764. ""
  1765. ],
  1766. "type": "string"
  1767. },
  1768. "googleCloudStoragePathForLatestReport": {
  1769. "description": "The path to the location in Google Cloud Storage where the latest report is stored.",
  1770. "type": "string"
  1771. },
  1772. "googleDrivePathForLatestReport": {
  1773. "description": "The path in Google Drive for the latest report.",
  1774. "type": "string"
  1775. },
  1776. "latestReportRunTimeMs": {
  1777. "description": "The time when the latest report started to run.",
  1778. "format": "int64",
  1779. "type": "string"
  1780. },
  1781. "locale": {
  1782. "description": "Locale of the generated reports. Valid values are cs CZECH de GERMAN en ENGLISH es SPANISH fr FRENCH it ITALIAN ja JAPANESE ko KOREAN pl POLISH pt-BR BRAZILIAN_PORTUGUESE ru RUSSIAN tr TURKISH uk UKRAINIAN zh-CN CHINA_CHINESE zh-TW TAIWAN_CHINESE\n\nAn locale string not in the list above will generate reports in English.",
  1783. "type": "string"
  1784. },
  1785. "reportCount": {
  1786. "description": "Number of reports that have been generated for the query.",
  1787. "format": "int32",
  1788. "type": "integer"
  1789. },
  1790. "running": {
  1791. "description": "Whether the latest report is currently running.",
  1792. "type": "boolean"
  1793. },
  1794. "sendNotification": {
  1795. "description": "Whether to send an email notification when a report is ready. Default to false.",
  1796. "type": "boolean"
  1797. },
  1798. "shareEmailAddress": {
  1799. "description": "List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.",
  1800. "items": {
  1801. "type": "string"
  1802. },
  1803. "type": "array"
  1804. },
  1805. "title": {
  1806. "description": "Query title. It is used to name the reports generated from this query.",
  1807. "type": "string"
  1808. }
  1809. },
  1810. "type": "object"
  1811. },
  1812. "QuerySchedule": {
  1813. "description": "Information on how frequently and when to run a query.",
  1814. "id": "QuerySchedule",
  1815. "properties": {
  1816. "endTimeMs": {
  1817. "description": "Datetime to periodically run the query until.",
  1818. "format": "int64",
  1819. "type": "string"
  1820. },
  1821. "frequency": {
  1822. "description": "How often the query is run.",
  1823. "enum": [
  1824. "DAILY",
  1825. "MONTHLY",
  1826. "ONE_TIME",
  1827. "QUARTERLY",
  1828. "SEMI_MONTHLY",
  1829. "WEEKLY"
  1830. ],
  1831. "enumDescriptions": [
  1832. "",
  1833. "",
  1834. "",
  1835. "",
  1836. "",
  1837. ""
  1838. ],
  1839. "type": "string"
  1840. },
  1841. "nextRunMinuteOfDay": {
  1842. "description": "Time of day at which a new report will be generated, represented as minutes past midnight. Range is 0 to 1439. Only applies to scheduled reports.",
  1843. "format": "int32",
  1844. "type": "integer"
  1845. },
  1846. "nextRunTimezoneCode": {
  1847. "description": "Canonical timezone code for report generation time. Defaults to America/New_York.",
  1848. "type": "string"
  1849. }
  1850. },
  1851. "type": "object"
  1852. },
  1853. "Report": {
  1854. "description": "Represents a report.",
  1855. "id": "Report",
  1856. "properties": {
  1857. "key": {
  1858. "$ref": "ReportKey",
  1859. "description": "Key used to identify a report."
  1860. },
  1861. "metadata": {
  1862. "$ref": "ReportMetadata",
  1863. "description": "Report metadata."
  1864. },
  1865. "params": {
  1866. "$ref": "Parameters",
  1867. "description": "Report parameters."
  1868. }
  1869. },
  1870. "type": "object"
  1871. },
  1872. "ReportFailure": {
  1873. "description": "An explanation of a report failure.",
  1874. "id": "ReportFailure",
  1875. "properties": {
  1876. "errorCode": {
  1877. "description": "Error code that shows why the report was not created.",
  1878. "enum": [
  1879. "AUTHENTICATION_ERROR",
  1880. "DEPRECATED_REPORTING_INVALID_QUERY",
  1881. "REPORTING_BUCKET_NOT_FOUND",
  1882. "REPORTING_CREATE_BUCKET_FAILED",
  1883. "REPORTING_DELETE_BUCKET_FAILED",
  1884. "REPORTING_FATAL_ERROR",
  1885. "REPORTING_ILLEGAL_FILENAME",
  1886. "REPORTING_IMCOMPATIBLE_METRICS",
  1887. "REPORTING_INVALID_QUERY_MISSING_PARTNER_AND_ADVERTISER_FILTERS",
  1888. "REPORTING_INVALID_QUERY_TITLE_MISSING",
  1889. "REPORTING_INVALID_QUERY_TOO_MANY_UNFILTERED_LARGE_GROUP_BYS",
  1890. "REPORTING_QUERY_NOT_FOUND",
  1891. "REPORTING_TRANSIENT_ERROR",
  1892. "REPORTING_UPDATE_BUCKET_PERMISSION_FAILED",
  1893. "REPORTING_WRITE_BUCKET_OBJECT_FAILED",
  1894. "SERVER_ERROR",
  1895. "UNAUTHORIZED_API_ACCESS",
  1896. "VALIDATION_ERROR"
  1897. ],
  1898. "enumDescriptions": [
  1899. "",
  1900. "",
  1901. "",
  1902. "",
  1903. "",
  1904. "",
  1905. "",
  1906. "",
  1907. "",
  1908. "",
  1909. "",
  1910. "",
  1911. "",
  1912. "",
  1913. "",
  1914. "",
  1915. "",
  1916. ""
  1917. ],
  1918. "type": "string"
  1919. }
  1920. },
  1921. "type": "object"
  1922. },
  1923. "ReportKey": {
  1924. "description": "Key used to identify a report.",
  1925. "id": "ReportKey",
  1926. "properties": {
  1927. "queryId": {
  1928. "description": "Query ID.",
  1929. "format": "int64",
  1930. "type": "string"
  1931. },
  1932. "reportId": {
  1933. "description": "Report ID.",
  1934. "format": "int64",
  1935. "type": "string"
  1936. }
  1937. },
  1938. "type": "object"
  1939. },
  1940. "ReportMetadata": {
  1941. "description": "Report metadata.",
  1942. "id": "ReportMetadata",
  1943. "properties": {
  1944. "googleCloudStoragePath": {
  1945. "description": "The path to the location in Google Cloud Storage where the report is stored.",
  1946. "type": "string"
  1947. },
  1948. "reportDataEndTimeMs": {
  1949. "description": "The ending time for the data that is shown in the report.",
  1950. "format": "int64",
  1951. "type": "string"
  1952. },
  1953. "reportDataStartTimeMs": {
  1954. "description": "The starting time for the data that is shown in the report.",
  1955. "format": "int64",
  1956. "type": "string"
  1957. },
  1958. "status": {
  1959. "$ref": "ReportStatus",
  1960. "description": "Report status."
  1961. }
  1962. },
  1963. "type": "object"
  1964. },
  1965. "ReportStatus": {
  1966. "description": "Report status.",
  1967. "id": "ReportStatus",
  1968. "properties": {
  1969. "failure": {
  1970. "$ref": "ReportFailure",
  1971. "description": "If the report failed, this records the cause."
  1972. },
  1973. "finishTimeMs": {
  1974. "description": "The time when this report either completed successfully or failed.",
  1975. "format": "int64",
  1976. "type": "string"
  1977. },
  1978. "format": {
  1979. "description": "The file type of the report.",
  1980. "enum": [
  1981. "CSV",
  1982. "EXCEL_CSV",
  1983. "XLSX"
  1984. ],
  1985. "enumDescriptions": [
  1986. "",
  1987. "",
  1988. ""
  1989. ],
  1990. "type": "string"
  1991. },
  1992. "state": {
  1993. "description": "The state of the report.",
  1994. "enum": [
  1995. "DONE",
  1996. "FAILED",
  1997. "RUNNING"
  1998. ],
  1999. "enumDescriptions": [
  2000. "",
  2001. "",
  2002. ""
  2003. ],
  2004. "type": "string"
  2005. }
  2006. },
  2007. "type": "object"
  2008. },
  2009. "RowStatus": {
  2010. "description": "Represents the upload status of a row in the request.",
  2011. "id": "RowStatus",
  2012. "properties": {
  2013. "changed": {
  2014. "description": "Whether the stored entity is changed as a result of upload.",
  2015. "type": "boolean"
  2016. },
  2017. "entityId": {
  2018. "description": "Entity Id.",
  2019. "format": "int64",
  2020. "type": "string"
  2021. },
  2022. "entityName": {
  2023. "description": "Entity name.",
  2024. "type": "string"
  2025. },
  2026. "errors": {
  2027. "description": "Reasons why the entity can't be uploaded.",
  2028. "items": {
  2029. "type": "string"
  2030. },
  2031. "type": "array"
  2032. },
  2033. "persisted": {
  2034. "description": "Whether the entity is persisted.",
  2035. "type": "boolean"
  2036. },
  2037. "rowNumber": {
  2038. "description": "Row number.",
  2039. "format": "int32",
  2040. "type": "integer"
  2041. }
  2042. },
  2043. "type": "object"
  2044. },
  2045. "RunQueryRequest": {
  2046. "description": "Request to run a stored query to generate a report.",
  2047. "id": "RunQueryRequest",
  2048. "properties": {
  2049. "dataRange": {
  2050. "description": "Report data range used to generate the report.",
  2051. "enum": [
  2052. "ALL_TIME",
  2053. "CURRENT_DAY",
  2054. "CUSTOM_DATES",
  2055. "LAST_14_DAYS",
  2056. "LAST_30_DAYS",
  2057. "LAST_365_DAYS",
  2058. "LAST_7_DAYS",
  2059. "LAST_90_DAYS",
  2060. "MONTH_TO_DATE",
  2061. "PREVIOUS_DAY",
  2062. "PREVIOUS_HALF_MONTH",
  2063. "PREVIOUS_MONTH",
  2064. "PREVIOUS_QUARTER",
  2065. "PREVIOUS_WEEK",
  2066. "PREVIOUS_YEAR",
  2067. "QUARTER_TO_DATE",
  2068. "TYPE_NOT_SUPPORTED",
  2069. "WEEK_TO_DATE",
  2070. "YEAR_TO_DATE"
  2071. ],
  2072. "enumDescriptions": [
  2073. "",
  2074. "",
  2075. "",
  2076. "",
  2077. "",
  2078. "",
  2079. "",
  2080. "",
  2081. "",
  2082. "",
  2083. "",
  2084. "",
  2085. "",
  2086. "",
  2087. "",
  2088. "",
  2089. "",
  2090. "",
  2091. ""
  2092. ],
  2093. "type": "string"
  2094. },
  2095. "reportDataEndTimeMs": {
  2096. "description": "The ending time for the data that is shown in the report. Note, reportDataEndTimeMs is required if dataRange is CUSTOM_DATES and ignored otherwise.",
  2097. "format": "int64",
  2098. "type": "string"
  2099. },
  2100. "reportDataStartTimeMs": {
  2101. "description": "The starting time for the data that is shown in the report. Note, reportDataStartTimeMs is required if dataRange is CUSTOM_DATES and ignored otherwise.",
  2102. "format": "int64",
  2103. "type": "string"
  2104. },
  2105. "timezoneCode": {
  2106. "description": "Canonical timezone code for report data time. Defaults to America/New_York.",
  2107. "type": "string"
  2108. }
  2109. },
  2110. "type": "object"
  2111. },
  2112. "UploadLineItemsRequest": {
  2113. "description": "Request to upload line items.",
  2114. "id": "UploadLineItemsRequest",
  2115. "properties": {
  2116. "dryRun": {
  2117. "description": "Set to true to get upload status without actually persisting the line items.",
  2118. "type": "boolean"
  2119. },
  2120. "format": {
  2121. "description": "Format the line items are in. Default to CSV.",
  2122. "enum": [
  2123. "CSV"
  2124. ],
  2125. "enumDescriptions": [
  2126. ""
  2127. ],
  2128. "type": "string"
  2129. },
  2130. "lineItems": {
  2131. "description": "Line items in CSV to upload. Refer to Entity Write File Format for more information on file format.",
  2132. "type": "string"
  2133. }
  2134. },
  2135. "type": "object"
  2136. },
  2137. "UploadLineItemsResponse": {
  2138. "description": "Upload line items response.",
  2139. "id": "UploadLineItemsResponse",
  2140. "properties": {
  2141. "uploadStatus": {
  2142. "$ref": "UploadStatus",
  2143. "description": "Status of upload."
  2144. }
  2145. },
  2146. "type": "object"
  2147. },
  2148. "UploadStatus": {
  2149. "description": "Represents the status of upload.",
  2150. "id": "UploadStatus",
  2151. "properties": {
  2152. "errors": {
  2153. "description": "Reasons why upload can't be completed.",
  2154. "items": {
  2155. "type": "string"
  2156. },
  2157. "type": "array"
  2158. },
  2159. "rowStatus": {
  2160. "description": "Per-row upload status.",
  2161. "items": {
  2162. "$ref": "RowStatus"
  2163. },
  2164. "type": "array"
  2165. }
  2166. },
  2167. "type": "object"
  2168. }
  2169. },
  2170. "servicePath": "doubleclickbidmanager/v1/",
  2171. "title": "DoubleClick Bid Manager API",
  2172. "version": "v1"
  2173. }