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  
  1. class Google_Service_Dfareporting_Creatives_Resource extends Google_Service_Resource 
  2.  
  3. /** 
  4. * Gets one creative by ID. (creatives.get) 
  5. * @param string $profileId User profile ID associated with this request. 
  6. * @param string $id Creative ID. 
  7. * @param array $optParams Optional parameters. 
  8. * @return Google_Service_Dfareporting_Creative 
  9. */ 
  10. public function get($profileId, $id, $optParams = array()) 
  11. $params = array('profileId' => $profileId, 'id' => $id); 
  12. $params = array_merge($params, $optParams); 
  13. return $this->call('get', array($params), "Google_Service_Dfareporting_Creative"); 
  14.  
  15. /** 
  16. * Inserts a new creative. (creatives.insert) 
  17. * @param string $profileId User profile ID associated with this request. 
  18. * @param Google_Creative $postBody 
  19. * @param array $optParams Optional parameters. 
  20. * @return Google_Service_Dfareporting_Creative 
  21. */ 
  22. public function insert($profileId, Google_Service_Dfareporting_Creative $postBody, $optParams = array()) 
  23. $params = array('profileId' => $profileId, 'postBody' => $postBody); 
  24. $params = array_merge($params, $optParams); 
  25. return $this->call('insert', array($params), "Google_Service_Dfareporting_Creative"); 
  26.  
  27. /** 
  28. * Retrieves a list of creatives, possibly filtered. (creatives.listCreatives) 
  29. * @param string $profileId User profile ID associated with this request. 
  30. * @param array $optParams Optional parameters. 
  31. * @opt_param string sizeIds Select only creatives with these size IDs. 
  32. * @opt_param bool archived Select only archived creatives. Leave blank to 
  33. * select archived and unarchived creatives. 
  34. * @opt_param string searchString Allows searching for objects by name or ID. 
  35. * Wildcards (*) are allowed. For example, "creative*2015" will return objects 
  36. * with names like "creative June 2015", "creative April 2015" or simply 
  37. * "creative 2015". Most of the searches also add wildcards implicitly at the 
  38. * start and the end of the search string. For example, a search string of 
  39. * "creative" will match objects with name "my creative", "creative 2015" or 
  40. * simply "creative". 
  41. * @opt_param string campaignId Select only creatives with this campaign ID. 
  42. * @opt_param string sortField Field by which to sort the list. 
  43. * @opt_param string renderingIds Select only creatives with these rendering 
  44. * IDs. 
  45. * @opt_param string ids Select only creatives with these IDs. 
  46. * @opt_param int maxResults Maximum number of results to return. 
  47. * @opt_param string advertiserId Select only creatives with this advertiser ID. 
  48. * @opt_param string pageToken Value of the nextPageToken from the previous 
  49. * result page. 
  50. * @opt_param string studioCreativeId Select only creatives corresponding to 
  51. * this Studio creative ID. 
  52. * @opt_param string sortOrder Order of sorted results, default is ASCENDING. 
  53. * @opt_param string companionCreativeIds Select only in-stream video creatives 
  54. * with these companion IDs. 
  55. * @opt_param bool active Select only active creatives. Leave blank to select 
  56. * active and inactive creatives. 
  57. * @opt_param string creativeFieldIds Select only creatives with these creative 
  58. * field IDs. 
  59. * @opt_param string types Select only creatives with these creative types. 
  60. * @return Google_Service_Dfareporting_CreativesListResponse 
  61. */ 
  62. public function listCreatives($profileId, $optParams = array()) 
  63. $params = array('profileId' => $profileId); 
  64. $params = array_merge($params, $optParams); 
  65. return $this->call('list', array($params), "Google_Service_Dfareporting_CreativesListResponse"); 
  66.  
  67. /** 
  68. * Updates an existing creative. This method supports patch semantics. 
  69. * (creatives.patch) 
  70. * @param string $profileId User profile ID associated with this request. 
  71. * @param string $id Creative ID. 
  72. * @param Google_Creative $postBody 
  73. * @param array $optParams Optional parameters. 
  74. * @return Google_Service_Dfareporting_Creative 
  75. */ 
  76. public function patch($profileId, $id, Google_Service_Dfareporting_Creative $postBody, $optParams = array()) 
  77. $params = array('profileId' => $profileId, 'id' => $id, 'postBody' => $postBody); 
  78. $params = array_merge($params, $optParams); 
  79. return $this->call('patch', array($params), "Google_Service_Dfareporting_Creative"); 
  80.  
  81. /** 
  82. * Updates an existing creative. (creatives.update) 
  83. * @param string $profileId User profile ID associated with this request. 
  84. * @param Google_Creative $postBody 
  85. * @param array $optParams Optional parameters. 
  86. * @return Google_Service_Dfareporting_Creative 
  87. */ 
  88. public function update($profileId, Google_Service_Dfareporting_Creative $postBody, $optParams = array()) 
  89. $params = array('profileId' => $profileId, 'postBody' => $postBody); 
  90. $params = array_merge($params, $optParams); 
  91. return $this->call('update', array($params), "Google_Service_Dfareporting_Creative");