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="adsensehost_v4_1.html">AdSense Host API</a> . <a href="adsensehost_v4_1.customchannels.html">customchannels</a></h1>
     76 <h2>Instance Methods</h2>
     77 <p class="toc_element">
     78   <code><a href="#delete">delete(adClientId, customChannelId)</a></code></p>
     79 <p class="firstline">Delete a specific custom channel from the host AdSense account.</p>
     80 <p class="toc_element">
     81   <code><a href="#get">get(adClientId, customChannelId)</a></code></p>
     82 <p class="firstline">Get a specific custom channel from the host AdSense account.</p>
     83 <p class="toc_element">
     84   <code><a href="#insert">insert(adClientId, body)</a></code></p>
     85 <p class="firstline">Add a new custom channel to the host AdSense account.</p>
     86 <p class="toc_element">
     87   <code><a href="#list">list(adClientId, pageToken=None, maxResults=None)</a></code></p>
     88 <p class="firstline">List all host custom channels in this AdSense account.</p>
     89 <p class="toc_element">
     90   <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
     91 <p class="firstline">Retrieves the next page of results.</p>
     92 <p class="toc_element">
     93   <code><a href="#patch">patch(adClientId, customChannelId, body)</a></code></p>
     94 <p class="firstline">Update a custom channel in the host AdSense account. This method supports patch semantics.</p>
     95 <p class="toc_element">
     96   <code><a href="#update">update(adClientId, body)</a></code></p>
     97 <p class="firstline">Update a custom channel in the host AdSense account.</p>
     98 <h3>Method Details</h3>
     99 <div class="method">
    100     <code class="details" id="delete">delete(adClientId, customChannelId)</code>
    101   <pre>Delete a specific custom channel from the host AdSense account.
    102 
    103 Args:
    104   adClientId: string, Ad client from which to delete the custom channel. (required)
    105   customChannelId: string, Custom channel to delete. (required)
    106 
    107 Returns:
    108   An object of the form:
    109 
    110     {
    111       "kind": "adsensehost#customChannel", # Kind of resource this is, in this case adsensehost#customChannel.
    112       "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
    113       "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
    114       "name": "A String", # Name of this custom channel.
    115     }</pre>
    116 </div>
    117 
    118 <div class="method">
    119     <code class="details" id="get">get(adClientId, customChannelId)</code>
    120   <pre>Get a specific custom channel from the host AdSense account.
    121 
    122 Args:
    123   adClientId: string, Ad client from which to get the custom channel. (required)
    124   customChannelId: string, Custom channel to get. (required)
    125 
    126 Returns:
    127   An object of the form:
    128 
    129     {
    130       "kind": "adsensehost#customChannel", # Kind of resource this is, in this case adsensehost#customChannel.
    131       "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
    132       "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
    133       "name": "A String", # Name of this custom channel.
    134     }</pre>
    135 </div>
    136 
    137 <div class="method">
    138     <code class="details" id="insert">insert(adClientId, body)</code>
    139   <pre>Add a new custom channel to the host AdSense account.
    140 
    141 Args:
    142   adClientId: string, Ad client to which the new custom channel will be added. (required)
    143   body: object, The request body. (required)
    144     The object takes the form of:
    145 
    146 {
    147     "kind": "adsensehost#customChannel", # Kind of resource this is, in this case adsensehost#customChannel.
    148     "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
    149     "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
    150     "name": "A String", # Name of this custom channel.
    151   }
    152 
    153 
    154 Returns:
    155   An object of the form:
    156 
    157     {
    158       "kind": "adsensehost#customChannel", # Kind of resource this is, in this case adsensehost#customChannel.
    159       "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
    160       "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
    161       "name": "A String", # Name of this custom channel.
    162     }</pre>
    163 </div>
    164 
    165 <div class="method">
    166     <code class="details" id="list">list(adClientId, pageToken=None, maxResults=None)</code>
    167   <pre>List all host custom channels in this AdSense account.
    168 
    169 Args:
    170   adClientId: string, Ad client for which to list custom channels. (required)
    171   pageToken: string, A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
    172   maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
    173 
    174 Returns:
    175   An object of the form:
    176 
    177     {
    178     "nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
    179     "items": [ # The custom channels returned in this list response.
    180       {
    181           "kind": "adsensehost#customChannel", # Kind of resource this is, in this case adsensehost#customChannel.
    182           "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
    183           "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
    184           "name": "A String", # Name of this custom channel.
    185         },
    186     ],
    187     "kind": "adsensehost#customChannels", # Kind of list this is, in this case adsensehost#customChannels.
    188     "etag": "A String", # ETag of this response for caching purposes.
    189   }</pre>
    190 </div>
    191 
    192 <div class="method">
    193     <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
    194   <pre>Retrieves the next page of results.
    195 
    196 Args:
    197   previous_request: The request for the previous page. (required)
    198   previous_response: The response from the request for the previous page. (required)
    199 
    200 Returns:
    201   A request object that you can call 'execute()' on to request the next
    202   page. Returns None if there are no more items in the collection.
    203     </pre>
    204 </div>
    205 
    206 <div class="method">
    207     <code class="details" id="patch">patch(adClientId, customChannelId, body)</code>
    208   <pre>Update a custom channel in the host AdSense account. This method supports patch semantics.
    209 
    210 Args:
    211   adClientId: string, Ad client in which the custom channel will be updated. (required)
    212   customChannelId: string, Custom channel to get. (required)
    213   body: object, The request body. (required)
    214     The object takes the form of:
    215 
    216 {
    217     "kind": "adsensehost#customChannel", # Kind of resource this is, in this case adsensehost#customChannel.
    218     "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
    219     "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
    220     "name": "A String", # Name of this custom channel.
    221   }
    222 
    223 
    224 Returns:
    225   An object of the form:
    226 
    227     {
    228       "kind": "adsensehost#customChannel", # Kind of resource this is, in this case adsensehost#customChannel.
    229       "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
    230       "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
    231       "name": "A String", # Name of this custom channel.
    232     }</pre>
    233 </div>
    234 
    235 <div class="method">
    236     <code class="details" id="update">update(adClientId, body)</code>
    237   <pre>Update a custom channel in the host AdSense account.
    238 
    239 Args:
    240   adClientId: string, Ad client in which the custom channel will be updated. (required)
    241   body: object, The request body. (required)
    242     The object takes the form of:
    243 
    244 {
    245     "kind": "adsensehost#customChannel", # Kind of resource this is, in this case adsensehost#customChannel.
    246     "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
    247     "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
    248     "name": "A String", # Name of this custom channel.
    249   }
    250 
    251 
    252 Returns:
    253   An object of the form:
    254 
    255     {
    256       "kind": "adsensehost#customChannel", # Kind of resource this is, in this case adsensehost#customChannel.
    257       "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
    258       "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
    259       "name": "A String", # Name of this custom channel.
    260     }</pre>
    261 </div>
    262 
    263 </body></html>