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/**
19 * Service definition for AdExchangeSeller (v2.0).
20 *
21 * <p>
22 * Accesses the inventory of Ad Exchange seller users and generates reports.</p>
23 *
24 * <p>
25 * For more information about this service, see the API
26 * <a href="https://developers.google.com/ad-exchange/seller-rest/" target="_blank">Documentation</a>
27 * </p>
28 *
29 * @author Google, Inc.
30 */
31class Google_Service_AdExchangeSeller extends Google_Service
32{
33  /** View and manage your Ad Exchange data. */
34  const ADEXCHANGE_SELLER =
35      "https://www.googleapis.com/auth/adexchange.seller";
36  /** View your Ad Exchange data. */
37  const ADEXCHANGE_SELLER_READONLY =
38      "https://www.googleapis.com/auth/adexchange.seller.readonly";
39
40  public $accounts;
41  public $accounts_adclients;
42  public $accounts_alerts;
43  public $accounts_customchannels;
44  public $accounts_metadata_dimensions;
45  public $accounts_metadata_metrics;
46  public $accounts_preferreddeals;
47  public $accounts_reports;
48  public $accounts_reports_saved;
49  public $accounts_urlchannels;
50
51  /**
52   * Constructs the internal representation of the AdExchangeSeller service.
53   *
54   * @param Google_Client $client
55   */
56  public function __construct(Google_Client $client)
57  {
58    parent::__construct($client);
59    $this->rootUrl = 'https://www.googleapis.com/';
60    $this->servicePath = 'adexchangeseller/v2.0/';
61    $this->version = 'v2.0';
62    $this->serviceName = 'adexchangeseller';
63
64    $this->accounts = new Google_Service_AdExchangeSeller_Resource_Accounts(
65        $this,
66        $this->serviceName,
67        'accounts',
68        array(
69          'methods' => array(
70            'get' => array(
71              'path' => 'accounts/{accountId}',
72              'httpMethod' => 'GET',
73              'parameters' => array(
74                'accountId' => array(
75                  'location' => 'path',
76                  'type' => 'string',
77                  'required' => true,
78                ),
79              ),
80            ),'list' => array(
81              'path' => 'accounts',
82              'httpMethod' => 'GET',
83              'parameters' => array(
84                'maxResults' => array(
85                  'location' => 'query',
86                  'type' => 'integer',
87                ),
88                'pageToken' => array(
89                  'location' => 'query',
90                  'type' => 'string',
91                ),
92              ),
93            ),
94          )
95        )
96    );
97    $this->accounts_adclients = new Google_Service_AdExchangeSeller_Resource_AccountsAdclients(
98        $this,
99        $this->serviceName,
100        'adclients',
101        array(
102          'methods' => array(
103            'list' => array(
104              'path' => 'accounts/{accountId}/adclients',
105              'httpMethod' => 'GET',
106              'parameters' => array(
107                'accountId' => array(
108                  'location' => 'path',
109                  'type' => 'string',
110                  'required' => true,
111                ),
112                'maxResults' => array(
113                  'location' => 'query',
114                  'type' => 'integer',
115                ),
116                'pageToken' => array(
117                  'location' => 'query',
118                  'type' => 'string',
119                ),
120              ),
121            ),
122          )
123        )
124    );
125    $this->accounts_alerts = new Google_Service_AdExchangeSeller_Resource_AccountsAlerts(
126        $this,
127        $this->serviceName,
128        'alerts',
129        array(
130          'methods' => array(
131            'list' => array(
132              'path' => 'accounts/{accountId}/alerts',
133              'httpMethod' => 'GET',
134              'parameters' => array(
135                'accountId' => array(
136                  'location' => 'path',
137                  'type' => 'string',
138                  'required' => true,
139                ),
140                'locale' => array(
141                  'location' => 'query',
142                  'type' => 'string',
143                ),
144              ),
145            ),
146          )
147        )
148    );
149    $this->accounts_customchannels = new Google_Service_AdExchangeSeller_Resource_AccountsCustomchannels(
150        $this,
151        $this->serviceName,
152        'customchannels',
153        array(
154          'methods' => array(
155            'get' => array(
156              'path' => 'accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}',
157              'httpMethod' => 'GET',
158              'parameters' => array(
159                'accountId' => array(
160                  'location' => 'path',
161                  'type' => 'string',
162                  'required' => true,
163                ),
164                'adClientId' => array(
165                  'location' => 'path',
166                  'type' => 'string',
167                  'required' => true,
168                ),
169                'customChannelId' => array(
170                  'location' => 'path',
171                  'type' => 'string',
172                  'required' => true,
173                ),
174              ),
175            ),'list' => array(
176              'path' => 'accounts/{accountId}/adclients/{adClientId}/customchannels',
177              'httpMethod' => 'GET',
178              'parameters' => array(
179                'accountId' => array(
180                  'location' => 'path',
181                  'type' => 'string',
182                  'required' => true,
183                ),
184                'adClientId' => array(
185                  'location' => 'path',
186                  'type' => 'string',
187                  'required' => true,
188                ),
189                'maxResults' => array(
190                  'location' => 'query',
191                  'type' => 'integer',
192                ),
193                'pageToken' => array(
194                  'location' => 'query',
195                  'type' => 'string',
196                ),
197              ),
198            ),
199          )
200        )
201    );
202    $this->accounts_metadata_dimensions = new Google_Service_AdExchangeSeller_Resource_AccountsMetadataDimensions(
203        $this,
204        $this->serviceName,
205        'dimensions',
206        array(
207          'methods' => array(
208            'list' => array(
209              'path' => 'accounts/{accountId}/metadata/dimensions',
210              'httpMethod' => 'GET',
211              'parameters' => array(
212                'accountId' => array(
213                  'location' => 'path',
214                  'type' => 'string',
215                  'required' => true,
216                ),
217              ),
218            ),
219          )
220        )
221    );
222    $this->accounts_metadata_metrics = new Google_Service_AdExchangeSeller_Resource_AccountsMetadataMetrics(
223        $this,
224        $this->serviceName,
225        'metrics',
226        array(
227          'methods' => array(
228            'list' => array(
229              'path' => 'accounts/{accountId}/metadata/metrics',
230              'httpMethod' => 'GET',
231              'parameters' => array(
232                'accountId' => array(
233                  'location' => 'path',
234                  'type' => 'string',
235                  'required' => true,
236                ),
237              ),
238            ),
239          )
240        )
241    );
242    $this->accounts_preferreddeals = new Google_Service_AdExchangeSeller_Resource_AccountsPreferreddeals(
243        $this,
244        $this->serviceName,
245        'preferreddeals',
246        array(
247          'methods' => array(
248            'get' => array(
249              'path' => 'accounts/{accountId}/preferreddeals/{dealId}',
250              'httpMethod' => 'GET',
251              'parameters' => array(
252                'accountId' => array(
253                  'location' => 'path',
254                  'type' => 'string',
255                  'required' => true,
256                ),
257                'dealId' => array(
258                  'location' => 'path',
259                  'type' => 'string',
260                  'required' => true,
261                ),
262              ),
263            ),'list' => array(
264              'path' => 'accounts/{accountId}/preferreddeals',
265              'httpMethod' => 'GET',
266              'parameters' => array(
267                'accountId' => array(
268                  'location' => 'path',
269                  'type' => 'string',
270                  'required' => true,
271                ),
272              ),
273            ),
274          )
275        )
276    );
277    $this->accounts_reports = new Google_Service_AdExchangeSeller_Resource_AccountsReports(
278        $this,
279        $this->serviceName,
280        'reports',
281        array(
282          'methods' => array(
283            'generate' => array(
284              'path' => 'accounts/{accountId}/reports',
285              'httpMethod' => 'GET',
286              'parameters' => array(
287                'accountId' => array(
288                  'location' => 'path',
289                  'type' => 'string',
290                  'required' => true,
291                ),
292                'startDate' => array(
293                  'location' => 'query',
294                  'type' => 'string',
295                  'required' => true,
296                ),
297                'endDate' => array(
298                  'location' => 'query',
299                  'type' => 'string',
300                  'required' => true,
301                ),
302                'dimension' => array(
303                  'location' => 'query',
304                  'type' => 'string',
305                  'repeated' => true,
306                ),
307                'filter' => array(
308                  'location' => 'query',
309                  'type' => 'string',
310                  'repeated' => true,
311                ),
312                'locale' => array(
313                  'location' => 'query',
314                  'type' => 'string',
315                ),
316                'maxResults' => array(
317                  'location' => 'query',
318                  'type' => 'integer',
319                ),
320                'metric' => array(
321                  'location' => 'query',
322                  'type' => 'string',
323                  'repeated' => true,
324                ),
325                'sort' => array(
326                  'location' => 'query',
327                  'type' => 'string',
328                  'repeated' => true,
329                ),
330                'startIndex' => array(
331                  'location' => 'query',
332                  'type' => 'integer',
333                ),
334              ),
335            ),
336          )
337        )
338    );
339    $this->accounts_reports_saved = new Google_Service_AdExchangeSeller_Resource_AccountsReportsSaved(
340        $this,
341        $this->serviceName,
342        'saved',
343        array(
344          'methods' => array(
345            'generate' => array(
346              'path' => 'accounts/{accountId}/reports/{savedReportId}',
347              'httpMethod' => 'GET',
348              'parameters' => array(
349                'accountId' => array(
350                  'location' => 'path',
351                  'type' => 'string',
352                  'required' => true,
353                ),
354                'savedReportId' => array(
355                  'location' => 'path',
356                  'type' => 'string',
357                  'required' => true,
358                ),
359                'locale' => array(
360                  'location' => 'query',
361                  'type' => 'string',
362                ),
363                'maxResults' => array(
364                  'location' => 'query',
365                  'type' => 'integer',
366                ),
367                'startIndex' => array(
368                  'location' => 'query',
369                  'type' => 'integer',
370                ),
371              ),
372            ),'list' => array(
373              'path' => 'accounts/{accountId}/reports/saved',
374              'httpMethod' => 'GET',
375              'parameters' => array(
376                'accountId' => array(
377                  'location' => 'path',
378                  'type' => 'string',
379                  'required' => true,
380                ),
381                'maxResults' => array(
382                  'location' => 'query',
383                  'type' => 'integer',
384                ),
385                'pageToken' => array(
386                  'location' => 'query',
387                  'type' => 'string',
388                ),
389              ),
390            ),
391          )
392        )
393    );
394    $this->accounts_urlchannels = new Google_Service_AdExchangeSeller_Resource_AccountsUrlchannels(
395        $this,
396        $this->serviceName,
397        'urlchannels',
398        array(
399          'methods' => array(
400            'list' => array(
401              'path' => 'accounts/{accountId}/adclients/{adClientId}/urlchannels',
402              'httpMethod' => 'GET',
403              'parameters' => array(
404                'accountId' => array(
405                  'location' => 'path',
406                  'type' => 'string',
407                  'required' => true,
408                ),
409                'adClientId' => array(
410                  'location' => 'path',
411                  'type' => 'string',
412                  'required' => true,
413                ),
414                'maxResults' => array(
415                  'location' => 'query',
416                  'type' => 'integer',
417                ),
418                'pageToken' => array(
419                  'location' => 'query',
420                  'type' => 'string',
421                ),
422              ),
423            ),
424          )
425        )
426    );
427  }
428}
429