[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\Order;
|
---|
| 21 | use Google\Service\Dfareporting\OrdersListResponse;
|
---|
| 22 |
|
---|
| 23 | /**
|
---|
| 24 | * The "orders" collection of methods.
|
---|
| 25 | * Typical usage is:
|
---|
| 26 | * <code>
|
---|
| 27 | * $dfareportingService = new Google\Service\Dfareporting(...);
|
---|
| 28 | * $orders = $dfareportingService->orders;
|
---|
| 29 | * </code>
|
---|
| 30 | */
|
---|
| 31 | class Orders extends \Google\Service\Resource
|
---|
| 32 | {
|
---|
| 33 | /**
|
---|
| 34 | * Gets one order by ID. (orders.get)
|
---|
| 35 | *
|
---|
| 36 | * @param string $profileId User profile ID associated with this request.
|
---|
| 37 | * @param string $projectId Project ID for orders.
|
---|
| 38 | * @param string $id Order ID.
|
---|
| 39 | * @param array $optParams Optional parameters.
|
---|
| 40 | * @return Order
|
---|
| 41 | * @throws \Google\Service\Exception
|
---|
| 42 | */
|
---|
| 43 | public function get($profileId, $projectId, $id, $optParams = [])
|
---|
| 44 | {
|
---|
| 45 | $params = ['profileId' => $profileId, 'projectId' => $projectId, 'id' => $id];
|
---|
| 46 | $params = array_merge($params, $optParams);
|
---|
| 47 | return $this->call('get', [$params], Order::class);
|
---|
| 48 | }
|
---|
| 49 | /**
|
---|
| 50 | * Retrieves a list of orders, possibly filtered. This method supports paging.
|
---|
| 51 | * (orders.listOrders)
|
---|
| 52 | *
|
---|
| 53 | * @param string $profileId User profile ID associated with this request.
|
---|
| 54 | * @param string $projectId Project ID for orders.
|
---|
| 55 | * @param array $optParams Optional parameters.
|
---|
| 56 | *
|
---|
| 57 | * @opt_param string ids Select only orders with these IDs.
|
---|
| 58 | * @opt_param int maxResults Maximum number of results to return.
|
---|
| 59 | * @opt_param string pageToken Value of the nextPageToken from the previous
|
---|
| 60 | * result page.
|
---|
| 61 | * @opt_param string searchString Allows searching for orders by name or ID.
|
---|
| 62 | * Wildcards (*) are allowed. For example, "order*2015" will return orders with
|
---|
| 63 | * names like "order June 2015", "order April 2015", or simply "order 2015".
|
---|
| 64 | * Most of the searches also add wildcards implicitly at the start and the end
|
---|
| 65 | * of the search string. For example, a search string of "order" will match
|
---|
| 66 | * orders with name "my order", "order 2015", or simply "order".
|
---|
| 67 | * @opt_param string siteId Select only orders that are associated with these
|
---|
| 68 | * site IDs.
|
---|
| 69 | * @opt_param string sortField Field by which to sort the list.
|
---|
| 70 | * @opt_param string sortOrder Order of sorted results.
|
---|
| 71 | * @return OrdersListResponse
|
---|
| 72 | * @throws \Google\Service\Exception
|
---|
| 73 | */
|
---|
| 74 | public function listOrders($profileId, $projectId, $optParams = [])
|
---|
| 75 | {
|
---|
| 76 | $params = ['profileId' => $profileId, 'projectId' => $projectId];
|
---|
| 77 | $params = array_merge($params, $optParams);
|
---|
| 78 | return $this->call('list', [$params], OrdersListResponse::class);
|
---|
| 79 | }
|
---|
| 80 | }
|
---|
| 81 |
|
---|
| 82 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
| 83 | class_alias(Orders::class, 'Google_Service_Dfareporting_Resource_Orders');
|
---|