Google_Service_Dfareporting_DirectorySites_Resource

The "directorySites" 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_DirectorySites_Resource extends Google_Service_Resource 
  2.  
  3. /** 
  4. * Gets one directory site by ID. (directorySites.get) 
  5. * @param string $profileId User profile ID associated with this request. 
  6. * @param string $id Directory site ID. 
  7. * @param array $optParams Optional parameters. 
  8. * @return Google_Service_Dfareporting_DirectorySite 
  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_DirectorySite"); 
  14.  
  15. /** 
  16. * Retrieves a list of directory sites, possibly filtered. 
  17. * (directorySites.listDirectorySites) 
  18. * @param string $profileId User profile ID associated with this request. 
  19. * @param array $optParams Optional parameters. 
  20. * @opt_param bool acceptsInterstitialPlacements This search filter is no longer 
  21. * supported and will have no effect on the results returned. 
  22. * @opt_param string sortOrder Order of sorted results, default is ASCENDING. 
  23. * @opt_param string searchString Allows searching for objects by name, ID or 
  24. * URL. Wildcards (*) are allowed. For example, "directory site*2015" will 
  25. * return objects with names like "directory site June 2015", "directory site 
  26. * April 2015" or simply "directory site 2015". Most of the searches also add 
  27. * wildcards implicitly at the start and the end of the search string. For 
  28. * example, a search string of "directory site" will match objects with name "my 
  29. * directory site", "directory site 2015" or simply "directory site". 
  30. * @opt_param string countryId Select only directory sites with this country ID. 
  31. * @opt_param string sortField Field by which to sort the list. 
  32. * @opt_param bool acceptsInStreamVideoPlacements This search filter is no 
  33. * longer supported and will have no effect on the results returned. 
  34. * @opt_param string ids Select only directory sites with these IDs. 
  35. * @opt_param int maxResults Maximum number of results to return. 
  36. * @opt_param string pageToken Value of the nextPageToken from the previous 
  37. * result page. 
  38. * @opt_param bool acceptsPublisherPaidPlacements Select only directory sites 
  39. * that accept publisher paid placements. This field can be left blank. 
  40. * @opt_param string parentId Select only directory sites with this parent ID. 
  41. * @opt_param bool active Select only active directory sites. Leave blank to 
  42. * retrieve both active and inactive directory sites. 
  43. * @opt_param string dfp_network_code Select only directory sites with this DFP 
  44. * network code. 
  45. * @return Google_Service_Dfareporting_DirectorySitesListResponse 
  46. */ 
  47. public function listDirectorySites($profileId, $optParams = array()) 
  48. $params = array('profileId' => $profileId); 
  49. $params = array_merge($params, $optParams); 
  50. return $this->call('list', array($params), "Google_Service_Dfareporting_DirectorySitesListResponse");