Google_Service_Dfareporting_Creatives_Resource
The "creatives" collection of methods.
Defined (1)
The class is defined in the following location(s).
- /includes/api-libs/Google/Service/Dfareporting.php
- class Google_Service_Dfareporting_Creatives_Resource extends Google_Service_Resource
- {
- /**
- * Gets one creative by ID. (creatives.get)
- *
- * @param string $profileId User profile ID associated with this request.
- * @param string $id Creative ID.
- * @param array $optParams Optional parameters.
- * @return Google_Service_Dfareporting_Creative
- */
- public function get($profileId, $id, $optParams = array())
- {
- $params = array('profileId' => $profileId, 'id' => $id);
- $params = array_merge($params, $optParams);
- return $this->call('get', array($params), "Google_Service_Dfareporting_Creative");
- }
- /**
- * Inserts a new creative. (creatives.insert)
- *
- * @param string $profileId User profile ID associated with this request.
- * @param Google_Creative $postBody
- * @param array $optParams Optional parameters.
- * @return Google_Service_Dfareporting_Creative
- */
- public function insert($profileId, Google_Service_Dfareporting_Creative $postBody, $optParams = array())
- {
- $params = array('profileId' => $profileId, 'postBody' => $postBody);
- $params = array_merge($params, $optParams);
- return $this->call('insert', array($params), "Google_Service_Dfareporting_Creative");
- }
- /**
- * Retrieves a list of creatives, possibly filtered. (creatives.listCreatives)
- *
- * @param string $profileId User profile ID associated with this request.
- * @param array $optParams Optional parameters.
- *
- * @opt_param string sizeIds Select only creatives with these size IDs.
- * @opt_param bool archived Select only archived creatives. Leave blank to
- * select archived and unarchived creatives.
- * @opt_param string searchString Allows searching for objects by name or ID.
- * Wildcards (*) are allowed. For example, "creative*2015" will return objects
- * with names like "creative June 2015", "creative April 2015" or simply
- * "creative 2015". Most of the searches also add wildcards implicitly at the
- * start and the end of the search string. For example, a search string of
- * "creative" will match objects with name "my creative", "creative 2015" or
- * simply "creative".
- * @opt_param string campaignId Select only creatives with this campaign ID.
- * @opt_param string sortField Field by which to sort the list.
- * @opt_param string renderingIds Select only creatives with these rendering
- * IDs.
- * @opt_param string ids Select only creatives with these IDs.
- * @opt_param int maxResults Maximum number of results to return.
- * @opt_param string advertiserId Select only creatives with this advertiser ID.
- * @opt_param string pageToken Value of the nextPageToken from the previous
- * result page.
- * @opt_param string studioCreativeId Select only creatives corresponding to
- * this Studio creative ID.
- * @opt_param string sortOrder Order of sorted results, default is ASCENDING.
- * @opt_param string companionCreativeIds Select only in-stream video creatives
- * with these companion IDs.
- * @opt_param bool active Select only active creatives. Leave blank to select
- * active and inactive creatives.
- * @opt_param string creativeFieldIds Select only creatives with these creative
- * field IDs.
- * @opt_param string types Select only creatives with these creative types.
- * @return Google_Service_Dfareporting_CreativesListResponse
- */
- public function listCreatives($profileId, $optParams = array())
- {
- $params = array('profileId' => $profileId);
- $params = array_merge($params, $optParams);
- return $this->call('list', array($params), "Google_Service_Dfareporting_CreativesListResponse");
- }
- /**
- * Updates an existing creative. This method supports patch semantics.
- * (creatives.patch)
- *
- * @param string $profileId User profile ID associated with this request.
- * @param string $id Creative ID.
- * @param Google_Creative $postBody
- * @param array $optParams Optional parameters.
- * @return Google_Service_Dfareporting_Creative
- */
- public function patch($profileId, $id, Google_Service_Dfareporting_Creative $postBody, $optParams = array())
- {
- $params = array('profileId' => $profileId, 'id' => $id, 'postBody' => $postBody);
- $params = array_merge($params, $optParams);
- return $this->call('patch', array($params), "Google_Service_Dfareporting_Creative");
- }
- /**
- * Updates an existing creative. (creatives.update)
- *
- * @param string $profileId User profile ID associated with this request.
- * @param Google_Creative $postBody
- * @param array $optParams Optional parameters.
- * @return Google_Service_Dfareporting_Creative
- */
- public function update($profileId, Google_Service_Dfareporting_Creative $postBody, $optParams = array())
- {
- $params = array('profileId' => $profileId, 'postBody' => $postBody);
- $params = array_merge($params, $optParams);
- return $this->call('update', array($params), "Google_Service_Dfareporting_Creative");
- }
- }