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
18namespace Google\Service\GoogleAnalyticsAdmin\Resource;
19
20use Google\Service\GoogleAnalyticsAdmin\GoogleAnalyticsAdminV1alphaApproveDisplayVideo360AdvertiserLinkProposalRequest;
21use Google\Service\GoogleAnalyticsAdmin\GoogleAnalyticsAdminV1alphaApproveDisplayVideo360AdvertiserLinkProposalResponse;
22use Google\Service\GoogleAnalyticsAdmin\GoogleAnalyticsAdminV1alphaCancelDisplayVideo360AdvertiserLinkProposalRequest;
23use Google\Service\GoogleAnalyticsAdmin\GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal;
24use Google\Service\GoogleAnalyticsAdmin\GoogleAnalyticsAdminV1alphaListDisplayVideo360AdvertiserLinkProposalsResponse;
25use Google\Service\GoogleAnalyticsAdmin\GoogleProtobufEmpty;
26
27/**
28 * The "displayVideo360AdvertiserLinkProposals" collection of methods.
29 * Typical usage is:
30 *  <code>
31 *   $analyticsadminService = new Google\Service\GoogleAnalyticsAdmin(...);
32 *   $displayVideo360AdvertiserLinkProposals = $analyticsadminService->displayVideo360AdvertiserLinkProposals;
33 *  </code>
34 */
35class PropertiesDisplayVideo360AdvertiserLinkProposals extends \Google\Service\Resource
36{
37  /**
38   * Approves a DisplayVideo360AdvertiserLinkProposal. The
39   * DisplayVideo360AdvertiserLinkProposal will be deleted and a new
40   * DisplayVideo360AdvertiserLink will be created.
41   * (displayVideo360AdvertiserLinkProposals.approve)
42   *
43   * @param string $name Required. The name of the
44   * DisplayVideo360AdvertiserLinkProposal to approve. Example format:
45   * properties/1234/displayVideo360AdvertiserLinkProposals/5678
46   * @param GoogleAnalyticsAdminV1alphaApproveDisplayVideo360AdvertiserLinkProposalRequest $postBody
47   * @param array $optParams Optional parameters.
48   * @return GoogleAnalyticsAdminV1alphaApproveDisplayVideo360AdvertiserLinkProposalResponse
49   */
50  public function approve($name, GoogleAnalyticsAdminV1alphaApproveDisplayVideo360AdvertiserLinkProposalRequest $postBody, $optParams = [])
51  {
52    $params = ['name' => $name, 'postBody' => $postBody];
53    $params = array_merge($params, $optParams);
54    return $this->call('approve', [$params], GoogleAnalyticsAdminV1alphaApproveDisplayVideo360AdvertiserLinkProposalResponse::class);
55  }
56  /**
57   * Cancels a DisplayVideo360AdvertiserLinkProposal. Cancelling can mean either:
58   * - Declining a proposal initiated from Display & Video 360 - Withdrawing a
59   * proposal initiated from Google Analytics After being cancelled, a proposal
60   * will eventually be deleted automatically.
61   * (displayVideo360AdvertiserLinkProposals.cancel)
62   *
63   * @param string $name Required. The name of the
64   * DisplayVideo360AdvertiserLinkProposal to cancel. Example format:
65   * properties/1234/displayVideo360AdvertiserLinkProposals/5678
66   * @param GoogleAnalyticsAdminV1alphaCancelDisplayVideo360AdvertiserLinkProposalRequest $postBody
67   * @param array $optParams Optional parameters.
68   * @return GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal
69   */
70  public function cancel($name, GoogleAnalyticsAdminV1alphaCancelDisplayVideo360AdvertiserLinkProposalRequest $postBody, $optParams = [])
71  {
72    $params = ['name' => $name, 'postBody' => $postBody];
73    $params = array_merge($params, $optParams);
74    return $this->call('cancel', [$params], GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal::class);
75  }
76  /**
77   * Creates a DisplayVideo360AdvertiserLinkProposal.
78   * (displayVideo360AdvertiserLinkProposals.create)
79   *
80   * @param string $parent Required. Example format: properties/1234
81   * @param GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal $postBody
82   * @param array $optParams Optional parameters.
83   * @return GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal
84   */
85  public function create($parent, GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal $postBody, $optParams = [])
86  {
87    $params = ['parent' => $parent, 'postBody' => $postBody];
88    $params = array_merge($params, $optParams);
89    return $this->call('create', [$params], GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal::class);
90  }
91  /**
92   * Deletes a DisplayVideo360AdvertiserLinkProposal on a property. This can only
93   * be used on cancelled proposals.
94   * (displayVideo360AdvertiserLinkProposals.delete)
95   *
96   * @param string $name Required. The name of the
97   * DisplayVideo360AdvertiserLinkProposal to delete. Example format:
98   * properties/1234/displayVideo360AdvertiserLinkProposals/5678
99   * @param array $optParams Optional parameters.
100   * @return GoogleProtobufEmpty
101   */
102  public function delete($name, $optParams = [])
103  {
104    $params = ['name' => $name];
105    $params = array_merge($params, $optParams);
106    return $this->call('delete', [$params], GoogleProtobufEmpty::class);
107  }
108  /**
109   * Lookup for a single DisplayVideo360AdvertiserLinkProposal.
110   * (displayVideo360AdvertiserLinkProposals.get)
111   *
112   * @param string $name Required. The name of the
113   * DisplayVideo360AdvertiserLinkProposal to get. Example format:
114   * properties/1234/displayVideo360AdvertiserLinkProposals/5678
115   * @param array $optParams Optional parameters.
116   * @return GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal
117   */
118  public function get($name, $optParams = [])
119  {
120    $params = ['name' => $name];
121    $params = array_merge($params, $optParams);
122    return $this->call('get', [$params], GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal::class);
123  }
124  /**
125   * Lists DisplayVideo360AdvertiserLinkProposals on a property. (displayVideo360A
126   * dvertiserLinkProposals.listPropertiesDisplayVideo360AdvertiserLinkProposals)
127   *
128   * @param string $parent Required. Example format: properties/1234
129   * @param array $optParams Optional parameters.
130   *
131   * @opt_param int pageSize The maximum number of resources to return. If
132   * unspecified, at most 50 resources will be returned. The maximum value is 200
133   * (higher values will be coerced to the maximum).
134   * @opt_param string pageToken A page token, received from a previous
135   * `ListDisplayVideo360AdvertiserLinkProposals` call. Provide this to retrieve
136   * the subsequent page. When paginating, all other parameters provided to
137   * `ListDisplayVideo360AdvertiserLinkProposals` must match the call that
138   * provided the page token.
139   * @return GoogleAnalyticsAdminV1alphaListDisplayVideo360AdvertiserLinkProposalsResponse
140   */
141  public function listPropertiesDisplayVideo360AdvertiserLinkProposals($parent, $optParams = [])
142  {
143    $params = ['parent' => $parent];
144    $params = array_merge($params, $optParams);
145    return $this->call('list', [$params], GoogleAnalyticsAdminV1alphaListDisplayVideo360AdvertiserLinkProposalsResponse::class);
146  }
147}
148
149// Adding a class alias for backwards compatibility with the previous class name.
150class_alias(PropertiesDisplayVideo360AdvertiserLinkProposals::class, 'Google_Service_GoogleAnalyticsAdmin_Resource_PropertiesDisplayVideo360AdvertiserLinkProposals');
151