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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
<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="admob_v1beta.html">AdMob API</a> . <a href="admob_v1beta.accounts.html">accounts</a> . <a href="admob_v1beta.accounts.campaigns.html">campaigns</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#batchUpdate">batchUpdate(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Batch update operation for campaigns under the specified AdMob publisher.</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="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List the campaigns under the specified AdMob account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="batchUpdate">batchUpdate(parent, body=None, x__xgafv=None)</code>
<pre>Batch update operation for campaigns under the specified AdMob publisher.
Args:
parent: string, Required. Resource name of the account to list campaigns for. The `parent` field in the individual UpdateCampaignRequest messages should match the value set here. Example: accounts/pub-9876543210987654 (required)
body: object, The request body.
The object takes the form of:
{ # The request for the BatchUpdateCampaigns API.
"requests": [ # Required. The individual requests to update campaigns. Max 1000 allowed.
{ # An update request for a singular campaign. Currently only cpi_micros of MAX_CPI and TARGET_CPI campaigns can be updated.
"campaign": { # Describes an AdMob campaign. # Required. The campaign which is being updated.
"cpiSetting": { # CPI setting for AdMob campaign. Ignored unless campaign goal type is MAX_CPI or TARGET_CPI. # The CPI setting of the campaign.
"cpiMicros": "A String", # Cost-per-install for this campaign in micro units in the currency of the GoogleAds account linked to this AdMob publisher.
},
"displayName": "A String", # Output only. The display name for the campaign.
"goalType": "A String", # Output only. The Goal type of the campaign.
"name": "A String", # Output only. Resource name for this campaign. Format is: accounts/{publisher_id}/campaigns/{campaign_id} Example: accounts/pub-9876543210987654/campaigns/0123456789
},
"updateMask": "A String", # List of campaign fields to be updated. Currently this field is not supported as only the cpi_micros field can be updated.
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response for the BatchUpdateCampaigns API.
"campaigns": [ # The updated campaigns per the request.
{ # Describes an AdMob campaign.
"cpiSetting": { # CPI setting for AdMob campaign. Ignored unless campaign goal type is MAX_CPI or TARGET_CPI. # The CPI setting of the campaign.
"cpiMicros": "A String", # Cost-per-install for this campaign in micro units in the currency of the GoogleAds account linked to this AdMob publisher.
},
"displayName": "A String", # Output only. The display name for the campaign.
"goalType": "A String", # Output only. The Goal type of the campaign.
"name": "A String", # Output only. Resource name for this campaign. Format is: accounts/{publisher_id}/campaigns/{campaign_id} Example: accounts/pub-9876543210987654/campaigns/0123456789
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>List the campaigns under the specified AdMob account.
Args:
parent: string, Required. Resource name of the account to list campaigns for. Example: accounts/pub-9876543210987654 (required)
filter: string, The filter string that uses [EBNF grammar syntax](https://google.aip.dev/assets/misc/ebnf-filtering.txt). Possible field to filter by is: - "CAMPAIGN_GOAL_TYPE" Possible filter function is: - `IN`: Used to filter fields that represent a singleton including "CAMPAIGN_GOAL_TYPE". The filter functions can be added together using `AND`. `OR` functionality is not supported. Example: filter: IN(CAMPAIGN_GOAL_TYPE, "NUMBER_OF_CLICKS", "MEDIATED_ADS")
pageSize: integer, The maximum number of campaigns to return.
pageToken: string, The value returned by the last `ListCampaignsResponse`; indicates that this is a continuation of a prior `ListGoogleBiddingAdUnits` call, and that the system should return the next page of data.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for the ListCampaignsRequest.
"campaigns": [ # The resulting mediation groups for the requested account.
{ # Describes an AdMob campaign.
"cpiSetting": { # CPI setting for AdMob campaign. Ignored unless campaign goal type is MAX_CPI or TARGET_CPI. # The CPI setting of the campaign.
"cpiMicros": "A String", # Cost-per-install for this campaign in micro units in the currency of the GoogleAds account linked to this AdMob publisher.
},
"displayName": "A String", # Output only. The display name for the campaign.
"goalType": "A String", # Output only. The Goal type of the campaign.
"name": "A String", # Output only. Resource name for this campaign. Format is: accounts/{publisher_id}/campaigns/{campaign_id} Example: accounts/pub-9876543210987654/campaigns/0123456789
},
],
"nextPageToken": "A String", # Used to set the `page_token` in the `ListCampaignsRequest` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</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>
|
