← Back to branch summary

~ubuntu-branches/ubuntu/vivid/juju-core/vivid-updates

« back to all changes in this revision

Viewing changes to src/google.golang.org/api/dfareporting/v1/dfareporting-api.json

  • Committer: Package Import Robot
  • Author(s): Curtis C. Hovey
  • Date: 2015-09-29 19:43:29 UTC
  • mfrom: (47.1.4 wily-proposed)
  • Revision ID: package-import@ubuntu.com-20150929194329-9y496tbic30hc7vp
Tags: 1.24.6-0ubuntu1~15.04.1
https://launchpad.net/bugs/1500916
https://launchpad.net/bugs/1497087
Backport of 1.24.6 from wily. (LP: #1500916, #1497087)

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/google.golang.org/api/dfareporting/v1/dfareporting-api.json
 
1
{
 
2
 "kind": "discovery#restDescription",
 
3
 "etag": "\"uUWyYHXmEn-ab7WLvo8qNz2S8ws/m0iCqG-A2H_Nrb1uAxgjjuBXSKA\"",
 
4
 "discoveryVersion": "v1",
 
5
 "id": "dfareporting:v1",
 
6
 "name": "dfareporting",
 
7
 "version": "v1",
 
8
 "revision": "20140910",
 
9
 "title": "DFA Reporting API",
 
10
 "description": "Lets you create, run and download reports.",
 
11
 "ownerDomain": "google.com",
 
12
 "ownerName": "Google",
 
13
 "icons": {
 
14
  "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
 
15
  "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
 
16
 },
 
17
 "documentationLink": "https://developers.google.com/doubleclick-advertisers/reporting/",
 
18
 "protocol": "rest",
 
19
 "baseUrl": "https://www.googleapis.com/dfareporting/v1/",
 
20
 "basePath": "/dfareporting/v1/",
 
21
 "rootUrl": "https://www.googleapis.com/",
 
22
 "servicePath": "dfareporting/v1/",
 
23
 "batchPath": "batch",
 
24
 "parameters": {
 
25
  "alt": {
 
26
   "type": "string",
 
27
   "description": "Data format for the response.",
 
28
   "default": "json",
 
29
   "enum": [
 
30
    "json"
 
31
   ],
 
32
   "enumDescriptions": [
 
33
    "Responses with Content-Type of application/json"
 
34
   ],
 
35
   "location": "query"
 
36
  },
 
37
  "fields": {
 
38
   "type": "string",
 
39
   "description": "Selector specifying which fields to include in a partial response.",
 
40
   "location": "query"
 
41
  },
 
42
  "key": {
 
43
   "type": "string",
 
44
   "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.",
 
45
   "location": "query"
 
46
  },
 
47
  "oauth_token": {
 
48
   "type": "string",
 
49
   "description": "OAuth 2.0 token for the current user.",
 
50
   "location": "query"
 
51
  },
 
52
  "prettyPrint": {
 
53
   "type": "boolean",
 
54
   "description": "Returns response with indentations and line breaks.",
 
55
   "default": "true",
 
56
   "location": "query"
 
57
  },
 
58
  "quotaUser": {
 
59
   "type": "string",
 
60
   "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
 
61
   "location": "query"
 
62
  },
 
63
  "userIp": {
 
64
   "type": "string",
 
65
   "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
 
66
   "location": "query"
 
67
  }
 
68
 },
 
69
 "auth": {
 
70
  "oauth2": {
 
71
   "scopes": {
 
72
    "https://www.googleapis.com/auth/dfareporting": {
 
73
     "description": "View and manage DoubleClick for Advertisers reports"
 
74
    }
 
75
   }
 
76
  }
 
77
 },
 
78
 "schemas": {
 
79
  "DimensionFilter": {
 
80
   "id": "DimensionFilter",
 
81
   "type": "object",
 
82
   "description": "Represents a dimension filter.",
 
83
   "properties": {
 
84
    "dimensionName": {
 
85
     "type": "string",
 
86
     "description": "The name of the dimension to filter."
 
87
    },
 
88
    "kind": {
 
89
     "type": "string",
 
90
     "description": "Kind of resource this is, in this case dfareporting#dimensionFilter.",
 
91
     "default": "dfareporting#dimensionFilter"
 
92
    },
 
93
    "value": {
 
94
     "type": "string",
 
95
     "description": "The value of the dimension to filter for."
 
96
    }
 
97
   }
 
98
  },
 
99
  "DimensionValue": {
 
100
   "id": "DimensionValue",
 
101
   "type": "object",
 
102
   "description": "Represents a DimensionValue resource.",
 
103
   "properties": {
 
104
    "dimensionName": {
 
105
     "type": "string",
 
106
     "description": "Name of the dimension."
 
107
    },
 
108
    "etag": {
 
109
     "type": "string",
 
110
     "description": "ETag of this response for caching purposes."
 
111
    },
 
112
    "id": {
 
113
     "type": "string",
 
114
     "description": "The ID associated with the value if available."
 
115
    },
 
116
    "kind": {
 
117
     "type": "string",
 
118
     "description": "Kind of resource this is, in this case dfareporting#dimensionValue.",
 
119
     "default": "dfareporting#dimensionValue"
 
120
    },
 
121
    "value": {
 
122
     "type": "string",
 
123
     "description": "The value of the dimension."
 
124
    }
 
125
   }
 
126
  },
 
127
  "DimensionValueList": {
 
128
   "id": "DimensionValueList",
 
129
   "type": "object",
 
130
   "description": "Represents the list of DimensionValue resources.",
 
131
   "properties": {
 
132
    "etag": {
 
133
     "type": "string",
 
134
     "description": "ETag of this response for caching purposes."
 
135
    },
 
136
    "items": {
 
137
     "type": "array",
 
138
     "description": "The dimension values returned in this response.",
 
139
     "items": {
 
140
      "$ref": "DimensionValue"
 
141
     }
 
142
    },
 
143
    "kind": {
 
144
     "type": "string",
 
145
     "description": "Kind of list this is, in this case dfareporting#dimensionValueList.",
 
146
     "default": "dfareporting#dimensionValueList"
 
147
    },
 
148
    "nextPageToken": {
 
149
     "type": "string",
 
150
     "description": "Continuation token used to page through dimension values. 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."
 
151
    }
 
152
   }
 
153
  },
 
154
  "DimensionValueRequest": {
 
155
   "id": "DimensionValueRequest",
 
156
   "type": "object",
 
157
   "description": "Represents a DimensionValuesRequest.",
 
158
   "properties": {
 
159
    "dimensionName": {
 
160
     "type": "string",
 
161
     "description": "The name of the dimension values should be requested for."
 
162
    },
 
163
    "endDate": {
 
164
     "type": "string",
 
165
     "description": "The end date of the date range for which to retrieve dimension values. A string of the format: \"yyyy-MM-dd\".",
 
166
     "format": "date"
 
167
    },
 
168
    "filters": {
 
169
     "type": "array",
 
170
     "description": "List of filters to filter values by. The filters are ANDed.",
 
171
     "items": {
 
172
      "$ref": "DimensionFilter"
 
173
     }
 
174
    },
 
175
    "kind": {
 
176
     "type": "string",
 
177
     "description": "Kind of request this is, in this case dfareporting#dimensionValueRequest.",
 
178
     "default": "dfareporting#dimensionValueRequest"
 
179
    },
 
180
    "startDate": {
 
181
     "type": "string",
 
182
     "description": "The start date of the date range for which to retrieve dimension values. A string of the format: \"yyyy-MM-dd\".",
 
183
     "format": "date"
 
184
    }
 
185
   }
 
186
  },
 
187
  "File": {
 
188
   "id": "File",
 
189
   "type": "object",
 
190
   "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_AVAILABLE\".",
 
191
   "properties": {
 
192
    "dateRange": {
 
193
     "type": "object",
 
194
     "description": "The date range for which the file has report data.",
 
195
     "properties": {
 
196
      "endDate": {
 
197
       "type": "string",
 
198
       "description": "The end date of the date range, inclusive. A string of the format: \"yyyy-MM-dd\".",
 
199
       "format": "date"
 
200
      },
 
201
      "startDate": {
 
202
       "type": "string",
 
203
       "description": "The start date of the date range, inclusive. A string of the format: \"yyyy-MM-dd\".",
 
204
       "format": "date"
 
205
      }
 
206
     }
 
207
    },
 
208
    "etag": {
 
209
     "type": "string",
 
210
     "description": "ETag of this response for caching purposes."
 
211
    },
 
212
    "fileName": {
 
213
     "type": "string",
 
214
     "description": "The file name of the file."
 
215
    },
 
216
    "id": {
 
217
     "type": "string",
 
218
     "description": "The unique ID of this report file.",
 
219
     "format": "int64"
 
220
    },
 
221
    "kind": {
 
222
     "type": "string",
 
223
     "description": "Kind of resource this is, in this case dfareporting#file.",
 
224
     "default": "dfareporting#file"
 
225
    },
 
226
    "lastModifiedTime": {
 
227
     "type": "string",
 
228
     "description": "The timestamp in milliseconds since epoch when this file was last modified.",
 
229
     "format": "int64"
 
230
    },
 
231
    "reportId": {
 
232
     "type": "string",
 
233
     "description": "The ID of the report this file was generated from.",
 
234
     "format": "int64"
 
235
    },
 
236
    "status": {
 
237
     "type": "string",
 
238
     "description": "The status of the report file, one of:  \n- \"PROCESSING\" \n- \"REPORT_AVAILABLE\" \n- \"FAILED\" \n- \"CANCELLED\""
 
239
    },
 
240
    "urls": {
 
241
     "type": "object",
 
242
     "description": "The urls where the completed report file can be downloaded.",
 
243
     "properties": {
 
244
      "csv": {
 
245
       "type": "object",
 
246
       "description": "Urls for generated CSV data.",
 
247
       "properties": {
 
248
        "apiUrl": {
 
249
         "type": "string",
 
250
         "description": "The url for downloading the report data through the API."
 
251
        },
 
252
        "browserUrl": {
 
253
         "type": "string",
 
254
         "description": "The url for downloading the report data through a browser."
 
255
        }
 
256
       }
 
257
      }
 
258
     }
 
259
    }
 
260
   }
 
261
  },
 
262
  "FileList": {
 
263
   "id": "FileList",
 
264
   "type": "object",
 
265
   "description": "Represents the list of File resources.",
 
266
   "properties": {
 
267
    "etag": {
 
268
     "type": "string",
 
269
     "description": "ETag of this response for caching purposes."
 
270
    },
 
271
    "items": {
 
272
     "type": "array",
 
273
     "description": "The files returned in this response.",
 
274
     "items": {
 
275
      "$ref": "File"
 
276
     }
 
277
    },
 
278
    "kind": {
 
279
     "type": "string",
 
280
     "description": "Kind of list this is, in this case dfareporting#fileList.",
 
281
     "default": "dfareporting#fileList"
 
282
    },
 
283
    "nextPageToken": {
 
284
     "type": "string",
 
285
     "description": "Continuation token used to page through files. 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."
 
286
    }
 
287
   }
 
288
  },
 
289
  "Report": {
 
290
   "id": "Report",
 
291
   "type": "object",
 
292
   "description": "Represents a Report resource.",
 
293
   "properties": {
 
294
    "accountId": {
 
295
     "type": "string",
 
296
     "description": "The account id this report belongs to.",
 
297
     "format": "int64",
 
298
     "annotations": {
 
299
      "required": [
 
300
       "dfareporting.reports.update"
 
301
      ]
 
302
     }
 
303
    },
 
304
    "criteria": {
 
305
     "type": "object",
 
306
     "description": "The report criteria.",
 
307
     "properties": {
 
308
      "activities": {
 
309
       "type": "object",
 
310
       "description": "Activity group.",
 
311
       "properties": {
 
312
        "filters": {
 
313
         "type": "array",
 
314
         "description": "List of activity filters. The dimension values need to be all either of type \"dfa:activity\" or \"dfa:activityGroup\".",
 
315
         "items": {
 
316
          "$ref": "DimensionValue"
 
317
         }
 
318
        },
 
319
        "metricNames": {
 
320
         "type": "array",
 
321
         "description": "List of names of floodlight activity metrics.",
 
322
         "items": {
 
323
          "type": "string"
 
324
         }
 
325
        }
 
326
       }
 
327
      },
 
328
      "customRichMediaEvents": {
 
329
       "type": "object",
 
330
       "description": "Custom Rich Media Events group.",
 
331
       "properties": {
 
332
        "filteredEventIds": {
 
333
         "type": "array",
 
334
         "description": "List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.",
 
335
         "items": {
 
336
          "$ref": "DimensionValue"
 
337
         }
 
338
        }
 
339
       }
 
340
      },
 
341
      "dateRange": {
 
342
       "type": "object",
 
343
       "description": "The date range this report should be run for.",
 
344
       "properties": {
 
345
        "endDate": {
 
346
         "type": "string",
 
347
         "description": "The end date of the date range, inclusive. A string of the format: \"yyyy-MM-dd\".",
 
348
         "format": "date"
 
349
        },
 
350
        "relativeDateRange": {
 
351
         "type": "string",
 
352
         "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- \"PREVIOUS_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_DAYS\" \n- \"LAST_24_MONTHS\""
 
353
        },
 
354
        "startDate": {
 
355
         "type": "string",
 
356
         "description": "The start date of the date range, inclusive. A string of the format: \"yyyy-MM-dd\".",
 
357
         "format": "date"
 
358
        }
 
359
       }
 
360
      },
 
361
      "dimensionFilters": {
 
362
       "type": "array",
 
363
       "description": "The list of filters dimensions are filtered on.\nFilters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
 
364
       "items": {
 
365
        "$ref": "DimensionValue"
 
366
       }
 
367
      },
 
368
      "dimensions": {
 
369
       "type": "array",
 
370
       "description": "The list of dimensions the report should include.",
 
371
       "items": {
 
372
        "$ref": "SortedDimension"
 
373
       }
 
374
      },
 
375
      "metricNames": {
 
376
       "type": "array",
 
377
       "description": "The list of names of metrics the report should include.",
 
378
       "items": {
 
379
        "type": "string"
 
380
       }
 
381
      }
 
382
     }
 
383
    },
 
384
    "etag": {
 
385
     "type": "string",
 
386
     "description": "ETag of this response for caching purposes."
 
387
    },
 
388
    "fileName": {
 
389
     "type": "string",
 
390
     "description": "The file name used when generating report files for this report."
 
391
    },
 
392
    "id": {
 
393
     "type": "string",
 
394
     "description": "The unique ID identifying this report resource.",
 
395
     "format": "int64",
 
396
     "annotations": {
 
397
      "required": [
 
398
       "dfareporting.reports.update"
 
399
      ]
 
400
     }
 
401
    },
 
402
    "kind": {
 
403
     "type": "string",
 
404
     "description": "Kind of resource this is, in this case dfareporting#report.",
 
405
     "default": "dfareporting#report"
 
406
    },
 
407
    "lastModifiedTime": {
 
408
     "type": "string",
 
409
     "description": "The timestamp (in milliseconds since epoch) of when this report was last modified.",
 
410
     "format": "uint64",
 
411
     "annotations": {
 
412
      "required": [
 
413
       "dfareporting.reports.update"
 
414
      ]
 
415
     }
 
416
    },
 
417
    "name": {
 
418
     "type": "string",
 
419
     "description": "The name of the report.",
 
420
     "annotations": {
 
421
      "required": [
 
422
       "dfareporting.reports.insert",
 
423
       "dfareporting.reports.update"
 
424
      ]
 
425
     }
 
426
    },
 
427
    "ownerProfileId": {
 
428
     "type": "string",
 
429
     "description": "The user profile id of the owner of this report.",
 
430
     "format": "int64",
 
431
     "annotations": {
 
432
      "required": [
 
433
       "dfareporting.reports.update"
 
434
      ]
 
435
     }
 
436
    },
 
437
    "schedule": {
 
438
     "type": "object",
 
439
     "description": "The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not \"TODAY\".",
 
440
     "properties": {
 
441
      "active": {
 
442
       "type": "boolean",
 
443
       "description": "Whether the schedule is active or not. Must be set to either true or false.",
 
444
       "annotations": {
 
445
        "required": [
 
446
         "dfareporting.reports.insert",
 
447
         "dfareporting.reports.update"
 
448
        ]
 
449
       }
 
450
      },
 
451
      "every": {
 
452
       "type": "integer",
 
453
       "description": "Defines every how many days, weeks or months the report should be run. Needs to be set when \"repeats\" is either \"DAILY\", \"WEEKLY\" or \"MONTHLY\".",
 
454
       "format": "int32"
 
455
      },
 
456
      "expirationDate": {
 
457
       "type": "string",
 
458
       "description": "The expiration date when the scheduled report stops running.",
 
459
       "format": "date",
 
460
       "annotations": {
 
461
        "required": [
 
462
         "dfareporting.reports.insert",
 
463
         "dfareporting.reports.update"
 
464
        ]
 
465
       }
 
466
      },
 
467
      "repeats": {
 
468
       "type": "string",
 
469
       "description": "The interval the report is repeated for, 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 \"runsOnDayOfMonth\" to be set. \n- \"QUARTERLY\" \n- \"YEARLY\"",
 
470
       "annotations": {
 
471
        "required": [
 
472
         "dfareporting.reports.insert",
 
473
         "dfareporting.reports.update"
 
474
        ]
 
475
       }
 
476
      },
 
477
      "repeatsOnWeekDays": {
 
478
       "type": "array",
 
479
       "description": "List of week days \"WEEKLY\" scheduled reports should run on.",
 
480
       "items": {
 
481
        "type": "string"
 
482
       }
 
483
      },
 
484
      "runsOnDayOfMonth": {
 
485
       "type": "string",
 
486
       "description": "Enum to define for \"MONTHLY\" scheduled 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 Monday of the month."
 
487
      },
 
488
      "startDate": {
 
489
       "type": "string",
 
490
       "description": "Start date of date range for which scheduled reports should be run.",
 
491
       "format": "date",
 
492
       "annotations": {
 
493
        "required": [
 
494
         "dfareporting.reports.insert",
 
495
         "dfareporting.reports.update"
 
496
        ]
 
497
       }
 
498
      }
 
499
     }
 
500
    },
 
501
    "subAccountId": {
 
502
     "type": "string",
 
503
     "description": "The subbaccount id this report belongs to if applicable.",
 
504
     "format": "int64"
 
505
    },
 
506
    "type": {
 
507
     "type": "string",
 
508
     "description": "The type of the report, currently only \"STANDARD\" is supported.",
 
509
     "annotations": {
 
510
      "required": [
 
511
       "dfareporting.reports.insert",
 
512
       "dfareporting.reports.update"
 
513
      ]
 
514
     }
 
515
    }
 
516
   }
 
517
  },
 
518
  "ReportList": {
 
519
   "id": "ReportList",
 
520
   "type": "object",
 
521
   "description": "Represents the list of reports.",
 
522
   "properties": {
 
523
    "etag": {
 
524
     "type": "string",
 
525
     "description": "ETag of this response for caching purposes."
 
526
    },
 
527
    "items": {
 
528
     "type": "array",
 
529
     "description": "The reports returned in this response.",
 
530
     "items": {
 
531
      "$ref": "Report"
 
532
     }
 
533
    },
 
534
    "kind": {
 
535
     "type": "string",
 
536
     "description": "Kind of list this is, in this case dfareporting#reportList.",
 
537
     "default": "dfareporting#reportList"
 
538
    },
 
539
    "nextPageToken": {
 
540
     "type": "string",
 
541
     "description": "Continuation token used to page through reports. 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."
 
542
    }
 
543
   }
 
544
  },
 
545
  "SortedDimension": {
 
546
   "id": "SortedDimension",
 
547
   "type": "object",
 
548
   "description": "Represents a sorted dimension.",
 
549
   "properties": {
 
550
    "kind": {
 
551
     "type": "string",
 
552
     "description": "Kind of resource this is, in this case dfareporting#sortedDimension.",
 
553
     "default": "dfareporting#sortedDimension"
 
554
    },
 
555
    "name": {
 
556
     "type": "string",
 
557
     "description": "The name of the dimension."
 
558
    },
 
559
    "sortOrder": {
 
560
     "type": "string",
 
561
     "description": "An optional sort order for the dimension column, one of:  \n- \"ASCENDING\" \n- \"DESCENDING\""
 
562
    }
 
563
   }
 
564
  },
 
565
  "UserProfile": {
 
566
   "id": "UserProfile",
 
567
   "type": "object",
 
568
   "description": "Represents a UserProfile resource.",
 
569
   "properties": {
 
570
    "accountId": {
 
571
     "type": "string",
 
572
     "description": "The account ID this profile belongs to.",
 
573
     "format": "int64"
 
574
    },
 
575
    "accountName": {
 
576
     "type": "string",
 
577
     "description": "The account name this profile belongs to."
 
578
    },
 
579
    "etag": {
 
580
     "type": "string",
 
581
     "description": "ETag of this response for caching purposes."
 
582
    },
 
583
    "kind": {
 
584
     "type": "string",
 
585
     "description": "Kind of resource this is, in this case dfareporting#userProfile.",
 
586
     "default": "dfareporting#userProfile"
 
587
    },
 
588
    "profileId": {
 
589
     "type": "string",
 
590
     "description": "The unique ID of the user profile.",
 
591
     "format": "int64"
 
592
    },
 
593
    "subAccountId": {
 
594
     "type": "string",
 
595
     "description": "The sub account ID this profile belongs to if applicable.",
 
596
     "format": "int64"
 
597
    },
 
598
    "subAccountName": {
 
599
     "type": "string",
 
600
     "description": "The sub account name this profile belongs to if applicable."
 
601
    },
 
602
    "userName": {
 
603
     "type": "string",
 
604
     "description": "The user name."
 
605
    }
 
606
   }
 
607
  },
 
608
  "UserProfileList": {
 
609
   "id": "UserProfileList",
 
610
   "type": "object",
 
611
   "description": "Represents the list of user profiles.",
 
612
   "properties": {
 
613
    "etag": {
 
614
     "type": "string",
 
615
     "description": "ETag of this response for caching purposes."
 
616
    },
 
617
    "items": {
 
618
     "type": "array",
 
619
     "description": "The user profiles returned in this response.",
 
620
     "items": {
 
621
      "$ref": "UserProfile"
 
622
     }
 
623
    },
 
624
    "kind": {
 
625
     "type": "string",
 
626
     "description": "Kind of list this is, in this case dfareporting#userProfileList.",
 
627
     "default": "dfareporting#userProfileList"
 
628
    }
 
629
   }
 
630
  }
 
631
 },
 
632
 "resources": {
 
633
  "dimensionValues": {
 
634
   "methods": {
 
635
    "query": {
 
636
     "id": "dfareporting.dimensionValues.query",
 
637
     "path": "userprofiles/{profileId}/dimensionvalues/query",
 
638
     "httpMethod": "POST",
 
639
     "description": "Retrieves list of report dimension values for a list of filters.",
 
640
     "parameters": {
 
641
      "maxResults": {
 
642
       "type": "integer",
 
643
       "description": "Maximum number of results to return.",
 
644
       "format": "int32",
 
645
       "minimum": "0",
 
646
       "maximum": "100",
 
647
       "location": "query"
 
648
      },
 
649
      "pageToken": {
 
650
       "type": "string",
 
651
       "description": "The value of the nextToken from the previous result page.",
 
652
       "location": "query"
 
653
      },
 
654
      "profileId": {
 
655
       "type": "string",
 
656
       "description": "The DFA user profile id.",
 
657
       "required": true,
 
658
       "format": "int64",
 
659
       "location": "path"
 
660
      }
 
661
     },
 
662
     "parameterOrder": [
 
663
      "profileId"
 
664
     ],
 
665
     "request": {
 
666
      "$ref": "DimensionValueRequest"
 
667
     },
 
668
     "response": {
 
669
      "$ref": "DimensionValueList"
 
670
     },
 
671
     "scopes": [
 
672
      "https://www.googleapis.com/auth/dfareporting"
 
673
     ]
 
674
    }
 
675
   }
 
676
  },
 
677
  "files": {
 
678
   "methods": {
 
679
    "list": {
 
680
     "id": "dfareporting.files.list",
 
681
     "path": "userprofiles/{profileId}/files",
 
682
     "httpMethod": "GET",
 
683
     "description": "Lists files for a user profile.",
 
684
     "parameters": {
 
685
      "maxResults": {
 
686
       "type": "integer",
 
687
       "description": "Maximum number of results to return.",
 
688
       "format": "int32",
 
689
       "minimum": "0",
 
690
       "maximum": "10",
 
691
       "location": "query"
 
692
      },
 
693
      "pageToken": {
 
694
       "type": "string",
 
695
       "description": "The value of the nextToken from the previous result page.",
 
696
       "location": "query"
 
697
      },
 
698
      "profileId": {
 
699
       "type": "string",
 
700
       "description": "The DFA profile id.",
 
701
       "required": true,
 
702
       "format": "int64",
 
703
       "location": "path"
 
704
      },
 
705
      "sortField": {
 
706
       "type": "string",
 
707
       "description": "The field to sort the list by.",
 
708
       "default": "LAST_MODIFIED_TIME",
 
709
       "enum": [
 
710
        "ID",
 
711
        "LAST_MODIFIED_TIME"
 
712
       ],
 
713
       "enumDescriptions": [
 
714
        "Sort by file id.",
 
715
        "Sort by 'lastmodifiedAt' field."
 
716
       ],
 
717
       "location": "query"
 
718
      },
 
719
      "sortOrder": {
 
720
       "type": "string",
 
721
       "description": "Order of sorted results, default is 'DESCENDING'.",
 
722
       "default": "DESCENDING",
 
723
       "enum": [
 
724
        "ASCENDING",
 
725
        "DESCENDING"
 
726
       ],
 
727
       "enumDescriptions": [
 
728
        "Ascending order.",
 
729
        "Descending order."
 
730
       ],
 
731
       "location": "query"
 
732
      }
 
733
     },
 
734
     "parameterOrder": [
 
735
      "profileId"
 
736
     ],
 
737
     "response": {
 
738
      "$ref": "FileList"
 
739
     },
 
740
     "scopes": [
 
741
      "https://www.googleapis.com/auth/dfareporting"
 
742
     ]
 
743
    }
 
744
   }
 
745
  },
 
746
  "reports": {
 
747
   "methods": {
 
748
    "delete": {
 
749
     "id": "dfareporting.reports.delete",
 
750
     "path": "userprofiles/{profileId}/reports/{reportId}",
 
751
     "httpMethod": "DELETE",
 
752
     "description": "Deletes a report by its id.",
 
753
     "parameters": {
 
754
      "profileId": {
 
755
       "type": "string",
 
756
       "description": "The DFA user profile id.",
 
757
       "required": true,
 
758
       "format": "int64",
 
759
       "location": "path"
 
760
      },
 
761
      "reportId": {
 
762
       "type": "string",
 
763
       "description": "The id of the report.",
 
764
       "required": true,
 
765
       "format": "int64",
 
766
       "location": "path"
 
767
      }
 
768
     },
 
769
     "parameterOrder": [
 
770
      "profileId",
 
771
      "reportId"
 
772
     ],
 
773
     "scopes": [
 
774
      "https://www.googleapis.com/auth/dfareporting"
 
775
     ]
 
776
    },
 
777
    "get": {
 
778
     "id": "dfareporting.reports.get",
 
779
     "path": "userprofiles/{profileId}/reports/{reportId}",
 
780
     "httpMethod": "GET",
 
781
     "description": "Retrieves a report by its id.",
 
782
     "parameters": {
 
783
      "profileId": {
 
784
       "type": "string",
 
785
       "description": "The DFA user profile id.",
 
786
       "required": true,
 
787
       "format": "int64",
 
788
       "location": "path"
 
789
      },
 
790
      "reportId": {
 
791
       "type": "string",
 
792
       "description": "The id of the report.",
 
793
       "required": true,
 
794
       "format": "int64",
 
795
       "location": "path"
 
796
      }
 
797
     },
 
798
     "parameterOrder": [
 
799
      "profileId",
 
800
      "reportId"
 
801
     ],
 
802
     "response": {
 
803
      "$ref": "Report"
 
804
     },
 
805
     "scopes": [
 
806
      "https://www.googleapis.com/auth/dfareporting"
 
807
     ]
 
808
    },
 
809
    "insert": {
 
810
     "id": "dfareporting.reports.insert",
 
811
     "path": "userprofiles/{profileId}/reports",
 
812
     "httpMethod": "POST",
 
813
     "description": "Creates a report.",
 
814
     "parameters": {
 
815
      "profileId": {
 
816
       "type": "string",
 
817
       "description": "The DFA user profile id.",
 
818
       "required": true,
 
819
       "format": "int64",
 
820
       "location": "path"
 
821
      }
 
822
     },
 
823
     "parameterOrder": [
 
824
      "profileId"
 
825
     ],
 
826
     "request": {
 
827
      "$ref": "Report"
 
828
     },
 
829
     "response": {
 
830
      "$ref": "Report"
 
831
     },
 
832
     "scopes": [
 
833
      "https://www.googleapis.com/auth/dfareporting"
 
834
     ]
 
835
    },
 
836
    "list": {
 
837
     "id": "dfareporting.reports.list",
 
838
     "path": "userprofiles/{profileId}/reports",
 
839
     "httpMethod": "GET",
 
840
     "description": "Retrieves list of reports.",
 
841
     "parameters": {
 
842
      "maxResults": {
 
843
       "type": "integer",
 
844
       "description": "Maximum number of results to return.",
 
845
       "format": "int32",
 
846
       "minimum": "0",
 
847
       "maximum": "10",
 
848
       "location": "query"
 
849
      },
 
850
      "pageToken": {
 
851
       "type": "string",
 
852
       "description": "The value of the nextToken from the previous result page.",
 
853
       "location": "query"
 
854
      },
 
855
      "profileId": {
 
856
       "type": "string",
 
857
       "description": "The DFA user profile id.",
 
858
       "required": true,
 
859
       "format": "int64",
 
860
       "location": "path"
 
861
      },
 
862
      "sortField": {
 
863
       "type": "string",
 
864
       "description": "The field to sort the list by.",
 
865
       "default": "LAST_MODIFIED_TIME",
 
866
       "enum": [
 
867
        "ID",
 
868
        "LAST_MODIFIED_TIME",
 
869
        "NAME"
 
870
       ],
 
871
       "enumDescriptions": [
 
872
        "Sort by report id.",
 
873
        "Sort by 'lastModifiedTime' field.",
 
874
        "Sort by display name of reports."
 
875
       ],
 
876
       "location": "query"
 
877
      },
 
878
      "sortOrder": {
 
879
       "type": "string",
 
880
       "description": "Order of sorted results, default is 'DESCENDING'.",
 
881
       "default": "DESCENDING",
 
882
       "enum": [
 
883
        "ASCENDING",
 
884
        "DESCENDING"
 
885
       ],
 
886
       "enumDescriptions": [
 
887
        "Ascending order.",
 
888
        "Descending order."
 
889
       ],
 
890
       "location": "query"
 
891
      }
 
892
     },
 
893
     "parameterOrder": [
 
894
      "profileId"
 
895
     ],
 
896
     "response": {
 
897
      "$ref": "ReportList"
 
898
     },
 
899
     "scopes": [
 
900
      "https://www.googleapis.com/auth/dfareporting"
 
901
     ]
 
902
    },
 
903
    "patch": {
 
904
     "id": "dfareporting.reports.patch",
 
905
     "path": "userprofiles/{profileId}/reports/{reportId}",
 
906
     "httpMethod": "PATCH",
 
907
     "description": "Updates a report. This method supports patch semantics.",
 
908
     "parameters": {
 
909
      "profileId": {
 
910
       "type": "string",
 
911
       "description": "The DFA user profile id.",
 
912
       "required": true,
 
913
       "format": "int64",
 
914
       "location": "path"
 
915
      },
 
916
      "reportId": {
 
917
       "type": "string",
 
918
       "description": "The id of the report.",
 
919
       "required": true,
 
920
       "format": "int64",
 
921
       "location": "path"
 
922
      }
 
923
     },
 
924
     "parameterOrder": [
 
925
      "profileId",
 
926
      "reportId"
 
927
     ],
 
928
     "request": {
 
929
      "$ref": "Report"
 
930
     },
 
931
     "response": {
 
932
      "$ref": "Report"
 
933
     },
 
934
     "scopes": [
 
935
      "https://www.googleapis.com/auth/dfareporting"
 
936
     ]
 
937
    },
 
938
    "run": {
 
939
     "id": "dfareporting.reports.run",
 
940
     "path": "userprofiles/{profileId}/reports/{reportId}/run",
 
941
     "httpMethod": "POST",
 
942
     "description": "Runs a report.",
 
943
     "parameters": {
 
944
      "profileId": {
 
945
       "type": "string",
 
946
       "description": "The DFA profile id.",
 
947
       "required": true,
 
948
       "format": "int64",
 
949
       "location": "path"
 
950
      },
 
951
      "reportId": {
 
952
       "type": "string",
 
953
       "description": "The id of the report.",
 
954
       "required": true,
 
955
       "format": "int64",
 
956
       "location": "path"
 
957
      },
 
958
      "synchronous": {
 
959
       "type": "boolean",
 
960
       "description": "If set and true, tries to run the report synchronously.",
 
961
       "location": "query"
 
962
      }
 
963
     },
 
964
     "parameterOrder": [
 
965
      "profileId",
 
966
      "reportId"
 
967
     ],
 
968
     "response": {
 
969
      "$ref": "File"
 
970
     },
 
971
     "scopes": [
 
972
      "https://www.googleapis.com/auth/dfareporting"
 
973
     ]
 
974
    },
 
975
    "update": {
 
976
     "id": "dfareporting.reports.update",
 
977
     "path": "userprofiles/{profileId}/reports/{reportId}",
 
978
     "httpMethod": "PUT",
 
979
     "description": "Updates a report.",
 
980
     "parameters": {
 
981
      "profileId": {
 
982
       "type": "string",
 
983
       "description": "The DFA user profile id.",
 
984
       "required": true,
 
985
       "format": "int64",
 
986
       "location": "path"
 
987
      },
 
988
      "reportId": {
 
989
       "type": "string",
 
990
       "description": "The id of the report.",
 
991
       "required": true,
 
992
       "format": "int64",
 
993
       "location": "path"
 
994
      }
 
995
     },
 
996
     "parameterOrder": [
 
997
      "profileId",
 
998
      "reportId"
 
999
     ],
 
1000
     "request": {
 
1001
      "$ref": "Report"
 
1002
     },
 
1003
     "response": {
 
1004
      "$ref": "Report"
 
1005
     },
 
1006
     "scopes": [
 
1007
      "https://www.googleapis.com/auth/dfareporting"
 
1008
     ]
 
1009
    }
 
1010
   },
 
1011
   "resources": {
 
1012
    "files": {
 
1013
     "methods": {
 
1014
      "get": {
 
1015
       "id": "dfareporting.reports.files.get",
 
1016
       "path": "userprofiles/{profileId}/reports/{reportId}/files/{fileId}",
 
1017
       "httpMethod": "GET",
 
1018
       "description": "Retrieves a report file.",
 
1019
       "parameters": {
 
1020
        "fileId": {
 
1021
         "type": "string",
 
1022
         "description": "The id of the report file.",
 
1023
         "required": true,
 
1024
         "format": "int64",
 
1025
         "location": "path"
 
1026
        },
 
1027
        "profileId": {
 
1028
         "type": "string",
 
1029
         "description": "The DFA profile id.",
 
1030
         "required": true,
 
1031
         "format": "int64",
 
1032
         "location": "path"
 
1033
        },
 
1034
        "reportId": {
 
1035
         "type": "string",
 
1036
         "description": "The id of the report.",
 
1037
         "required": true,
 
1038
         "format": "int64",
 
1039
         "location": "path"
 
1040
        }
 
1041
       },
 
1042
       "parameterOrder": [
 
1043
        "profileId",
 
1044
        "reportId",
 
1045
        "fileId"
 
1046
       ],
 
1047
       "response": {
 
1048
        "$ref": "File"
 
1049
       },
 
1050
       "scopes": [
 
1051
        "https://www.googleapis.com/auth/dfareporting"
 
1052
       ]
 
1053
      },
 
1054
      "list": {
 
1055
       "id": "dfareporting.reports.files.list",
 
1056
       "path": "userprofiles/{profileId}/reports/{reportId}/files",
 
1057
       "httpMethod": "GET",
 
1058
       "description": "Lists files for a report.",
 
1059
       "parameters": {
 
1060
        "maxResults": {
 
1061
         "type": "integer",
 
1062
         "description": "Maximum number of results to return.",
 
1063
         "format": "int32",
 
1064
         "minimum": "0",
 
1065
         "maximum": "10",
 
1066
         "location": "query"
 
1067
        },
 
1068
        "pageToken": {
 
1069
         "type": "string",
 
1070
         "description": "The value of the nextToken from the previous result page.",
 
1071
         "location": "query"
 
1072
        },
 
1073
        "profileId": {
 
1074
         "type": "string",
 
1075
         "description": "The DFA profile id.",
 
1076
         "required": true,
 
1077
         "format": "int64",
 
1078
         "location": "path"
 
1079
        },
 
1080
        "reportId": {
 
1081
         "type": "string",
 
1082
         "description": "The id of the parent report.",
 
1083
         "required": true,
 
1084
         "format": "int64",
 
1085
         "location": "path"
 
1086
        },
 
1087
        "sortField": {
 
1088
         "type": "string",
 
1089
         "description": "The field to sort the list by.",
 
1090
         "default": "LAST_MODIFIED_TIME",
 
1091
         "enum": [
 
1092
          "ID",
 
1093
          "LAST_MODIFIED_TIME"
 
1094
         ],
 
1095
         "enumDescriptions": [
 
1096
          "Sort by file id.",
 
1097
          "Sort by 'lastmodifiedAt' field."
 
1098
         ],
 
1099
         "location": "query"
 
1100
        },
 
1101
        "sortOrder": {
 
1102
         "type": "string",
 
1103
         "description": "Order of sorted results, default is 'DESCENDING'.",
 
1104
         "default": "DESCENDING",
 
1105
         "enum": [
 
1106
          "ASCENDING",
 
1107
          "DESCENDING"
 
1108
         ],
 
1109
         "enumDescriptions": [
 
1110
          "Ascending order.",
 
1111
          "Descending order."
 
1112
         ],
 
1113
         "location": "query"
 
1114
        }
 
1115
       },
 
1116
       "parameterOrder": [
 
1117
        "profileId",
 
1118
        "reportId"
 
1119
       ],
 
1120
       "response": {
 
1121
        "$ref": "FileList"
 
1122
       },
 
1123
       "scopes": [
 
1124
        "https://www.googleapis.com/auth/dfareporting"
 
1125
       ]
 
1126
      }
 
1127
     }
 
1128
    }
 
1129
   }
 
1130
  },
 
1131
  "userProfiles": {
 
1132
   "methods": {
 
1133
    "get": {
 
1134
     "id": "dfareporting.userProfiles.get",
 
1135
     "path": "userprofiles/{profileId}",
 
1136
     "httpMethod": "GET",
 
1137
     "description": "Gets one user profile by id.",
 
1138
     "parameters": {
 
1139
      "profileId": {
 
1140
       "type": "string",
 
1141
       "description": "The user profile id.",
 
1142
       "required": true,
 
1143
       "format": "int64",
 
1144
       "location": "path"
 
1145
      }
 
1146
     },
 
1147
     "parameterOrder": [
 
1148
      "profileId"
 
1149
     ],
 
1150
     "response": {
 
1151
      "$ref": "UserProfile"
 
1152
     },
 
1153
     "scopes": [
 
1154
      "https://www.googleapis.com/auth/dfareporting"
 
1155
     ]
 
1156
    },
 
1157
    "list": {
 
1158
     "id": "dfareporting.userProfiles.list",
 
1159
     "path": "userprofiles",
 
1160
     "httpMethod": "GET",
 
1161
     "description": "Retrieves list of user profiles for a user.",
 
1162
     "response": {
 
1163
      "$ref": "UserProfileList"
 
1164
     },
 
1165
     "scopes": [
 
1166
      "https://www.googleapis.com/auth/dfareporting"
 
1167
     ]
 
1168
    }
 
1169
   }
 
1170
  }
 
1171
 }
 
1172
}