📂 File Browser

📁 Directories

📄 Files

📄 Source: CampaignCreativeAssociations.php

<?php
/*
 * Copyright 2014 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

namespace Google\Service\Dfareporting\Resource;

use Google\Service\Dfareporting\CampaignCreativeAssociation;
use Google\Service\Dfareporting\CampaignCreativeAssociationsListResponse;

/**
 * The "campaignCreativeAssociations" collection of methods.
 * Typical usage is:
 *  <code>
 *   $dfareportingService = new Google\Service\Dfareporting(...);
 *   $campaignCreativeAssociations = $dfareportingService->campaignCreativeAssociations;
 *  </code>
 */
class CampaignCreativeAssociations extends \Google\Service\Resource
{
  /**
   * Associates a creative with the specified campaign. This method creates a
   * default ad with dimensions matching the creative in the campaign if such a
   * default ad does not exist already. (campaignCreativeAssociations.insert)
   *
   * @param string $profileId User profile ID associated with this request.
   * @param string $campaignId Campaign ID in this association.
   * @param CampaignCreativeAssociation $postBody
   * @param array $optParams Optional parameters.
   * @return CampaignCreativeAssociation
   * @throws \Google\Service\Exception
   */
  public function insert($profileId, $campaignId, CampaignCreativeAssociation $postBody, $optParams = [])
  {
    $params = ['profileId' => $profileId, 'campaignId' => $campaignId, 'postBody' => $postBody];
    $params = array_merge($params, $optParams);
    return $this->call('insert', [$params], CampaignCreativeAssociation::class);
  }
  /**
   * Retrieves the list of creative IDs associated with the specified campaign.
   * This method supports paging.
   * (campaignCreativeAssociations.listCampaignCreativeAssociations)
   *
   * @param string $profileId User profile ID associated with this request.
   * @param string $campaignId Campaign ID in this association.
   * @param array $optParams Optional parameters.
   *
   * @opt_param int maxResults Maximum number of results to return.
   * @opt_param string pageToken Value of the nextPageToken from the previous
   * result page.
   * @opt_param string sortOrder Order of sorted results.
   * @return CampaignCreativeAssociationsListResponse
   * @throws \Google\Service\Exception
   */
  public function listCampaignCreativeAssociations($profileId, $campaignId, $optParams = [])
  {
    $params = ['profileId' => $profileId, 'campaignId' => $campaignId];
    $params = array_merge($params, $optParams);
    return $this->call('list', [$params], CampaignCreativeAssociationsListResponse::class);
  }
}

// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CampaignCreativeAssociations::class, 'Google_Service_Dfareporting_Resource_CampaignCreativeAssociations');