Google_EventsServiceResource

The "events" collection of methods.

Defined (2)

The class is defined in the following location(s).

/google-api/src/contrib/Google_CalendarService.php  
  1. class Google_EventsServiceResource extends Google_ServiceResource { 
  2.  
  3.  
  4. /** 
  5. * Deletes an event. (events.delete) 
  6. * @param string $calendarId Calendar identifier. 
  7. * @param string $eventId Event identifier. 
  8. * @param array $optParams Optional parameters. 
  9. * @opt_param bool sendNotifications Whether to send notifications about the deletion of the event. Optional. The default is False. 
  10. */ 
  11. public function delete($calendarId, $eventId, $optParams = array()) { 
  12. $params = array('calendarId' => $calendarId, 'eventId' => $eventId); 
  13. $params = array_merge($params, $optParams); 
  14. $data = $this->__call('delete', array($params)); 
  15. return $data; 
  16. /** 
  17. * Returns an event. (events.get) 
  18. * @param string $calendarId Calendar identifier. 
  19. * @param string $eventId Event identifier. 
  20. * @param array $optParams Optional parameters. 
  21. * @opt_param bool alwaysIncludeEmail Whether to always include a value in the "email" field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False. 
  22. * @opt_param int maxAttendees The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. 
  23. * @opt_param string timeZone Time zone used in the response. Optional. The default is the time zone of the calendar. 
  24. * @return Google_Event 
  25. */ 
  26. public function get($calendarId, $eventId, $optParams = array()) { 
  27. $params = array('calendarId' => $calendarId, 'eventId' => $eventId); 
  28. $params = array_merge($params, $optParams); 
  29. $data = $this->__call('get', array($params)); 
  30. if ($this->useObjects()) { 
  31. return new Google_Event($data); 
  32. } else { 
  33. return $data; 
  34. /** 
  35. * Imports an event. (events.import) 
  36. * @param string $calendarId Calendar identifier. 
  37. * @param Google_Event $postBody 
  38. * @param array $optParams Optional parameters. 
  39. * @return Google_Event 
  40. */ 
  41. public function import($calendarId, Google_Event $postBody, $optParams = array()) { 
  42. $params = array('calendarId' => $calendarId, 'postBody' => $postBody); 
  43. $params = array_merge($params, $optParams); 
  44. $data = $this->__call('import', array($params)); 
  45. if ($this->useObjects()) { 
  46. return new Google_Event($data); 
  47. } else { 
  48. return $data; 
  49. /** 
  50. * Creates an event. (events.insert) 
  51. * @param string $calendarId Calendar identifier. 
  52. * @param Google_Event $postBody 
  53. * @param array $optParams Optional parameters. 
  54. * @opt_param int maxAttendees The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. 
  55. * @opt_param bool sendNotifications Whether to send notifications about the creation of the new event. Optional. The default is False. 
  56. * @return Google_Event 
  57. */ 
  58. public function insert($calendarId, Google_Event $postBody, $optParams = array()) { 
  59. $params = array('calendarId' => $calendarId, 'postBody' => $postBody); 
  60. $params = array_merge($params, $optParams); 
  61. $data = $this->__call('insert', array($params)); 
  62. if ($this->useObjects()) { 
  63. return new Google_Event($data); 
  64. } else { 
  65. return $data; 
  66. /** 
  67. * Returns instances of the specified recurring event. (events.instances) 
  68. * @param string $calendarId Calendar identifier. 
  69. * @param string $eventId Recurring event identifier. 
  70. * @param array $optParams Optional parameters. 
  71. * @opt_param bool alwaysIncludeEmail Whether to always include a value in the "email" field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False. 
  72. * @opt_param int maxAttendees The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. 
  73. * @opt_param int maxResults Maximum number of events returned on one result page. Optional. 
  74. * @opt_param string originalStart The original start time of the instance in the result. Optional. 
  75. * @opt_param string pageToken Token specifying which result page to return. Optional. 
  76. * @opt_param bool showDeleted Whether to include deleted events (with 'status' equals 'cancelled') in the result. Cancelled instances of recurring events will still be included if 'singleEvents' is False. Optional. The default is False. 
  77. * @opt_param string timeMax Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. 
  78. * @opt_param string timeMin Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. 
  79. * @opt_param string timeZone Time zone used in the response. Optional. The default is the time zone of the calendar. 
  80. * @return Google_Events 
  81. */ 
  82. public function instances($calendarId, $eventId, $optParams = array()) { 
  83. $params = array('calendarId' => $calendarId, 'eventId' => $eventId); 
  84. $params = array_merge($params, $optParams); 
  85. $data = $this->__call('instances', array($params)); 
  86. if ($this->useObjects()) { 
  87. return new Google_Events($data); 
  88. } else { 
  89. return $data; 
  90. /** 
  91. * Returns events on the specified calendar. (events.list) 
  92. * @param string $calendarId Calendar identifier. 
  93. * @param array $optParams Optional parameters. 
  94. * @opt_param bool alwaysIncludeEmail Whether to always include a value in the "email" field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False. 
  95. * @opt_param string iCalUID Specifies iCalendar UID (iCalUID) of events to be included in the response. Optional. 
  96. * @opt_param int maxAttendees The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. 
  97. * @opt_param int maxResults Maximum number of events returned on one result page. Optional. 
  98. * @opt_param string orderBy The order of the events returned in the result. Optional. The default is an unspecified, stable order. 
  99. * @opt_param string pageToken Token specifying which result page to return. Optional. 
  100. * @opt_param string q Free text search terms to find events that match these terms in any field, except for extended properties. Optional. 
  101. * @opt_param bool showDeleted Whether to include deleted events (with 'status' equals 'cancelled') in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if 'showDeleted' and 'singleEvents' are both False. If 'showDeleted' and 'singleEvents' are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False. 
  102. * @opt_param bool showHiddenInvitations Whether to include hidden invitations in the result. Optional. The default is False. 
  103. * @opt_param bool singleEvents Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False. 
  104. * @opt_param string timeMax Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. 
  105. * @opt_param string timeMin Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. 
  106. * @opt_param string timeZone Time zone used in the response. Optional. The default is the time zone of the calendar. 
  107. * @opt_param string updatedMin Lower bound for an event's last modification time (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by last modification time. 
  108. * @return Google_Events 
  109. */ 
  110. public function listEvents($calendarId, $optParams = array()) { 
  111. $params = array('calendarId' => $calendarId); 
  112. $params = array_merge($params, $optParams); 
  113. $data = $this->__call('list', array($params)); 
  114. if ($this->useObjects()) { 
  115. return new Google_Events($data); 
  116. } else { 
  117. return $data; 
  118. /** 
  119. * Moves an event to another calendar, i.e. changes an event's organizer. (events.move) 
  120. * @param string $calendarId Calendar identifier of the source calendar where the event currently is on. 
  121. * @param string $eventId Event identifier. 
  122. * @param string $destination Calendar identifier of the target calendar where the event is to be moved to. 
  123. * @param array $optParams Optional parameters. 
  124. * @opt_param bool sendNotifications Whether to send notifications about the change of the event's organizer. Optional. The default is False. 
  125. * @return Google_Event 
  126. */ 
  127. public function move($calendarId, $eventId, $destination, $optParams = array()) { 
  128. $params = array('calendarId' => $calendarId, 'eventId' => $eventId, 'destination' => $destination); 
  129. $params = array_merge($params, $optParams); 
  130. $data = $this->__call('move', array($params)); 
  131. if ($this->useObjects()) { 
  132. return new Google_Event($data); 
  133. } else { 
  134. return $data; 
  135. /** 
  136. * Updates an event. This method supports patch semantics. (events.patch) 
  137. * @param string $calendarId Calendar identifier. 
  138. * @param string $eventId Event identifier. 
  139. * @param Google_Event $postBody 
  140. * @param array $optParams Optional parameters. 
  141. * @opt_param bool alwaysIncludeEmail Whether to always include a value in the "email" field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False. 
  142. * @opt_param int maxAttendees The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. 
  143. * @opt_param bool sendNotifications Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False. 
  144. * @return Google_Event 
  145. */ 
  146. public function patch($calendarId, $eventId, Google_Event $postBody, $optParams = array()) { 
  147. $params = array('calendarId' => $calendarId, 'eventId' => $eventId, 'postBody' => $postBody); 
  148. $params = array_merge($params, $optParams); 
  149. $data = $this->__call('patch', array($params)); 
  150. if ($this->useObjects()) { 
  151. return new Google_Event($data); 
  152. } else { 
  153. return $data; 
  154. /** 
  155. * Creates an event based on a simple text string. (events.quickAdd) 
  156. * @param string $calendarId Calendar identifier. 
  157. * @param string $text The text describing the event to be created. 
  158. * @param array $optParams Optional parameters. 
  159. * @opt_param bool sendNotifications Whether to send notifications about the creation of the event. Optional. The default is False. 
  160. * @return Google_Event 
  161. */ 
  162. public function quickAdd($calendarId, $text, $optParams = array()) { 
  163. $params = array('calendarId' => $calendarId, 'text' => $text); 
  164. $params = array_merge($params, $optParams); 
  165. $data = $this->__call('quickAdd', array($params)); 
  166. if ($this->useObjects()) { 
  167. return new Google_Event($data); 
  168. } else { 
  169. return $data; 
  170. /** 
  171. * Updates an event. (events.update) 
  172. * @param string $calendarId Calendar identifier. 
  173. * @param string $eventId Event identifier. 
  174. * @param Google_Event $postBody 
  175. * @param array $optParams Optional parameters. 
  176. * @opt_param bool alwaysIncludeEmail Whether to always include a value in the "email" field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False. 
  177. * @opt_param int maxAttendees The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. 
  178. * @opt_param bool sendNotifications Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False. 
  179. * @return Google_Event 
  180. */ 
  181. public function update($calendarId, $eventId, Google_Event $postBody, $optParams = array()) { 
  182. $params = array('calendarId' => $calendarId, 'eventId' => $eventId, 'postBody' => $postBody); 
  183. $params = array_merge($params, $optParams); 
  184. $data = $this->__call('update', array($params)); 
  185. if ($this->useObjects()) { 
  186. return new Google_Event($data); 
  187. } else { 
  188. return $data; 
/google-api/src/contrib/Google_GanService.php  
  1. class Google_EventsServiceResource extends Google_ServiceResource { 
  2.  
  3.  
  4. /** 
  5. * Retrieves event data for a given advertiser/publisher. (events.list) 
  6. * @param string $role The role of the requester. Valid values: 'advertisers' or 'publishers'. 
  7. * @param string $roleId The ID of the requesting advertiser or publisher. 
  8. * @param array $optParams Optional parameters. 
  9. * @opt_param string orderId Caret(^) delimited list of order IDs. Filters out all events that do not reference one of the given order IDs. Optional. 
  10. * @opt_param string sku Caret(^) delimited list of SKUs. Filters out all events that do not reference one of the given SKU. Optional. 
  11. * @opt_param string eventDateMax Filters out all events later than given date. Optional. Defaults to 24 hours after eventMin. 
  12. * @opt_param string type Filters out all events that are not of the given type. Valid values: 'action', 'transaction', 'charge'. Optional. 
  13. * @opt_param string linkId Caret(^) delimited list of link IDs. Filters out all events that do not reference one of the given link IDs. Optional. 
  14. * @opt_param string modifyDateMin Filters out all events modified earlier than given date. Optional. Defaults to 24 hours before the current modifyDateMax, if modifyDateMax is explicitly set. 
  15. * @opt_param string eventDateMin Filters out all events earlier than given date. Optional. Defaults to 24 hours from current date/time. 
  16. * @opt_param string memberId Caret(^) delimited list of member IDs. Filters out all events that do not reference one of the given member IDs. Optional. 
  17. * @opt_param string maxResults Max number of offers to return in this page. Optional. Defaults to 20. 
  18. * @opt_param string advertiserId Caret(^) delimited list of advertiser IDs. Filters out all events that do not reference one of the given advertiser IDs. Only used when under publishers role. Optional. 
  19. * @opt_param string pageToken The value of 'nextPageToken' from the previous page. Optional. 
  20. * @opt_param string productCategory Caret(^) delimited list of product categories. Filters out all events that do not reference a product in one of the given product categories. Optional. 
  21. * @opt_param string chargeType Filters out all charge events that are not of the given charge type. Valid values: 'other', 'slotting_fee', 'monthly_minimum', 'tier_bonus', 'credit', 'debit'. Optional. 
  22. * @opt_param string modifyDateMax Filters out all events modified later than given date. Optional. Defaults to 24 hours after modifyDateMin, if modifyDateMin is explicitly set. 
  23. * @opt_param string status Filters out all events that do not have the given status. Valid values: 'active', 'canceled'. Optional. 
  24. * @opt_param string publisherId Caret(^) delimited list of publisher IDs. Filters out all events that do not reference one of the given publishers IDs. Only used when under advertiser role. Optional. 
  25. * @return Google_Events 
  26. */ 
  27. public function listEvents($role, $roleId, $optParams = array()) { 
  28. $params = array('role' => $role, 'roleId' => $roleId); 
  29. $params = array_merge($params, $optParams); 
  30. $data = $this->__call('list', array($params)); 
  31. if ($this->useObjects()) { 
  32. return new Google_Events($data); 
  33. } else { 
  34. return $data;