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="adexchangeseller_v1.html">Ad Exchange Seller API</a> . <a href="adexchangeseller_v1.adunits.html">adunits</a></h1>
     76 <h2>Instance Methods</h2>
     77 <p class="toc_element">
     78   <code><a href="adexchangeseller_v1.adunits.customchannels.html">customchannels()</a></code>
     79 </p>
     80 <p class="firstline">Returns the customchannels Resource.</p>
     81 
     82 <p class="toc_element">
     83   <code><a href="#get">get(adClientId, adUnitId)</a></code></p>
     84 <p class="firstline">Gets the specified ad unit in the specified ad client.</p>
     85 <p class="toc_element">
     86   <code><a href="#list">list(adClientId, pageToken=None, includeInactive=None, maxResults=None)</a></code></p>
     87 <p class="firstline">List all ad units in the specified ad client for this Ad Exchange account.</p>
     88 <p class="toc_element">
     89   <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
     90 <p class="firstline">Retrieves the next page of results.</p>
     91 <h3>Method Details</h3>
     92 <div class="method">
     93     <code class="details" id="get">get(adClientId, adUnitId)</code>
     94   <pre>Gets the specified ad unit in the specified ad client.
     95 
     96 Args:
     97   adClientId: string, Ad client for which to get the ad unit. (required)
     98   adUnitId: string, Ad unit to retrieve. (required)
     99 
    100 Returns:
    101   An object of the form:
    102 
    103     {
    104     "status": "A String", # Status of this ad unit. Possible values are:
    105         # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
    106         #
    107         # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
    108         #
    109         # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
    110     "kind": "adexchangeseller#adUnit", # Kind of resource this is, in this case adexchangeseller#adUnit.
    111     "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
    112     "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
    113     "name": "A String", # Name of this ad unit.
    114   }</pre>
    115 </div>
    116 
    117 <div class="method">
    118     <code class="details" id="list">list(adClientId, pageToken=None, includeInactive=None, maxResults=None)</code>
    119   <pre>List all ad units in the specified ad client for this Ad Exchange account.
    120 
    121 Args:
    122   adClientId: string, Ad client for which to list ad units. (required)
    123   pageToken: string, A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
    124   includeInactive: boolean, Whether to include inactive ad units. Default: true.
    125   maxResults: integer, The maximum number of ad units to include in the response, used for paging.
    126 
    127 Returns:
    128   An object of the form:
    129 
    130     {
    131     "nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
    132     "items": [ # The ad units returned in this list response.
    133       {
    134         "status": "A String", # Status of this ad unit. Possible values are:
    135             # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
    136             #
    137             # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
    138             #
    139             # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
    140         "kind": "adexchangeseller#adUnit", # Kind of resource this is, in this case adexchangeseller#adUnit.
    141         "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
    142         "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
    143         "name": "A String", # Name of this ad unit.
    144       },
    145     ],
    146     "kind": "adexchangeseller#adUnits", # Kind of list this is, in this case adexchangeseller#adUnits.
    147     "etag": "A String", # ETag of this response for caching purposes.
    148   }</pre>
    149 </div>
    150 
    151 <div class="method">
    152     <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
    153   <pre>Retrieves the next page of results.
    154 
    155 Args:
    156   previous_request: The request for the previous page. (required)
    157   previous_response: The response from the request for the previous page. (required)
    158 
    159 Returns:
    160   A request object that you can call 'execute()' on to request the next
    161   page. Returns None if there are no more items in the collection.
    162     </pre>
    163 </div>
    164 
    165 </body></html>