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.adclients.html">adclients</a></h1>
     76 <h2>Instance Methods</h2>
     77 <p class="toc_element">
     78   <code><a href="#get">get(adClientId)</a></code></p>
     79 <p class="firstline">Get information about one of the ad clients in the Host AdSense account.</p>
     80 <p class="toc_element">
     81   <code><a href="#list">list(pageToken=None, maxResults=None)</a></code></p>
     82 <p class="firstline">List all host ad clients in this AdSense account.</p>
     83 <p class="toc_element">
     84   <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
     85 <p class="firstline">Retrieves the next page of results.</p>
     86 <h3>Method Details</h3>
     87 <div class="method">
     88     <code class="details" id="get">get(adClientId)</code>
     89   <pre>Get information about one of the ad clients in the Host AdSense account.
     90 
     91 Args:
     92   adClientId: string, Ad client to get. (required)
     93 
     94 Returns:
     95   An object of the form:
     96 
     97     {
     98     "productCode": "A String", # This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.
     99     "kind": "adsensehost#adClient", # Kind of resource this is, in this case adsensehost#adClient.
    100     "id": "A String", # Unique identifier of this ad client.
    101     "arcOptIn": True or False, # Whether this ad client is opted in to ARC.
    102     "supportsReporting": True or False, # Whether this ad client supports being reported on.
    103   }</pre>
    104 </div>
    105 
    106 <div class="method">
    107     <code class="details" id="list">list(pageToken=None, maxResults=None)</code>
    108   <pre>List all host ad clients in this AdSense account.
    109 
    110 Args:
    111   pageToken: string, A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
    112   maxResults: integer, The maximum number of ad clients to include in the response, used for paging.
    113 
    114 Returns:
    115   An object of the form:
    116 
    117     {
    118     "nextPageToken": "A String", # Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's "pageToken" value to this.
    119     "items": [ # The ad clients returned in this list response.
    120       {
    121         "productCode": "A String", # This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.
    122         "kind": "adsensehost#adClient", # Kind of resource this is, in this case adsensehost#adClient.
    123         "id": "A String", # Unique identifier of this ad client.
    124         "arcOptIn": True or False, # Whether this ad client is opted in to ARC.
    125         "supportsReporting": True or False, # Whether this ad client supports being reported on.
    126       },
    127     ],
    128     "kind": "adsensehost#adClients", # Kind of list this is, in this case adsensehost#adClients.
    129     "etag": "A String", # ETag of this response for caching purposes.
    130   }</pre>
    131 </div>
    132 
    133 <div class="method">
    134     <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
    135   <pre>Retrieves the next page of results.
    136 
    137 Args:
    138   previous_request: The request for the previous page. (required)
    139   previous_response: The response from the request for the previous page. (required)
    140 
    141 Returns:
    142   A request object that you can call 'execute()' on to request the next
    143   page. Returns None if there are no more items in the collection.
    144     </pre>
    145 </div>
    146 
    147 </body></html>