| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="youtubeAnalytics_v1.html">YouTube Analytics API</a> . <a href="youtubeAnalytics_v1.groups.html">groups</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#delete">delete(id, onBehalfOfContentOwner=None)</a></code></p> |
| 79 | <p class="firstline">Deletes a group.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#insert">insert(body, onBehalfOfContentOwner=None)</a></code></p> |
| 82 | <p class="firstline">Creates a group.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#list">list(onBehalfOfContentOwner=None, mine=None, id=None)</a></code></p> |
| 85 | <p class="firstline">Returns a collection of groups that match the API request parameters. For example, you can retrieve all groups that the authenticated user owns, or you can retrieve one or more groups by their unique IDs.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#update">update(body, onBehalfOfContentOwner=None)</a></code></p> |
| 88 | <p class="firstline">Modifies a group. For example, you could change a group's title.</p> |
| 89 | <h3>Method Details</h3> |
| 90 | <div class="method"> |
| 91 | <code class="details" id="delete">delete(id, onBehalfOfContentOwner=None)</code> |
| 92 | <pre>Deletes a group. |
| 93 | |
| 94 | Args: |
| 95 | id: string, The id parameter specifies the YouTube group ID for the group that is being deleted. (required) |
| 96 | onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners. |
| 97 | |
| 98 | The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. |
| 99 | </pre> |
| 100 | </div> |
| 101 | |
| 102 | <div class="method"> |
| 103 | <code class="details" id="insert">insert(body, onBehalfOfContentOwner=None)</code> |
| 104 | <pre>Creates a group. |
| 105 | |
| 106 | Args: |
| 107 | body: object, The request body. (required) |
| 108 | The object takes the form of: |
| 109 | |
| 110 | { |
| 111 | "snippet": { |
| 112 | "publishedAt": "A String", |
| 113 | "title": "A String", |
| 114 | }, |
| 115 | "contentDetails": { |
| 116 | "itemCount": "A String", |
| 117 | "itemType": "A String", |
| 118 | }, |
| 119 | "kind": "youtube#group", |
| 120 | "etag": "A String", |
| 121 | "id": "A String", |
| 122 | } |
| 123 | |
| 124 | onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners. |
| 125 | |
| 126 | The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. |
| 127 | |
| 128 | Returns: |
| 129 | An object of the form: |
| 130 | |
| 131 | { |
| 132 | "snippet": { |
| 133 | "publishedAt": "A String", |
| 134 | "title": "A String", |
| 135 | }, |
| 136 | "contentDetails": { |
| 137 | "itemCount": "A String", |
| 138 | "itemType": "A String", |
| 139 | }, |
| 140 | "kind": "youtube#group", |
| 141 | "etag": "A String", |
| 142 | "id": "A String", |
| 143 | }</pre> |
| 144 | </div> |
| 145 | |
| 146 | <div class="method"> |
| 147 | <code class="details" id="list">list(onBehalfOfContentOwner=None, mine=None, id=None)</code> |
| 148 | <pre>Returns a collection of groups that match the API request parameters. For example, you can retrieve all groups that the authenticated user owns, or you can retrieve one or more groups by their unique IDs. |
| 149 | |
| 150 | Args: |
| 151 | onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners. |
| 152 | |
| 153 | The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. |
| 154 | mine: boolean, Set this parameter's value to true to instruct the API to only return groups owned by the authenticated user. |
| 155 | id: string, The id parameter specifies a comma-separated list of the YouTube group ID(s) for the resource(s) that are being retrieved. In a group resource, the id property specifies the group's YouTube group ID. |
| 156 | |
| 157 | Returns: |
| 158 | An object of the form: |
| 159 | |
| 160 | { # A paginated list of grouList resources returned in response to a youtubeAnalytics.groupApi.list request. |
| 161 | "items": [ |
| 162 | { |
| 163 | "snippet": { |
| 164 | "publishedAt": "A String", |
| 165 | "title": "A String", |
| 166 | }, |
| 167 | "contentDetails": { |
| 168 | "itemCount": "A String", |
| 169 | "itemType": "A String", |
| 170 | }, |
| 171 | "kind": "youtube#group", |
| 172 | "etag": "A String", |
| 173 | "id": "A String", |
| 174 | }, |
| 175 | ], |
| 176 | "kind": "youtube#groupListResponse", |
| 177 | "etag": "A String", |
| 178 | }</pre> |
| 179 | </div> |
| 180 | |
| 181 | <div class="method"> |
| 182 | <code class="details" id="update">update(body, onBehalfOfContentOwner=None)</code> |
| 183 | <pre>Modifies a group. For example, you could change a group's title. |
| 184 | |
| 185 | Args: |
| 186 | body: object, The request body. (required) |
| 187 | The object takes the form of: |
| 188 | |
| 189 | { |
| 190 | "snippet": { |
| 191 | "publishedAt": "A String", |
| 192 | "title": "A String", |
| 193 | }, |
| 194 | "contentDetails": { |
| 195 | "itemCount": "A String", |
| 196 | "itemType": "A String", |
| 197 | }, |
| 198 | "kind": "youtube#group", |
| 199 | "etag": "A String", |
| 200 | "id": "A String", |
| 201 | } |
| 202 | |
| 203 | onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners. |
| 204 | |
| 205 | The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. |
| 206 | |
| 207 | Returns: |
| 208 | An object of the form: |
| 209 | |
| 210 | { |
| 211 | "snippet": { |
| 212 | "publishedAt": "A String", |
| 213 | "title": "A String", |
| 214 | }, |
| 215 | "contentDetails": { |
| 216 | "itemCount": "A String", |
| 217 | "itemType": "A String", |
| 218 | }, |
| 219 | "kind": "youtube#group", |
| 220 | "etag": "A String", |
| 221 | "id": "A String", |
| 222 | }</pre> |
| 223 | </div> |
| 224 | |
| 225 | </body></html> |