| @@ 1054-1218 (lines=165) @@ | ||
| 1051 | * $calendarList = $calendarService->calendarList; |
|
| 1052 | * </code> |
|
| 1053 | */ |
|
| 1054 | class Google_Service_Calendar_CalendarList_Resource extends Google_Service_Resource |
|
| 1055 | { |
|
| 1056 | ||
| 1057 | /** |
|
| 1058 | * Deletes an entry on the user's calendar list. (calendarList.delete) |
|
| 1059 | * |
|
| 1060 | * @param string $calendarId Calendar identifier. |
|
| 1061 | * @param array $optParams Optional parameters. |
|
| 1062 | */ |
|
| 1063 | public function delete($calendarId, $optParams = array()) |
|
| 1064 | { |
|
| 1065 | $params = array('calendarId' => $calendarId); |
|
| 1066 | $params = array_merge($params, $optParams); |
|
| 1067 | return $this->call('delete', array($params)); |
|
| 1068 | } |
|
| 1069 | ||
| 1070 | /** |
|
| 1071 | * Returns an entry on the user's calendar list. (calendarList.get) |
|
| 1072 | * |
|
| 1073 | * @param string $calendarId Calendar identifier. |
|
| 1074 | * @param array $optParams Optional parameters. |
|
| 1075 | * @return Google_Service_Calendar_CalendarListEntry |
|
| 1076 | */ |
|
| 1077 | public function get($calendarId, $optParams = array()) |
|
| 1078 | { |
|
| 1079 | $params = array('calendarId' => $calendarId); |
|
| 1080 | $params = array_merge($params, $optParams); |
|
| 1081 | return $this->call('get', array($params), "Google_Service_Calendar_CalendarListEntry"); |
|
| 1082 | } |
|
| 1083 | ||
| 1084 | /** |
|
| 1085 | * Adds an entry to the user's calendar list. (calendarList.insert) |
|
| 1086 | * |
|
| 1087 | * @param Google_CalendarListEntry $postBody |
|
| 1088 | * @param array $optParams Optional parameters. |
|
| 1089 | * |
|
| 1090 | * @opt_param bool colorRgbFormat Whether to use the foregroundColor and |
|
| 1091 | * backgroundColor fields to write the calendar colors (RGB). If this feature is |
|
| 1092 | * used, the index-based colorId field will be set to the best matching option |
|
| 1093 | * automatically. Optional. The default is False. |
|
| 1094 | * @return Google_Service_Calendar_CalendarListEntry |
|
| 1095 | */ |
|
| 1096 | public function insert(Google_Service_Calendar_CalendarListEntry $postBody, $optParams = array()) |
|
| 1097 | { |
|
| 1098 | $params = array('postBody' => $postBody); |
|
| 1099 | $params = array_merge($params, $optParams); |
|
| 1100 | return $this->call('insert', array($params), "Google_Service_Calendar_CalendarListEntry"); |
|
| 1101 | } |
|
| 1102 | ||
| 1103 | /** |
|
| 1104 | * Returns entries on the user's calendar list. (calendarList.listCalendarList) |
|
| 1105 | * |
|
| 1106 | * @param array $optParams Optional parameters. |
|
| 1107 | * |
|
| 1108 | * @opt_param string syncToken Token obtained from the nextSyncToken field |
|
| 1109 | * returned on the last page of results from the previous list request. It makes |
|
| 1110 | * the result of this list request contain only entries that have changed since |
|
| 1111 | * then. If only read-only fields such as calendar properties or ACLs have |
|
| 1112 | * changed, the entry won't be returned. All entries deleted and hidden since |
|
| 1113 | * the previous list request will always be in the result set and it is not |
|
| 1114 | * allowed to set showDeleted neither showHidden to False. To ensure client |
|
| 1115 | * state consistency minAccessRole query parameter cannot be specified together |
|
| 1116 | * with nextSyncToken. If the syncToken expires, the server will respond with a |
|
| 1117 | * 410 GONE response code and the client should clear its storage and perform a |
|
| 1118 | * full synchronization without any syncToken. Learn more about incremental |
|
| 1119 | * synchronization. Optional. The default is to return all entries. |
|
| 1120 | * @opt_param bool showDeleted Whether to include deleted calendar list entries |
|
| 1121 | * in the result. Optional. The default is False. |
|
| 1122 | * @opt_param string minAccessRole The minimum access role for the user in the |
|
| 1123 | * returned entries. Optional. The default is no restriction. |
|
| 1124 | * @opt_param int maxResults Maximum number of entries returned on one result |
|
| 1125 | * page. By default the value is 100 entries. The page size can never be larger |
|
| 1126 | * than 250 entries. Optional. |
|
| 1127 | * @opt_param string pageToken Token specifying which result page to return. |
|
| 1128 | * Optional. |
|
| 1129 | * @opt_param bool showHidden Whether to show hidden entries. Optional. The |
|
| 1130 | * default is False. |
|
| 1131 | * @return Google_Service_Calendar_CalendarList |
|
| 1132 | */ |
|
| 1133 | public function listCalendarList($optParams = array()) |
|
| 1134 | { |
|
| 1135 | $params = array(); |
|
| 1136 | $params = array_merge($params, $optParams); |
|
| 1137 | return $this->call('list', array($params), "Google_Service_Calendar_CalendarList"); |
|
| 1138 | } |
|
| 1139 | ||
| 1140 | /** |
|
| 1141 | * Updates an entry on the user's calendar list. This method supports patch |
|
| 1142 | * semantics. (calendarList.patch) |
|
| 1143 | * |
|
| 1144 | * @param string $calendarId Calendar identifier. |
|
| 1145 | * @param Google_CalendarListEntry $postBody |
|
| 1146 | * @param array $optParams Optional parameters. |
|
| 1147 | * |
|
| 1148 | * @opt_param bool colorRgbFormat Whether to use the foregroundColor and |
|
| 1149 | * backgroundColor fields to write the calendar colors (RGB). If this feature is |
|
| 1150 | * used, the index-based colorId field will be set to the best matching option |
|
| 1151 | * automatically. Optional. The default is False. |
|
| 1152 | * @return Google_Service_Calendar_CalendarListEntry |
|
| 1153 | */ |
|
| 1154 | public function patch($calendarId, Google_Service_Calendar_CalendarListEntry $postBody, $optParams = array()) |
|
| 1155 | { |
|
| 1156 | $params = array('calendarId' => $calendarId, 'postBody' => $postBody); |
|
| 1157 | $params = array_merge($params, $optParams); |
|
| 1158 | return $this->call('patch', array($params), "Google_Service_Calendar_CalendarListEntry"); |
|
| 1159 | } |
|
| 1160 | ||
| 1161 | /** |
|
| 1162 | * Updates an entry on the user's calendar list. (calendarList.update) |
|
| 1163 | * |
|
| 1164 | * @param string $calendarId Calendar identifier. |
|
| 1165 | * @param Google_CalendarListEntry $postBody |
|
| 1166 | * @param array $optParams Optional parameters. |
|
| 1167 | * |
|
| 1168 | * @opt_param bool colorRgbFormat Whether to use the foregroundColor and |
|
| 1169 | * backgroundColor fields to write the calendar colors (RGB). If this feature is |
|
| 1170 | * used, the index-based colorId field will be set to the best matching option |
|
| 1171 | * automatically. Optional. The default is False. |
|
| 1172 | * @return Google_Service_Calendar_CalendarListEntry |
|
| 1173 | */ |
|
| 1174 | public function update($calendarId, Google_Service_Calendar_CalendarListEntry $postBody, $optParams = array()) |
|
| 1175 | { |
|
| 1176 | $params = array('calendarId' => $calendarId, 'postBody' => $postBody); |
|
| 1177 | $params = array_merge($params, $optParams); |
|
| 1178 | return $this->call('update', array($params), "Google_Service_Calendar_CalendarListEntry"); |
|
| 1179 | } |
|
| 1180 | ||
| 1181 | /** |
|
| 1182 | * Watch for changes to CalendarList resources. (calendarList.watch) |
|
| 1183 | * |
|
| 1184 | * @param Google_Channel $postBody |
|
| 1185 | * @param array $optParams Optional parameters. |
|
| 1186 | * |
|
| 1187 | * @opt_param string syncToken Token obtained from the nextSyncToken field |
|
| 1188 | * returned on the last page of results from the previous list request. It makes |
|
| 1189 | * the result of this list request contain only entries that have changed since |
|
| 1190 | * then. If only read-only fields such as calendar properties or ACLs have |
|
| 1191 | * changed, the entry won't be returned. All entries deleted and hidden since |
|
| 1192 | * the previous list request will always be in the result set and it is not |
|
| 1193 | * allowed to set showDeleted neither showHidden to False. To ensure client |
|
| 1194 | * state consistency minAccessRole query parameter cannot be specified together |
|
| 1195 | * with nextSyncToken. If the syncToken expires, the server will respond with a |
|
| 1196 | * 410 GONE response code and the client should clear its storage and perform a |
|
| 1197 | * full synchronization without any syncToken. Learn more about incremental |
|
| 1198 | * synchronization. Optional. The default is to return all entries. |
|
| 1199 | * @opt_param bool showDeleted Whether to include deleted calendar list entries |
|
| 1200 | * in the result. Optional. The default is False. |
|
| 1201 | * @opt_param string minAccessRole The minimum access role for the user in the |
|
| 1202 | * returned entries. Optional. The default is no restriction. |
|
| 1203 | * @opt_param int maxResults Maximum number of entries returned on one result |
|
| 1204 | * page. By default the value is 100 entries. The page size can never be larger |
|
| 1205 | * than 250 entries. Optional. |
|
| 1206 | * @opt_param string pageToken Token specifying which result page to return. |
|
| 1207 | * Optional. |
|
| 1208 | * @opt_param bool showHidden Whether to show hidden entries. Optional. The |
|
| 1209 | * default is False. |
|
| 1210 | * @return Google_Service_Calendar_Channel |
|
| 1211 | */ |
|
| 1212 | public function watch(Google_Service_Calendar_Channel $postBody, $optParams = array()) |
|
| 1213 | { |
|
| 1214 | $params = array('postBody' => $postBody); |
|
| 1215 | $params = array_merge($params, $optParams); |
|
| 1216 | return $this->call('watch', array($params), "Google_Service_Calendar_Channel"); |
|
| 1217 | } |
|
| 1218 | } |
|
| 1219 | ||
| 1220 | /** |
|
| 1221 | * The "calendars" collection of methods. |
|
| @@ 136-241 (lines=106) @@ | ||
| 133 | * $webResource = $siteVerificationService->webResource; |
|
| 134 | * </code> |
|
| 135 | */ |
|
| 136 | class Google_Service_SiteVerification_WebResource_Resource extends Google_Service_Resource |
|
| 137 | { |
|
| 138 | ||
| 139 | /** |
|
| 140 | * Relinquish ownership of a website or domain. (webResource.delete) |
|
| 141 | * |
|
| 142 | * @param string $id The id of a verified site or domain. |
|
| 143 | * @param array $optParams Optional parameters. |
|
| 144 | */ |
|
| 145 | public function delete($id, $optParams = array()) |
|
| 146 | { |
|
| 147 | $params = array('id' => $id); |
|
| 148 | $params = array_merge($params, $optParams); |
|
| 149 | return $this->call('delete', array($params)); |
|
| 150 | } |
|
| 151 | ||
| 152 | /** |
|
| 153 | * Get the most current data for a website or domain. (webResource.get) |
|
| 154 | * |
|
| 155 | * @param string $id The id of a verified site or domain. |
|
| 156 | * @param array $optParams Optional parameters. |
|
| 157 | * @return Google_Service_SiteVerification_SiteVerificationWebResourceResource |
|
| 158 | */ |
|
| 159 | public function get($id, $optParams = array()) |
|
| 160 | { |
|
| 161 | $params = array('id' => $id); |
|
| 162 | $params = array_merge($params, $optParams); |
|
| 163 | return $this->call('get', array($params), "Google_Service_SiteVerification_SiteVerificationWebResourceResource"); |
|
| 164 | } |
|
| 165 | ||
| 166 | /** |
|
| 167 | * Get a verification token for placing on a website or domain. |
|
| 168 | * (webResource.getToken) |
|
| 169 | * |
|
| 170 | * @param Google_SiteVerificationWebResourceGettokenRequest $postBody |
|
| 171 | * @param array $optParams Optional parameters. |
|
| 172 | * @return Google_Service_SiteVerification_SiteVerificationWebResourceGettokenResponse |
|
| 173 | */ |
|
| 174 | public function getToken(Google_Service_SiteVerification_SiteVerificationWebResourceGettokenRequest $postBody, $optParams = array()) |
|
| 175 | { |
|
| 176 | $params = array('postBody' => $postBody); |
|
| 177 | $params = array_merge($params, $optParams); |
|
| 178 | return $this->call('getToken', array($params), "Google_Service_SiteVerification_SiteVerificationWebResourceGettokenResponse"); |
|
| 179 | } |
|
| 180 | ||
| 181 | /** |
|
| 182 | * Attempt verification of a website or domain. (webResource.insert) |
|
| 183 | * |
|
| 184 | * @param string $verificationMethod The method to use for verifying a site or |
|
| 185 | * domain. |
|
| 186 | * @param Google_SiteVerificationWebResourceResource $postBody |
|
| 187 | * @param array $optParams Optional parameters. |
|
| 188 | * @return Google_Service_SiteVerification_SiteVerificationWebResourceResource |
|
| 189 | */ |
|
| 190 | public function insert($verificationMethod, Google_Service_SiteVerification_SiteVerificationWebResourceResource $postBody, $optParams = array()) |
|
| 191 | { |
|
| 192 | $params = array('verificationMethod' => $verificationMethod, 'postBody' => $postBody); |
|
| 193 | $params = array_merge($params, $optParams); |
|
| 194 | return $this->call('insert', array($params), "Google_Service_SiteVerification_SiteVerificationWebResourceResource"); |
|
| 195 | } |
|
| 196 | ||
| 197 | /** |
|
| 198 | * Get the list of your verified websites and domains. |
|
| 199 | * (webResource.listWebResource) |
|
| 200 | * |
|
| 201 | * @param array $optParams Optional parameters. |
|
| 202 | * @return Google_Service_SiteVerification_SiteVerificationWebResourceListResponse |
|
| 203 | */ |
|
| 204 | public function listWebResource($optParams = array()) |
|
| 205 | { |
|
| 206 | $params = array(); |
|
| 207 | $params = array_merge($params, $optParams); |
|
| 208 | return $this->call('list', array($params), "Google_Service_SiteVerification_SiteVerificationWebResourceListResponse"); |
|
| 209 | } |
|
| 210 | ||
| 211 | /** |
|
| 212 | * Modify the list of owners for your website or domain. This method supports |
|
| 213 | * patch semantics. (webResource.patch) |
|
| 214 | * |
|
| 215 | * @param string $id The id of a verified site or domain. |
|
| 216 | * @param Google_SiteVerificationWebResourceResource $postBody |
|
| 217 | * @param array $optParams Optional parameters. |
|
| 218 | * @return Google_Service_SiteVerification_SiteVerificationWebResourceResource |
|
| 219 | */ |
|
| 220 | public function patch($id, Google_Service_SiteVerification_SiteVerificationWebResourceResource $postBody, $optParams = array()) |
|
| 221 | { |
|
| 222 | $params = array('id' => $id, 'postBody' => $postBody); |
|
| 223 | $params = array_merge($params, $optParams); |
|
| 224 | return $this->call('patch', array($params), "Google_Service_SiteVerification_SiteVerificationWebResourceResource"); |
|
| 225 | } |
|
| 226 | ||
| 227 | /** |
|
| 228 | * Modify the list of owners for your website or domain. (webResource.update) |
|
| 229 | * |
|
| 230 | * @param string $id The id of a verified site or domain. |
|
| 231 | * @param Google_SiteVerificationWebResourceResource $postBody |
|
| 232 | * @param array $optParams Optional parameters. |
|
| 233 | * @return Google_Service_SiteVerification_SiteVerificationWebResourceResource |
|
| 234 | */ |
|
| 235 | public function update($id, Google_Service_SiteVerification_SiteVerificationWebResourceResource $postBody, $optParams = array()) |
|
| 236 | { |
|
| 237 | $params = array('id' => $id, 'postBody' => $postBody); |
|
| 238 | $params = array_merge($params, $optParams); |
|
| 239 | return $this->call('update', array($params), "Google_Service_SiteVerification_SiteVerificationWebResourceResource"); |
|
| 240 | } |
|
| 241 | } |
|
| 242 | ||
| 243 | ||
| 244 | ||
| @@ 4112-4404 (lines=293) @@ | ||
| 4109 | * $videos = $youtubeService->videos; |
|
| 4110 | * </code> |
|
| 4111 | */ |
|
| 4112 | class Google_Service_YouTube_Videos_Resource extends Google_Service_Resource |
|
| 4113 | { |
|
| 4114 | ||
| 4115 | /** |
|
| 4116 | * Deletes a YouTube video. (videos.delete) |
|
| 4117 | * |
|
| 4118 | * @param string $id The id parameter specifies the YouTube video ID for the |
|
| 4119 | * resource that is being deleted. In a video resource, the id property |
|
| 4120 | * specifies the video's ID. |
|
| 4121 | * @param array $optParams Optional parameters. |
|
| 4122 | * |
|
| 4123 | * @opt_param string onBehalfOfContentOwner Note: This parameter is intended |
|
| 4124 | * exclusively for YouTube content partners. |
|
| 4125 | * |
|
| 4126 | * The onBehalfOfContentOwner parameter indicates that the request's |
|
| 4127 | * authorization credentials identify a YouTube CMS user who is acting on behalf |
|
| 4128 | * of the content owner specified in the parameter value. This parameter is |
|
| 4129 | * intended for YouTube content partners that own and manage many different |
|
| 4130 | * YouTube channels. It allows content owners to authenticate once and get |
|
| 4131 | * access to all their video and channel data, without having to provide |
|
| 4132 | * authentication credentials for each individual channel. The actual CMS |
|
| 4133 | * account that the user authenticates with must be linked to the specified |
|
| 4134 | * YouTube content owner. |
|
| 4135 | */ |
|
| 4136 | public function delete($id, $optParams = array()) |
|
| 4137 | { |
|
| 4138 | $params = array('id' => $id); |
|
| 4139 | $params = array_merge($params, $optParams); |
|
| 4140 | return $this->call('delete', array($params)); |
|
| 4141 | } |
|
| 4142 | ||
| 4143 | /** |
|
| 4144 | * Retrieves the ratings that the authorized user gave to a list of specified |
|
| 4145 | * videos. (videos.getRating) |
|
| 4146 | * |
|
| 4147 | * @param string $id The id parameter specifies a comma-separated list of the |
|
| 4148 | * YouTube video ID(s) for the resource(s) for which you are retrieving rating |
|
| 4149 | * data. In a video resource, the id property specifies the video's ID. |
|
| 4150 | * @param array $optParams Optional parameters. |
|
| 4151 | * |
|
| 4152 | * @opt_param string onBehalfOfContentOwner Note: This parameter is intended |
|
| 4153 | * exclusively for YouTube content partners. |
|
| 4154 | * |
|
| 4155 | * The onBehalfOfContentOwner parameter indicates that the request's |
|
| 4156 | * authorization credentials identify a YouTube CMS user who is acting on behalf |
|
| 4157 | * of the content owner specified in the parameter value. This parameter is |
|
| 4158 | * intended for YouTube content partners that own and manage many different |
|
| 4159 | * YouTube channels. It allows content owners to authenticate once and get |
|
| 4160 | * access to all their video and channel data, without having to provide |
|
| 4161 | * authentication credentials for each individual channel. The CMS account that |
|
| 4162 | * the user authenticates with must be linked to the specified YouTube content |
|
| 4163 | * owner. |
|
| 4164 | * @return Google_Service_YouTube_VideoGetRatingResponse |
|
| 4165 | */ |
|
| 4166 | public function getRating($id, $optParams = array()) |
|
| 4167 | { |
|
| 4168 | $params = array('id' => $id); |
|
| 4169 | $params = array_merge($params, $optParams); |
|
| 4170 | return $this->call('getRating', array($params), "Google_Service_YouTube_VideoGetRatingResponse"); |
|
| 4171 | } |
|
| 4172 | ||
| 4173 | /** |
|
| 4174 | * Uploads a video to YouTube and optionally sets the video's metadata. |
|
| 4175 | * (videos.insert) |
|
| 4176 | * |
|
| 4177 | * @param string $part The part parameter serves two purposes in this operation. |
|
| 4178 | * It identifies the properties that the write operation will set as well as the |
|
| 4179 | * properties that the API response will include. |
|
| 4180 | * |
|
| 4181 | * Note that not all parts contain properties that can be set when inserting or |
|
| 4182 | * updating a video. For example, the statistics object encapsulates statistics |
|
| 4183 | * that YouTube calculates for a video and does not contain values that you can |
|
| 4184 | * set or modify. If the parameter value specifies a part that does not contain |
|
| 4185 | * mutable values, that part will still be included in the API response. |
|
| 4186 | * @param Google_Video $postBody |
|
| 4187 | * @param array $optParams Optional parameters. |
|
| 4188 | * |
|
| 4189 | * @opt_param string onBehalfOfContentOwner Note: This parameter is intended |
|
| 4190 | * exclusively for YouTube content partners. |
|
| 4191 | * |
|
| 4192 | * The onBehalfOfContentOwner parameter indicates that the request's |
|
| 4193 | * authorization credentials identify a YouTube CMS user who is acting on behalf |
|
| 4194 | * of the content owner specified in the parameter value. This parameter is |
|
| 4195 | * intended for YouTube content partners that own and manage many different |
|
| 4196 | * YouTube channels. It allows content owners to authenticate once and get |
|
| 4197 | * access to all their video and channel data, without having to provide |
|
| 4198 | * authentication credentials for each individual channel. The CMS account that |
|
| 4199 | * the user authenticates with must be linked to the specified YouTube content |
|
| 4200 | * owner. |
|
| 4201 | * @opt_param bool stabilize The stabilize parameter indicates whether YouTube |
|
| 4202 | * should adjust the video to remove shaky camera motions. |
|
| 4203 | * @opt_param string onBehalfOfContentOwnerChannel This parameter can only be |
|
| 4204 | * used in a properly authorized request. Note: This parameter is intended |
|
| 4205 | * exclusively for YouTube content partners. |
|
| 4206 | * |
|
| 4207 | * The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID |
|
| 4208 | * of the channel to which a video is being added. This parameter is required |
|
| 4209 | * when a request specifies a value for the onBehalfOfContentOwner parameter, |
|
| 4210 | * and it can only be used in conjunction with that parameter. In addition, the |
|
| 4211 | * request must be authorized using a CMS account that is linked to the content |
|
| 4212 | * owner that the onBehalfOfContentOwner parameter specifies. Finally, the |
|
| 4213 | * channel that the onBehalfOfContentOwnerChannel parameter value specifies must |
|
| 4214 | * be linked to the content owner that the onBehalfOfContentOwner parameter |
|
| 4215 | * specifies. |
|
| 4216 | * |
|
| 4217 | * This parameter is intended for YouTube content partners that own and manage |
|
| 4218 | * many different YouTube channels. It allows content owners to authenticate |
|
| 4219 | * once and perform actions on behalf of the channel specified in the parameter |
|
| 4220 | * value, without having to provide authentication credentials for each separate |
|
| 4221 | * channel. |
|
| 4222 | * @opt_param bool notifySubscribers The notifySubscribers parameter indicates |
|
| 4223 | * whether YouTube should send a notification about the new video to users who |
|
| 4224 | * subscribe to the video's channel. A parameter value of True indicates that |
|
| 4225 | * subscribers will be notified of newly uploaded videos. However, a channel |
|
| 4226 | * owner who is uploading many videos might prefer to set the value to False to |
|
| 4227 | * avoid sending a notification about each new video to the channel's |
|
| 4228 | * subscribers. |
|
| 4229 | * @opt_param bool autoLevels The autoLevels parameter indicates whether YouTube |
|
| 4230 | * should automatically enhance the video's lighting and color. |
|
| 4231 | * @return Google_Service_YouTube_Video |
|
| 4232 | */ |
|
| 4233 | public function insert($part, Google_Service_YouTube_Video $postBody, $optParams = array()) |
|
| 4234 | { |
|
| 4235 | $params = array('part' => $part, 'postBody' => $postBody); |
|
| 4236 | $params = array_merge($params, $optParams); |
|
| 4237 | return $this->call('insert', array($params), "Google_Service_YouTube_Video"); |
|
| 4238 | } |
|
| 4239 | ||
| 4240 | /** |
|
| 4241 | * Returns a list of videos that match the API request parameters. |
|
| 4242 | * (videos.listVideos) |
|
| 4243 | * |
|
| 4244 | * @param string $part The part parameter specifies a comma-separated list of |
|
| 4245 | * one or more video resource properties that the API response will include. |
|
| 4246 | * |
|
| 4247 | * If the parameter identifies a property that contains child properties, the |
|
| 4248 | * child properties will be included in the response. For example, in a video |
|
| 4249 | * resource, the snippet property contains the channelId, title, description, |
|
| 4250 | * tags, and categoryId properties. As such, if you set part=snippet, the API |
|
| 4251 | * response will contain all of those properties. |
|
| 4252 | * @param array $optParams Optional parameters. |
|
| 4253 | * |
|
| 4254 | * @opt_param string onBehalfOfContentOwner Note: This parameter is intended |
|
| 4255 | * exclusively for YouTube content partners. |
|
| 4256 | * |
|
| 4257 | * The onBehalfOfContentOwner parameter indicates that the request's |
|
| 4258 | * authorization credentials identify a YouTube CMS user who is acting on behalf |
|
| 4259 | * of the content owner specified in the parameter value. This parameter is |
|
| 4260 | * intended for YouTube content partners that own and manage many different |
|
| 4261 | * YouTube channels. It allows content owners to authenticate once and get |
|
| 4262 | * access to all their video and channel data, without having to provide |
|
| 4263 | * authentication credentials for each individual channel. The CMS account that |
|
| 4264 | * the user authenticates with must be linked to the specified YouTube content |
|
| 4265 | * owner. |
|
| 4266 | * @opt_param string regionCode The regionCode parameter instructs the API to |
|
| 4267 | * select a video chart available in the specified region. This parameter can |
|
| 4268 | * only be used in conjunction with the chart parameter. The parameter value is |
|
| 4269 | * an ISO 3166-1 alpha-2 country code. |
|
| 4270 | * @opt_param string locale DEPRECATED |
|
| 4271 | * @opt_param string videoCategoryId The videoCategoryId parameter identifies |
|
| 4272 | * the video category for which the chart should be retrieved. This parameter |
|
| 4273 | * can only be used in conjunction with the chart parameter. By default, charts |
|
| 4274 | * are not restricted to a particular category. |
|
| 4275 | * @opt_param string chart The chart parameter identifies the chart that you |
|
| 4276 | * want to retrieve. |
|
| 4277 | * @opt_param string maxResults The maxResults parameter specifies the maximum |
|
| 4278 | * number of items that should be returned in the result set. |
|
| 4279 | * |
|
| 4280 | * Note: This parameter is supported for use in conjunction with the myRating |
|
| 4281 | * parameter, but it is not supported for use in conjunction with the id |
|
| 4282 | * parameter. |
|
| 4283 | * @opt_param string pageToken The pageToken parameter identifies a specific |
|
| 4284 | * page in the result set that should be returned. In an API response, the |
|
| 4285 | * nextPageToken and prevPageToken properties identify other pages that could be |
|
| 4286 | * retrieved. |
|
| 4287 | * |
|
| 4288 | * Note: This parameter is supported for use in conjunction with the myRating |
|
| 4289 | * parameter, but it is not supported for use in conjunction with the id |
|
| 4290 | * parameter. |
|
| 4291 | * @opt_param string debugProjectIdOverride The debugProjectIdOverride parameter |
|
| 4292 | * should be used for mimicking a request for a certain project ID |
|
| 4293 | * @opt_param string hl The hl parameter instructs the API to retrieve localized |
|
| 4294 | * resource metadata for a specific application language that the YouTube |
|
| 4295 | * website supports. The parameter value must be a language code included in the |
|
| 4296 | * list returned by the i18nLanguages.list method. |
|
| 4297 | * |
|
| 4298 | * If localized resource details are available in that language, the resource's |
|
| 4299 | * snippet.localized object will contain the localized values. However, if |
|
| 4300 | * localized details are not available, the snippet.localized object will |
|
| 4301 | * contain resource details in the resource's default language. |
|
| 4302 | * @opt_param string myRating Set this parameter's value to like or dislike to |
|
| 4303 | * instruct the API to only return videos liked or disliked by the authenticated |
|
| 4304 | * user. |
|
| 4305 | * @opt_param string id The id parameter specifies a comma-separated list of the |
|
| 4306 | * YouTube video ID(s) for the resource(s) that are being retrieved. In a video |
|
| 4307 | * resource, the id property specifies the video's ID. |
|
| 4308 | * @return Google_Service_YouTube_VideoListResponse |
|
| 4309 | */ |
|
| 4310 | public function listVideos($part, $optParams = array()) |
|
| 4311 | { |
|
| 4312 | $params = array('part' => $part); |
|
| 4313 | $params = array_merge($params, $optParams); |
|
| 4314 | return $this->call('list', array($params), "Google_Service_YouTube_VideoListResponse"); |
|
| 4315 | } |
|
| 4316 | ||
| 4317 | /** |
|
| 4318 | * Add a like or dislike rating to a video or remove a rating from a video. |
|
| 4319 | * (videos.rate) |
|
| 4320 | * |
|
| 4321 | * @param string $id The id parameter specifies the YouTube video ID of the |
|
| 4322 | * video that is being rated or having its rating removed. |
|
| 4323 | * @param string $rating Specifies the rating to record. |
|
| 4324 | * @param array $optParams Optional parameters. |
|
| 4325 | */ |
|
| 4326 | public function rate($id, $rating, $optParams = array()) |
|
| 4327 | { |
|
| 4328 | $params = array('id' => $id, 'rating' => $rating); |
|
| 4329 | $params = array_merge($params, $optParams); |
|
| 4330 | return $this->call('rate', array($params)); |
|
| 4331 | } |
|
| 4332 | ||
| 4333 | /** |
|
| 4334 | * Report abuse for a video. (videos.reportAbuse) |
|
| 4335 | * |
|
| 4336 | * @param Google_VideoAbuseReport $postBody |
|
| 4337 | * @param array $optParams Optional parameters. |
|
| 4338 | * |
|
| 4339 | * @opt_param string onBehalfOfContentOwner Note: This parameter is intended |
|
| 4340 | * exclusively for YouTube content partners. |
|
| 4341 | * |
|
| 4342 | * The onBehalfOfContentOwner parameter indicates that the request's |
|
| 4343 | * authorization credentials identify a YouTube CMS user who is acting on behalf |
|
| 4344 | * of the content owner specified in the parameter value. This parameter is |
|
| 4345 | * intended for YouTube content partners that own and manage many different |
|
| 4346 | * YouTube channels. It allows content owners to authenticate once and get |
|
| 4347 | * access to all their video and channel data, without having to provide |
|
| 4348 | * authentication credentials for each individual channel. The CMS account that |
|
| 4349 | * the user authenticates with must be linked to the specified YouTube content |
|
| 4350 | * owner. |
|
| 4351 | */ |
|
| 4352 | public function reportAbuse(Google_Service_YouTube_VideoAbuseReport $postBody, $optParams = array()) |
|
| 4353 | { |
|
| 4354 | $params = array('postBody' => $postBody); |
|
| 4355 | $params = array_merge($params, $optParams); |
|
| 4356 | return $this->call('reportAbuse', array($params)); |
|
| 4357 | } |
|
| 4358 | ||
| 4359 | /** |
|
| 4360 | * Updates a video's metadata. (videos.update) |
|
| 4361 | * |
|
| 4362 | * @param string $part The part parameter serves two purposes in this operation. |
|
| 4363 | * It identifies the properties that the write operation will set as well as the |
|
| 4364 | * properties that the API response will include. |
|
| 4365 | * |
|
| 4366 | * Note that this method will override the existing values for all of the |
|
| 4367 | * mutable properties that are contained in any parts that the parameter value |
|
| 4368 | * specifies. For example, a video's privacy setting is contained in the status |
|
| 4369 | * part. As such, if your request is updating a private video, and the request's |
|
| 4370 | * part parameter value includes the status part, the video's privacy setting |
|
| 4371 | * will be updated to whatever value the request body specifies. If the request |
|
| 4372 | * body does not specify a value, the existing privacy setting will be removed |
|
| 4373 | * and the video will revert to the default privacy setting. |
|
| 4374 | * |
|
| 4375 | * In addition, not all parts contain properties that can be set when inserting |
|
| 4376 | * or updating a video. For example, the statistics object encapsulates |
|
| 4377 | * statistics that YouTube calculates for a video and does not contain values |
|
| 4378 | * that you can set or modify. If the parameter value specifies a part that does |
|
| 4379 | * not contain mutable values, that part will still be included in the API |
|
| 4380 | * response. |
|
| 4381 | * @param Google_Video $postBody |
|
| 4382 | * @param array $optParams Optional parameters. |
|
| 4383 | * |
|
| 4384 | * @opt_param string onBehalfOfContentOwner Note: This parameter is intended |
|
| 4385 | * exclusively for YouTube content partners. |
|
| 4386 | * |
|
| 4387 | * The onBehalfOfContentOwner parameter indicates that the request's |
|
| 4388 | * authorization credentials identify a YouTube CMS user who is acting on behalf |
|
| 4389 | * of the content owner specified in the parameter value. This parameter is |
|
| 4390 | * intended for YouTube content partners that own and manage many different |
|
| 4391 | * YouTube channels. It allows content owners to authenticate once and get |
|
| 4392 | * access to all their video and channel data, without having to provide |
|
| 4393 | * authentication credentials for each individual channel. The actual CMS |
|
| 4394 | * account that the user authenticates with must be linked to the specified |
|
| 4395 | * YouTube content owner. |
|
| 4396 | * @return Google_Service_YouTube_Video |
|
| 4397 | */ |
|
| 4398 | public function update($part, Google_Service_YouTube_Video $postBody, $optParams = array()) |
|
| 4399 | { |
|
| 4400 | $params = array('part' => $part, 'postBody' => $postBody); |
|
| 4401 | $params = array_merge($params, $optParams); |
|
| 4402 | return $this->call('update', array($params), "Google_Service_YouTube_Video"); |
|
| 4403 | } |
|
| 4404 | } |
|
| 4405 | ||
| 4406 | /** |
|
| 4407 | * The "watermarks" collection of methods. |
|