Blame - docs/dyn/adexchangebuyer2_v2beta1.accounts.clients.html - platform/external/python/google-api-python-client

2020-05-01 07:42:23 -0700

[diff] [blame]

88

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

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

89

<p class="firstline">Creates a new client buyer.</p>

90

91

<code><a href="#get">get(accountId, clientAccountId, x__xgafv=None)</a></code></p>

92

<p class="firstline">Gets a client buyer with a given client account ID.</p>

93

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

94

<code><a href="#list">list(accountId, pageToken=None, partnerClientId=None, pageSize=None, x__xgafv=None)</a></code></p>

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

95

<p class="firstline">Lists all the clients for the current sponsor buyer.</p>

96

97

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

98

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

99

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

100

<code><a href="#update">update(accountId, clientAccountId, body=None, x__xgafv=None)</a></code></p>

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

101

<p class="firstline">Updates an existing client buyer.</p>

102

<h3>Method Details</h3>

103

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

104

<code class="details" id="create">create(accountId, body=None, x__xgafv=None)</code>

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

105

<pre>Creates a new client buyer.

106

107

Args:

108

accountId: string, Unique numerical account ID for the buyer of which the client buyer

109

is a customer; the sponsor buyer to create a client for. (required) (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

110

body: object, The request body.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

111

The object takes the form of:

112

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

113

{ # A client resource represents a client buyer&mdash;an agency, a brand, or an

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

114

# advertiser customer of the sponsor buyer. Users associated with the client

115

# buyer have restricted access to the Marketplace and certain other sections of

116

# the Authorized Buyers UI based on the role granted to the client buyer. All

117

# fields are required unless otherwise specified.

118

"entityId": "A String", # Numerical identifier of the client entity.

119

# The entity can be an advertiser, a brand, or an agency.

120

# This identifier is unique among all the entities with the same type.

121

# The value of this field is ignored if the entity type is not provided.

122

#

123

# A list of all known advertisers with their identifiers is available in the

124

# [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)

125

# file.

126

#

127

# A list of all known brands with their identifiers is available in the

128

# [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)

129

# file.

130

#

131

# A list of all known agencies with their identifiers is available in the

132

# [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)

133

# file.

134

"status": "A String", # The status of the client buyer.

135

"visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.

136

"clientName": "A String", # Name used to represent this client to publishers.

137

# You may have multiple clients that map to the same entity,

138

# but for each client the combination of `clientName` and entity

139

# must be unique.

140

# You can specify this field as empty.

141

"entityName": "A String", # The name of the entity. This field is automatically fetched based on

142

# the type and ID.

143

# The value of this field is ignored in create and update operations.

144

"partnerClientId": "A String", # Optional arbitrary unique identifier of this client buyer from the

145

# standpoint of its Ad Exchange sponsor buyer.

146

#

147

# This field can be used to associate a client buyer with the identifier

148

# in the namespace of its sponsor buyer, lookup client buyers by that

149

# identifier and verify whether an Ad Exchange counterpart of a given client

150

# buyer already exists.

151

#

152

# If present, must be unique among all the client buyers for its

153

# Ad Exchange sponsor buyer.

154

"clientAccountId": "A String", # The globally-unique numerical ID of the client.

155

# The value of this field is ignored in create and update operations.

156

"entityType": "A String", # An optional field for specifying the type of the client entity:

157

# `ADVERTISER`, `BRAND`, or `AGENCY`.

158

"role": "A String", # The role which is assigned to the client buyer. Each role implies a set of

159

# permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,

160

# `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.

161

}

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

162

163

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

170

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

171

{ # A client resource represents a client buyer&mdash;an agency, a brand, or an

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

172

# advertiser customer of the sponsor buyer. Users associated with the client

173

# buyer have restricted access to the Marketplace and certain other sections of

174

# the Authorized Buyers UI based on the role granted to the client buyer. All

175

# fields are required unless otherwise specified.

176

"entityId": "A String", # Numerical identifier of the client entity.

177

# The entity can be an advertiser, a brand, or an agency.

178

# This identifier is unique among all the entities with the same type.

179

# The value of this field is ignored if the entity type is not provided.

180

#

181

# A list of all known advertisers with their identifiers is available in the

182

# [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)

183

# file.

184

#

185

# A list of all known brands with their identifiers is available in the

186

# [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)

187

# file.

188

#

189

# A list of all known agencies with their identifiers is available in the

190

# [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)

191

# file.

192

"status": "A String", # The status of the client buyer.

193

"visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.

194

"clientName": "A String", # Name used to represent this client to publishers.

195

# You may have multiple clients that map to the same entity,

196

# but for each client the combination of `clientName` and entity

197

# must be unique.

198

# You can specify this field as empty.

199

"entityName": "A String", # The name of the entity. This field is automatically fetched based on

200

# the type and ID.

201

# The value of this field is ignored in create and update operations.

202

"partnerClientId": "A String", # Optional arbitrary unique identifier of this client buyer from the

203

# standpoint of its Ad Exchange sponsor buyer.

204

#

205

# This field can be used to associate a client buyer with the identifier

206

# in the namespace of its sponsor buyer, lookup client buyers by that

207

# identifier and verify whether an Ad Exchange counterpart of a given client

208

# buyer already exists.

209

#

210

# If present, must be unique among all the client buyers for its

211

# Ad Exchange sponsor buyer.

212

"clientAccountId": "A String", # The globally-unique numerical ID of the client.

213

# The value of this field is ignored in create and update operations.

214

"entityType": "A String", # An optional field for specifying the type of the client entity:

215

# `ADVERTISER`, `BRAND`, or `AGENCY`.

216

"role": "A String", # The role which is assigned to the client buyer. Each role implies a set of

217

# permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,

218

# `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.

219

}</pre>

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

</div>

<code class="details" id="get">get(accountId, clientAccountId, x__xgafv=None)</code>

224

<pre>Gets a client buyer with a given client account ID.

225

226

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

227

accountId: string, Numerical account ID of the client's sponsor buyer. (required) (required)

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

228

clientAccountId: string, Numerical account ID of the client buyer to retrieve. (required) (required)

229

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

236

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

237

{ # A client resource represents a client buyer&mdash;an agency, a brand, or an

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

238

# advertiser customer of the sponsor buyer. Users associated with the client

239

# buyer have restricted access to the Marketplace and certain other sections of

240

# the Authorized Buyers UI based on the role granted to the client buyer. All

241

# fields are required unless otherwise specified.

242

"entityId": "A String", # Numerical identifier of the client entity.

243

# The entity can be an advertiser, a brand, or an agency.

244

# This identifier is unique among all the entities with the same type.

245

# The value of this field is ignored if the entity type is not provided.

246

#

247

# A list of all known advertisers with their identifiers is available in the

248

# [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)

249

# file.

250

#

251

# A list of all known brands with their identifiers is available in the

252

# [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)

253

# file.

254

#

255

# A list of all known agencies with their identifiers is available in the

256

# [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)

257

# file.

258

"status": "A String", # The status of the client buyer.

259

"visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.

260

"clientName": "A String", # Name used to represent this client to publishers.

261

# You may have multiple clients that map to the same entity,

262

# but for each client the combination of `clientName` and entity

263

# must be unique.

264

# You can specify this field as empty.

265

"entityName": "A String", # The name of the entity. This field is automatically fetched based on

266

# the type and ID.

267

# The value of this field is ignored in create and update operations.

268

"partnerClientId": "A String", # Optional arbitrary unique identifier of this client buyer from the

269

# standpoint of its Ad Exchange sponsor buyer.

270

#

271

# This field can be used to associate a client buyer with the identifier

272

# in the namespace of its sponsor buyer, lookup client buyers by that

273

# identifier and verify whether an Ad Exchange counterpart of a given client

274

# buyer already exists.

275

#

276

# If present, must be unique among all the client buyers for its

277

# Ad Exchange sponsor buyer.

278

"clientAccountId": "A String", # The globally-unique numerical ID of the client.

279

# The value of this field is ignored in create and update operations.

280

"entityType": "A String", # An optional field for specifying the type of the client entity:

281

# `ADVERTISER`, `BRAND`, or `AGENCY`.

282

"role": "A String", # The role which is assigned to the client buyer. Each role implies a set of

283

# permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,

284

# `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.

285

}</pre>

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

289

<code class="details" id="list">list(accountId, pageToken=None, partnerClientId=None, pageSize=None, x__xgafv=None)</code>

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

290

<pre>Lists all the clients for the current sponsor buyer.

291

292

Args:

293

accountId: string, Unique numerical account ID of the sponsor buyer to list the clients for. (required)

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

294

pageToken: string, A token identifying a page of results the server should return.

295

Typically, this is the value of

296

ListClientsResponse.nextPageToken

297

returned from the previous call to the

Bu Sun Kim

715bd7f

2019-06-14 16:50:42 -0700

[diff] [blame]

298

accounts.clients.list

299

method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

300

partnerClientId: string, Optional unique identifier (from the standpoint of an Ad Exchange sponsor

301

buyer partner) of the client to return.

302

If specified, at most one client will be returned in the response.

303

pageSize: integer, Requested page size. The server may return fewer clients than requested.

304

If unspecified, the server will pick an appropriate default.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

305

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

312

313

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

314

"clients": [ # The returned list of clients.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

315

{ # A client resource represents a client buyer&mdash;an agency, a brand, or an

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

316

# advertiser customer of the sponsor buyer. Users associated with the client

317

# buyer have restricted access to the Marketplace and certain other sections of

318

# the Authorized Buyers UI based on the role granted to the client buyer. All

319

# fields are required unless otherwise specified.

320

"entityId": "A String", # Numerical identifier of the client entity.

321

# The entity can be an advertiser, a brand, or an agency.

322

# This identifier is unique among all the entities with the same type.

323

# The value of this field is ignored if the entity type is not provided.

324

#

325

# A list of all known advertisers with their identifiers is available in the

326

# [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)

327

# file.

328

#

329

# A list of all known brands with their identifiers is available in the

330

# [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)

331

# file.

332

#

333

# A list of all known agencies with their identifiers is available in the

334

# [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)

335

# file.

336

"status": "A String", # The status of the client buyer.

337

"visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.

338

"clientName": "A String", # Name used to represent this client to publishers.

339

# You may have multiple clients that map to the same entity,

340

# but for each client the combination of `clientName` and entity

341

# must be unique.

342

# You can specify this field as empty.

343

"entityName": "A String", # The name of the entity. This field is automatically fetched based on

344

# the type and ID.

345

# The value of this field is ignored in create and update operations.

346

"partnerClientId": "A String", # Optional arbitrary unique identifier of this client buyer from the

347

# standpoint of its Ad Exchange sponsor buyer.

348

#

349

# This field can be used to associate a client buyer with the identifier

350

# in the namespace of its sponsor buyer, lookup client buyers by that

351

# identifier and verify whether an Ad Exchange counterpart of a given client

352

# buyer already exists.

353

#

354

# If present, must be unique among all the client buyers for its

355

# Ad Exchange sponsor buyer.

356

"clientAccountId": "A String", # The globally-unique numerical ID of the client.

357

# The value of this field is ignored in create and update operations.

358

"entityType": "A String", # An optional field for specifying the type of the client entity:

359

# `ADVERTISER`, `BRAND`, or `AGENCY`.

360

"role": "A String", # The role which is assigned to the client buyer. Each role implies a set of

361

# permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,

362

# `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.

363

},

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

364

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

365

"nextPageToken": "A String", # A token to retrieve the next page of results.

366

# Pass this value in the

367

# ListClientsRequest.pageToken

368

# field in the subsequent call to the

369

# accounts.clients.list

370

# method to retrieve the next page of results.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

}</pre>

</div>

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

376

<pre>Retrieves the next page of results.

377

378

Args:

379

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

380

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

381

382

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

383

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

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

384

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

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

389

<code class="details" id="update">update(accountId, clientAccountId, body=None, x__xgafv=None)</code>

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

390

<pre>Updates an existing client buyer.

391

392

Args:

393

accountId: string, Unique numerical account ID for the buyer of which the client buyer

394

is a customer; the sponsor buyer to update a client for. (required) (required)

395

clientAccountId: string, Unique numerical account ID of the client to update. (required) (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

396

body: object, The request body.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

397

The object takes the form of:

398

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

399

{ # A client resource represents a client buyer&mdash;an agency, a brand, or an

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

400

# advertiser customer of the sponsor buyer. Users associated with the client

401

# buyer have restricted access to the Marketplace and certain other sections of

402

# the Authorized Buyers UI based on the role granted to the client buyer. All

403

# fields are required unless otherwise specified.

404

"entityId": "A String", # Numerical identifier of the client entity.

405

# The entity can be an advertiser, a brand, or an agency.

406

# This identifier is unique among all the entities with the same type.

407

# The value of this field is ignored if the entity type is not provided.

408

#

409

# A list of all known advertisers with their identifiers is available in the

410

# [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)

411

# file.

412

#

413

# A list of all known brands with their identifiers is available in the

414

# [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)

415

# file.

416

#

417

# A list of all known agencies with their identifiers is available in the

418

# [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)

419

# file.

420

"status": "A String", # The status of the client buyer.

421

"visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.

422

"clientName": "A String", # Name used to represent this client to publishers.

423

# You may have multiple clients that map to the same entity,

424

# but for each client the combination of `clientName` and entity

425

# must be unique.

426

# You can specify this field as empty.

427

"entityName": "A String", # The name of the entity. This field is automatically fetched based on

428

# the type and ID.

429

# The value of this field is ignored in create and update operations.

430

"partnerClientId": "A String", # Optional arbitrary unique identifier of this client buyer from the

431

# standpoint of its Ad Exchange sponsor buyer.

432

#

433

# This field can be used to associate a client buyer with the identifier

434

# in the namespace of its sponsor buyer, lookup client buyers by that

435

# identifier and verify whether an Ad Exchange counterpart of a given client

436

# buyer already exists.

437

#

438

# If present, must be unique among all the client buyers for its

439

# Ad Exchange sponsor buyer.

440

"clientAccountId": "A String", # The globally-unique numerical ID of the client.

441

# The value of this field is ignored in create and update operations.

442

"entityType": "A String", # An optional field for specifying the type of the client entity:

443

# `ADVERTISER`, `BRAND`, or `AGENCY`.

444

"role": "A String", # The role which is assigned to the client buyer. Each role implies a set of

445

# permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,

446

# `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.

447

}

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

448

449

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

456

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

457

{ # A client resource represents a client buyer&mdash;an agency, a brand, or an

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

458

# advertiser customer of the sponsor buyer. Users associated with the client

459

# buyer have restricted access to the Marketplace and certain other sections of

460

# the Authorized Buyers UI based on the role granted to the client buyer. All

461

# fields are required unless otherwise specified.

462

"entityId": "A String", # Numerical identifier of the client entity.

463

# The entity can be an advertiser, a brand, or an agency.

464

# This identifier is unique among all the entities with the same type.

465

# The value of this field is ignored if the entity type is not provided.

466

#

467

# A list of all known advertisers with their identifiers is available in the

468

# [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)

469

# file.

470

#

471

# A list of all known brands with their identifiers is available in the

472

# [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)

473

# file.

474

#

475

# A list of all known agencies with their identifiers is available in the

476

# [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)

477

# file.

478

"status": "A String", # The status of the client buyer.

479

"visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.

480

"clientName": "A String", # Name used to represent this client to publishers.

481

# You may have multiple clients that map to the same entity,

482

# but for each client the combination of `clientName` and entity

483

# must be unique.

484

# You can specify this field as empty.

485

"entityName": "A String", # The name of the entity. This field is automatically fetched based on

486

# the type and ID.

487

# The value of this field is ignored in create and update operations.

488

"partnerClientId": "A String", # Optional arbitrary unique identifier of this client buyer from the

489

# standpoint of its Ad Exchange sponsor buyer.

490

#

491

# This field can be used to associate a client buyer with the identifier

492

# in the namespace of its sponsor buyer, lookup client buyers by that

493

# identifier and verify whether an Ad Exchange counterpart of a given client

494

# buyer already exists.

495

#

496

# If present, must be unique among all the client buyers for its

497

# Ad Exchange sponsor buyer.

498

"clientAccountId": "A String", # The globally-unique numerical ID of the client.

499

# The value of this field is ignored in create and update operations.

500

"entityType": "A String", # An optional field for specifying the type of the client entity:

501

# `ADVERTISER`, `BRAND`, or `AGENCY`.

502

"role": "A String", # The role which is assigned to the client buyer. Each role implies a set of

503

# permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,

504

# `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.

505

}</pre>

Jon Wayne Parrott