File: adsensehost_v4_1.accounts.adclients.html

package info (click to toggle)
python-googleapi 1.7.11-4
  • links: PTS
  • area: main
  • in suites: bullseye
  • size: 110,952 kB
  • sloc: python: 7,784; javascript: 249; makefile: 59; sh: 53; xml: 5
file content (149 lines) | stat: -rw-r--r-- 4,571 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
<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="adsensehost_v4_1.html">AdSense Host API</a> . <a href="adsensehost_v4_1.accounts.html">accounts</a> . <a href="adsensehost_v4_1.accounts.adclients.html">adclients</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#get">get(accountId, adClientId)</a></code></p>
<p class="firstline">Get information about one of the ad clients in the specified publisher's AdSense account.</p>
<p class="toc_element">
  <code><a href="#list">list(accountId, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all hosted ad clients in the specified hosted account.</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="get">get(accountId, adClientId)</code>
  <pre>Get information about one of the ad clients in the specified publisher's AdSense account.

Args:
  accountId: string, Account which contains the ad client. (required)
  adClientId: string, Ad client to get. (required)

Returns:
  An object of the form:

    {
    "productCode": "A String", # This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.
    "kind": "adsensehost#adClient", # Kind of resource this is, in this case adsensehost#adClient.
    "id": "A String", # Unique identifier of this ad client.
    "arcOptIn": True or False, # Whether this ad client is opted in to ARC.
    "supportsReporting": True or False, # Whether this ad client supports being reported on.
  }</pre>
</div>

<div class="method">
    <code class="details" id="list">list(accountId, pageToken=None, maxResults=None)</code>
  <pre>List all hosted ad clients in the specified hosted account.

Args:
  accountId: string, Account for which to list ad clients. (required)
  pageToken: string, A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
  maxResults: integer, The maximum number of ad clients to include in the response, used for paging.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's "pageToken" value to this.
    "items": [ # The ad clients returned in this list response.
      {
        "productCode": "A String", # This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.
        "kind": "adsensehost#adClient", # Kind of resource this is, in this case adsensehost#adClient.
        "id": "A String", # Unique identifier of this ad client.
        "arcOptIn": True or False, # Whether this ad client is opted in to ARC.
        "supportsReporting": True or False, # Whether this ad client supports being reported on.
      },
    ],
    "kind": "adsensehost#adClients", # Kind of list this is, in this case adsensehost#adClients.
    "etag": "A String", # ETag of this response for caching purposes.
  }</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>