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\Doubleclicksearch\Resource;
|
---|
19 |
|
---|
20 | use Google\Service\Doubleclicksearch\ConversionList;
|
---|
21 | use Google\Service\Doubleclicksearch\UpdateAvailabilityRequest;
|
---|
22 | use Google\Service\Doubleclicksearch\UpdateAvailabilityResponse;
|
---|
23 |
|
---|
24 | /**
|
---|
25 | * The "conversion" collection of methods.
|
---|
26 | * Typical usage is:
|
---|
27 | * <code>
|
---|
28 | * $doubleclicksearchService = new Google\Service\Doubleclicksearch(...);
|
---|
29 | * $conversion = $doubleclicksearchService->conversion;
|
---|
30 | * </code>
|
---|
31 | */
|
---|
32 | class Conversion extends \Google\Service\Resource
|
---|
33 | {
|
---|
34 | /**
|
---|
35 | * Retrieves a list of conversions from a DoubleClick Search engine account.
|
---|
36 | * (conversion.get)
|
---|
37 | *
|
---|
38 | * @param string $agencyId Numeric ID of the agency.
|
---|
39 | * @param string $advertiserId Numeric ID of the advertiser.
|
---|
40 | * @param string $engineAccountId Numeric ID of the engine account.
|
---|
41 | * @param int $endDate Last date (inclusive) on which to retrieve conversions.
|
---|
42 | * Format is yyyymmdd.
|
---|
43 | * @param int $rowCount The number of conversions to return per call.
|
---|
44 | * @param int $startDate First date (inclusive) on which to retrieve
|
---|
45 | * conversions. Format is yyyymmdd.
|
---|
46 | * @param string $startRow The 0-based starting index for retrieving conversions
|
---|
47 | * results.
|
---|
48 | * @param array $optParams Optional parameters.
|
---|
49 | *
|
---|
50 | * @opt_param string adGroupId Numeric ID of the ad group.
|
---|
51 | * @opt_param string adId Numeric ID of the ad.
|
---|
52 | * @opt_param string campaignId Numeric ID of the campaign.
|
---|
53 | * @opt_param string criterionId Numeric ID of the criterion.
|
---|
54 | * @opt_param string customerId Customer ID of a client account in the new
|
---|
55 | * Search Ads 360 experience.
|
---|
56 | * @return ConversionList
|
---|
57 | * @throws \Google\Service\Exception
|
---|
58 | */
|
---|
59 | public function get($agencyId, $advertiserId, $engineAccountId, $endDate, $rowCount, $startDate, $startRow, $optParams = [])
|
---|
60 | {
|
---|
61 | $params = ['agencyId' => $agencyId, 'advertiserId' => $advertiserId, 'engineAccountId' => $engineAccountId, 'endDate' => $endDate, 'rowCount' => $rowCount, 'startDate' => $startDate, 'startRow' => $startRow];
|
---|
62 | $params = array_merge($params, $optParams);
|
---|
63 | return $this->call('get', [$params], ConversionList::class);
|
---|
64 | }
|
---|
65 | /**
|
---|
66 | * Retrieves a list of conversions from a DoubleClick Search engine account.
|
---|
67 | * (conversion.getByCustomerId)
|
---|
68 | *
|
---|
69 | * @param string $customerId Customer ID of a client account in the new Search
|
---|
70 | * Ads 360 experience.
|
---|
71 | * @param int $endDate Last date (inclusive) on which to retrieve conversions.
|
---|
72 | * Format is yyyymmdd.
|
---|
73 | * @param int $rowCount The number of conversions to return per call.
|
---|
74 | * @param int $startDate First date (inclusive) on which to retrieve
|
---|
75 | * conversions. Format is yyyymmdd.
|
---|
76 | * @param string $startRow The 0-based starting index for retrieving conversions
|
---|
77 | * results.
|
---|
78 | * @param array $optParams Optional parameters.
|
---|
79 | *
|
---|
80 | * @opt_param string adGroupId Numeric ID of the ad group.
|
---|
81 | * @opt_param string adId Numeric ID of the ad.
|
---|
82 | * @opt_param string advertiserId Numeric ID of the advertiser.
|
---|
83 | * @opt_param string agencyId Numeric ID of the agency.
|
---|
84 | * @opt_param string campaignId Numeric ID of the campaign.
|
---|
85 | * @opt_param string criterionId Numeric ID of the criterion.
|
---|
86 | * @opt_param string engineAccountId Numeric ID of the engine account.
|
---|
87 | * @return ConversionList
|
---|
88 | * @throws \Google\Service\Exception
|
---|
89 | */
|
---|
90 | public function getByCustomerId($customerId, $endDate, $rowCount, $startDate, $startRow, $optParams = [])
|
---|
91 | {
|
---|
92 | $params = ['customerId' => $customerId, 'endDate' => $endDate, 'rowCount' => $rowCount, 'startDate' => $startDate, 'startRow' => $startRow];
|
---|
93 | $params = array_merge($params, $optParams);
|
---|
94 | return $this->call('getByCustomerId', [$params], ConversionList::class);
|
---|
95 | }
|
---|
96 | /**
|
---|
97 | * Inserts a batch of new conversions into DoubleClick Search.
|
---|
98 | * (conversion.insert)
|
---|
99 | *
|
---|
100 | * @param ConversionList $postBody
|
---|
101 | * @param array $optParams Optional parameters.
|
---|
102 | * @return ConversionList
|
---|
103 | * @throws \Google\Service\Exception
|
---|
104 | */
|
---|
105 | public function insert(ConversionList $postBody, $optParams = [])
|
---|
106 | {
|
---|
107 | $params = ['postBody' => $postBody];
|
---|
108 | $params = array_merge($params, $optParams);
|
---|
109 | return $this->call('insert', [$params], ConversionList::class);
|
---|
110 | }
|
---|
111 | /**
|
---|
112 | * Updates a batch of conversions in DoubleClick Search. (conversion.update)
|
---|
113 | *
|
---|
114 | * @param ConversionList $postBody
|
---|
115 | * @param array $optParams Optional parameters.
|
---|
116 | * @return ConversionList
|
---|
117 | * @throws \Google\Service\Exception
|
---|
118 | */
|
---|
119 | public function update(ConversionList $postBody, $optParams = [])
|
---|
120 | {
|
---|
121 | $params = ['postBody' => $postBody];
|
---|
122 | $params = array_merge($params, $optParams);
|
---|
123 | return $this->call('update', [$params], ConversionList::class);
|
---|
124 | }
|
---|
125 | /**
|
---|
126 | * Updates the availabilities of a batch of floodlight activities in DoubleClick
|
---|
127 | * Search. (conversion.updateAvailability)
|
---|
128 | *
|
---|
129 | * @param UpdateAvailabilityRequest $postBody
|
---|
130 | * @param array $optParams Optional parameters.
|
---|
131 | * @return UpdateAvailabilityResponse
|
---|
132 | * @throws \Google\Service\Exception
|
---|
133 | */
|
---|
134 | public function updateAvailability(UpdateAvailabilityRequest $postBody, $optParams = [])
|
---|
135 | {
|
---|
136 | $params = ['postBody' => $postBody];
|
---|
137 | $params = array_merge($params, $optParams);
|
---|
138 | return $this->call('updateAvailability', [$params], UpdateAvailabilityResponse::class);
|
---|
139 | }
|
---|
140 | }
|
---|
141 |
|
---|
142 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
143 | class_alias(Conversion::class, 'Google_Service_Doubleclicksearch_Resource_Conversion');
|
---|