Google_Service_Dfareporting_Ads_Resource

The "ads" 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_Ads_Resource extends Google_Service_Resource 
  2.  
  3. /** 
  4. * Gets one ad by ID. (ads.get) 
  5. * @param string $profileId User profile ID associated with this request. 
  6. * @param string $id Ad ID. 
  7. * @param array $optParams Optional parameters. 
  8. * @return Google_Service_Dfareporting_Ad 
  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_Ad"); 
  14.  
  15. /** 
  16. * Inserts a new ad. (ads.insert) 
  17. * @param string $profileId User profile ID associated with this request. 
  18. * @param Google_Ad $postBody 
  19. * @param array $optParams Optional parameters. 
  20. * @return Google_Service_Dfareporting_Ad 
  21. */ 
  22. public function insert($profileId, Google_Service_Dfareporting_Ad $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_Ad"); 
  26.  
  27. /** 
  28. * Retrieves a list of ads, possibly filtered. (ads.listAds) 
  29. * @param string $profileId User profile ID associated with this request. 
  30. * @param array $optParams Optional parameters. 
  31. * @opt_param string landingPageIds Select only ads with these landing page IDs. 
  32. * @opt_param string overriddenEventTagId Select only ads with this event tag 
  33. * override ID. 
  34. * @opt_param string campaignIds Select only ads with these campaign IDs. 
  35. * @opt_param bool archived Select only archived ads. 
  36. * @opt_param string creativeOptimizationConfigurationIds Select only ads with 
  37. * these creative optimization configuration IDs. 
  38. * @opt_param bool sslCompliant Select only ads that are SSL-compliant. 
  39. * @opt_param string sizeIds Select only ads with these size IDs. 
  40. * @opt_param string pageToken Value of the nextPageToken from the previous 
  41. * result page. 
  42. * @opt_param string sortOrder Order of sorted results, default is ASCENDING. 
  43. * @opt_param string type Select only ads with these types. 
  44. * @opt_param bool sslRequired Select only ads that require SSL. 
  45. * @opt_param string creativeIds Select only ads with these creative IDs 
  46. * assigned. 
  47. * @opt_param int maxResults Maximum number of results to return. 
  48. * @opt_param string creativeType Select only ads with the specified 
  49. * creativeType. 
  50. * @opt_param string placementIds Select only ads with these placement IDs 
  51. * assigned. 
  52. * @opt_param bool active Select only active ads. 
  53. * @opt_param string compatibility Select default ads with the specified 
  54. * compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. WEB and 
  55. * WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices 
  56. * for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are 
  57. * for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in- 
  58. * stream video ads developed with the VAST standard. 
  59. * @opt_param string advertiserId Select only ads with this advertiser ID. 
  60. * @opt_param string searchString Allows searching for objects by name or ID. 
  61. * Wildcards (*) are allowed. For example, "ad*2015" will return objects with 
  62. * names like "ad June 2015", "ad April 2015" or simply "ad 2015". Most of the 
  63. * searches also add wildcards implicitly at the start and the end of the search 
  64. * string. For example, a search string of "ad" will match objects with name "my 
  65. * ad", "ad 2015" or simply "ad". 
  66. * @opt_param string sortField Field by which to sort the list. 
  67. * @opt_param string audienceSegmentIds Select only ads with these audience 
  68. * segment IDs. 
  69. * @opt_param string ids Select only ads with these IDs. 
  70. * @opt_param string remarketingListIds Select only ads whose list targeting 
  71. * expression use these remarketing list IDs. 
  72. * @opt_param bool dynamicClickTracker Select only dynamic click trackers. 
  73. * Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic 
  74. * click trackers. If false, select static click trackers. Leave unset to select 
  75. * both. 
  76. * @return Google_Service_Dfareporting_AdsListResponse 
  77. */ 
  78. public function listAds($profileId, $optParams = array()) 
  79. $params = array('profileId' => $profileId); 
  80. $params = array_merge($params, $optParams); 
  81. return $this->call('list', array($params), "Google_Service_Dfareporting_AdsListResponse"); 
  82.  
  83. /** 
  84. * Updates an existing ad. This method supports patch semantics. (ads.patch) 
  85. * @param string $profileId User profile ID associated with this request. 
  86. * @param string $id Ad ID. 
  87. * @param Google_Ad $postBody 
  88. * @param array $optParams Optional parameters. 
  89. * @return Google_Service_Dfareporting_Ad 
  90. */ 
  91. public function patch($profileId, $id, Google_Service_Dfareporting_Ad $postBody, $optParams = array()) 
  92. $params = array('profileId' => $profileId, 'id' => $id, 'postBody' => $postBody); 
  93. $params = array_merge($params, $optParams); 
  94. return $this->call('patch', array($params), "Google_Service_Dfareporting_Ad"); 
  95.  
  96. /** 
  97. * Updates an existing ad. (ads.update) 
  98. * @param string $profileId User profile ID associated with this request. 
  99. * @param Google_Ad $postBody 
  100. * @param array $optParams Optional parameters. 
  101. * @return Google_Service_Dfareporting_Ad 
  102. */ 
  103. public function update($profileId, Google_Service_Dfareporting_Ad $postBody, $optParams = array()) 
  104. $params = array('profileId' => $profileId, 'postBody' => $postBody); 
  105. $params = array_merge($params, $optParams); 
  106. return $this->call('update', array($params), "Google_Service_Dfareporting_Ad");