Home | History | Annotate | Download | only in dyn 
      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, pageToken=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="#list_next">list_next(previous_request, previous_response)</a></code></p>
     88 <p class="firstline">Retrieves the next page of results.</p>
     89 <p class="toc_element">
     90   <code><a href="#update">update(body, onBehalfOfContentOwner=None)</a></code></p>
     91 <p class="firstline">Modifies a group. For example, you could change a group's title.</p>
     92 <h3>Method Details</h3>
     93 <div class="method">
     94     <code class="details" id="delete">delete(id, onBehalfOfContentOwner=None)</code>
     95   <pre>Deletes a group.
     96 
     97 Args:
     98   id: string, The id parameter specifies the YouTube group ID for the group that is being deleted. (required)
     99   onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
    100 
    101 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.
    102 </pre>
    103 </div>
    104 
    105 <div class="method">
    106     <code class="details" id="insert">insert(body, onBehalfOfContentOwner=None)</code>
    107   <pre>Creates a group.
    108 
    109 Args:
    110   body: object, The request body. (required)
    111     The object takes the form of:
    112 
    113 {
    114     "snippet": {
    115       "publishedAt": "A String",
    116       "title": "A String",
    117     },
    118     "contentDetails": {
    119       "itemCount": "A String",
    120       "itemType": "A String",
    121     },
    122     "kind": "youtube#group",
    123     "etag": "A String",
    124     "id": "A String",
    125   }
    126 
    127   onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
    128 
    129 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.
    130 
    131 Returns:
    132   An object of the form:
    133 
    134     {
    135       "snippet": {
    136         "publishedAt": "A String",
    137         "title": "A String",
    138       },
    139       "contentDetails": {
    140         "itemCount": "A String",
    141         "itemType": "A String",
    142       },
    143       "kind": "youtube#group",
    144       "etag": "A String",
    145       "id": "A String",
    146     }</pre>
    147 </div>
    148 
    149 <div class="method">
    150     <code class="details" id="list">list(onBehalfOfContentOwner=None, pageToken=None, mine=None, id=None)</code>
    151   <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.
    152 
    153 Args:
    154   onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
    155 
    156 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.
    157   pageToken: string, The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identifies the next page that can be retrieved.
    158   mine: boolean, Set this parameter's value to true to instruct the API to only return groups owned by the authenticated user.
    159   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.
    160 
    161 Returns:
    162   An object of the form:
    163 
    164     { # A paginated list of grouList resources returned in response to a youtubeAnalytics.groupApi.list request.
    165     "nextPageToken": "A String",
    166     "items": [
    167       {
    168           "snippet": {
    169             "publishedAt": "A String",
    170             "title": "A String",
    171           },
    172           "contentDetails": {
    173             "itemCount": "A String",
    174             "itemType": "A String",
    175           },
    176           "kind": "youtube#group",
    177           "etag": "A String",
    178           "id": "A String",
    179         },
    180     ],
    181     "kind": "youtube#groupListResponse",
    182     "etag": "A String",
    183   }</pre>
    184 </div>
    185 
    186 <div class="method">
    187     <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
    188   <pre>Retrieves the next page of results.
    189 
    190 Args:
    191   previous_request: The request for the previous page. (required)
    192   previous_response: The response from the request for the previous page. (required)
    193 
    194 Returns:
    195   A request object that you can call 'execute()' on to request the next
    196   page. Returns None if there are no more items in the collection.
    197     </pre>
    198 </div>
    199 
    200 <div class="method">
    201     <code class="details" id="update">update(body, onBehalfOfContentOwner=None)</code>
    202   <pre>Modifies a group. For example, you could change a group's title.
    203 
    204 Args:
    205   body: object, The request body. (required)
    206     The object takes the form of:
    207 
    208 {
    209     "snippet": {
    210       "publishedAt": "A String",
    211       "title": "A String",
    212     },
    213     "contentDetails": {
    214       "itemCount": "A String",
    215       "itemType": "A String",
    216     },
    217     "kind": "youtube#group",
    218     "etag": "A String",
    219     "id": "A String",
    220   }
    221 
    222   onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
    223 
    224 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.
    225 
    226 Returns:
    227   An object of the form:
    228 
    229     {
    230       "snippet": {
    231         "publishedAt": "A String",
    232         "title": "A String",
    233       },
    234       "contentDetails": {
    235         "itemCount": "A String",
    236         "itemType": "A String",
    237       },
    238       "kind": "youtube#group",
    239       "etag": "A String",
    240       "id": "A String",
    241     }</pre>
    242 </div>
    243 
    244 </body></html>