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.urlchannels.html">urlchannels</a></h1>
     76 <h2>Instance Methods</h2>
     77 <p class="toc_element">
     78   <code><a href="#delete">delete(adClientId, urlChannelId)</a></code></p>
     79 <p class="firstline">Delete a URL channel from the host AdSense account.</p>
     80 <p class="toc_element">
     81   <code><a href="#insert">insert(adClientId, body)</a></code></p>
     82 <p class="firstline">Add a new URL channel to the host AdSense account.</p>
     83 <p class="toc_element">
     84   <code><a href="#list">list(adClientId, pageToken=None, maxResults=None)</a></code></p>
     85 <p class="firstline">List all host URL channels in the host AdSense account.</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 <h3>Method Details</h3>
     90 <div class="method">
     91     <code class="details" id="delete">delete(adClientId, urlChannelId)</code>
     92   <pre>Delete a URL channel from the host AdSense account.
     93 
     94 Args:
     95   adClientId: string, Ad client from which to delete the URL channel. (required)
     96   urlChannelId: string, URL channel to delete. (required)
     97 
     98 Returns:
     99   An object of the form:
    100 
    101     {
    102       "kind": "adsensehost#urlChannel", # Kind of resource this is, in this case adsensehost#urlChannel.
    103       "id": "A String", # Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
    104       "urlPattern": "A String", # URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home
    105     }</pre>
    106 </div>
    107 
    108 <div class="method">
    109     <code class="details" id="insert">insert(adClientId, body)</code>
    110   <pre>Add a new URL channel to the host AdSense account.
    111 
    112 Args:
    113   adClientId: string, Ad client to which the new URL channel will be added. (required)
    114   body: object, The request body. (required)
    115     The object takes the form of:
    116 
    117 {
    118     "kind": "adsensehost#urlChannel", # Kind of resource this is, in this case adsensehost#urlChannel.
    119     "id": "A String", # Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
    120     "urlPattern": "A String", # URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home
    121   }
    122 
    123 
    124 Returns:
    125   An object of the form:
    126 
    127     {
    128       "kind": "adsensehost#urlChannel", # Kind of resource this is, in this case adsensehost#urlChannel.
    129       "id": "A String", # Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
    130       "urlPattern": "A String", # URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home
    131     }</pre>
    132 </div>
    133 
    134 <div class="method">
    135     <code class="details" id="list">list(adClientId, pageToken=None, maxResults=None)</code>
    136   <pre>List all host URL channels in the host AdSense account.
    137 
    138 Args:
    139   adClientId: string, Ad client for which to list URL channels. (required)
    140   pageToken: string, A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
    141   maxResults: integer, The maximum number of URL channels to include in the response, used for paging.
    142 
    143 Returns:
    144   An object of the form:
    145 
    146     {
    147     "nextPageToken": "A String", # Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
    148     "items": [ # The URL channels returned in this list response.
    149       {
    150           "kind": "adsensehost#urlChannel", # Kind of resource this is, in this case adsensehost#urlChannel.
    151           "id": "A String", # Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
    152           "urlPattern": "A String", # URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home
    153         },
    154     ],
    155     "kind": "adsensehost#urlChannels", # Kind of list this is, in this case adsensehost#urlChannels.
    156     "etag": "A String", # ETag of this response for caching purposes.
    157   }</pre>
    158 </div>
    159 
    160 <div class="method">
    161     <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
    162   <pre>Retrieves the next page of results.
    163 
    164 Args:
    165   previous_request: The request for the previous page. (required)
    166   previous_response: The response from the request for the previous page. (required)
    167 
    168 Returns:
    169   A request object that you can call 'execute()' on to request the next
    170   page. Returns None if there are no more items in the collection.
    171     </pre>
    172 </div>
    173 
    174 </body></html>