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="adsense_v2.html">AdSense Management API</a> . <a href="adsense_v2.accounts.html">accounts</a> . <a href="adsense_v2.accounts.adclients.html">adclients</a> . <a href="adsense_v2.accounts.adclients.customchannels.html">customchannels</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 82<p class="firstline">Gets information about the selected custom channel.</p> 83<p class="toc_element"> 84 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Lists all the custom channels available in an ad client.</p> 86<p class="toc_element"> 87 <code><a href="#listLinkedAdUnits">listLinkedAdUnits(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Lists all the ad units available for a custom channel.</p> 89<p class="toc_element"> 90 <code><a href="#listLinkedAdUnits_next">listLinkedAdUnits_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="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<h3>Method Details</h3> 96<div class="method"> 97 <code class="details" id="close">close()</code> 98 <pre>Close httplib2 connections.</pre> 99</div> 100 101<div class="method"> 102 <code class="details" id="get">get(name, x__xgafv=None)</code> 103 <pre>Gets information about the selected custom channel. 104 105Args: 106 name: string, Required. Name of the custom channel. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel} (required) 107 x__xgafv: string, V1 error format. 108 Allowed values 109 1 - v1 error format 110 2 - v2 error format 111 112Returns: 113 An object of the form: 114 115 { # Representation of a custom channel. 116 "displayName": "A String", # Display name of the custom channel. 117 "name": "A String", # Resource name of the custom channel. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel} 118 "reportingDimensionId": "A String", # Output only. Unique ID of the custom channel as used in the `CUSTOM_CHANNEL_ID` reporting dimension. 119}</pre> 120</div> 121 122<div class="method"> 123 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 124 <pre>Lists all the custom channels available in an ad client. 125 126Args: 127 parent: string, Required. The ad client which owns the collection of custom channels. Format: accounts/{account}/adclients/{adclient} (required) 128 pageSize: integer, The maximum number of custom channels to include in the response, used for paging. If unspecified, at most 10000 custom channels will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000. 129 pageToken: string, A page token, received from a previous `ListCustomChannels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomChannels` must match the call that provided the page token. 130 x__xgafv: string, V1 error format. 131 Allowed values 132 1 - v1 error format 133 2 - v2 error format 134 135Returns: 136 An object of the form: 137 138 { # Response definition for the custom channel list rpc. 139 "customChannels": [ # The custom channels returned in this list response. 140 { # Representation of a custom channel. 141 "displayName": "A String", # Display name of the custom channel. 142 "name": "A String", # Resource name of the custom channel. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel} 143 "reportingDimensionId": "A String", # Output only. Unique ID of the custom channel as used in the `CUSTOM_CHANNEL_ID` reporting dimension. 144 }, 145 ], 146 "nextPageToken": "A String", # Continuation token used to page through alerts. To retrieve the next page of the results, set the next request's "page_token" value to this. 147}</pre> 148</div> 149 150<div class="method"> 151 <code class="details" id="listLinkedAdUnits">listLinkedAdUnits(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 152 <pre>Lists all the ad units available for a custom channel. 153 154Args: 155 parent: string, Required. The custom channel which owns the collection of ad units. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel} (required) 156 pageSize: integer, The maximum number of ad units to include in the response, used for paging. If unspecified, at most 10000 ad units will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000. 157 pageToken: string, A page token, received from a previous `ListLinkedAdUnits` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListLinkedAdUnits` must match the call that provided the page token. 158 x__xgafv: string, V1 error format. 159 Allowed values 160 1 - v1 error format 161 2 - v2 error format 162 163Returns: 164 An object of the form: 165 166 { # Response definition for the ad units linked to a custom channel list rpc. 167 "adUnits": [ # The ad units returned in the list response. 168 { # Representation of an ad unit. An ad unit represents a saved ad unit with a specific set of ad settings that have been customized within an account. 169 "contentAdsSettings": { # Settings specific to content ads (AFC). # Settings specific to content ads (AFC). 170 "size": "A String", # Size of the ad unit. e.g. "728x90", "1x3" (for responsive ad units). 171 "type": "A String", # Type of the ad unit. 172 }, 173 "displayName": "A String", # Display name of the ad unit, as provided when the ad unit was created. 174 "name": "A String", # Resource name of the ad unit. Format: accounts/{account}/adclients/{adclient}/adunits/{adunit} 175 "reportingDimensionId": "A String", # Output only. Unique ID of the ad unit as used in the `AD_UNIT_ID` reporting dimension. 176 "state": "A String", # State of the ad unit. 177 }, 178 ], 179 "nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of the results, set the next request's "page_token" value to this. 180}</pre> 181</div> 182 183<div class="method"> 184 <code class="details" id="listLinkedAdUnits_next">listLinkedAdUnits_next(previous_request, previous_response)</code> 185 <pre>Retrieves the next page of results. 186 187Args: 188 previous_request: The request for the previous page. (required) 189 previous_response: The response from the request for the previous page. (required) 190 191Returns: 192 A request object that you can call 'execute()' on to request the next 193 page. Returns None if there are no more items in the collection. 194 </pre> 195</div> 196 197<div class="method"> 198 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 199 <pre>Retrieves the next page of results. 200 201Args: 202 previous_request: The request for the previous page. (required) 203 previous_response: The response from the request for the previous page. (required) 204 205Returns: 206 A request object that you can call 'execute()' on to request the next 207 page. Returns None if there are no more items in the collection. 208 </pre> 209</div> 210 211</body></html>