[e3d4e0a] | 1 | <?php
|
---|
| 2 | /*
|
---|
| 3 | * Copyright 2014 Google Inc.
|
---|
| 4 | *
|
---|
| 5 | * Licensed under the Apache License, Version 2.0 (the "License"); you may not
|
---|
| 6 | * use this file except in compliance with the License. You may obtain a copy of
|
---|
| 7 | * the License at
|
---|
| 8 | *
|
---|
| 9 | * http://www.apache.org/licenses/LICENSE-2.0
|
---|
| 10 | *
|
---|
| 11 | * Unless required by applicable law or agreed to in writing, software
|
---|
| 12 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
---|
| 13 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
---|
| 14 | * License for the specific language governing permissions and limitations under
|
---|
| 15 | * the License.
|
---|
| 16 | */
|
---|
| 17 |
|
---|
| 18 | namespace Google\Service\Dfareporting\Resource;
|
---|
| 19 |
|
---|
| 20 | use Google\Service\Dfareporting\DfareportingFile;
|
---|
| 21 | use Google\Service\Dfareporting\FileList;
|
---|
| 22 |
|
---|
| 23 | /**
|
---|
| 24 | * The "files" collection of methods.
|
---|
| 25 | * Typical usage is:
|
---|
| 26 | * <code>
|
---|
| 27 | * $dfareportingService = new Google\Service\Dfareporting(...);
|
---|
| 28 | * $files = $dfareportingService->files;
|
---|
| 29 | * </code>
|
---|
| 30 | */
|
---|
| 31 | class Files extends \Google\Service\Resource
|
---|
| 32 | {
|
---|
| 33 | /**
|
---|
| 34 | * Retrieves a report file by its report ID and file ID. This method supports
|
---|
| 35 | * media download. (files.get)
|
---|
| 36 | *
|
---|
| 37 | * @param string $reportId The ID of the report.
|
---|
| 38 | * @param string $fileId The ID of the report file.
|
---|
| 39 | * @param array $optParams Optional parameters.
|
---|
| 40 | * @return DfareportingFile
|
---|
| 41 | * @throws \Google\Service\Exception
|
---|
| 42 | */
|
---|
| 43 | public function get($reportId, $fileId, $optParams = [])
|
---|
| 44 | {
|
---|
| 45 | $params = ['reportId' => $reportId, 'fileId' => $fileId];
|
---|
| 46 | $params = array_merge($params, $optParams);
|
---|
| 47 | return $this->call('get', [$params], DfareportingFile::class);
|
---|
| 48 | }
|
---|
| 49 | /**
|
---|
| 50 | * Lists files for a user profile. (files.listFiles)
|
---|
| 51 | *
|
---|
| 52 | * @param string $profileId The Campaign Manager 360 user profile ID.
|
---|
| 53 | * @param array $optParams Optional parameters.
|
---|
| 54 | *
|
---|
| 55 | * @opt_param int maxResults Maximum number of results to return.
|
---|
| 56 | * @opt_param string pageToken The value of the nextToken from the previous
|
---|
| 57 | * result page.
|
---|
| 58 | * @opt_param string scope The scope that defines which results are returned.
|
---|
| 59 | * @opt_param string sortField The field by which to sort the list.
|
---|
| 60 | * @opt_param string sortOrder Order of sorted results.
|
---|
| 61 | * @return FileList
|
---|
| 62 | * @throws \Google\Service\Exception
|
---|
| 63 | */
|
---|
| 64 | public function listFiles($profileId, $optParams = [])
|
---|
| 65 | {
|
---|
| 66 | $params = ['profileId' => $profileId];
|
---|
| 67 | $params = array_merge($params, $optParams);
|
---|
| 68 | return $this->call('list', [$params], FileList::class);
|
---|
| 69 | }
|
---|
| 70 | }
|
---|
| 71 |
|
---|
| 72 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
| 73 | class_alias(Files::class, 'Google_Service_Dfareporting_Resource_Files');
|
---|