| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="adsense_v2.html">AdSense Management API</a> . <a href="adsense_v2.accounts.html">accounts</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="adsense_v2.accounts.adclients.html">adclients()</a></code> |
| </p> |
| <p class="firstline">Returns the adclients Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="adsense_v2.accounts.alerts.html">alerts()</a></code> |
| </p> |
| <p class="firstline">Returns the alerts Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="adsense_v2.accounts.payments.html">payments()</a></code> |
| </p> |
| <p class="firstline">Returns the payments Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="adsense_v2.accounts.reports.html">reports()</a></code> |
| </p> |
| <p class="firstline">Returns the reports Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="adsense_v2.accounts.sites.html">sites()</a></code> |
| </p> |
| <p class="firstline">Returns the sites Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets information about the selected AdSense account.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists all accounts available to this user.</p> |
| <p class="toc_element"> |
| <code><a href="#listChildAccounts">listChildAccounts(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists all accounts directly managed by the given AdSense account.</p> |
| <p class="toc_element"> |
| <code><a href="#listChildAccounts_next">listChildAccounts_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Gets information about the selected AdSense account. |
| |
| Args: |
| name: string, Required. Account to get information about. Format: accounts/{account} (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Representation of an account. |
| "createTime": "A String", # Output only. Creation time of the account. |
| "displayName": "A String", # Output only. Display name of this account. |
| "name": "A String", # Resource name of the account. Format: accounts/pub-[0-9]+ |
| "pendingTasks": [ # Output only. Outstanding tasks that need to be completed as part of the sign-up process for a new account. e.g. "billing-profile-creation", "phone-pin-verification". |
| "A String", |
| ], |
| "premium": True or False, # Output only. Whether this account is premium. |
| "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # The account time zone, as used by reporting. For more information, see [changing the time zone of your reports](https://support.google.com/adsense/answer/9830725). |
| "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". |
| "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Lists all accounts available to this user. |
| |
| Args: |
| pageSize: integer, The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000. |
| pageToken: string, A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response definition for the account list rpc. |
| "accounts": [ # The accounts returned in this list response. |
| { # Representation of an account. |
| "createTime": "A String", # Output only. Creation time of the account. |
| "displayName": "A String", # Output only. Display name of this account. |
| "name": "A String", # Resource name of the account. Format: accounts/pub-[0-9]+ |
| "pendingTasks": [ # Output only. Outstanding tasks that need to be completed as part of the sign-up process for a new account. e.g. "billing-profile-creation", "phone-pin-verification". |
| "A String", |
| ], |
| "premium": True or False, # Output only. Whether this account is premium. |
| "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # The account time zone, as used by reporting. For more information, see [changing the time zone of your reports](https://support.google.com/adsense/answer/9830725). |
| "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". |
| "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". |
| }, |
| }, |
| ], |
| "nextPageToken": "A String", # Continuation token used to page through accounts. To retrieve the next page of the results, set the next request's "page_token" value to this. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="listChildAccounts">listChildAccounts(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Lists all accounts directly managed by the given AdSense account. |
| |
| Args: |
| parent: string, Required. The parent account, which owns the child accounts. Format: accounts/{account} (required) |
| pageSize: integer, The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000. |
| pageToken: string, A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response definition for the child account list rpc. |
| "accounts": [ # The accounts returned in this list response. |
| { # Representation of an account. |
| "createTime": "A String", # Output only. Creation time of the account. |
| "displayName": "A String", # Output only. Display name of this account. |
| "name": "A String", # Resource name of the account. Format: accounts/pub-[0-9]+ |
| "pendingTasks": [ # Output only. Outstanding tasks that need to be completed as part of the sign-up process for a new account. e.g. "billing-profile-creation", "phone-pin-verification". |
| "A String", |
| ], |
| "premium": True or False, # Output only. Whether this account is premium. |
| "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # The account time zone, as used by reporting. For more information, see [changing the time zone of your reports](https://support.google.com/adsense/answer/9830725). |
| "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". |
| "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". |
| }, |
| }, |
| ], |
| "nextPageToken": "A String", # Continuation token used to page through accounts. To retrieve the next page of the results, set the next request's "page_token" value to this. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="listChildAccounts_next">listChildAccounts_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| </body></html> |