1<html><body> 2<style> 3 4body, 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 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, 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_v2_0.html">Ad Exchange Seller API</a> . <a href="adexchangeseller_v2_0.accounts.html">accounts</a> . <a href="adexchangeseller_v2_0.accounts.customchannels.html">customchannels</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#get">get(accountId, adClientId, customChannelId)</a></code></p> 79<p class="firstline">Get the specified custom channel from the specified ad client.</p> 80<p class="toc_element"> 81 <code><a href="#list">list(accountId, adClientId, pageToken=None, maxResults=None)</a></code></p> 82<p class="firstline">List all custom channels in the specified ad client for this Ad Exchange 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(accountId, adClientId, customChannelId)</code> 89 <pre>Get the specified custom channel from the specified ad client. 90 91Args: 92 accountId: string, Account to which the ad client belongs. (required) 93 adClientId: string, Ad client which contains the custom channel. (required) 94 customChannelId: string, Custom channel to retrieve. (required) 95 96Returns: 97 An object of the form: 98 99 { 100 "kind": "adexchangeseller#customChannel", # Kind of resource this is, in this case adexchangeseller#customChannel. 101 "code": "A String", # Code of this custom channel, not necessarily unique across ad clients. 102 "targetingInfo": { # The targeting information of this custom channel, if activated. 103 "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS. 104 "adsAppearOn": "A String", # The name used to describe this channel externally. 105 "siteLanguage": "A String", # The language of the sites ads will be displayed on. 106 "description": "A String", # The external description of the channel. 107 }, 108 "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. 109 "name": "A String", # Name of this custom channel. 110 }</pre> 111</div> 112 113<div class="method"> 114 <code class="details" id="list">list(accountId, adClientId, pageToken=None, maxResults=None)</code> 115 <pre>List all custom channels in the specified ad client for this Ad Exchange account. 116 117Args: 118 accountId: string, Account to which the ad client belongs. (required) 119 adClientId: string, Ad client for which to list custom channels. (required) 120 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. 121 maxResults: integer, The maximum number of custom channels to include in the response, used for paging. 122 123Returns: 124 An object of the form: 125 126 { 127 "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. 128 "items": [ # The custom channels returned in this list response. 129 { 130 "kind": "adexchangeseller#customChannel", # Kind of resource this is, in this case adexchangeseller#customChannel. 131 "code": "A String", # Code of this custom channel, not necessarily unique across ad clients. 132 "targetingInfo": { # The targeting information of this custom channel, if activated. 133 "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS. 134 "adsAppearOn": "A String", # The name used to describe this channel externally. 135 "siteLanguage": "A String", # The language of the sites ads will be displayed on. 136 "description": "A String", # The external description of the channel. 137 }, 138 "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. 139 "name": "A String", # Name of this custom channel. 140 }, 141 ], 142 "kind": "adexchangeseller#customChannels", # Kind of list this is, in this case adexchangeseller#customChannels. 143 "etag": "A String", # ETag of this response for caching purposes. 144 }</pre> 145</div> 146 147<div class="method"> 148 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 149 <pre>Retrieves the next page of results. 150 151Args: 152 previous_request: The request for the previous page. (required) 153 previous_response: The response from the request for the previous page. (required) 154 155Returns: 156 A request object that you can call 'execute()' on to request the next 157 page. Returns None if there are no more items in the collection. 158 </pre> 159</div> 160 161</body></html>