OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
5 "https://www.googleapis.com/auth/adexchange.buyer": { | 5 "https://www.googleapis.com/auth/adexchange.buyer": { |
6 "description": "Manage your Ad Exchange buyer account config
uration" | 6 "description": "Manage your Ad Exchange buyer account config
uration" |
7 } | 7 } |
8 } | 8 } |
9 } | 9 } |
10 }, | 10 }, |
11 "basePath": "", | 11 "basePath": "", |
12 "baseUrl": "https://adexchangebuyer.googleapis.com/", | 12 "baseUrl": "https://adexchangebuyer.googleapis.com/", |
13 "batchPath": "batch", | 13 "batchPath": "batch", |
14 "canonicalName": "AdExchangeBuyerII", | 14 "canonicalName": "AdExchangeBuyerII", |
15 "description": "Accesses the latest features for managing Ad Exchange accoun
ts, Real-Time Bidding configurations and auction metrics, and Marketplace progra
mmatic deals.", | 15 "description": "Accesses the latest features for managing Ad Exchange accoun
ts, Real-Time Bidding configurations and auction metrics, and Marketplace progra
mmatic deals.", |
16 "discoveryVersion": "v1", | 16 "discoveryVersion": "v1", |
17 "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest/g
uides/client-access/", | 17 "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest/g
uides/client-access/", |
18 "icons": { | 18 "icons": { |
19 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 19 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
20 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 20 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
21 }, | 21 }, |
22 "id": "adexchangebuyer2:v2beta1", | 22 "id": "adexchangebuyer2:v2beta1", |
23 "kind": "discovery#restDescription", | 23 "kind": "discovery#restDescription", |
24 "name": "adexchangebuyer2", | 24 "name": "adexchangebuyer2", |
25 "ownerDomain": "google.com", | 25 "ownerDomain": "google.com", |
26 "ownerName": "Google", | 26 "ownerName": "Google", |
27 "parameters": { | 27 "parameters": { |
28 "oauth_token": { | 28 "key": { |
29 "description": "OAuth 2.0 token for the current user.", | 29 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
30 "location": "query", | 30 "location": "query", |
31 "type": "string" | 31 "type": "string" |
32 }, | 32 }, |
| 33 "access_token": { |
| 34 "description": "OAuth access token.", |
| 35 "location": "query", |
| 36 "type": "string" |
| 37 }, |
| 38 "quotaUser": { |
| 39 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", |
| 40 "location": "query", |
| 41 "type": "string" |
| 42 }, |
| 43 "pp": { |
| 44 "default": "true", |
| 45 "description": "Pretty-print response.", |
| 46 "location": "query", |
| 47 "type": "boolean" |
| 48 }, |
33 "bearer_token": { | 49 "bearer_token": { |
34 "description": "OAuth bearer token.", | 50 "description": "OAuth bearer token.", |
35 "location": "query", | 51 "location": "query", |
36 "type": "string" | 52 "type": "string" |
37 }, | 53 }, |
| 54 "oauth_token": { |
| 55 "description": "OAuth 2.0 token for the current user.", |
| 56 "location": "query", |
| 57 "type": "string" |
| 58 }, |
38 "upload_protocol": { | 59 "upload_protocol": { |
39 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 60 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
40 "location": "query", | 61 "location": "query", |
41 "type": "string" | 62 "type": "string" |
42 }, | 63 }, |
43 "prettyPrint": { | 64 "prettyPrint": { |
44 "default": "true", | 65 "default": "true", |
45 "description": "Returns response with indentations and line breaks."
, | 66 "description": "Returns response with indentations and line breaks."
, |
46 "location": "query", | 67 "location": "query", |
47 "type": "boolean" | 68 "type": "boolean" |
48 }, | 69 }, |
49 "uploadType": { | 70 "uploadType": { |
50 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 71 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
51 "location": "query", | 72 "location": "query", |
52 "type": "string" | 73 "type": "string" |
53 }, | 74 }, |
54 "fields": { | 75 "fields": { |
55 "description": "Selector specifying which fields to include in a par
tial response.", | 76 "description": "Selector specifying which fields to include in a par
tial response.", |
56 "location": "query", | 77 "location": "query", |
57 "type": "string" | 78 "type": "string" |
58 }, | 79 }, |
| 80 "callback": { |
| 81 "description": "JSONP", |
| 82 "location": "query", |
| 83 "type": "string" |
| 84 }, |
59 "$.xgafv": { | 85 "$.xgafv": { |
60 "description": "V1 error format.", | 86 "description": "V1 error format.", |
61 "enum": [ | 87 "enum": [ |
62 "1", | 88 "1", |
63 "2" | 89 "2" |
64 ], | 90 ], |
65 "enumDescriptions": [ | 91 "enumDescriptions": [ |
66 "v1 error format", | 92 "v1 error format", |
67 "v2 error format" | 93 "v2 error format" |
68 ], | 94 ], |
69 "location": "query", | 95 "location": "query", |
70 "type": "string" | 96 "type": "string" |
71 }, | 97 }, |
72 "callback": { | |
73 "description": "JSONP", | |
74 "location": "query", | |
75 "type": "string" | |
76 }, | |
77 "alt": { | 98 "alt": { |
78 "default": "json", | 99 "default": "json", |
79 "description": "Data format for response.", | 100 "description": "Data format for response.", |
80 "enum": [ | 101 "enum": [ |
81 "json", | 102 "json", |
82 "media", | 103 "media", |
83 "proto" | 104 "proto" |
84 ], | 105 ], |
85 "enumDescriptions": [ | 106 "enumDescriptions": [ |
86 "Responses with Content-Type of application/json", | 107 "Responses with Content-Type of application/json", |
87 "Media download with context-dependent Content-Type", | 108 "Media download with context-dependent Content-Type", |
88 "Responses with Content-Type of application/x-protobuf" | 109 "Responses with Content-Type of application/x-protobuf" |
89 ], | 110 ], |
90 "location": "query", | 111 "location": "query", |
91 "type": "string" | 112 "type": "string" |
92 }, | |
93 "access_token": { | |
94 "description": "OAuth access token.", | |
95 "location": "query", | |
96 "type": "string" | |
97 }, | |
98 "key": { | |
99 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", | |
100 "location": "query", | |
101 "type": "string" | |
102 }, | |
103 "quotaUser": { | |
104 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", | |
105 "location": "query", | |
106 "type": "string" | |
107 }, | |
108 "pp": { | |
109 "default": "true", | |
110 "description": "Pretty-print response.", | |
111 "location": "query", | |
112 "type": "boolean" | |
113 } | 113 } |
114 }, | 114 }, |
115 "protocol": "rest", | 115 "protocol": "rest", |
116 "resources": { | 116 "resources": { |
117 "accounts": { | 117 "accounts": { |
118 "resources": { | 118 "resources": { |
119 "clients": { | 119 "creatives": { |
120 "methods": { | 120 "methods": { |
| 121 "create": { |
| 122 "description": "Creates a creative.", |
| 123 "httpMethod": "POST", |
| 124 "id": "adexchangebuyer2.accounts.creatives.create", |
| 125 "parameterOrder": [ |
| 126 "accountId" |
| 127 ], |
| 128 "parameters": { |
| 129 "accountId": { |
| 130 "description": "The account that this creati
ve belongs to.\nCan be used to filter the response of the\ncreatives.list\nmetho
d.", |
| 131 "location": "path", |
| 132 "required": true, |
| 133 "type": "string" |
| 134 }, |
| 135 "duplicateIdMode": { |
| 136 "description": "Indicates if multiple creati
ves can share an ID or not. Default is\nNO_DUPLICATES (one ID per creative).", |
| 137 "enum": [ |
| 138 "NO_DUPLICATES", |
| 139 "FORCE_ENABLE_DUPLICATE_IDS" |
| 140 ], |
| 141 "location": "query", |
| 142 "type": "string" |
| 143 } |
| 144 }, |
| 145 "path": "v2beta1/accounts/{accountId}/creatives", |
| 146 "request": { |
| 147 "$ref": "Creative" |
| 148 }, |
| 149 "response": { |
| 150 "$ref": "Creative" |
| 151 }, |
| 152 "scopes": [ |
| 153 "https://www.googleapis.com/auth/adexchange.buye
r" |
| 154 ] |
| 155 }, |
| 156 "stopWatching": { |
| 157 "description": "Stops watching a creative. Will stop
push notifications being sent to the\ntopics when the creative changes status."
, |
| 158 "httpMethod": "POST", |
| 159 "id": "adexchangebuyer2.accounts.creatives.stopWatch
ing", |
| 160 "parameterOrder": [ |
| 161 "accountId", |
| 162 "creativeId" |
| 163 ], |
| 164 "parameters": { |
| 165 "accountId": { |
| 166 "description": "The account of the creative
to stop notifications for.", |
| 167 "location": "path", |
| 168 "required": true, |
| 169 "type": "string" |
| 170 }, |
| 171 "creativeId": { |
| 172 "description": "The creative ID of the creat
ive to stop notifications for.\nSpecify \"-\" to specify stopping account level
notifications.", |
| 173 "location": "path", |
| 174 "required": true, |
| 175 "type": "string" |
| 176 } |
| 177 }, |
| 178 "path": "v2beta1/accounts/{accountId}/creatives/{cre
ativeId}:stopWatching", |
| 179 "request": { |
| 180 "$ref": "StopWatchingCreativeRequest" |
| 181 }, |
| 182 "response": { |
| 183 "$ref": "Empty" |
| 184 }, |
| 185 "scopes": [ |
| 186 "https://www.googleapis.com/auth/adexchange.buye
r" |
| 187 ] |
| 188 }, |
121 "get": { | 189 "get": { |
122 "description": "Gets a client buyer with a given cli
ent account ID.", | 190 "description": "Gets a creative.", |
123 "httpMethod": "GET", | 191 "httpMethod": "GET", |
124 "id": "adexchangebuyer2.accounts.clients.get", | 192 "id": "adexchangebuyer2.accounts.creatives.get", |
125 "parameterOrder": [ | 193 "parameterOrder": [ |
126 "accountId", | 194 "accountId", |
127 "clientAccountId" | 195 "creativeId" |
128 ], | 196 ], |
129 "parameters": { | 197 "parameters": { |
130 "accountId": { | 198 "accountId": { |
131 "description": "Numerical account ID of the
client's sponsor buyer. (required)", | 199 "description": "The account the creative bel
ongs to.", |
132 "format": "int64", | 200 "location": "path", |
133 "location": "path", | 201 "required": true, |
134 "required": true, | 202 "type": "string" |
135 "type": "string" | 203 }, |
136 }, | 204 "creativeId": { |
137 "clientAccountId": { | 205 "description": "The ID of the creative to re
trieve.", |
138 "description": "Numerical account ID of the
client buyer to retrieve. (required)", | 206 "location": "path", |
139 "format": "int64", | 207 "required": true, |
140 "location": "path", | 208 "type": "string" |
141 "required": true, | 209 } |
142 "type": "string" | 210 }, |
143 } | 211 "path": "v2beta1/accounts/{accountId}/creatives/{cre
ativeId}", |
144 }, | 212 "response": { |
145 "path": "v2beta1/accounts/{accountId}/clients/{clien
tAccountId}", | 213 "$ref": "Creative" |
146 "response": { | 214 }, |
147 "$ref": "Client" | 215 "scopes": [ |
| 216 "https://www.googleapis.com/auth/adexchange.buye
r" |
| 217 ] |
| 218 }, |
| 219 "watch": { |
| 220 "description": "Watches a creative. Will result in p
ush notifications being sent to the\ntopic when the creative changes status.", |
| 221 "httpMethod": "POST", |
| 222 "id": "adexchangebuyer2.accounts.creatives.watch", |
| 223 "parameterOrder": [ |
| 224 "accountId", |
| 225 "creativeId" |
| 226 ], |
| 227 "parameters": { |
| 228 "accountId": { |
| 229 "description": "The account of the creative
to watch.", |
| 230 "location": "path", |
| 231 "required": true, |
| 232 "type": "string" |
| 233 }, |
| 234 "creativeId": { |
| 235 "description": "The creative ID to watch for
status changes.\nSpecify \"-\" to watch all creatives under the above account.\
nIf both creative-level and account-level notifications are\nsent, only a single
notification will be sent to the\ncreative-level notification topic.", |
| 236 "location": "path", |
| 237 "required": true, |
| 238 "type": "string" |
| 239 } |
| 240 }, |
| 241 "path": "v2beta1/accounts/{accountId}/creatives/{cre
ativeId}:watch", |
| 242 "request": { |
| 243 "$ref": "WatchCreativeRequest" |
| 244 }, |
| 245 "response": { |
| 246 "$ref": "Empty" |
| 247 }, |
| 248 "scopes": [ |
| 249 "https://www.googleapis.com/auth/adexchange.buye
r" |
| 250 ] |
| 251 }, |
| 252 "update": { |
| 253 "description": "Updates a creative.", |
| 254 "httpMethod": "PUT", |
| 255 "id": "adexchangebuyer2.accounts.creatives.update", |
| 256 "parameterOrder": [ |
| 257 "accountId", |
| 258 "creativeId" |
| 259 ], |
| 260 "parameters": { |
| 261 "accountId": { |
| 262 "description": "The account that this creati
ve belongs to.\nCan be used to filter the response of the\ncreatives.list\nmetho
d.", |
| 263 "location": "path", |
| 264 "required": true, |
| 265 "type": "string" |
| 266 }, |
| 267 "creativeId": { |
| 268 "description": "The buyer-defined creative I
D of this creative.\nCan be used to filter the response of the\ncreatives.list\n
method.", |
| 269 "location": "path", |
| 270 "required": true, |
| 271 "type": "string" |
| 272 } |
| 273 }, |
| 274 "path": "v2beta1/accounts/{accountId}/creatives/{cre
ativeId}", |
| 275 "request": { |
| 276 "$ref": "Creative" |
| 277 }, |
| 278 "response": { |
| 279 "$ref": "Creative" |
148 }, | 280 }, |
149 "scopes": [ | 281 "scopes": [ |
150 "https://www.googleapis.com/auth/adexchange.buye
r" | 282 "https://www.googleapis.com/auth/adexchange.buye
r" |
151 ] | 283 ] |
152 }, | 284 }, |
153 "list": { | 285 "list": { |
154 "description": "Lists all the clients for the curren
t sponsor buyer.", | 286 "description": "Lists creatives.", |
155 "httpMethod": "GET", | 287 "httpMethod": "GET", |
156 "id": "adexchangebuyer2.accounts.clients.list", | 288 "id": "adexchangebuyer2.accounts.creatives.list", |
157 "parameterOrder": [ | 289 "parameterOrder": [ |
158 "accountId" | 290 "accountId" |
159 ], | 291 ], |
160 "parameters": { | 292 "parameters": { |
161 "accountId": { | 293 "pageToken": { |
162 "description": "Unique numerical account ID
of the sponsor buyer to list the clients for.", | 294 "description": "A token identifying a page o
f results the server should return.\nTypically, this is the value of\nListCreati
vesResponse.next_page_token\nreturned from the previous call to 'ListCreatives'
method.", |
163 "format": "int64", | 295 "location": "query", |
| 296 "type": "string" |
| 297 }, |
| 298 "accountId": { |
| 299 "description": "The account to list the crea
tives from.\nSpecify \"-\" to list all creatives the current user has access to.
", |
164 "location": "path", | 300 "location": "path", |
165 "required": true, | 301 "required": true, |
166 "type": "string" | 302 "type": "string" |
167 }, | 303 }, |
168 "pageSize": { | 304 "pageSize": { |
169 "description": "Requested page size. The ser
ver may return fewer clients than requested.\nIf unspecified, the server will pi
ck an appropriate default.", | 305 "description": "Requested page size. The ser
ver may return fewer creatives than requested\n(due to timeout constraint) even
if more are available via another call.\nIf unspecified, server will pick an app
ropriate default.\nAcceptable values are 1 to 1000, inclusive.", |
170 "format": "int32", | 306 "format": "int32", |
171 "location": "query", | 307 "location": "query", |
172 "type": "integer" | 308 "type": "integer" |
173 }, | 309 }, |
174 "pageToken": { | 310 "query": { |
175 "description": "A token identifying a page o
f results the server should return.\nTypically, this is the value of\nListClient
sResponse.nextPageToken\nreturned from the previous call to the\naccounts.client
s.list method.", | 311 "description": "An optional query string to
filter creatives. If no filter is specified,\nall active creatives will be retur
ned.\nSupported queries are:\n<ul>\n<li>accountId=<i>account_id_string</i>\n<li>
creativeId=<i>creative_id_string</i>\n<li>dealsStatus: {approved, conditionally_
approved, disapproved,\n not_checked}\n<li>openAuctionStatus:
{approved, conditionally_approved, disapproved,\n not_c
hecked}\n<li>attribute: {a numeric attribute from the list of attributes}\n<li>d
isapprovalReason: {a reason from DisapprovalReason\n</ul>\nExample: 'accountId=1
2345 AND (dealsStatus:disapproved AND disapprovalReason:unacceptable_content) OR
attribute:47'", |
176 "location": "query", | 312 "location": "query", |
177 "type": "string" | 313 "type": "string" |
178 } | 314 } |
179 }, | 315 }, |
180 "path": "v2beta1/accounts/{accountId}/clients", | 316 "path": "v2beta1/accounts/{accountId}/creatives", |
181 "response": { | 317 "response": { |
182 "$ref": "ListClientsResponse" | 318 "$ref": "ListCreativesResponse" |
183 }, | 319 }, |
184 "scopes": [ | 320 "scopes": [ |
185 "https://www.googleapis.com/auth/adexchange.buye
r" | 321 "https://www.googleapis.com/auth/adexchange.buye
r" |
186 ] | |
187 }, | |
188 "update": { | |
189 "description": "Updates an existing client buyer.", | |
190 "httpMethod": "PUT", | |
191 "id": "adexchangebuyer2.accounts.clients.update", | |
192 "parameterOrder": [ | |
193 "accountId", | |
194 "clientAccountId" | |
195 ], | |
196 "parameters": { | |
197 "accountId": { | |
198 "description": "Unique numerical account ID
for the buyer of which the client buyer\nis a customer; the sponsor buyer to upd
ate a client for. (required)", | |
199 "format": "int64", | |
200 "location": "path", | |
201 "required": true, | |
202 "type": "string" | |
203 }, | |
204 "clientAccountId": { | |
205 "description": "Unique numerical account ID
of the client to update. (required)", | |
206 "format": "int64", | |
207 "location": "path", | |
208 "required": true, | |
209 "type": "string" | |
210 } | |
211 }, | |
212 "path": "v2beta1/accounts/{accountId}/clients/{clien
tAccountId}", | |
213 "request": { | |
214 "$ref": "Client" | |
215 }, | |
216 "response": { | |
217 "$ref": "Client" | |
218 }, | |
219 "scopes": [ | |
220 "https://www.googleapis.com/auth/adexchange.buye
r" | |
221 ] | |
222 }, | |
223 "create": { | |
224 "description": "Creates a new client buyer.", | |
225 "httpMethod": "POST", | |
226 "id": "adexchangebuyer2.accounts.clients.create", | |
227 "parameterOrder": [ | |
228 "accountId" | |
229 ], | |
230 "parameters": { | |
231 "accountId": { | |
232 "description": "Unique numerical account ID
for the buyer of which the client buyer\nis a customer; the sponsor buyer to cre
ate a client for. (required)", | |
233 "format": "int64", | |
234 "location": "path", | |
235 "required": true, | |
236 "type": "string" | |
237 } | |
238 }, | |
239 "path": "v2beta1/accounts/{accountId}/clients", | |
240 "request": { | |
241 "$ref": "Client" | |
242 }, | |
243 "response": { | |
244 "$ref": "Client" | |
245 }, | |
246 "scopes": [ | |
247 "https://www.googleapis.com/auth/adexchange.buye
r" | |
248 ] | 322 ] |
249 } | 323 } |
250 }, | 324 }, |
251 "resources": { | 325 "resources": { |
| 326 "dealAssociations": { |
| 327 "methods": { |
| 328 "list": { |
| 329 "description": "List all creative-deal assoc
iations.", |
| 330 "httpMethod": "GET", |
| 331 "id": "adexchangebuyer2.accounts.creatives.d
ealAssociations.list", |
| 332 "parameterOrder": [ |
| 333 "accountId", |
| 334 "creativeId" |
| 335 ], |
| 336 "parameters": { |
| 337 "pageToken": { |
| 338 "description": "A token identifying
a page of results the server should return.\nTypically, this is the value of\nLi
stDealAssociationsResponse.next_page_token\nreturned from the previous call to '
ListDealAssociations' method.", |
| 339 "location": "query", |
| 340 "type": "string" |
| 341 }, |
| 342 "accountId": { |
| 343 "description": "The account to list
the associations from.\nSpecify \"-\" to list all creatives the current user has
access to.", |
| 344 "location": "path", |
| 345 "required": true, |
| 346 "type": "string" |
| 347 }, |
| 348 "pageSize": { |
| 349 "description": "Requested page size.
Server may return fewer associations than requested.\nIf unspecified, server wi
ll pick an appropriate default.", |
| 350 "format": "int32", |
| 351 "location": "query", |
| 352 "type": "integer" |
| 353 }, |
| 354 "query": { |
| 355 "description": "An optional query st
ring to filter deal associations. If no filter is\nspecified, all associations w
ill be returned.\nSupported queries are:\n<ul>\n<li>accountId=<i>account_id_stri
ng</i>\n<li>creativeId=<i>creative_id_string</i>\n<li>dealsId=<i>deals_id_string
</i>\n<li>dealsStatus:{approved, conditionally_approved, disapproved,\n
not_checked}\n<li>openAuctionStatus:{approved, conditionally_approved,
disapproved,\n not_checked}\n</ul>\nExample: 'dealsId=12
345 AND dealsStatus:disapproved'", |
| 356 "location": "query", |
| 357 "type": "string" |
| 358 }, |
| 359 "creativeId": { |
| 360 "description": "The creative ID to l
ist the associations from.\nSpecify \"-\" to list all creatives under the above
account.", |
| 361 "location": "path", |
| 362 "required": true, |
| 363 "type": "string" |
| 364 } |
| 365 }, |
| 366 "path": "v2beta1/accounts/{accountId}/creati
ves/{creativeId}/dealAssociations", |
| 367 "response": { |
| 368 "$ref": "ListDealAssociationsResponse" |
| 369 }, |
| 370 "scopes": [ |
| 371 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
| 372 ] |
| 373 }, |
| 374 "add": { |
| 375 "description": "Associate an existing deal w
ith a creative.", |
| 376 "httpMethod": "POST", |
| 377 "id": "adexchangebuyer2.accounts.creatives.d
ealAssociations.add", |
| 378 "parameterOrder": [ |
| 379 "accountId", |
| 380 "creativeId" |
| 381 ], |
| 382 "parameters": { |
| 383 "accountId": { |
| 384 "description": "The account the crea
tive belongs to.", |
| 385 "location": "path", |
| 386 "required": true, |
| 387 "type": "string" |
| 388 }, |
| 389 "creativeId": { |
| 390 "description": "The ID of the creati
ve associated with the deal.", |
| 391 "location": "path", |
| 392 "required": true, |
| 393 "type": "string" |
| 394 } |
| 395 }, |
| 396 "path": "v2beta1/accounts/{accountId}/creati
ves/{creativeId}/dealAssociations:add", |
| 397 "request": { |
| 398 "$ref": "AddDealAssociationRequest" |
| 399 }, |
| 400 "response": { |
| 401 "$ref": "Empty" |
| 402 }, |
| 403 "scopes": [ |
| 404 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
| 405 ] |
| 406 }, |
| 407 "remove": { |
| 408 "description": "Remove the association betwe
en a deal and a creative.", |
| 409 "httpMethod": "POST", |
| 410 "id": "adexchangebuyer2.accounts.creatives.d
ealAssociations.remove", |
| 411 "parameterOrder": [ |
| 412 "accountId", |
| 413 "creativeId" |
| 414 ], |
| 415 "parameters": { |
| 416 "accountId": { |
| 417 "description": "The account the crea
tive belongs to.", |
| 418 "location": "path", |
| 419 "required": true, |
| 420 "type": "string" |
| 421 }, |
| 422 "creativeId": { |
| 423 "description": "The ID of the creati
ve associated with the deal.", |
| 424 "location": "path", |
| 425 "required": true, |
| 426 "type": "string" |
| 427 } |
| 428 }, |
| 429 "path": "v2beta1/accounts/{accountId}/creati
ves/{creativeId}/dealAssociations:remove", |
| 430 "request": { |
| 431 "$ref": "RemoveDealAssociationRequest" |
| 432 }, |
| 433 "response": { |
| 434 "$ref": "Empty" |
| 435 }, |
| 436 "scopes": [ |
| 437 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
| 438 ] |
| 439 } |
| 440 } |
| 441 } |
| 442 } |
| 443 }, |
| 444 "clients": { |
| 445 "methods": { |
| 446 "get": { |
| 447 "description": "Gets a client buyer with a given cli
ent account ID.", |
| 448 "httpMethod": "GET", |
| 449 "id": "adexchangebuyer2.accounts.clients.get", |
| 450 "parameterOrder": [ |
| 451 "accountId", |
| 452 "clientAccountId" |
| 453 ], |
| 454 "parameters": { |
| 455 "accountId": { |
| 456 "description": "Numerical account ID of the
client's sponsor buyer. (required)", |
| 457 "format": "int64", |
| 458 "location": "path", |
| 459 "required": true, |
| 460 "type": "string" |
| 461 }, |
| 462 "clientAccountId": { |
| 463 "description": "Numerical account ID of the
client buyer to retrieve. (required)", |
| 464 "format": "int64", |
| 465 "location": "path", |
| 466 "required": true, |
| 467 "type": "string" |
| 468 } |
| 469 }, |
| 470 "path": "v2beta1/accounts/{accountId}/clients/{clien
tAccountId}", |
| 471 "response": { |
| 472 "$ref": "Client" |
| 473 }, |
| 474 "scopes": [ |
| 475 "https://www.googleapis.com/auth/adexchange.buye
r" |
| 476 ] |
| 477 }, |
| 478 "list": { |
| 479 "description": "Lists all the clients for the curren
t sponsor buyer.", |
| 480 "httpMethod": "GET", |
| 481 "id": "adexchangebuyer2.accounts.clients.list", |
| 482 "parameterOrder": [ |
| 483 "accountId" |
| 484 ], |
| 485 "parameters": { |
| 486 "pageToken": { |
| 487 "description": "A token identifying a page o
f results the server should return.\nTypically, this is the value of\nListClient
sResponse.nextPageToken\nreturned from the previous call to the\naccounts.client
s.list method.", |
| 488 "location": "query", |
| 489 "type": "string" |
| 490 }, |
| 491 "accountId": { |
| 492 "description": "Unique numerical account ID
of the sponsor buyer to list the clients for.", |
| 493 "format": "int64", |
| 494 "location": "path", |
| 495 "required": true, |
| 496 "type": "string" |
| 497 }, |
| 498 "pageSize": { |
| 499 "description": "Requested page size. The ser
ver may return fewer clients than requested.\nIf unspecified, the server will pi
ck an appropriate default.", |
| 500 "format": "int32", |
| 501 "location": "query", |
| 502 "type": "integer" |
| 503 } |
| 504 }, |
| 505 "path": "v2beta1/accounts/{accountId}/clients", |
| 506 "response": { |
| 507 "$ref": "ListClientsResponse" |
| 508 }, |
| 509 "scopes": [ |
| 510 "https://www.googleapis.com/auth/adexchange.buye
r" |
| 511 ] |
| 512 }, |
| 513 "update": { |
| 514 "description": "Updates an existing client buyer.", |
| 515 "httpMethod": "PUT", |
| 516 "id": "adexchangebuyer2.accounts.clients.update", |
| 517 "parameterOrder": [ |
| 518 "accountId", |
| 519 "clientAccountId" |
| 520 ], |
| 521 "parameters": { |
| 522 "accountId": { |
| 523 "description": "Unique numerical account ID
for the buyer of which the client buyer\nis a customer; the sponsor buyer to upd
ate a client for. (required)", |
| 524 "format": "int64", |
| 525 "location": "path", |
| 526 "required": true, |
| 527 "type": "string" |
| 528 }, |
| 529 "clientAccountId": { |
| 530 "description": "Unique numerical account ID
of the client to update. (required)", |
| 531 "format": "int64", |
| 532 "location": "path", |
| 533 "required": true, |
| 534 "type": "string" |
| 535 } |
| 536 }, |
| 537 "path": "v2beta1/accounts/{accountId}/clients/{clien
tAccountId}", |
| 538 "request": { |
| 539 "$ref": "Client" |
| 540 }, |
| 541 "response": { |
| 542 "$ref": "Client" |
| 543 }, |
| 544 "scopes": [ |
| 545 "https://www.googleapis.com/auth/adexchange.buye
r" |
| 546 ] |
| 547 }, |
| 548 "create": { |
| 549 "description": "Creates a new client buyer.", |
| 550 "httpMethod": "POST", |
| 551 "id": "adexchangebuyer2.accounts.clients.create", |
| 552 "parameterOrder": [ |
| 553 "accountId" |
| 554 ], |
| 555 "parameters": { |
| 556 "accountId": { |
| 557 "description": "Unique numerical account ID
for the buyer of which the client buyer\nis a customer; the sponsor buyer to cre
ate a client for. (required)", |
| 558 "format": "int64", |
| 559 "location": "path", |
| 560 "required": true, |
| 561 "type": "string" |
| 562 } |
| 563 }, |
| 564 "path": "v2beta1/accounts/{accountId}/clients", |
| 565 "request": { |
| 566 "$ref": "Client" |
| 567 }, |
| 568 "response": { |
| 569 "$ref": "Client" |
| 570 }, |
| 571 "scopes": [ |
| 572 "https://www.googleapis.com/auth/adexchange.buye
r" |
| 573 ] |
| 574 } |
| 575 }, |
| 576 "resources": { |
252 "invitations": { | 577 "invitations": { |
253 "methods": { | 578 "methods": { |
254 "get": { | 579 "get": { |
255 "description": "Retrieves an existing client
user invitation.", | 580 "description": "Retrieves an existing client
user invitation.", |
256 "httpMethod": "GET", | 581 "httpMethod": "GET", |
257 "id": "adexchangebuyer2.accounts.clients.inv
itations.get", | 582 "id": "adexchangebuyer2.accounts.clients.inv
itations.get", |
258 "parameterOrder": [ | 583 "parameterOrder": [ |
259 "accountId", | 584 "accountId", |
260 "clientAccountId", | 585 "clientAccountId", |
261 "invitationId" | 586 "invitationId" |
262 ], | 587 ], |
263 "parameters": { | 588 "parameters": { |
| 589 "accountId": { |
| 590 "description": "Numerical account ID
of the client's sponsor buyer. (required)", |
| 591 "format": "int64", |
| 592 "location": "path", |
| 593 "required": true, |
| 594 "type": "string" |
| 595 }, |
| 596 "clientAccountId": { |
| 597 "description": "Numerical account ID
of the client buyer that the user invitation\nto be retrieved is associated wit
h. (required)", |
| 598 "format": "int64", |
| 599 "location": "path", |
| 600 "required": true, |
| 601 "type": "string" |
| 602 }, |
264 "invitationId": { | 603 "invitationId": { |
265 "description": "Numerical identifier
of the user invitation to retrieve. (required)", | 604 "description": "Numerical identifier
of the user invitation to retrieve. (required)", |
266 "format": "int64", | 605 "format": "int64", |
267 "location": "path", | 606 "location": "path", |
268 "required": true, | 607 "required": true, |
269 "type": "string" | 608 "type": "string" |
270 }, | |
271 "accountId": { | |
272 "description": "Numerical account ID
of the client's sponsor buyer. (required)", | |
273 "format": "int64", | |
274 "location": "path", | |
275 "required": true, | |
276 "type": "string" | |
277 }, | |
278 "clientAccountId": { | |
279 "description": "Numerical account ID
of the client buyer that the user invitation\nto be retrieved is associated wit
h. (required)", | |
280 "format": "int64", | |
281 "location": "path", | |
282 "required": true, | |
283 "type": "string" | |
284 } | 609 } |
285 }, | 610 }, |
286 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/invitations/{invitationId}", | 611 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/invitations/{invitationId}", |
287 "response": { | 612 "response": { |
288 "$ref": "ClientUserInvitation" | 613 "$ref": "ClientUserInvitation" |
289 }, | 614 }, |
290 "scopes": [ | 615 "scopes": [ |
291 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 616 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
292 ] | 617 ] |
293 }, | 618 }, |
(...skipping 203 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
497 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 822 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
498 ] | 823 ] |
499 } | 824 } |
500 } | 825 } |
501 } | 826 } |
502 } | 827 } |
503 } | 828 } |
504 } | 829 } |
505 } | 830 } |
506 }, | 831 }, |
507 "revision": "20170206", | 832 "revision": "20170302", |
508 "rootUrl": "https://adexchangebuyer.googleapis.com/", | 833 "rootUrl": "https://adexchangebuyer.googleapis.com/", |
509 "schemas": { | 834 "schemas": { |
| 835 "ListClientUsersResponse": { |
| 836 "id": "ListClientUsersResponse", |
| 837 "properties": { |
| 838 "users": { |
| 839 "description": "The returned list of client users.", |
| 840 "items": { |
| 841 "$ref": "ClientUser" |
| 842 }, |
| 843 "type": "array" |
| 844 }, |
| 845 "nextPageToken": { |
| 846 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListClientUsersRequest.pageToken\nfield in the subseq
uent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of
results.", |
| 847 "type": "string" |
| 848 } |
| 849 }, |
| 850 "type": "object" |
| 851 }, |
| 852 "ListClientUserInvitationsResponse": { |
| 853 "id": "ListClientUserInvitationsResponse", |
| 854 "properties": { |
| 855 "invitations": { |
| 856 "description": "The returned list of client users.", |
| 857 "items": { |
| 858 "$ref": "ClientUserInvitation" |
| 859 }, |
| 860 "type": "array" |
| 861 }, |
| 862 "nextPageToken": { |
| 863 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListClientUserInvitationsRequest.pageToken\nfield in
the subsequent call to the\nclients.invitations.list\nmethod to retrieve the nex
t\npage of results.", |
| 864 "type": "string" |
| 865 } |
| 866 }, |
| 867 "type": "object" |
| 868 }, |
| 869 "LocationContext": { |
| 870 "description": "@OutputOnly The Geo criteria the restriction applies
to.", |
| 871 "id": "LocationContext", |
| 872 "properties": { |
| 873 "geoCriteriaIds": { |
| 874 "description": "IDs representing the geo location for this c
ontext.\nPlease refer to the\n[geo-table.csv](https://storage.googleapis.com/adx
-rtb-dictionaries/geo-table.csv)\nfile for different geo criteria IDs.", |
| 875 "items": { |
| 876 "format": "int32", |
| 877 "type": "integer" |
| 878 }, |
| 879 "type": "array" |
| 880 } |
| 881 }, |
| 882 "type": "object" |
| 883 }, |
| 884 "PlatformContext": { |
| 885 "description": "@OutputOnly The type of platform the restriction app
lies to.", |
| 886 "id": "PlatformContext", |
| 887 "properties": { |
| 888 "platforms": { |
| 889 "description": "The platforms this restriction applies to.", |
| 890 "enumDescriptions": [ |
| 891 "Desktop platform.", |
| 892 "Android platform.", |
| 893 "iOS platform." |
| 894 ], |
| 895 "items": { |
| 896 "enum": [ |
| 897 "DESKTOP", |
| 898 "ANDROID", |
| 899 "IOS" |
| 900 ], |
| 901 "type": "string" |
| 902 }, |
| 903 "type": "array" |
| 904 } |
| 905 }, |
| 906 "type": "object" |
| 907 }, |
| 908 "ClientUser": { |
| 909 "description": "A client user is created under a client buyer and ha
s restricted access to\nthe Ad Exchange Marketplace and certain other sections\n
of the Ad Exchange Buyer UI based on the role\ngranted to the associated client
buyer.\n\nThe only way a new client user can be created is via accepting an\nema
il invitation\n(see the\naccounts.clients.invitations.create\nmethod).\n\nAll fi
elds are required unless otherwise specified.", |
| 910 "id": "ClientUser", |
| 911 "properties": { |
| 912 "status": { |
| 913 "description": "The status of the client user.", |
| 914 "enum": [ |
| 915 "USER_STATUS_UNSPECIFIED", |
| 916 "PENDING", |
| 917 "ACTIVE", |
| 918 "DISABLED" |
| 919 ], |
| 920 "enumDescriptions": [ |
| 921 "A placeholder for an undefined user status.", |
| 922 "A user who was already created but hasn't accepted the
invitation yet.", |
| 923 "A user that is currently active.", |
| 924 "A user that is currently disabled." |
| 925 ], |
| 926 "type": "string" |
| 927 }, |
| 928 "userId": { |
| 929 "description": "The unique numerical ID of the client user\n
that has accepted an invitation.\nThe value of this field is ignored in an updat
e operation.", |
| 930 "format": "int64", |
| 931 "type": "string" |
| 932 }, |
| 933 "email": { |
| 934 "description": "User's email address. The value of this fiel
d\nis ignored in an update operation.", |
| 935 "type": "string" |
| 936 }, |
| 937 "clientAccountId": { |
| 938 "description": "Numerical account ID of the client buyer\nwi
th which the user is associated; the\nbuyer must be a client of the current spon
sor buyer.\nThe value of this field is ignored in an update operation.", |
| 939 "format": "int64", |
| 940 "type": "string" |
| 941 } |
| 942 }, |
| 943 "type": "object" |
| 944 }, |
| 945 "CreativeDealAssociation": { |
| 946 "description": "The association between a creative and a deal.", |
| 947 "id": "CreativeDealAssociation", |
| 948 "properties": { |
| 949 "accountId": { |
| 950 "description": "The account the creative belongs to.", |
| 951 "type": "string" |
| 952 }, |
| 953 "creativeId": { |
| 954 "description": "The ID of the creative associated with the d
eal.", |
| 955 "type": "string" |
| 956 }, |
| 957 "dealsId": { |
| 958 "description": "The externalDealId for the deal associated w
ith the creative.", |
| 959 "type": "string" |
| 960 } |
| 961 }, |
| 962 "type": "object" |
| 963 }, |
| 964 "Creative": { |
| 965 "description": "A creative and its classification data.", |
| 966 "id": "Creative", |
| 967 "properties": { |
| 968 "native": { |
| 969 "$ref": "NativeContent", |
| 970 "description": "A native creative." |
| 971 }, |
| 972 "video": { |
| 973 "$ref": "VideoContent", |
| 974 "description": "A video creative." |
| 975 }, |
| 976 "servingRestrictions": { |
| 977 "description": "@OutputOnly The granular status of this ad i
n specific contexts.\nA context here relates to where something ultimately serve
s (for example,\na physical location, a platform, an HTTPS vs HTTP request, or t
he type\nof auction).", |
| 978 "items": { |
| 979 "$ref": "ServingRestriction" |
| 980 }, |
| 981 "type": "array" |
| 982 }, |
| 983 "agencyId": { |
| 984 "description": "The agency ID for this creative.", |
| 985 "format": "int64", |
| 986 "type": "string" |
| 987 }, |
| 988 "clickThroughUrls": { |
| 989 "description": "The set of destination URLs for the creative
.", |
| 990 "items": { |
| 991 "type": "string" |
| 992 }, |
| 993 "type": "array" |
| 994 }, |
| 995 "detectedSensitiveCategories": { |
| 996 "description": "@OutputOnly Detected sensitive categories, i
f any.\nSee the ad-sensitive-categories.txt file in the technical documentation
for\na list of IDs. You should use these IDs along with the\nexcluded-sensitive-
category field in the bid request to filter your bids.", |
| 997 "items": { |
| 998 "format": "int32", |
| 999 "type": "integer" |
| 1000 }, |
| 1001 "type": "array" |
| 1002 }, |
| 1003 "adChoicesDestinationUrl": { |
| 1004 "description": "The link to AdChoices destination page.", |
| 1005 "type": "string" |
| 1006 }, |
| 1007 "restrictedCategories": { |
| 1008 "description": "All restricted categories for the ads that m
ay be shown from this creative.", |
| 1009 "enumDescriptions": [ |
| 1010 "The ad has no restricted categories", |
| 1011 "The alcohol restricted category." |
| 1012 ], |
| 1013 "items": { |
| 1014 "enum": [ |
| 1015 "NO_RESTRICTED_CATEGORIES", |
| 1016 "ALCOHOL" |
| 1017 ], |
| 1018 "type": "string" |
| 1019 }, |
| 1020 "type": "array" |
| 1021 }, |
| 1022 "corrections": { |
| 1023 "description": "@OutputOnly Shows any corrections that were
applied to this creative.", |
| 1024 "items": { |
| 1025 "$ref": "Correction" |
| 1026 }, |
| 1027 "type": "array" |
| 1028 }, |
| 1029 "version": { |
| 1030 "description": "@OutputOnly The version of this creative.", |
| 1031 "format": "int32", |
| 1032 "type": "integer" |
| 1033 }, |
| 1034 "vendorIds": { |
| 1035 "description": "All vendor IDs for the ads that may be shown
from this creative.\nSee https://storage.googleapis.com/adx-rtb-dictionaries/ve
ndors.txt\nfor possible values.", |
| 1036 "items": { |
| 1037 "format": "int32", |
| 1038 "type": "integer" |
| 1039 }, |
| 1040 "type": "array" |
| 1041 }, |
| 1042 "impressionTrackingUrls": { |
| 1043 "description": "The set of URLs to be called to record an im
pression.", |
| 1044 "items": { |
| 1045 "type": "string" |
| 1046 }, |
| 1047 "type": "array" |
| 1048 }, |
| 1049 "html": { |
| 1050 "$ref": "HtmlContent", |
| 1051 "description": "An HTML creative." |
| 1052 }, |
| 1053 "dealsStatus": { |
| 1054 "description": "@OutputOnly The top-level deals status of th
is creative.\nIf disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL')
in\nserving_restrictions will also exist. Note\nthat this may be nuanced with o
ther contextual restrictions, in which case,\nit may be preferable to read from
serving_restrictions directly.\nCan be used to filter the response of the\ncreat
ives.list\nmethod.", |
| 1055 "enum": [ |
| 1056 "STATUS_UNSPECIFIED", |
| 1057 "NOT_CHECKED", |
| 1058 "CONDITIONALLY_APPROVED", |
| 1059 "APPROVED", |
| 1060 "DISAPPROVED" |
| 1061 ], |
| 1062 "enumDescriptions": [ |
| 1063 "The status is unknown.", |
| 1064 "The creative has not been checked.", |
| 1065 "The creative has been conditionally approved.\nSee serv
ing_restrictions for details.", |
| 1066 "The creative has been approved.", |
| 1067 "The creative has been disapproved." |
| 1068 ], |
| 1069 "type": "string" |
| 1070 }, |
| 1071 "detectedProductCategories": { |
| 1072 "description": "@OutputOnly Detected product categories, if
any.\nSee the ad-product-categories.txt file in the technical documentation\nfor
a list of IDs.", |
| 1073 "items": { |
| 1074 "format": "int32", |
| 1075 "type": "integer" |
| 1076 }, |
| 1077 "type": "array" |
| 1078 }, |
| 1079 "openAuctionStatus": { |
| 1080 "description": "@OutputOnly The top-level open auction statu
s of this creative.\nIf disapproved, an entry for 'auctionType = OPEN_AUCTION' (
or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanc
ed with other contextual restrictions, in which case,\nit may be preferable to r
ead from serving_restrictions directly.\nCan be used to filter the response of t
he\ncreatives.list\nmethod.", |
| 1081 "enum": [ |
| 1082 "STATUS_UNSPECIFIED", |
| 1083 "NOT_CHECKED", |
| 1084 "CONDITIONALLY_APPROVED", |
| 1085 "APPROVED", |
| 1086 "DISAPPROVED" |
| 1087 ], |
| 1088 "enumDescriptions": [ |
| 1089 "The status is unknown.", |
| 1090 "The creative has not been checked.", |
| 1091 "The creative has been conditionally approved.\nSee serv
ing_restrictions for details.", |
| 1092 "The creative has been approved.", |
| 1093 "The creative has been disapproved." |
| 1094 ], |
| 1095 "type": "string" |
| 1096 }, |
| 1097 "advertiserName": { |
| 1098 "description": "The name of the company being advertised in
the creative.", |
| 1099 "type": "string" |
| 1100 }, |
| 1101 "detectedAdvertiserIds": { |
| 1102 "description": "@OutputOnly Detected advertiser IDs, if any.
", |
| 1103 "items": { |
| 1104 "format": "int64", |
| 1105 "type": "string" |
| 1106 }, |
| 1107 "type": "array" |
| 1108 }, |
| 1109 "detectedDomains": { |
| 1110 "description": "@OutputOnly\nThe detected domains for this c
reative.", |
| 1111 "items": { |
| 1112 "type": "string" |
| 1113 }, |
| 1114 "type": "array" |
| 1115 }, |
| 1116 "filteringStats": { |
| 1117 "$ref": "FilteringStats", |
| 1118 "description": "@OutputOnly The filtering stats for this cre
ative." |
| 1119 }, |
| 1120 "attributes": { |
| 1121 "description": "All attributes for the ads that may be shown
from this creative.\nCan be used to filter the response of the\ncreatives.list\
nmethod.", |
| 1122 "enumDescriptions": [ |
| 1123 "Do not use. This is a placeholder value only.", |
| 1124 "The creative is tagged.", |
| 1125 "The creative is cookie targeted.", |
| 1126 "The creative is user interest targeted.", |
| 1127 "The creative does not expand.", |
| 1128 "The creative expands up.", |
| 1129 "The creative expands down.", |
| 1130 "The creative expands left.", |
| 1131 "The creative expands right.", |
| 1132 "The creative expands up and left.", |
| 1133 "The creative expands up and right.", |
| 1134 "The creative expands down and left.", |
| 1135 "The creative expands down and right.", |
| 1136 "The creative expands up or down.", |
| 1137 "The creative expands left or right.", |
| 1138 "The creative expands on any diagonal.", |
| 1139 "The creative expands when rolled over.", |
| 1140 "The instream vast video type is vpaid flash.", |
| 1141 "The creative is MRAID", |
| 1142 "The creative is SSL.", |
| 1143 "The creative is an interstitial.", |
| 1144 "The creative is eligible for native.", |
| 1145 "The creative is not eligible for native.", |
| 1146 "The creative can dynamically resize to fill a variety o
f slot sizes." |
| 1147 ], |
| 1148 "items": { |
| 1149 "enum": [ |
| 1150 "ATTRIBUTE_UNSPECIFIED", |
| 1151 "IS_TAGGED", |
| 1152 "IS_COOKIE_TARGETED", |
| 1153 "IS_USER_INTEREST_TARGETED", |
| 1154 "EXPANDING_DIRECTION_NONE", |
| 1155 "EXPANDING_DIRECTION_UP", |
| 1156 "EXPANDING_DIRECTION_DOWN", |
| 1157 "EXPANDING_DIRECTION_LEFT", |
| 1158 "EXPANDING_DIRECTION_RIGHT", |
| 1159 "EXPANDING_DIRECTION_UP_LEFT", |
| 1160 "EXPANDING_DIRECTION_UP_RIGHT", |
| 1161 "EXPANDING_DIRECTION_DOWN_LEFT", |
| 1162 "EXPANDING_DIRECTION_DOWN_RIGHT", |
| 1163 "EXPANDING_DIRECTION_UP_OR_DOWN", |
| 1164 "EXPANDING_DIRECTION_LEFT_OR_RIGHT", |
| 1165 "EXPANDING_DIRECTION_ANY_DIAGONAL", |
| 1166 "EXPANDING_ACTION_ROLLOVER_TO_EXPAND", |
| 1167 "INSTREAM_VAST_VIDEO_TYPE_VPAID_FLASH", |
| 1168 "RICH_MEDIA_CAPABILITY_TYPE_MRAID", |
| 1169 "RICH_MEDIA_CAPABILITY_TYPE_SSL", |
| 1170 "RICH_MEDIA_CAPABILITY_TYPE_INTERSTITIAL", |
| 1171 "NATIVE_ELIGIBILITY_ELIGIBLE", |
| 1172 "NATIVE_ELIGIBILITY_NOT_ELIGIBLE", |
| 1173 "RENDERING_SIZELESS_ADX" |
| 1174 ], |
| 1175 "type": "string" |
| 1176 }, |
| 1177 "type": "array" |
| 1178 }, |
| 1179 "apiUpdateTime": { |
| 1180 "description": "@OutputOnly The last update timestamp of the
creative via API.", |
| 1181 "format": "google-datetime", |
| 1182 "type": "string" |
| 1183 }, |
| 1184 "detectedLanguages": { |
| 1185 "description": "@OutputOnly\nThe detected languages for this
creative. The order is arbitrary. The codes\nare 2 or 5 characters and are docu
mented at\nhttps://developers.google.com/adwords/api/docs/appendix/languagecodes
.", |
| 1186 "items": { |
| 1187 "type": "string" |
| 1188 }, |
| 1189 "type": "array" |
| 1190 }, |
| 1191 "creativeId": { |
| 1192 "description": "The buyer-defined creative ID of this creati
ve.\nCan be used to filter the response of the\ncreatives.list\nmethod.", |
| 1193 "type": "string" |
| 1194 }, |
| 1195 "accountId": { |
| 1196 "description": "The account that this creative belongs to.\n
Can be used to filter the response of the\ncreatives.list\nmethod.", |
| 1197 "type": "string" |
| 1198 } |
| 1199 }, |
| 1200 "type": "object" |
| 1201 }, |
| 1202 "FilteringStats": { |
| 1203 "description": "@OutputOnly Filtering reasons for this creative duri
ng a period of a single\nday (from midnight to midnight Pacific).", |
| 1204 "id": "FilteringStats", |
| 1205 "properties": { |
| 1206 "reasons": { |
| 1207 "description": "The set of filtering reasons for this date."
, |
| 1208 "items": { |
| 1209 "$ref": "Reason" |
| 1210 }, |
| 1211 "type": "array" |
| 1212 }, |
| 1213 "date": { |
| 1214 "$ref": "Date", |
| 1215 "description": "The day during which the data was collected.
\nThe data is collected from 00:00:00 to 23:59:59 PT.\nDuring switches from PST
to PDT and back, the day may\ncontain 23 or 25 hours of data instead of the usua
l 24." |
| 1216 } |
| 1217 }, |
| 1218 "type": "object" |
| 1219 }, |
| 1220 "RemoveDealAssociationRequest": { |
| 1221 "description": "A request for removing the association between a dea
l and a creative.", |
| 1222 "id": "RemoveDealAssociationRequest", |
| 1223 "properties": { |
| 1224 "association": { |
| 1225 "$ref": "CreativeDealAssociation", |
| 1226 "description": "The association between a creative and a dea
l that should be removed." |
| 1227 } |
| 1228 }, |
| 1229 "type": "object" |
| 1230 }, |
510 "Client": { | 1231 "Client": { |
511 "description": "A client resource represents a client buyer—an
agency,\na brand, or an advertiser customer of the sponsor buyer.\nUsers associ
ated with the client buyer have restricted access to\nthe Ad Exchange Marketplac
e and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngra
nted to the client buyer.\nAll fields are required unless otherwise specified.", | 1232 "description": "A client resource represents a client buyer—an
agency,\na brand, or an advertiser customer of the sponsor buyer.\nUsers associ
ated with the client buyer have restricted access to\nthe Ad Exchange Marketplac
e and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngra
nted to the client buyer.\nAll fields are required unless otherwise specified.", |
512 "id": "Client", | 1233 "id": "Client", |
513 "properties": { | 1234 "properties": { |
514 "clientName": { | 1235 "clientName": { |
515 "description": "Name used to represent this client to publis
hers.\nYou may have multiple clients that map to the same entity,\nbut for each
client the combination of `clientName` and entity\nmust be unique.\nYou can spec
ify this field as empty.", | 1236 "description": "Name used to represent this client to publis
hers.\nYou may have multiple clients that map to the same entity,\nbut for each
client the combination of `clientName` and entity\nmust be unique.\nYou can spec
ify this field as empty.", |
516 "type": "string" | 1237 "type": "string" |
517 }, | 1238 }, |
518 "role": { | 1239 "role": { |
519 "description": "The role which is assigned to the client buy
er. Each role implies a set of\npermissions granted to the client. Must be one o
f `CLIENT_DEAL_VIEWER`,\n`CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.", | 1240 "description": "The role which is assigned to the client buy
er. Each role implies a set of\npermissions granted to the client. Must be one o
f `CLIENT_DEAL_VIEWER`,\n`CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.", |
(...skipping 55 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
575 "A placeholder for an undefined client entity type. Shou
ld not be used.", | 1296 "A placeholder for an undefined client entity type. Shou
ld not be used.", |
576 "An advertiser.", | 1297 "An advertiser.", |
577 "A brand.", | 1298 "A brand.", |
578 "An advertising agency." | 1299 "An advertising agency." |
579 ], | 1300 ], |
580 "type": "string" | 1301 "type": "string" |
581 } | 1302 } |
582 }, | 1303 }, |
583 "type": "object" | 1304 "type": "object" |
584 }, | 1305 }, |
585 "ClientUser": { | 1306 "Correction": { |
586 "description": "A client user is created under a client buyer and ha
s restricted access to\nthe Ad Exchange Marketplace and certain other sections\n
of the Ad Exchange Buyer UI based on the role\ngranted to the associated client
buyer.\n\nThe only way a new client user can be created is via accepting an\nema
il invitation\n(see the\naccounts.clients.invitations.create\nmethod).\n\nAll fi
elds are required unless otherwise specified.", | 1307 "description": "@OutputOnly Shows any corrections that were applied
to this creative.", |
587 "id": "ClientUser", | 1308 "id": "Correction", |
588 "properties": { | 1309 "properties": { |
| 1310 "details": { |
| 1311 "description": "Additional details about what was corrected.
", |
| 1312 "items": { |
| 1313 "type": "string" |
| 1314 }, |
| 1315 "type": "array" |
| 1316 }, |
| 1317 "type": { |
| 1318 "description": "The type of correction that was applied to t
he creative.", |
| 1319 "enum": [ |
| 1320 "CORRECTION_TYPE_UNSPECIFIED", |
| 1321 "VENDOR_IDS_ADDED", |
| 1322 "SSL_ATTRIBUTE_REMOVED", |
| 1323 "FLASH_FREE_ATTRIBUTE_REMOVED", |
| 1324 "FLASH_FREE_ATTRIBUTE_ADDED", |
| 1325 "REQUIRED_ATTRIBUTE_ADDED", |
| 1326 "REQUIRED_VENDOR_ADDED", |
| 1327 "SSL_ATTRIBUTE_ADDED", |
| 1328 "IN_BANNER_VIDEO_ATTRIBUTE_ADDED", |
| 1329 "MRAID_ATTRIBUTE_ADDED", |
| 1330 "FLASH_ATTRIBUTE_REMOVED", |
| 1331 "VIDEO_IN_SNIPPET_ATTRIBUTE_ADDED" |
| 1332 ], |
| 1333 "enumDescriptions": [ |
| 1334 "The correction type is unknown. Refer to the details fo
r more information.", |
| 1335 "The ad's declared vendors did not match the vendors tha
t were detected.\nThe detected vendors were added.", |
| 1336 "The ad had the SSL attribute declared but was not SSL-c
ompliant.\nThe SSL attribute was removed.", |
| 1337 "The ad was declared as Flash-free but contained Flash,
so the Flash-free\nattribute was removed.", |
| 1338 "The ad was not declared as Flash-free but it did not re
ference any flash\ncontent, so the Flash-free attribute was added.", |
| 1339 "The ad did not declare a required creative attribute.\n
The attribute was added.", |
| 1340 "The ad did not declare a required technology vendor.\nT
he technology vendor was added.", |
| 1341 "The ad did not declare the SSL attribute but was SSL-co
mpliant, so the\nSSL attribute was added.", |
| 1342 "Properties consistent with In-banner video were found,
so an\nIn-Banner Video attribute was added.", |
| 1343 "The ad makes calls to the MRAID API so the MRAID attrib
ute was added.", |
| 1344 "The ad unnecessarily declared the Flash attribute, so t
he Flash attribute\nwas removed.", |
| 1345 "The ad contains video content." |
| 1346 ], |
| 1347 "type": "string" |
| 1348 }, |
| 1349 "contexts": { |
| 1350 "description": "The contexts for the correction.", |
| 1351 "items": { |
| 1352 "$ref": "ServingContext" |
| 1353 }, |
| 1354 "type": "array" |
| 1355 } |
| 1356 }, |
| 1357 "type": "object" |
| 1358 }, |
| 1359 "AddDealAssociationRequest": { |
| 1360 "description": "A request for associating a deal and a creative.", |
| 1361 "id": "AddDealAssociationRequest", |
| 1362 "properties": { |
| 1363 "association": { |
| 1364 "$ref": "CreativeDealAssociation", |
| 1365 "description": "The association between a creative and a dea
l that should be added." |
| 1366 } |
| 1367 }, |
| 1368 "type": "object" |
| 1369 }, |
| 1370 "ListDealAssociationsResponse": { |
| 1371 "description": "A response for listing creative and deal association
s", |
| 1372 "id": "ListDealAssociationsResponse", |
| 1373 "properties": { |
| 1374 "associations": { |
| 1375 "description": "The list of associations.", |
| 1376 "items": { |
| 1377 "$ref": "CreativeDealAssociation" |
| 1378 }, |
| 1379 "type": "array" |
| 1380 }, |
| 1381 "nextPageToken": { |
| 1382 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListDealAssociationsRequest.page_token\nfield in the
subsequent call to 'ListDealAssociation' method to retrieve\nthe next page of re
sults.", |
| 1383 "type": "string" |
| 1384 } |
| 1385 }, |
| 1386 "type": "object" |
| 1387 }, |
| 1388 "StopWatchingCreativeRequest": { |
| 1389 "description": "A request for stopping notifications for changes to
creative Status.", |
| 1390 "id": "StopWatchingCreativeRequest", |
| 1391 "properties": {}, |
| 1392 "type": "object" |
| 1393 }, |
| 1394 "Disapproval": { |
| 1395 "description": "@OutputOnly The reason and details for a disapproval
.", |
| 1396 "id": "Disapproval", |
| 1397 "properties": { |
| 1398 "details": { |
| 1399 "description": "Additional details about the reason for disa
pproval.", |
| 1400 "items": { |
| 1401 "type": "string" |
| 1402 }, |
| 1403 "type": "array" |
| 1404 }, |
| 1405 "reason": { |
| 1406 "description": "The categorized reason for disapproval.", |
| 1407 "enum": [ |
| 1408 "LENGTH_OF_IMAGE_ANIMATION", |
| 1409 "BROKEN_URL", |
| 1410 "MEDIA_NOT_FUNCTIONAL", |
| 1411 "INVALID_FOURTH_PARTY_CALL", |
| 1412 "INCORRECT_REMARKETING_DECLARATION", |
| 1413 "LANDING_PAGE_ERROR", |
| 1414 "AD_SIZE_DOES_NOT_MATCH_AD_SLOT", |
| 1415 "NO_BORDER", |
| 1416 "FOURTH_PARTY_BROWSER_COOKIES", |
| 1417 "LSO_OBJECTS", |
| 1418 "BLANK_CREATIVE", |
| 1419 "DESTINATION_URLS_UNDECLARED", |
| 1420 "PROBLEM_WITH_CLICK_MACRO", |
| 1421 "INCORRECT_AD_TECHNOLOGY_DECLARATION", |
| 1422 "INCORRECT_DESTINATION_URL_DECLARATION", |
| 1423 "EXPANDABLE_INCORRECT_DIRECTION", |
| 1424 "EXPANDABLE_DIRECTION_NOT_SUPPORTED", |
| 1425 "EXPANDABLE_INVALID_VENDOR", |
| 1426 "EXPANDABLE_FUNCTIONALITY", |
| 1427 "VIDEO_INVALID_VENDOR", |
| 1428 "VIDEO_UNSUPPORTED_LENGTH", |
| 1429 "VIDEO_UNSUPPORTED_FORMAT", |
| 1430 "VIDEO_FUNCTIONALITY", |
| 1431 "LANDING_PAGE_DISABLED", |
| 1432 "MALWARE_SUSPECTED", |
| 1433 "ADULT_IMAGE_OR_VIDEO", |
| 1434 "INACCURATE_AD_TEXT", |
| 1435 "COUNTERFEIT_DESIGNER_GOODS", |
| 1436 "POP_UP", |
| 1437 "INVALID_RTB_PROTOCOL_USAGE", |
| 1438 "RAW_IP_ADDRESS_IN_SNIPPET", |
| 1439 "UNACCEPTABLE_CONTENT_SOFTWARE", |
| 1440 "UNAUTHORIZED_COOKIE_ON_GOOGLE_DOMAIN", |
| 1441 "UNDECLARED_FLASH_OBJECTS", |
| 1442 "INVALID_SSL_DECLARATION", |
| 1443 "DIRECT_DOWNLOAD_IN_AD", |
| 1444 "MAXIMUM_DOWNLOAD_SIZE_EXCEEDED", |
| 1445 "DESTINATION_URL_SITE_NOT_CRAWLABLE", |
| 1446 "BAD_URL_LEGAL_DISAPPROVAL", |
| 1447 "PHARMA_GAMBLING_ALCOHOL_NOT_ALLOWED", |
| 1448 "DYNAMIC_DNS_AT_DESTINATION_URL", |
| 1449 "POOR_IMAGE_OR_VIDEO_QUALITY", |
| 1450 "UNACCEPTABLE_IMAGE_CONTENT", |
| 1451 "INCORRECT_IMAGE_LAYOUT", |
| 1452 "IRRELEVANT_IMAGE_OR_VIDEO", |
| 1453 "DESTINATION_SITE_DOES_NOT_ALLOW_GOING_BACK", |
| 1454 "MISLEADING_CLAIMS_IN_AD", |
| 1455 "RESTRICTED_PRODUCTS", |
| 1456 "UNACCEPTABLE_CONTENT", |
| 1457 "AUTOMATED_AD_CLICKING", |
| 1458 "INVALID_URL_PROTOCOL", |
| 1459 "UNDECLARED_RESTRICTED_CONTENT", |
| 1460 "INVALID_REMARKETING_LIST_USAGE", |
| 1461 "DESTINATION_SITE_NOT_CRAWLABLE_ROBOTS_TXT", |
| 1462 "CLICK_TO_DOWNLOAD_NOT_AN_APP", |
| 1463 "INACCURATE_REVIEW_EXTENSION", |
| 1464 "SEXUALLY_EXPLICIT_CONTENT", |
| 1465 "GAINING_AN_UNFAIR_ADVANTAGE", |
| 1466 "GAMING_THE_GOOGLE_NETWORK", |
| 1467 "DANGEROUS_PRODUCTS_KNIVES", |
| 1468 "DANGEROUS_PRODUCTS_EXPLOSIVES", |
| 1469 "DANGEROUS_PRODUCTS_GUNS", |
| 1470 "DANGEROUS_PRODUCTS_DRUGS", |
| 1471 "DANGEROUS_PRODUCTS_TOBACCO", |
| 1472 "DANGEROUS_PRODUCTS_WEAPONS", |
| 1473 "UNCLEAR_OR_IRRELEVANT_AD", |
| 1474 "PROFESSIONAL_STANDARDS", |
| 1475 "DYSFUNCTIONAL_PROMOTION", |
| 1476 "INVALID_INTEREST_BASED_AD", |
| 1477 "MISUSE_OF_PERSONAL_INFORMATION", |
| 1478 "OMISSION_OF_RELEVANT_INFORMATION", |
| 1479 "UNAVAILABLE_PROMOTIONS", |
| 1480 "MISLEADING_PROMOTIONS", |
| 1481 "INAPPROPRIATE_CONTENT", |
| 1482 "SENSITIVE_EVENTS", |
| 1483 "SHOCKING_CONTENT", |
| 1484 "ENABLING_DISHONEST_BEHAVIOR", |
| 1485 "TECHNICAL_REQUIREMENTS", |
| 1486 "RESTRICTED_POLITICAL_CONTENT", |
| 1487 "UNSUPPORTED_CONTENT", |
| 1488 "INVALID_BIDDING_METHOD", |
| 1489 "VIDEO_TOO_LONG", |
| 1490 "VIOLATES_JAPANESE_PHARMACY_LAW", |
| 1491 "UNACCREDITED_PET_PHARMACY", |
| 1492 "ABORTION", |
| 1493 "CONTRACEPTIVES", |
| 1494 "NEED_CERTIFICATES_TO_ADVERTISE_IN_CHINA", |
| 1495 "KCDSP_REGISTRATION", |
| 1496 "NOT_FAMILY_SAFE", |
| 1497 "CLINICAL_TRIAL_RECRUITMENT", |
| 1498 "MAXIMUM_NUMBER_OF_HTTP_CALLS_EXCEEDED", |
| 1499 "MAXIMUM_NUMBER_OF_COOKIES_EXCEEDED", |
| 1500 "PERSONAL_LOANS", |
| 1501 "UNSUPPORTED_FLASH_CONTENT" |
| 1502 ], |
| 1503 "enumDescriptions": [ |
| 1504 "The length of the image animation is longer than allowe
d.", |
| 1505 "The click through URL doesn't work properly.", |
| 1506 "Something is wrong with the creative itself.", |
| 1507 "The ad makes a fourth party call to an unapproved vendo
r.", |
| 1508 "The ad targets consumers using remarketing lists and/or
collects\ndata for subsequent use in retargeting, but does not correctly declar
e\nthat use.", |
| 1509 "Clicking on the ad leads to an error page.", |
| 1510 "The ad size when rendered does not match the declaratio
n.", |
| 1511 "Ads with a white background require a border, which was
missing.", |
| 1512 "The creative attempts to set cookies from a fourth part
y that is not\ncertified.", |
| 1513 "The creative sets an LSO object.", |
| 1514 "The ad serves a blank.", |
| 1515 "The ad uses rotation, but not all destination URLs were
declared.", |
| 1516 "There is a problem with the way the click macro is used
.", |
| 1517 "The ad technology declaration is not accurate.", |
| 1518 "The actual destination URL does not match the declared
destination URL.", |
| 1519 "The declared expanding direction does not match the act
ual direction.", |
| 1520 "The ad does not expand in a supported direction.", |
| 1521 "The ad uses an expandable vendor that is not supported.
", |
| 1522 "There was an issue with the expandable ad.", |
| 1523 "The ad uses a video vendor that is not supported.", |
| 1524 "The length of the video ad is not supported.", |
| 1525 "The format of the video ad is not supported.", |
| 1526 "There was an issue with the video ad.", |
| 1527 "The landing page does not conform to Ad Exchange policy
.", |
| 1528 "The ad or the landing page may contain malware.", |
| 1529 "The ad contains adult images or video content.", |
| 1530 "The ad contains text that is unclear or inaccurate.", |
| 1531 "The ad promotes counterfeit designer goods.", |
| 1532 "The ad causes a popup window to appear.", |
| 1533 "The creative does not follow policies set for the RTB p
rotocol.", |
| 1534 "The ad contains a URL that uses a numeric IP address fo
r the domain.", |
| 1535 "The ad or landing page contains unacceptable content be
cause it initiated\na software or executable download.", |
| 1536 "The ad set an unauthorized cookie on a Google domain.", |
| 1537 "Flash content found when no flash was declared.", |
| 1538 "SSL support declared but not working correctly.", |
| 1539 "Rich Media - Direct Download in Ad (ex. PDF download)."
, |
| 1540 "Maximum download size exceeded.", |
| 1541 "Bad Destination URL: Site Not Crawlable.", |
| 1542 "Bad URL: Legal disapproval.", |
| 1543 "Pharmaceuticals, Gambling, Alcohol not allowed and at l
east one was\ndetected.", |
| 1544 "Dynamic DNS at Destination URL.", |
| 1545 "Poor Image / Video Quality.", |
| 1546 "For example, Image Trick to Click.", |
| 1547 "Incorrect Image Layout.", |
| 1548 "Irrelevant Image / Video.", |
| 1549 "Broken back button.", |
| 1550 "Misleading/Inaccurate claims in ads.", |
| 1551 "Restricted Products.", |
| 1552 "Unacceptable content. For example, malware.", |
| 1553 "The ad automatically redirects to the destination site
without a click,\nor reports a click when none were made.", |
| 1554 "The ad uses URL protocols that do not exist or are not
allowed on AdX.", |
| 1555 "Restricted content (for example, alcohol) was found in
the ad but not\ndeclared.", |
| 1556 "Violation of the remarketing list policy.", |
| 1557 "The destination site's robot.txt file prevents it from
being crawled.", |
| 1558 "Click to download must link to an app.", |
| 1559 "A review extension must be an accurate review.", |
| 1560 "Sexually explicit content.", |
| 1561 "The ad tries to gain an unfair traffic advantage.", |
| 1562 "The ad tries to circumvent Google's advertising systems
.", |
| 1563 "The ad promotes dangerous knives.", |
| 1564 "The ad promotes explosives.", |
| 1565 "The ad promotes guns & parts.", |
| 1566 "The ad promotes recreational drugs/services & related e
quipment.", |
| 1567 "The ad promotes tobacco products/services & related equ
ipment.", |
| 1568 "The ad promotes weapons.", |
| 1569 "The ad is unclear or irrelevant to the destination site
.", |
| 1570 "The ad does not meet professional standards.", |
| 1571 "The promotion is unnecessarily difficult to navigate.", |
| 1572 "Violation of Google's policy for interest-based ads.", |
| 1573 "Misuse of personal information.", |
| 1574 "Omission of relevant information.", |
| 1575 "Unavailable promotions.", |
| 1576 "Misleading or unrealistic promotions.", |
| 1577 "Offensive or inappropriate content.", |
| 1578 "Capitalizing on sensitive events.", |
| 1579 "Shocking content.", |
| 1580 "Products & Services that enable dishonest behavior.", |
| 1581 "The ad does not meet technical requirements.", |
| 1582 "Restricted political content.", |
| 1583 "Unsupported content.", |
| 1584 "Invalid bidding method.", |
| 1585 "Video length exceeds limits.", |
| 1586 "Unacceptable content: Japanese healthcare.", |
| 1587 "Online pharmacy ID required.", |
| 1588 "Unacceptable content: Abortion.", |
| 1589 "Unacceptable content: Birth control.", |
| 1590 "Restricted in China.", |
| 1591 "Unacceptable content: Korean healthcare.", |
| 1592 "Non-family safe or adult content.", |
| 1593 "Clinical trial recruitment.", |
| 1594 "Maximum number of HTTP calls exceeded.", |
| 1595 "Maximum number of cookies exceeded.", |
| 1596 "Financial service ad does not adhere to specifications.
", |
| 1597 "Flash content was found in an unsupported context." |
| 1598 ], |
| 1599 "type": "string" |
| 1600 } |
| 1601 }, |
| 1602 "type": "object" |
| 1603 }, |
| 1604 "ServingRestriction": { |
| 1605 "description": "@OutputOnly A representation of the status of an ad
in a\nspecific context. A context here relates to where something ultimately ser
ves\n(for example, a user or publisher geo, a platform, an HTTPS vs HTTP request
,\nor the type of auction).", |
| 1606 "id": "ServingRestriction", |
| 1607 "properties": { |
| 1608 "disapprovalReasons": { |
| 1609 "description": "Any disapprovals bound to this restriction.\
nOnly present if status=DISAPPROVED.\nCan be used to filter the response of the\
ncreatives.list\nmethod.", |
| 1610 "items": { |
| 1611 "$ref": "Disapproval" |
| 1612 }, |
| 1613 "type": "array" |
| 1614 }, |
| 1615 "contexts": { |
| 1616 "description": "The contexts for the restriction.", |
| 1617 "items": { |
| 1618 "$ref": "ServingContext" |
| 1619 }, |
| 1620 "type": "array" |
| 1621 }, |
589 "status": { | 1622 "status": { |
590 "description": "The status of the client user.", | 1623 "description": "The status of the creative in this context (
for example, it has been\nexplicitly disapproved or is pending review).", |
591 "enum": [ | 1624 "enum": [ |
592 "USER_STATUS_UNSPECIFIED", | 1625 "STATUS_UNSPECIFIED", |
593 "PENDING", | 1626 "DISAPPROVAL", |
594 "ACTIVE", | 1627 "PENDING_REVIEW" |
595 "DISABLED" | |
596 ], | 1628 ], |
597 "enumDescriptions": [ | 1629 "enumDescriptions": [ |
598 "A placeholder for an undefined user status.", | 1630 "The status is not known.", |
599 "A user who was already created but hasn't accepted the
invitation yet.", | 1631 "The ad was disapproved in this context.", |
600 "A user that is currently active.", | 1632 "The ad is pending review in this context." |
601 "A user that is currently disabled." | 1633 ], |
602 ], | 1634 "type": "string" |
603 "type": "string" | 1635 } |
604 }, | 1636 }, |
605 "userId": { | 1637 "type": "object" |
606 "description": "The unique numerical ID of the client user\n
that has accepted an invitation.\nThe value of this field is ignored in an updat
e operation.", | 1638 }, |
607 "format": "int64", | 1639 "Date": { |
608 "type": "string" | 1640 "description": "Represents a whole calendar date, e.g. date of birth
. The time of day and\ntime zone are either specified elsewhere or are not signi
ficant. The date\nis relative to the Proleptic Gregorian Calendar. The day may b
e 0 to\nrepresent a year and month where the day is not significant, e.g. credit
card\nexpiration date. The year may be 0 to represent a month and day independe
nt\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand
`google.protobuf.Timestamp`.", |
609 }, | 1641 "id": "Date", |
610 "email": { | 1642 "properties": { |
611 "description": "User's email address. The value of this fiel
d\nis ignored in an update operation.", | 1643 "year": { |
612 "type": "string" | 1644 "description": "Year of date. Must be from 1 to 9999, or 0 i
f specifying a date without\na year.", |
613 }, | 1645 "format": "int32", |
614 "clientAccountId": { | 1646 "type": "integer" |
615 "description": "Numerical account ID of the client buyer\nwi
th which the user is associated; the\nbuyer must be a client of the current spon
sor buyer.\nThe value of this field is ignored in an update operation.", | 1647 }, |
616 "format": "int64", | 1648 "day": { |
617 "type": "string" | 1649 "description": "Day of month. Must be from 1 to 31 and valid
for the year and month, or 0\nif specifying a year/month where the day is not s
ignificant.", |
618 } | 1650 "format": "int32", |
619 }, | 1651 "type": "integer" |
620 "type": "object" | 1652 }, |
621 }, | 1653 "month": { |
622 "ClientUserInvitation": { | 1654 "description": "Month of year. Must be from 1 to 12.", |
623 "description": "An invitation for a new client user to get access to
the Ad Exchange\nBuyer UI.\nAll fields are required unless otherwise specified.
", | 1655 "format": "int32", |
624 "id": "ClientUserInvitation", | 1656 "type": "integer" |
625 "properties": { | 1657 } |
626 "email": { | 1658 }, |
627 "description": "The email address to which the invitation is
sent. Email\naddresses should be unique among all client users under each spons
or\nbuyer.", | 1659 "type": "object" |
628 "type": "string" | 1660 }, |
629 }, | 1661 "Empty": { |
630 "clientAccountId": { | 1662 "description": "A generic empty message that you can re-use to avoid
defining duplicated\nempty messages in your APIs. A typical example is to use i
t as the request\nor the response type of an API method. For instance:\n\n se
rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty
);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", |
631 "description": "Numerical account ID of the client buyer\nth
at the invited user is associated with.\nThe value of this field is ignored in c
reate operations.", | 1663 "id": "Empty", |
632 "format": "int64", | 1664 "properties": {}, |
633 "type": "string" | 1665 "type": "object" |
634 }, | 1666 }, |
635 "invitationId": { | 1667 "WatchCreativeRequest": { |
636 "description": "The unique numerical ID of the invitation th
at is sent to the user.\nThe value of this field is ignored in create operations
.", | 1668 "description": "A request for watching changes to creative Status.", |
637 "format": "int64", | 1669 "id": "WatchCreativeRequest", |
638 "type": "string" | 1670 "properties": { |
639 } | 1671 "topic": { |
640 }, | 1672 "description": "The Pub/Sub topic to publish notifications t
o.\nThis topic must already exist and must give permission to\nad-exchange-buysi
de-reports@google.com to write to the topic.\nThis should be the full resource n
ame in\n\"projects/{project_id}/topics/{topic_id}\" format.", |
641 "type": "object" | 1673 "type": "string" |
642 }, | 1674 } |
643 "ListClientUsersResponse": { | 1675 }, |
644 "id": "ListClientUsersResponse", | 1676 "type": "object" |
645 "properties": { | 1677 }, |
646 "nextPageToken": { | 1678 "AppContext": { |
647 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListClientUsersRequest.pageToken\nfield in the subseq
uent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of
results.", | 1679 "description": "@OutputOnly The app type the restriction applies to
for mobile device.", |
648 "type": "string" | 1680 "id": "AppContext", |
649 }, | 1681 "properties": { |
650 "users": { | 1682 "appTypes": { |
651 "description": "The returned list of client users.", | 1683 "description": "The app types this restriction applies to.", |
652 "items": { | 1684 "enumDescriptions": [ |
653 "$ref": "ClientUser" | 1685 "Native app context.", |
654 }, | 1686 "Mobile web app context." |
655 "type": "array" | 1687 ], |
656 } | 1688 "items": { |
657 }, | 1689 "enum": [ |
658 "type": "object" | 1690 "NATIVE", |
659 }, | 1691 "WEB" |
660 "ListClientUserInvitationsResponse": { | 1692 ], |
661 "id": "ListClientUserInvitationsResponse", | 1693 "type": "string" |
662 "properties": { | 1694 }, |
663 "nextPageToken": { | 1695 "type": "array" |
664 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListClientUserInvitationsRequest.pageToken\nfield in
the subsequent call to the\nclients.invitations.list\nmethod to retrieve the nex
t\npage of results.", | 1696 } |
665 "type": "string" | 1697 }, |
666 }, | 1698 "type": "object" |
667 "invitations": { | 1699 }, |
668 "description": "The returned list of client users.", | 1700 "NativeContent": { |
669 "items": { | 1701 "description": "Native content for a creative.", |
670 "$ref": "ClientUserInvitation" | 1702 "id": "NativeContent", |
671 }, | 1703 "properties": { |
672 "type": "array" | 1704 "videoUrl": { |
673 } | 1705 "description": "The URL to fetch a native video ad.", |
674 }, | 1706 "type": "string" |
675 "type": "object" | 1707 }, |
| 1708 "logo": { |
| 1709 "$ref": "Image", |
| 1710 "description": "A smaller image, for the advertiser's logo." |
| 1711 }, |
| 1712 "clickLinkUrl": { |
| 1713 "description": "The URL that the browser/SDK will load when
the user clicks the ad.", |
| 1714 "type": "string" |
| 1715 }, |
| 1716 "priceDisplayText": { |
| 1717 "description": "The price of the promoted app including curr
ency info.", |
| 1718 "type": "string" |
| 1719 }, |
| 1720 "clickTrackingUrl": { |
| 1721 "description": "The URL to use for click tracking.", |
| 1722 "type": "string" |
| 1723 }, |
| 1724 "image": { |
| 1725 "$ref": "Image", |
| 1726 "description": "A large image." |
| 1727 }, |
| 1728 "advertiserName": { |
| 1729 "description": "The name of the advertiser or sponsor, to be
displayed in the ad creative.", |
| 1730 "type": "string" |
| 1731 }, |
| 1732 "storeUrl": { |
| 1733 "description": "The URL to the app store to purchase/downloa
d the promoted app.", |
| 1734 "type": "string" |
| 1735 }, |
| 1736 "headline": { |
| 1737 "description": "A short title for the ad.", |
| 1738 "type": "string" |
| 1739 }, |
| 1740 "appIcon": { |
| 1741 "$ref": "Image", |
| 1742 "description": "The app icon, for app download ads." |
| 1743 }, |
| 1744 "callToAction": { |
| 1745 "description": "A label for the button that the user is supp
osed to click.", |
| 1746 "type": "string" |
| 1747 }, |
| 1748 "body": { |
| 1749 "description": "A long description of the ad.", |
| 1750 "type": "string" |
| 1751 }, |
| 1752 "starRating": { |
| 1753 "description": "The app rating in the app store. Must be in
the range [0-5].", |
| 1754 "format": "double", |
| 1755 "type": "number" |
| 1756 } |
| 1757 }, |
| 1758 "type": "object" |
676 }, | 1759 }, |
677 "ListClientsResponse": { | 1760 "ListClientsResponse": { |
678 "id": "ListClientsResponse", | 1761 "id": "ListClientsResponse", |
679 "properties": { | 1762 "properties": { |
680 "nextPageToken": { | 1763 "nextPageToken": { |
681 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListClientsRequest.pageToken\nfield in the subsequent
call to the\naccounts.clients.list method\nto retrieve the next page of results
.", | 1764 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListClientsRequest.pageToken\nfield in the subsequent
call to the\naccounts.clients.list method\nto retrieve the next page of results
.", |
682 "type": "string" | 1765 "type": "string" |
683 }, | 1766 }, |
684 "clients": { | 1767 "clients": { |
685 "description": "The returned list of clients.", | 1768 "description": "The returned list of clients.", |
686 "items": { | 1769 "items": { |
687 "$ref": "Client" | 1770 "$ref": "Client" |
688 }, | 1771 }, |
689 "type": "array" | 1772 "type": "array" |
690 } | 1773 } |
691 }, | 1774 }, |
692 "type": "object" | 1775 "type": "object" |
| 1776 }, |
| 1777 "SecurityContext": { |
| 1778 "description": "@OutputOnly A security context.", |
| 1779 "id": "SecurityContext", |
| 1780 "properties": { |
| 1781 "securities": { |
| 1782 "description": "The security types in this context.", |
| 1783 "enumDescriptions": [ |
| 1784 "Matches impressions that require insecure compatibility
.", |
| 1785 "Matches impressions that require SSL compatibility." |
| 1786 ], |
| 1787 "items": { |
| 1788 "enum": [ |
| 1789 "INSECURE", |
| 1790 "SSL" |
| 1791 ], |
| 1792 "type": "string" |
| 1793 }, |
| 1794 "type": "array" |
| 1795 } |
| 1796 }, |
| 1797 "type": "object" |
| 1798 }, |
| 1799 "HtmlContent": { |
| 1800 "description": "HTML content for a creative.", |
| 1801 "id": "HtmlContent", |
| 1802 "properties": { |
| 1803 "height": { |
| 1804 "description": "The height of the HTML snippet in pixels.", |
| 1805 "format": "int32", |
| 1806 "type": "integer" |
| 1807 }, |
| 1808 "width": { |
| 1809 "description": "The width of the HTML snippet in pixels.", |
| 1810 "format": "int32", |
| 1811 "type": "integer" |
| 1812 }, |
| 1813 "snippet": { |
| 1814 "description": "The HTML snippet that displays the ad when i
nserted in the web page.", |
| 1815 "type": "string" |
| 1816 } |
| 1817 }, |
| 1818 "type": "object" |
| 1819 }, |
| 1820 "ListCreativesResponse": { |
| 1821 "description": "A response for listing creatives.", |
| 1822 "id": "ListCreativesResponse", |
| 1823 "properties": { |
| 1824 "creatives": { |
| 1825 "description": "The list of creatives.", |
| 1826 "items": { |
| 1827 "$ref": "Creative" |
| 1828 }, |
| 1829 "type": "array" |
| 1830 }, |
| 1831 "nextPageToken": { |
| 1832 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListCreativesRequest.page_token\nfield in the subsequ
ent call to `ListCreatives` method to retrieve the next\npage of results.", |
| 1833 "type": "string" |
| 1834 } |
| 1835 }, |
| 1836 "type": "object" |
| 1837 }, |
| 1838 "ServingContext": { |
| 1839 "description": "The serving context for this restriction.", |
| 1840 "id": "ServingContext", |
| 1841 "properties": { |
| 1842 "location": { |
| 1843 "$ref": "LocationContext", |
| 1844 "description": "Matches impressions coming from users *or* p
ublishers in a specific\nlocation." |
| 1845 }, |
| 1846 "auctionType": { |
| 1847 "$ref": "AuctionContext", |
| 1848 "description": "Matches impressions for a particular auction
type." |
| 1849 }, |
| 1850 "all": { |
| 1851 "description": "Matches all contexts.", |
| 1852 "enum": [ |
| 1853 "SIMPLE_CONTEXT" |
| 1854 ], |
| 1855 "enumDescriptions": [ |
| 1856 "A simple context." |
| 1857 ], |
| 1858 "type": "string" |
| 1859 }, |
| 1860 "appType": { |
| 1861 "$ref": "AppContext", |
| 1862 "description": "Matches impressions for a particular app typ
e." |
| 1863 }, |
| 1864 "securityType": { |
| 1865 "$ref": "SecurityContext", |
| 1866 "description": "Matches impressions for a particular securit
y type." |
| 1867 }, |
| 1868 "platform": { |
| 1869 "$ref": "PlatformContext", |
| 1870 "description": "Matches impressions coming from a particular
platform." |
| 1871 } |
| 1872 }, |
| 1873 "type": "object" |
| 1874 }, |
| 1875 "Image": { |
| 1876 "description": "An image resource. You may provide a larger image th
an was requested,\nso long as the aspect ratio is preserved.", |
| 1877 "id": "Image", |
| 1878 "properties": { |
| 1879 "url": { |
| 1880 "description": "The URL of the image.", |
| 1881 "type": "string" |
| 1882 }, |
| 1883 "height": { |
| 1884 "description": "Image height in pixels.", |
| 1885 "format": "int32", |
| 1886 "type": "integer" |
| 1887 }, |
| 1888 "width": { |
| 1889 "description": "Image width in pixels.", |
| 1890 "format": "int32", |
| 1891 "type": "integer" |
| 1892 } |
| 1893 }, |
| 1894 "type": "object" |
| 1895 }, |
| 1896 "Reason": { |
| 1897 "description": "A specific filtering status and how many times it oc
curred.", |
| 1898 "id": "Reason", |
| 1899 "properties": { |
| 1900 "status": { |
| 1901 "description": "The filtering status code. Please refer to t
he\n[creative-status-codes.txt](https://storage.googleapis.com/adx-rtb-dictionar
ies/creative-status-codes.txt)\nfile for different statuses.", |
| 1902 "format": "int32", |
| 1903 "type": "integer" |
| 1904 }, |
| 1905 "count": { |
| 1906 "description": "The number of times the creative was filtere
d for the status. The\ncount is aggregated across all publishers on the exchange
.", |
| 1907 "format": "int64", |
| 1908 "type": "string" |
| 1909 } |
| 1910 }, |
| 1911 "type": "object" |
| 1912 }, |
| 1913 "VideoContent": { |
| 1914 "description": "Video content for a creative.", |
| 1915 "id": "VideoContent", |
| 1916 "properties": { |
| 1917 "videoUrl": { |
| 1918 "description": "The URL to fetch a video ad.", |
| 1919 "type": "string" |
| 1920 } |
| 1921 }, |
| 1922 "type": "object" |
| 1923 }, |
| 1924 "ClientUserInvitation": { |
| 1925 "description": "An invitation for a new client user to get access to
the Ad Exchange\nBuyer UI.\nAll fields are required unless otherwise specified.
", |
| 1926 "id": "ClientUserInvitation", |
| 1927 "properties": { |
| 1928 "invitationId": { |
| 1929 "description": "The unique numerical ID of the invitation th
at is sent to the user.\nThe value of this field is ignored in create operations
.", |
| 1930 "format": "int64", |
| 1931 "type": "string" |
| 1932 }, |
| 1933 "email": { |
| 1934 "description": "The email address to which the invitation is
sent. Email\naddresses should be unique among all client users under each spons
or\nbuyer.", |
| 1935 "type": "string" |
| 1936 }, |
| 1937 "clientAccountId": { |
| 1938 "description": "Numerical account ID of the client buyer\nth
at the invited user is associated with.\nThe value of this field is ignored in c
reate operations.", |
| 1939 "format": "int64", |
| 1940 "type": "string" |
| 1941 } |
| 1942 }, |
| 1943 "type": "object" |
| 1944 }, |
| 1945 "AuctionContext": { |
| 1946 "description": "@OutputOnly The auction type the restriction applies
to.", |
| 1947 "id": "AuctionContext", |
| 1948 "properties": { |
| 1949 "auctionTypes": { |
| 1950 "description": "The auction types this restriction applies t
o.", |
| 1951 "enumDescriptions": [ |
| 1952 "The restriction applies to open auction.", |
| 1953 "The restriction applies to direct deals." |
| 1954 ], |
| 1955 "items": { |
| 1956 "enum": [ |
| 1957 "OPEN_AUCTION", |
| 1958 "DIRECT_DEALS" |
| 1959 ], |
| 1960 "type": "string" |
| 1961 }, |
| 1962 "type": "array" |
| 1963 } |
| 1964 }, |
| 1965 "type": "object" |
693 } | 1966 } |
694 }, | 1967 }, |
695 "servicePath": "", | 1968 "servicePath": "", |
696 "title": "Ad Exchange Buyer API II", | 1969 "title": "Ad Exchange Buyer API II", |
697 "version": "v2beta1" | 1970 "version": "v2beta1" |
698 } | 1971 } |
OLD | NEW |