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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
|
<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.mediationGroups.html">mediationGroups</a> . <a href="admob_v1beta.accounts.mediationGroups.mediationAbExperiments.html">mediationAbExperiments</a></h1>
<h2>Instance Methods</h2>
<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="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Create an A/B testing experiment for a specified AdMob account and a mediation group. This method has limited access. If you see a 403 permission denied error, please reach out to your account manager for access.</p>
<p class="toc_element">
<code><a href="#stop">stop(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Stop the mediation A/B experiment and choose a variant. This method has limited access. If you see a 403 permission denied error, please reach out to your account manager for access.</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="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Create an A/B testing experiment for a specified AdMob account and a mediation group. This method has limited access. If you see a 403 permission denied error, please reach out to your account manager for access.
Args:
parent: string, Required. The parent which owns the mediation group. Format: accounts/{publisher_id}/mediationGroups/{mediation_group_id} (required)
body: object, The request body.
The object takes the form of:
{ # The mediation A/B experiment.
"controlMediationLines": [ # Output only. The experiment mediation lines for control. They are inherited from the parent mediation group. It is an output only field.
{ # The mediation group line for the experiment. It will be used for serving during the run of the experiment.
"mediationGroupLine": { # Settings for an ad network used by a mediation group. # The mediation group line used by the experiment.
"adSourceId": "A String", # The ID of the ad source this mediation line is associated with.
"adUnitMappings": { # References of the ad unit mappings for each ad unit associated with this mediation line. Key is the ad unit ID, value is resource name of the ad unit mapping. For mediation lines where the ad source id is the AdMob Network, ad unit mappings will be ignored.
"a_key": "A String",
},
"cpmMicros": "A String", # The CPM for this allocation line. $0.01 is the minimum allowed amount. For LIVE CPM modes, the default amount is $0.01. This value is ignored if `cpm_mode` is `LIVE`. **Warning:** "USD" is the only supported currency at the moment. The unit is in micros.
"cpmMode": "A String", # Indicates how the CPM for this mediation line is provided. Note that `MANUAL` and `LIVE` are the only fully-supported mode at the moment. Please use the AdMob UI (https://admob.google.com) if you wish to create or update to other cpm modes.
"displayName": "A String", # User-provided label for this mediation line. The maximum length allowed is 255 characters.
"experimentVariant": "A String", # Output only. The Mediation A/B experiment variant to which the mediation group line belongs to.
"id": "A String", # The 16 digit ID for this mediation line e.g. 0123456789012345. When creating a new mediation group line, use a distinct negative integer as the ID place holder.
"state": "A String", # The status of the mediation group line. Only enabled mediation group lines will be served.
},
},
],
"displayName": "A String", # The display name for the mediation A/B experiment.
"endTime": "A String", # Output only. The time at which the experiment was ended or target to end (in UTC).
"experimentId": "A String", # Output only. Unique identifier for the mediation A/B experiment. It is an output only property.
"mediationGroupId": "A String", # Output only. The mediation group id this experiment belongs to. This can be used for filtering the experiments in the list experiments API.
"name": "A String", # Resource name for this experiment. The format is accounts/{publisher_id}/ mediationGroups/{mediation_group_id}/mediationAbExperiment/ {mediation_group_experiment_id}. For example: accounts/pub-9876543210987654/mediationGroups/0123456789/ mediationAbExperiment/12345
"startTime": "A String", # Output only. The time at which the experiment was started (in UTC).
"state": "A String", # Output only. The state of the experiment. It is an output only field.
"treatmentMediationLines": [ # The experiment mediation lines created for the treatment. They will be used for serving when the experiment status is RUNNING.
{ # The mediation group line for the experiment. It will be used for serving during the run of the experiment.
"mediationGroupLine": { # Settings for an ad network used by a mediation group. # The mediation group line used by the experiment.
"adSourceId": "A String", # The ID of the ad source this mediation line is associated with.
"adUnitMappings": { # References of the ad unit mappings for each ad unit associated with this mediation line. Key is the ad unit ID, value is resource name of the ad unit mapping. For mediation lines where the ad source id is the AdMob Network, ad unit mappings will be ignored.
"a_key": "A String",
},
"cpmMicros": "A String", # The CPM for this allocation line. $0.01 is the minimum allowed amount. For LIVE CPM modes, the default amount is $0.01. This value is ignored if `cpm_mode` is `LIVE`. **Warning:** "USD" is the only supported currency at the moment. The unit is in micros.
"cpmMode": "A String", # Indicates how the CPM for this mediation line is provided. Note that `MANUAL` and `LIVE` are the only fully-supported mode at the moment. Please use the AdMob UI (https://admob.google.com) if you wish to create or update to other cpm modes.
"displayName": "A String", # User-provided label for this mediation line. The maximum length allowed is 255 characters.
"experimentVariant": "A String", # Output only. The Mediation A/B experiment variant to which the mediation group line belongs to.
"id": "A String", # The 16 digit ID for this mediation line e.g. 0123456789012345. When creating a new mediation group line, use a distinct negative integer as the ID place holder.
"state": "A String", # The status of the mediation group line. Only enabled mediation group lines will be served.
},
},
],
"treatmentTrafficPercentage": "A String", # The percentage of the mediation A/B experiment traffic that will be send to the treatment (variant B). The remainder is sent to the control (variant A). The percentage is expressed as an integer in the inclusive range of [1,99]. See https://support.google.com/admob/answer/9572326 for details.
"variantLeader": "A String", # Output only. The variant leader for the experiment according to some key metrics.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The mediation A/B experiment.
"controlMediationLines": [ # Output only. The experiment mediation lines for control. They are inherited from the parent mediation group. It is an output only field.
{ # The mediation group line for the experiment. It will be used for serving during the run of the experiment.
"mediationGroupLine": { # Settings for an ad network used by a mediation group. # The mediation group line used by the experiment.
"adSourceId": "A String", # The ID of the ad source this mediation line is associated with.
"adUnitMappings": { # References of the ad unit mappings for each ad unit associated with this mediation line. Key is the ad unit ID, value is resource name of the ad unit mapping. For mediation lines where the ad source id is the AdMob Network, ad unit mappings will be ignored.
"a_key": "A String",
},
"cpmMicros": "A String", # The CPM for this allocation line. $0.01 is the minimum allowed amount. For LIVE CPM modes, the default amount is $0.01. This value is ignored if `cpm_mode` is `LIVE`. **Warning:** "USD" is the only supported currency at the moment. The unit is in micros.
"cpmMode": "A String", # Indicates how the CPM for this mediation line is provided. Note that `MANUAL` and `LIVE` are the only fully-supported mode at the moment. Please use the AdMob UI (https://admob.google.com) if you wish to create or update to other cpm modes.
"displayName": "A String", # User-provided label for this mediation line. The maximum length allowed is 255 characters.
"experimentVariant": "A String", # Output only. The Mediation A/B experiment variant to which the mediation group line belongs to.
"id": "A String", # The 16 digit ID for this mediation line e.g. 0123456789012345. When creating a new mediation group line, use a distinct negative integer as the ID place holder.
"state": "A String", # The status of the mediation group line. Only enabled mediation group lines will be served.
},
},
],
"displayName": "A String", # The display name for the mediation A/B experiment.
"endTime": "A String", # Output only. The time at which the experiment was ended or target to end (in UTC).
"experimentId": "A String", # Output only. Unique identifier for the mediation A/B experiment. It is an output only property.
"mediationGroupId": "A String", # Output only. The mediation group id this experiment belongs to. This can be used for filtering the experiments in the list experiments API.
"name": "A String", # Resource name for this experiment. The format is accounts/{publisher_id}/ mediationGroups/{mediation_group_id}/mediationAbExperiment/ {mediation_group_experiment_id}. For example: accounts/pub-9876543210987654/mediationGroups/0123456789/ mediationAbExperiment/12345
"startTime": "A String", # Output only. The time at which the experiment was started (in UTC).
"state": "A String", # Output only. The state of the experiment. It is an output only field.
"treatmentMediationLines": [ # The experiment mediation lines created for the treatment. They will be used for serving when the experiment status is RUNNING.
{ # The mediation group line for the experiment. It will be used for serving during the run of the experiment.
"mediationGroupLine": { # Settings for an ad network used by a mediation group. # The mediation group line used by the experiment.
"adSourceId": "A String", # The ID of the ad source this mediation line is associated with.
"adUnitMappings": { # References of the ad unit mappings for each ad unit associated with this mediation line. Key is the ad unit ID, value is resource name of the ad unit mapping. For mediation lines where the ad source id is the AdMob Network, ad unit mappings will be ignored.
"a_key": "A String",
},
"cpmMicros": "A String", # The CPM for this allocation line. $0.01 is the minimum allowed amount. For LIVE CPM modes, the default amount is $0.01. This value is ignored if `cpm_mode` is `LIVE`. **Warning:** "USD" is the only supported currency at the moment. The unit is in micros.
"cpmMode": "A String", # Indicates how the CPM for this mediation line is provided. Note that `MANUAL` and `LIVE` are the only fully-supported mode at the moment. Please use the AdMob UI (https://admob.google.com) if you wish to create or update to other cpm modes.
"displayName": "A String", # User-provided label for this mediation line. The maximum length allowed is 255 characters.
"experimentVariant": "A String", # Output only. The Mediation A/B experiment variant to which the mediation group line belongs to.
"id": "A String", # The 16 digit ID for this mediation line e.g. 0123456789012345. When creating a new mediation group line, use a distinct negative integer as the ID place holder.
"state": "A String", # The status of the mediation group line. Only enabled mediation group lines will be served.
},
},
],
"treatmentTrafficPercentage": "A String", # The percentage of the mediation A/B experiment traffic that will be send to the treatment (variant B). The remainder is sent to the control (variant A). The percentage is expressed as an integer in the inclusive range of [1,99]. See https://support.google.com/admob/answer/9572326 for details.
"variantLeader": "A String", # Output only. The variant leader for the experiment according to some key metrics.
}</pre>
</div>
<div class="method">
<code class="details" id="stop">stop(name, body=None, x__xgafv=None)</code>
<pre>Stop the mediation A/B experiment and choose a variant. This method has limited access. If you see a 403 permission denied error, please reach out to your account manager for access.
Args:
name: string, Name of the mediation group, the experiment for which to choose a variant for. Example: accounts/pub-9876543210987654/mediationGroups/0123456789/ mediationAbExperiments (required)
body: object, The request body.
The object takes the form of:
{ # Request to end the mediation A/B experiment and choose a winning variant.
"variantChoice": "A String", # The choice for the winning variant.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The mediation A/B experiment.
"controlMediationLines": [ # Output only. The experiment mediation lines for control. They are inherited from the parent mediation group. It is an output only field.
{ # The mediation group line for the experiment. It will be used for serving during the run of the experiment.
"mediationGroupLine": { # Settings for an ad network used by a mediation group. # The mediation group line used by the experiment.
"adSourceId": "A String", # The ID of the ad source this mediation line is associated with.
"adUnitMappings": { # References of the ad unit mappings for each ad unit associated with this mediation line. Key is the ad unit ID, value is resource name of the ad unit mapping. For mediation lines where the ad source id is the AdMob Network, ad unit mappings will be ignored.
"a_key": "A String",
},
"cpmMicros": "A String", # The CPM for this allocation line. $0.01 is the minimum allowed amount. For LIVE CPM modes, the default amount is $0.01. This value is ignored if `cpm_mode` is `LIVE`. **Warning:** "USD" is the only supported currency at the moment. The unit is in micros.
"cpmMode": "A String", # Indicates how the CPM for this mediation line is provided. Note that `MANUAL` and `LIVE` are the only fully-supported mode at the moment. Please use the AdMob UI (https://admob.google.com) if you wish to create or update to other cpm modes.
"displayName": "A String", # User-provided label for this mediation line. The maximum length allowed is 255 characters.
"experimentVariant": "A String", # Output only. The Mediation A/B experiment variant to which the mediation group line belongs to.
"id": "A String", # The 16 digit ID for this mediation line e.g. 0123456789012345. When creating a new mediation group line, use a distinct negative integer as the ID place holder.
"state": "A String", # The status of the mediation group line. Only enabled mediation group lines will be served.
},
},
],
"displayName": "A String", # The display name for the mediation A/B experiment.
"endTime": "A String", # Output only. The time at which the experiment was ended or target to end (in UTC).
"experimentId": "A String", # Output only. Unique identifier for the mediation A/B experiment. It is an output only property.
"mediationGroupId": "A String", # Output only. The mediation group id this experiment belongs to. This can be used for filtering the experiments in the list experiments API.
"name": "A String", # Resource name for this experiment. The format is accounts/{publisher_id}/ mediationGroups/{mediation_group_id}/mediationAbExperiment/ {mediation_group_experiment_id}. For example: accounts/pub-9876543210987654/mediationGroups/0123456789/ mediationAbExperiment/12345
"startTime": "A String", # Output only. The time at which the experiment was started (in UTC).
"state": "A String", # Output only. The state of the experiment. It is an output only field.
"treatmentMediationLines": [ # The experiment mediation lines created for the treatment. They will be used for serving when the experiment status is RUNNING.
{ # The mediation group line for the experiment. It will be used for serving during the run of the experiment.
"mediationGroupLine": { # Settings for an ad network used by a mediation group. # The mediation group line used by the experiment.
"adSourceId": "A String", # The ID of the ad source this mediation line is associated with.
"adUnitMappings": { # References of the ad unit mappings for each ad unit associated with this mediation line. Key is the ad unit ID, value is resource name of the ad unit mapping. For mediation lines where the ad source id is the AdMob Network, ad unit mappings will be ignored.
"a_key": "A String",
},
"cpmMicros": "A String", # The CPM for this allocation line. $0.01 is the minimum allowed amount. For LIVE CPM modes, the default amount is $0.01. This value is ignored if `cpm_mode` is `LIVE`. **Warning:** "USD" is the only supported currency at the moment. The unit is in micros.
"cpmMode": "A String", # Indicates how the CPM for this mediation line is provided. Note that `MANUAL` and `LIVE` are the only fully-supported mode at the moment. Please use the AdMob UI (https://admob.google.com) if you wish to create or update to other cpm modes.
"displayName": "A String", # User-provided label for this mediation line. The maximum length allowed is 255 characters.
"experimentVariant": "A String", # Output only. The Mediation A/B experiment variant to which the mediation group line belongs to.
"id": "A String", # The 16 digit ID for this mediation line e.g. 0123456789012345. When creating a new mediation group line, use a distinct negative integer as the ID place holder.
"state": "A String", # The status of the mediation group line. Only enabled mediation group lines will be served.
},
},
],
"treatmentTrafficPercentage": "A String", # The percentage of the mediation A/B experiment traffic that will be send to the treatment (variant B). The remainder is sent to the control (variant A). The percentage is expressed as an integer in the inclusive range of [1,99]. See https://support.google.com/admob/answer/9572326 for details.
"variantLeader": "A String", # Output only. The variant leader for the experiment according to some key metrics.
}</pre>
</div>
</body></html>
|
