Google_Service_Dfareporting_EventTags_Resource

The "eventTags" 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_EventTags_Resource extends Google_Service_Resource 
  2.  
  3. /** 
  4. * Deletes an existing event tag. (eventTags.delete) 
  5. * @param string $profileId User profile ID associated with this request. 
  6. * @param string $id Event tag ID. 
  7. * @param array $optParams Optional parameters. 
  8. */ 
  9. public function delete($profileId, $id, $optParams = array()) 
  10. $params = array('profileId' => $profileId, 'id' => $id); 
  11. $params = array_merge($params, $optParams); 
  12. return $this->call('delete', array($params)); 
  13.  
  14. /** 
  15. * Gets one event tag by ID. (eventTags.get) 
  16. * @param string $profileId User profile ID associated with this request. 
  17. * @param string $id Event tag ID. 
  18. * @param array $optParams Optional parameters. 
  19. * @return Google_Service_Dfareporting_EventTag 
  20. */ 
  21. public function get($profileId, $id, $optParams = array()) 
  22. $params = array('profileId' => $profileId, 'id' => $id); 
  23. $params = array_merge($params, $optParams); 
  24. return $this->call('get', array($params), "Google_Service_Dfareporting_EventTag"); 
  25.  
  26. /** 
  27. * Inserts a new event tag. (eventTags.insert) 
  28. * @param string $profileId User profile ID associated with this request. 
  29. * @param Google_EventTag $postBody 
  30. * @param array $optParams Optional parameters. 
  31. * @return Google_Service_Dfareporting_EventTag 
  32. */ 
  33. public function insert($profileId, Google_Service_Dfareporting_EventTag $postBody, $optParams = array()) 
  34. $params = array('profileId' => $profileId, 'postBody' => $postBody); 
  35. $params = array_merge($params, $optParams); 
  36. return $this->call('insert', array($params), "Google_Service_Dfareporting_EventTag"); 
  37.  
  38. /** 
  39. * Retrieves a list of event tags, possibly filtered. (eventTags.listEventTags) 
  40. * @param string $profileId User profile ID associated with this request. 
  41. * @param array $optParams Optional parameters. 
  42. * @opt_param string searchString Allows searching for objects by name or ID. 
  43. * Wildcards (*) are allowed. For example, "eventtag*2015" will return objects 
  44. * with names like "eventtag June 2015", "eventtag April 2015" or simply 
  45. * "eventtag 2015". Most of the searches also add wildcards implicitly at the 
  46. * start and the end of the search string. For example, a search string of 
  47. * "eventtag" will match objects with name "my eventtag", "eventtag 2015" or 
  48. * simply "eventtag". 
  49. * @opt_param string campaignId Select only event tags that belong to this 
  50. * campaign. 
  51. * @opt_param string sortField Field by which to sort the list. 
  52. * @opt_param bool enabled Select only enabled event tags. When definitionsOnly 
  53. * is set to true, only the specified advertiser or campaign's event tags' 
  54. * enabledByDefault field is examined. When definitionsOnly is set to false, the 
  55. * specified ad or specified campaign's parent advertiser's or parent campaign's 
  56. * event tags' enabledByDefault and status fields are examined as well. 
  57. * @opt_param string ids Select only event tags with these IDs. 
  58. * @opt_param string advertiserId Select only event tags that belong to this 
  59. * advertiser. 
  60. * @opt_param string adId Select only event tags that belong to this ad. 
  61. * @opt_param string sortOrder Order of sorted results, default is ASCENDING. 
  62. * @opt_param string eventTagTypes Select only event tags with the specified 
  63. * event tag types. Event tag types can be used to specify whether to use a 
  64. * third-party pixel, a third-party JavaScript URL, or a third-party click- 
  65. * through URL for either impression or click tracking. 
  66. * @opt_param bool definitionsOnly Examine only the specified ad or campaign or 
  67. * advertiser's event tags for matching selector criteria. When set to false,  
  68. * the parent advertiser and parent campaign is examined as well. In addition,  
  69. * when set to false, the status field is examined as well along with the 
  70. * enabledByDefault field. 
  71. * @return Google_Service_Dfareporting_EventTagsListResponse 
  72. */ 
  73. public function listEventTags($profileId, $optParams = array()) 
  74. $params = array('profileId' => $profileId); 
  75. $params = array_merge($params, $optParams); 
  76. return $this->call('list', array($params), "Google_Service_Dfareporting_EventTagsListResponse"); 
  77.  
  78. /** 
  79. * Updates an existing event tag. This method supports patch semantics. 
  80. * (eventTags.patch) 
  81. * @param string $profileId User profile ID associated with this request. 
  82. * @param string $id Event tag ID. 
  83. * @param Google_EventTag $postBody 
  84. * @param array $optParams Optional parameters. 
  85. * @return Google_Service_Dfareporting_EventTag 
  86. */ 
  87. public function patch($profileId, $id, Google_Service_Dfareporting_EventTag $postBody, $optParams = array()) 
  88. $params = array('profileId' => $profileId, 'id' => $id, 'postBody' => $postBody); 
  89. $params = array_merge($params, $optParams); 
  90. return $this->call('patch', array($params), "Google_Service_Dfareporting_EventTag"); 
  91.  
  92. /** 
  93. * Updates an existing event tag. (eventTags.update) 
  94. * @param string $profileId User profile ID associated with this request. 
  95. * @param Google_EventTag $postBody 
  96. * @param array $optParams Optional parameters. 
  97. * @return Google_Service_Dfareporting_EventTag 
  98. */ 
  99. public function update($profileId, Google_Service_Dfareporting_EventTag $postBody, $optParams = array()) 
  100. $params = array('profileId' => $profileId, 'postBody' => $postBody); 
  101. $params = array_merge($params, $optParams); 
  102. return $this->call('update', array($params), "Google_Service_Dfareporting_EventTag");