Blame - docs/dyn/realtimebidding_v1.bidders.creatives.html - platform/external/python/google-api-python-client

2020-10-06 16:46:05 -0700

[diff] [blame]

78

<code><a href="#close">close()</a></code></p>

79

<p class="firstline">Close httplib2 connections.</p>

80

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

81

<code><a href="#list">list(parent, pageSize=None, filter=None, view=None, pageToken=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

82

<p class="firstline">Lists creatives.</p>

83

84

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

85

<p class="firstline">Retrieves the next page of results.</p>

86

87

<code><a href="#watch">watch(parent, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

88

<p class="firstline">Watches all creatives pertaining to a bidder. It is sufficient to invoke this endpoint once per bidder. A Pub/Sub topic will be created and notifications will be pushed to the topic when any of the bidder's creatives change status. All of the bidder's service accounts will have access to read from the topic. Subsequent invocations of this method will return the existing Pub/Sub configuration.</p>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

89

<h3>Method Details</h3>

90

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

91

<code class="details" id="close">close()</code>

92

<pre>Close httplib2 connections.</pre>

</div>

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

96

<code class="details" id="list">list(parent, pageSize=None, filter=None, view=None, pageToken=None, x__xgafv=None)</code>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

97

<pre>Lists creatives.

98

99

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

100

parent: string, Required. Name of the parent buyer that owns the creatives. The pattern for this resource is either `buyers/{buyerAccountId}` or `bidders/{bidderAccountId}`. For `buyers/{buyerAccountId}`, the `buyerAccountId` can be one of the following: 1. The ID of the buyer that is accessing their own creatives. 2. The ID of the child seat buyer under a bidder account. So for listing creatives pertaining to the child seat buyer (`456`) under bidder account (`123`), you would use the pattern: `buyers/456`. 3. The ID of the bidder itself. So for listing creatives pertaining to bidder (`123`), you would use `buyers/123`. If you want to access all creatives pertaining to both the bidder and all of its child seat accounts, you would use `bidders/{bidderAccountId}`, e.g., for all creatives pertaining to bidder (`123`), use `bidders/123`. (required)

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

101

pageSize: integer, Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available via another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

102

filter: string, Query string to filter creatives. If no filter is specified, all active creatives will be returned. Example: 'accountId=12345 AND (dealsStatus:DISAPPROVED AND disapprovalReason:UNACCEPTABLE_CONTENT) OR declaredAttributes:IS_COOKIE_TARGETED'

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

103

view: string, Controls the amount of information included in the response. By default only creativeServingDecision is included. To retrieve the entire creative resource (including the declared fields and the creative content) specify the view as "FULL".

104

Allowed values

105

CREATIVE_VIEW_UNSPECIFIED - Not specified, equivalent to SERVING_DECISION_ONLY.

106

SERVING_DECISION_ONLY - Only creativeServingDecision is included in the response.

107

FULL - The entire creative resource (including the declared fields and the creative content) is included in the response.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

108

pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of ListCreativesResponse.nextPageToken returned from the previous call to the 'ListCreatives' method.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

109

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

116

117

{ # A response for listing creatives.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

118

"creatives": [ # The list of creatives.

119

{ # A creative and its classification data.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

120

"name": "A String", # Output only. Name of the creative. Follows the pattern `buyers/{buyer}/creatives/{creative}`, where `{buyer}` represents the account ID of the buyer who owns the creative, and `{creative}` is the buyer-specific creative ID that references this creative in the bid response.

121

"creativeId": "A String", # Buyer-specific creative ID that references this creative in bid responses. This field is Ignored in update operations. Can be used to filter the response of the creatives.list method. The maximum length of the creative ID is 128 bytes.

122

"declaredVendorIds": [ # IDs for the declared ad technology vendors that may be used by this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values. Can be used to filter the response of the creatives.list method.

123

42,

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

124

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

125

"declaredAttributes": [ # All declared attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method. If the `excluded_attribute` field of a [bid request](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto") contains one of the attributes that were declared or detected for a given creative, and a bid is submitted with that creative, the bid will be filtered before the auction.

126

"A String",

127

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

128

"adChoicesDestinationUrl": "A String", # The link to AdChoices destination page. This is only supported for native ads.

129

"creativeFormat": "A String", # Output only. The format of this creative. Can be used to filter the response of the creatives.list method.

130

"agencyId": "A String", # The agency ID for this creative.

131

"accountId": "A String", # Output only. ID of the buyer account that this creative is owned by. Can be used to filter the response of the creatives.list method with equality and inequality check.

132

"native": { # Native content for a creative. # A native creative.

133

"headline": "A String", # A short title for the ad.

134

"callToAction": "A String", # A label for the button that the user is supposed to click.

135

"advertiserName": "A String", # The name of the advertiser or sponsor, to be displayed in the ad creative.

136

"clickTrackingUrl": "A String", # The URL to use for click tracking.

137

"image": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A large image.

138

"width": 42, # Image width in pixels.

139

"url": "A String", # The URL of the image.

140

"height": 42, # Image height in pixels.

141

},

142

"logo": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A smaller image, for the advertiser's logo.

143

"width": 42, # Image width in pixels.

144

"url": "A String", # The URL of the image.

145

"height": 42, # Image height in pixels.

146

},

147

"clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad.

148

"appIcon": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # The app icon, for app download ads.

149

"width": 42, # Image width in pixels.

150

"url": "A String", # The URL of the image.

151

"height": 42, # Image height in pixels.

152

},

153

"priceDisplayText": "A String", # The price of the promoted app including currency info.

154

"starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].

155

"videoUrl": "A String", # The URL to fetch a native video ad.

156

"body": "A String", # A long description of the ad.

157

},

158

"restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

159

"A String",

160

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

161

"apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

162

"dealIds": [ # Output only. IDs of all of the deals with which this creative has been used in bidding. Can be used to filter the response of the creatives.list method.

163

"A String",

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

164

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

165

"creativeServingDecision": { # Top level status and detected attributes of a creative. # Output only. Top level status and detected attributes of a creative (for example domain, language, advertiser, product category, etc.) that affect whether (status) and where (context) a creative will be allowed to serve.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

166

"chinaPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # The policy compliance of this creative in China. When approved or disapproved, this applies to both deals and open auction in China. When pending review, this creative is allowed to serve for deals but not for open auction.

167

"status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

168

"topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED.

169

{ # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

170

"evidences": [ # Pieces of evidence associated with this policy topic entry.

171

{ # Evidence associated with a policy topic entry.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

172

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

173

"httpError": 42, # HTTP error code (e.g. 404 or 5xx)

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

174

"expandedUrl": "A String", # The full non-working URL.

175

"platform": "A String", # Platform of the non-working URL.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

176

"urlRejected": "A String", # Rejected because of malformed URLs or invalid requests.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

177

"invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

178

"lastCheckTime": "A String", # Approximate time when the ad destination was last checked.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

179

"redirectionError": "A String", # HTTP redirect chain error.

180

"dnsError": "A String", # DNS lookup errors.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

181

},

182

"downloadSize": { # Total download size and URL-level download size breakdown for resources in a creative. # Total download size and URL-level download size breakdown for resources in a creative.

183

"totalDownloadSizeKb": 42, # Total download size (in kilobytes) for all the resources in the creative.

184

"topUrlDownloadSizeBreakdowns": [ # Download size broken down by URLs with the top download size.

185

{ # The URL-level breakdown for the download size.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

186

"downloadSizeKb": 42, # Download size of the URL in kilobytes.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

187

"normalizedUrl": "A String", # The normalized URL with query parameters and fragment removed.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

188

},

189

],

190

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

191

"destinationUrl": { # The full landing page URL of the destination. # URL of the actual landing page.

192

"destinationUrl": "A String", # The full landing page URL of the destination.

193

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

194

"domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain.

195

"totalHttpCallCount": 42, # The total number of HTTP calls made by the creative, including but not limited to the number of calls in the top_http_call_domains.

196

"topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative.

197

{ # The number of HTTP calls made to the given domain.

198

"domain": "A String", # The domain name.

199

"httpCallCount": 42, # Number of HTTP calls made to the domain.

200

},

201

],

202

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

203

"destinationNotCrawlable": { # Evidence that the creative's destination URL was not crawlable by Google. # The creative's destination URL was not crawlable by Google.

204

"reason": "A String", # Reason of destination not crawlable.

205

"crawlTime": "A String", # Approximate time of the crawl.

206

"crawledUrl": "A String", # Destination URL that was attempted to be crawled.

207

},

208

"httpCookie": { # Evidence for HTTP cookie-related policy violations. # Evidence for HTTP cookie-related policy violations.

209

"maxCookieCount": 42, # The largest number of cookies set by a creative. If this field is set, cookie_names above will be set to the cookie names of top domains with the largest number of cookies. This field will only be set for TOO_MANY_COOKIES policy.

210

"cookieNames": [ # Names of cookies that violate Google policies. For TOO_MANY_COOKIES policy, this will be the cookie names of top domains with the largest number of cookies. For other policies, this will be all the cookie names that violate the policy.

"A String",

],

},

"httpCall": { # HTTP calls made by a creative that resulted in policy violations. # HTTP calls made by the creative that resulted in policy violations.

215

"urls": [ # URLs of HTTP calls made by the creative.

216

"A String",

217

],

218

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

219

},

220

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

221

"helpCenterUrl": "A String", # URL of the help center article describing this policy topic.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

222

"policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method

223

},

224

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

225

},

226

"platformPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # Policy compliance of this creative when bidding in Open Bidding (outside of Russia and China). For the list of platform policies, see: https://support.google.com/platformspolicy/answer/3013851.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

227

"status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

228

"topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED.

229

{ # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

230

"evidences": [ # Pieces of evidence associated with this policy topic entry.

231

{ # Evidence associated with a policy topic entry.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

232

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

233

"httpError": 42, # HTTP error code (e.g. 404 or 5xx)

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

234

"expandedUrl": "A String", # The full non-working URL.

235

"platform": "A String", # Platform of the non-working URL.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

236

"urlRejected": "A String", # Rejected because of malformed URLs or invalid requests.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

237

"invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

238

"lastCheckTime": "A String", # Approximate time when the ad destination was last checked.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

239

"redirectionError": "A String", # HTTP redirect chain error.

240

"dnsError": "A String", # DNS lookup errors.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

241

},

242

"downloadSize": { # Total download size and URL-level download size breakdown for resources in a creative. # Total download size and URL-level download size breakdown for resources in a creative.

243

"totalDownloadSizeKb": 42, # Total download size (in kilobytes) for all the resources in the creative.

244

"topUrlDownloadSizeBreakdowns": [ # Download size broken down by URLs with the top download size.

245

{ # The URL-level breakdown for the download size.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

246

"downloadSizeKb": 42, # Download size of the URL in kilobytes.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

247

"normalizedUrl": "A String", # The normalized URL with query parameters and fragment removed.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

248

},

249

],

250

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

251

"destinationUrl": { # The full landing page URL of the destination. # URL of the actual landing page.

252

"destinationUrl": "A String", # The full landing page URL of the destination.

253

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

254

"domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain.

255

"totalHttpCallCount": 42, # The total number of HTTP calls made by the creative, including but not limited to the number of calls in the top_http_call_domains.

256

"topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative.

257

{ # The number of HTTP calls made to the given domain.

258

"domain": "A String", # The domain name.

259

"httpCallCount": 42, # Number of HTTP calls made to the domain.

260

},

261

],

262

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

263

"destinationNotCrawlable": { # Evidence that the creative's destination URL was not crawlable by Google. # The creative's destination URL was not crawlable by Google.

264

"reason": "A String", # Reason of destination not crawlable.

265

"crawlTime": "A String", # Approximate time of the crawl.

266

"crawledUrl": "A String", # Destination URL that was attempted to be crawled.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

267

},

268

"httpCookie": { # Evidence for HTTP cookie-related policy violations. # Evidence for HTTP cookie-related policy violations.

269

"maxCookieCount": 42, # The largest number of cookies set by a creative. If this field is set, cookie_names above will be set to the cookie names of top domains with the largest number of cookies. This field will only be set for TOO_MANY_COOKIES policy.

270

"cookieNames": [ # Names of cookies that violate Google policies. For TOO_MANY_COOKIES policy, this will be the cookie names of top domains with the largest number of cookies. For other policies, this will be all the cookie names that violate the policy.

271

"A String",

272

],

273

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

274

"httpCall": { # HTTP calls made by a creative that resulted in policy violations. # HTTP calls made by the creative that resulted in policy violations.

275

"urls": [ # URLs of HTTP calls made by the creative.

276

"A String",

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

],

},

},

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

281

"helpCenterUrl": "A String", # URL of the help center article describing this policy topic.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

282

"policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method

283

},

284

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

285

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

286

"detectedVendorIds": [ # IDs of the ad technology vendors that were detected to be used by this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values. Can be used to filter the response of the creatives.list method. If the `allowed_vendor_type` field of a [bid request](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) does not contain one of the vendor type IDs that were declared or detected for a given creative, and a bid is submitted with that creative, the bid will be filtered before the auction.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

287

42,

288

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

289

"russiaPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # The policy compliance of this creative in Russia. When approved or disapproved, this applies to both deals and open auction in Russia. When pending review, this creative is allowed to serve for deals but not for open auction.

290

"status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method.

291

"topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED.

292

{ # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation.

293

"evidences": [ # Pieces of evidence associated with this policy topic entry.

294

{ # Evidence associated with a policy topic entry.

295

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up.

296

"httpError": 42, # HTTP error code (e.g. 404 or 5xx)

297

"expandedUrl": "A String", # The full non-working URL.

298

"platform": "A String", # Platform of the non-working URL.

299

"urlRejected": "A String", # Rejected because of malformed URLs or invalid requests.

300

"invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page.

301

"lastCheckTime": "A String", # Approximate time when the ad destination was last checked.

302

"redirectionError": "A String", # HTTP redirect chain error.

303

"dnsError": "A String", # DNS lookup errors.

304

},

305

"downloadSize": { # Total download size and URL-level download size breakdown for resources in a creative. # Total download size and URL-level download size breakdown for resources in a creative.

306

"totalDownloadSizeKb": 42, # Total download size (in kilobytes) for all the resources in the creative.

307

"topUrlDownloadSizeBreakdowns": [ # Download size broken down by URLs with the top download size.

308

{ # The URL-level breakdown for the download size.

309

"downloadSizeKb": 42, # Download size of the URL in kilobytes.

310

"normalizedUrl": "A String", # The normalized URL with query parameters and fragment removed.

},

],

},

"destinationUrl": { # The full landing page URL of the destination. # URL of the actual landing page.

315

"destinationUrl": "A String", # The full landing page URL of the destination.

316

},

317

"domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain.

318

"totalHttpCallCount": 42, # The total number of HTTP calls made by the creative, including but not limited to the number of calls in the top_http_call_domains.

319

"topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative.

320

{ # The number of HTTP calls made to the given domain.

321

"domain": "A String", # The domain name.

322

"httpCallCount": 42, # Number of HTTP calls made to the domain.

},

],

},

"destinationNotCrawlable": { # Evidence that the creative's destination URL was not crawlable by Google. # The creative's destination URL was not crawlable by Google.

327

"reason": "A String", # Reason of destination not crawlable.

328

"crawlTime": "A String", # Approximate time of the crawl.

329

"crawledUrl": "A String", # Destination URL that was attempted to be crawled.

330

},

331

"httpCookie": { # Evidence for HTTP cookie-related policy violations. # Evidence for HTTP cookie-related policy violations.

332

"maxCookieCount": 42, # The largest number of cookies set by a creative. If this field is set, cookie_names above will be set to the cookie names of top domains with the largest number of cookies. This field will only be set for TOO_MANY_COOKIES policy.

333

"cookieNames": [ # Names of cookies that violate Google policies. For TOO_MANY_COOKIES policy, this will be the cookie names of top domains with the largest number of cookies. For other policies, this will be all the cookie names that violate the policy.

"A String",

],

},

"httpCall": { # HTTP calls made by a creative that resulted in policy violations. # HTTP calls made by the creative that resulted in policy violations.

338

"urls": [ # URLs of HTTP calls made by the creative.

"A String",

],

},

},

],

"helpCenterUrl": "A String", # URL of the help center article describing this policy topic.

345

"policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method

},

],

},

"detectedLanguages": [ # The detected languages for this creative. The order is arbitrary. The codes are 2 or 5 characters and are documented at https://developers.google.com/adwords/api/docs/appendix/languagecodes. Can be used to filter the response of the creatives.list method.

350

"A String",

351

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

352

"detectedProductCategories": [ # Detected product categories, if any. See the ad-product-categories.txt file in the technical documentation for a list of IDs. Can be used to filter the response of the creatives.list method.

353

42,

354

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

355

"detectedAttributes": [ # Publisher-excludable attributes that were detected for this creative. Can be used to filter the response of the creatives.list method. If the `excluded_attribute` field of a [bid request](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) contains one of the attributes that were declared or detected for a given creative, and a bid is submitted with that creative, the bid will be filtered before the auction.

356

"A String",

357

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

358

"detectedDomains": [ # The detected domains for this creative.

359

"A String",

360

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

361

"networkPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # Policy compliance of this creative when bidding in open auction, private auction, or auction packages (outside of Russia and China).

362

"status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method.

363

"topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED.

364

{ # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation.

365

"evidences": [ # Pieces of evidence associated with this policy topic entry.

366

{ # Evidence associated with a policy topic entry.

367

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up.

368

"httpError": 42, # HTTP error code (e.g. 404 or 5xx)

369

"expandedUrl": "A String", # The full non-working URL.

370

"platform": "A String", # Platform of the non-working URL.

371

"urlRejected": "A String", # Rejected because of malformed URLs or invalid requests.

372

"invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page.

373

"lastCheckTime": "A String", # Approximate time when the ad destination was last checked.

374

"redirectionError": "A String", # HTTP redirect chain error.

375

"dnsError": "A String", # DNS lookup errors.

376

},

377

"downloadSize": { # Total download size and URL-level download size breakdown for resources in a creative. # Total download size and URL-level download size breakdown for resources in a creative.

378

"totalDownloadSizeKb": 42, # Total download size (in kilobytes) for all the resources in the creative.

379

"topUrlDownloadSizeBreakdowns": [ # Download size broken down by URLs with the top download size.

380

{ # The URL-level breakdown for the download size.

381

"downloadSizeKb": 42, # Download size of the URL in kilobytes.

382

"normalizedUrl": "A String", # The normalized URL with query parameters and fragment removed.

},

],

},

"destinationUrl": { # The full landing page URL of the destination. # URL of the actual landing page.

387

"destinationUrl": "A String", # The full landing page URL of the destination.

388

},

389

"domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain.

390

"totalHttpCallCount": 42, # The total number of HTTP calls made by the creative, including but not limited to the number of calls in the top_http_call_domains.

391

"topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative.

392

{ # The number of HTTP calls made to the given domain.

393

"domain": "A String", # The domain name.

394

"httpCallCount": 42, # Number of HTTP calls made to the domain.

},

],

},

"destinationNotCrawlable": { # Evidence that the creative's destination URL was not crawlable by Google. # The creative's destination URL was not crawlable by Google.

399

"reason": "A String", # Reason of destination not crawlable.

400

"crawlTime": "A String", # Approximate time of the crawl.

401

"crawledUrl": "A String", # Destination URL that was attempted to be crawled.

402

},

403

"httpCookie": { # Evidence for HTTP cookie-related policy violations. # Evidence for HTTP cookie-related policy violations.

404

"maxCookieCount": 42, # The largest number of cookies set by a creative. If this field is set, cookie_names above will be set to the cookie names of top domains with the largest number of cookies. This field will only be set for TOO_MANY_COOKIES policy.

405

"cookieNames": [ # Names of cookies that violate Google policies. For TOO_MANY_COOKIES policy, this will be the cookie names of top domains with the largest number of cookies. For other policies, this will be all the cookie names that violate the policy.

"A String",

],

},

"httpCall": { # HTTP calls made by a creative that resulted in policy violations. # HTTP calls made by the creative that resulted in policy violations.

410

"urls": [ # URLs of HTTP calls made by the creative.

"A String",

],

},

},

],

"helpCenterUrl": "A String", # URL of the help center article describing this policy topic.

417

"policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method

},

],

},

"lastStatusUpdate": "A String", # The last time the creative status was updated. Can be used to filter the response of the creatives.list method.

422

"detectedAdvertisers": [ # Detected advertisers and brands.

423

{ # Detected advertiser and brand information.

424

"advertiserId": "A String", # See https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt for the list of possible values. Can be used to filter the response of the creatives.list method.

425

"brandId": "A String", # Detected brand ID or zero if no brand has been detected. See https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt for the list of possible values. Can be used to filter the response of the creatives.list method.

426

"brandName": "A String", # Brand name. Can be used to filter the response of the creatives.list method.

427

"advertiserName": "A String", # Advertiser name. Can be used to filter the response of the creatives.list method.

428

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

429

],

430

"detectedClickThroughUrls": [ # The set of detected destination URLs for the creative. Can be used to filter the response of the creatives.list method.

431

"A String",

432

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

433

"detectedSensitiveCategories": [ # Detected sensitive categories, if any. Can be used to filter the response of the creatives.list method. See the ad-sensitive-categories.txt file in the technical documentation for a list of IDs. You should use these IDs along with the excluded-sensitive-category field in the bid request to filter your bids.

434

42,

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

435

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

436

"dealsPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # Policy compliance of this creative when bidding on Programmatic Guaranteed and Preferred Deals (outside of Russia and China).

437

"status": "A String", # Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method.

438

"topics": [ # Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED.

439

{ # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation.

440

"evidences": [ # Pieces of evidence associated with this policy topic entry.

441

{ # Evidence associated with a policy topic entry.

442

"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up.

443

"httpError": 42, # HTTP error code (e.g. 404 or 5xx)

444

"expandedUrl": "A String", # The full non-working URL.

445

"platform": "A String", # Platform of the non-working URL.

446

"urlRejected": "A String", # Rejected because of malformed URLs or invalid requests.

447

"invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page.

448

"lastCheckTime": "A String", # Approximate time when the ad destination was last checked.

449

"redirectionError": "A String", # HTTP redirect chain error.

450

"dnsError": "A String", # DNS lookup errors.

451

},

452

"downloadSize": { # Total download size and URL-level download size breakdown for resources in a creative. # Total download size and URL-level download size breakdown for resources in a creative.

453

"totalDownloadSizeKb": 42, # Total download size (in kilobytes) for all the resources in the creative.

454

"topUrlDownloadSizeBreakdowns": [ # Download size broken down by URLs with the top download size.

455

{ # The URL-level breakdown for the download size.

456

"downloadSizeKb": 42, # Download size of the URL in kilobytes.

457

"normalizedUrl": "A String", # The normalized URL with query parameters and fragment removed.

},

],

},

"destinationUrl": { # The full landing page URL of the destination. # URL of the actual landing page.

462

"destinationUrl": "A String", # The full landing page URL of the destination.

463

},

464

"domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain.

465

"totalHttpCallCount": 42, # The total number of HTTP calls made by the creative, including but not limited to the number of calls in the top_http_call_domains.

466

"topHttpCallDomains": [ # Breakdown of the most frequent domains called via HTTP by the creative.

467

{ # The number of HTTP calls made to the given domain.

468

"domain": "A String", # The domain name.

469

"httpCallCount": 42, # Number of HTTP calls made to the domain.

},

],

},

"destinationNotCrawlable": { # Evidence that the creative's destination URL was not crawlable by Google. # The creative's destination URL was not crawlable by Google.

474

"reason": "A String", # Reason of destination not crawlable.

475

"crawlTime": "A String", # Approximate time of the crawl.

476

"crawledUrl": "A String", # Destination URL that was attempted to be crawled.

477

},

478

"httpCookie": { # Evidence for HTTP cookie-related policy violations. # Evidence for HTTP cookie-related policy violations.

479

"maxCookieCount": 42, # The largest number of cookies set by a creative. If this field is set, cookie_names above will be set to the cookie names of top domains with the largest number of cookies. This field will only be set for TOO_MANY_COOKIES policy.

480

"cookieNames": [ # Names of cookies that violate Google policies. For TOO_MANY_COOKIES policy, this will be the cookie names of top domains with the largest number of cookies. For other policies, this will be all the cookie names that violate the policy.

"A String",

],

},

"httpCall": { # HTTP calls made by a creative that resulted in policy violations. # HTTP calls made by the creative that resulted in policy violations.

485

"urls": [ # URLs of HTTP calls made by the creative.

"A String",

],

},

},

],

"helpCenterUrl": "A String", # URL of the help center article describing this policy topic.

492

"policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method

493

},

494

],

495

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

496

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

497

"advertiserName": "A String", # The name of the company being advertised in the creative. Can be used to filter the response of the creatives.list method.

498

"declaredRestrictedCategories": [ # All declared restricted categories for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

499

"A String",

500

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

501

"declaredClickThroughUrls": [ # The set of declared destination URLs for the creative. Can be used to filter the response of the creatives.list method.

502

"A String",

503

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

504

"html": { # HTML content for a creative. # An HTML creative.

505

"height": 42, # The height of the HTML snippet in pixels. Can be used to filter the response of the creatives.list method.

506

"width": 42, # The width of the HTML snippet in pixels. Can be used to filter the response of the creatives.list method.

507

"snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page.

508

},

509

"impressionTrackingUrls": [ # The set of URLs to be called to record an impression.

510

"A String",

511

],

512

"version": 42, # Output only. The version of this creative. Version for a new creative is 1 and it increments during subsequent creative updates.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

513

"video": { # Video content for a creative. # A video creative.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

514

"videoVastXml": "A String", # The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

515

"videoMetadata": { # Video metadata for a creative. # Output only. Video metadata.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

516

"skipOffset": "A String", # The minimum duration that the user has to watch before being able to skip this ad. If the field is not set, the ad is not skippable. If the field is set, the ad is skippable. Can be used to filter the response of the creatives.list method.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

517

"mediaFiles": [ # The list of all media files declared in the VAST. If there are multiple VASTs in a wrapper chain, this includes the media files from the deepest one in the chain.

518

{ # Information about each media file in the VAST.

519

"bitrate": "A String", # Bitrate of the video file, in Kbps. Can be used to filter the response of the creatives.list method.

520

"mimeType": "A String", # The MIME type of this media file. Can be used to filter the response of the creatives.list method.

521

},

522

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

523

"duration": "A String", # The duration of the ad. Can be used to filter the response of the creatives.list method.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

524

"isVpaid": True or False, # Is this a VPAID ad? Can be used to filter the response of the creatives.list method.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

525

"isValidVast": True or False, # Is this a valid VAST ad? Can be used to filter the response of the creatives.list method.

526

"vastVersion": "A String", # The maximum VAST version across all wrapped VAST documents. Can be used to filter the response of the creatives.list method.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

527

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

528

"videoUrl": "A String", # The URL to fetch a video ad.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

529

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

530

},

531

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

532

"nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the ListCreativesRequest.pageToken field in the subsequent call to the `ListCreatives` method to retrieve the next page of results.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

538

<pre>Retrieves the next page of results.

539

540

Args:

541

previous_request: The request for the previous page. (required)

542

previous_response: The response from the request for the previous page. (required)

543

544

Returns:

545

A request object that you can call 'execute()' on to request the next

546

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="watch">watch(parent, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

552

<pre>Watches all creatives pertaining to a bidder. It is sufficient to invoke this endpoint once per bidder. A Pub/Sub topic will be created and notifications will be pushed to the topic when any of the bidder's creatives change status. All of the bidder's service accounts will have access to read from the topic. Subsequent invocations of this method will return the existing Pub/Sub configuration.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

553

554

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

555

parent: string, Required. To watch all creatives pertaining to the bidder and all its child seat accounts, the bidder must follow the pattern `bidders/{bidderAccountId}`. (required)

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

556

body: object, The request body.

557

The object takes the form of:

558

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

559

{ # A request to receive push notifications when any of the creatives belonging to the bidder changes status.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

560

}

561

562

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

569

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

570

{ # A response for the request to receive push notification when a bidder's creatives change status.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

571

"subscription": "A String", # The Pub/Sub subscription that can be used to pull creative status notifications. This would be of the format `projects/{project_id}/subscriptions/{subscription_id}`. Subscription is created with pull delivery. All service accounts belonging to the bidder will have read access to this subscription. Subscriptions that are inactive for more than 90 days will be disabled. Please use watchCreatives to re-enable the subscription.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

572

"topic": "A String", # The Pub/Sub topic that will be used to publish creative serving status notifications. This would be of the format `projects/{project_id}/topics/{topic_id}`.

Bu Sun Kim