| yoshi-code-bot | 3dd1527 | 2021-04-21 15:07:48 -0700 | [diff] [blame] | 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="admob_v1.html">AdMob API</a> . <a href="admob_v1.accounts.html">accounts</a> . <a href="admob_v1.accounts.adUnits.html">adUnits</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="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">List the ad units under the specified AdMob 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="close">close()</code> |
| 89 | <pre>Close httplib2 connections.</pre> |
| 90 | </div> |
| 91 | |
| 92 | <div class="method"> |
| 93 | <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| 94 | <pre>List the ad units under the specified AdMob account. |
| 95 | |
| 96 | Args: |
| 97 | parent: string, Required. Resource name of the account to list ad units for. Example: accounts/pub-9876543210987654 (required) |
| 98 | pageSize: integer, The maximum number of ad units to return. If unspecified or 0, at most 1000 ad units will be returned. The maximum value is 10,000; values above 10,000 will be coerced to 10,000. |
| 99 | pageToken: string, The value returned by the last `ListAdUnitsResponse`; indicates that this is a continuation of a prior `ListAdUnits` call, and that the system should return the next page of data. |
| 100 | x__xgafv: string, V1 error format. |
| 101 | Allowed values |
| 102 | 1 - v1 error format |
| 103 | 2 - v2 error format |
| 104 | |
| 105 | Returns: |
| 106 | An object of the form: |
| 107 | |
| 108 | { # Response for the ad units list request. |
| 109 | "adUnits": [ # The resulting ad units for the requested account. |
| 110 | { # Describes an AdMob ad unit. |
| 111 | "adFormat": "A String", # AdFormat of the ad unit. Possible values are as follows: "BANNER" - Banner ad format. "BANNER_INTERSTITIAL" - Legacy format that can be used as either banner or interstitial. This format can no longer be created but can be targeted by mediation groups. "INTERSTITIAL" - A full screen ad. Supported ad types are "RICH_MEDIA" and "VIDEO". "NATIVE" - Native ad format. "REWARDED" - An ad that, once viewed, gets a callback verifying the view so that a reward can be given to the user. Supported ad types are "RICH_MEDIA" (interactive) and video where video can not be excluded. |
| 112 | "adTypes": [ # Ad media type supported by this ad unit. Possible values as follows: "RICH_MEDIA" - Text, image, and other non-video media. "VIDEO" - Video media. |
| 113 | "A String", |
| 114 | ], |
| 115 | "adUnitId": "A String", # The externally visible ID of the ad unit which can be used to integrate with the AdMob SDK. This is a read only property. Example: ca-app-pub-9876543210987654/0123456789 |
| 116 | "appId": "A String", # The externally visible ID of the app this ad unit is associated with. Example: ca-app-pub-9876543210987654~0123456789 |
| 117 | "displayName": "A String", # The display name of the ad unit as shown in the AdMob UI, which is provided by the user. The maximum length allowed is 80 characters. |
| 118 | "name": "A String", # Resource name for this ad unit. Format is accounts/{publisher_id}/adUnits/{ad_unit_id_fragment} Example: accounts/pub-9876543210987654/adUnits/0123456789 |
| 119 | }, |
| 120 | ], |
| 121 | "nextPageToken": "A String", # If not empty, indicates that there may be more ad units for the request; this value should be passed in a new `ListAdUnitsRequest`. |
| 122 | }</pre> |
| 123 | </div> |
| 124 | |
| 125 | <div class="method"> |
| 126 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 127 | <pre>Retrieves the next page of results. |
| 128 | |
| 129 | Args: |
| 130 | previous_request: The request for the previous page. (required) |
| 131 | previous_response: The response from the request for the previous page. (required) |
| 132 | |
| 133 | Returns: |
| 134 | A request object that you can call 'execute()' on to request the next |
| 135 | page. Returns None if there are no more items in the collection. |
| 136 | </pre> |
| 137 | </div> |
| 138 | |
| 139 | </body></html> |