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\Dfareporting\Resource;
19
20use Google\Service\Dfareporting\CampaignCreativeAssociation;
21use Google\Service\Dfareporting\CampaignCreativeAssociationsListResponse;
22
23/**
24 * The "campaignCreativeAssociations" collection of methods.
25 * Typical usage is:
26 *  <code>
27 *   $dfareportingService = new Google\Service\Dfareporting(...);
28 *   $campaignCreativeAssociations = $dfareportingService->campaignCreativeAssociations;
29 *  </code>
30 */
31class CampaignCreativeAssociations extends \Google\Service\Resource
32{
33  /**
34   * Associates a creative with the specified campaign. This method creates a
35   * default ad with dimensions matching the creative in the campaign if such a
36   * default ad does not exist already. (campaignCreativeAssociations.insert)
37   *
38   * @param string $profileId User profile ID associated with this request.
39   * @param string $campaignId Campaign ID in this association.
40   * @param CampaignCreativeAssociation $postBody
41   * @param array $optParams Optional parameters.
42   * @return CampaignCreativeAssociation
43   */
44  public function insert($profileId, $campaignId, CampaignCreativeAssociation $postBody, $optParams = [])
45  {
46    $params = ['profileId' => $profileId, 'campaignId' => $campaignId, 'postBody' => $postBody];
47    $params = array_merge($params, $optParams);
48    return $this->call('insert', [$params], CampaignCreativeAssociation::class);
49  }
50  /**
51   * Retrieves the list of creative IDs associated with the specified campaign.
52   * This method supports paging.
53   * (campaignCreativeAssociations.listCampaignCreativeAssociations)
54   *
55   * @param string $profileId User profile ID associated with this request.
56   * @param string $campaignId Campaign ID in this association.
57   * @param array $optParams Optional parameters.
58   *
59   * @opt_param int maxResults Maximum number of results to return.
60   * @opt_param string pageToken Value of the nextPageToken from the previous
61   * result page.
62   * @opt_param string sortOrder Order of sorted results.
63   * @return CampaignCreativeAssociationsListResponse
64   */
65  public function listCampaignCreativeAssociations($profileId, $campaignId, $optParams = [])
66  {
67    $params = ['profileId' => $profileId, 'campaignId' => $campaignId];
68    $params = array_merge($params, $optParams);
69    return $this->call('list', [$params], CampaignCreativeAssociationsListResponse::class);
70  }
71}
72
73// Adding a class alias for backwards compatibility with the previous class name.
74class_alias(CampaignCreativeAssociations::class, 'Google_Service_Dfareporting_Resource_CampaignCreativeAssociations');
75