1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adexchangebuyer2_v2beta1.html">Ad Exchange Buyer API II</a> . <a href="adexchangebuyer2_v2beta1.bidders.html">bidders</a> . <a href="adexchangebuyer2_v2beta1.bidders.accounts.html">accounts</a> . <a href="adexchangebuyer2_v2beta1.bidders.accounts.filterSets.html">filterSets</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="adexchangebuyer2_v2beta1.bidders.accounts.filterSets.bidMetrics.html">bidMetrics()</a></code>
</p>
<p class="firstline">Returns the bidMetrics Resource.</p>
<p class="toc_element">
<code><a href="adexchangebuyer2_v2beta1.bidders.accounts.filterSets.bidResponseErrors.html">bidResponseErrors()</a></code>
</p>
<p class="firstline">Returns the bidResponseErrors Resource.</p>
<p class="toc_element">
<code><a href="adexchangebuyer2_v2beta1.bidders.accounts.filterSets.bidResponsesWithoutBids.html">bidResponsesWithoutBids()</a></code>
</p>
<p class="firstline">Returns the bidResponsesWithoutBids Resource.</p>
<p class="toc_element">
<code><a href="adexchangebuyer2_v2beta1.bidders.accounts.filterSets.filteredBidRequests.html">filteredBidRequests()</a></code>
</p>
<p class="firstline">Returns the filteredBidRequests Resource.</p>
<p class="toc_element">
<code><a href="adexchangebuyer2_v2beta1.bidders.accounts.filterSets.filteredBids.html">filteredBids()</a></code>
</p>
<p class="firstline">Returns the filteredBids Resource.</p>
<p class="toc_element">
<code><a href="adexchangebuyer2_v2beta1.bidders.accounts.filterSets.impressionMetrics.html">impressionMetrics()</a></code>
</p>
<p class="firstline">Returns the impressionMetrics Resource.</p>
<p class="toc_element">
<code><a href="adexchangebuyer2_v2beta1.bidders.accounts.filterSets.losingBids.html">losingBids()</a></code>
</p>
<p class="firstline">Returns the losingBids Resource.</p>
<p class="toc_element">
<code><a href="adexchangebuyer2_v2beta1.bidders.accounts.filterSets.nonBillableWinningBids.html">nonBillableWinningBids()</a></code>
</p>
<p class="firstline">Returns the nonBillableWinningBids Resource.</p>
<p class="toc_element">
<code><a href="#create">create(ownerName=None, 123, body, isTransient=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates the specified filter set for the account with the given account ID.</p>
<p class="toc_element">
<code><a href="#delete">delete(name=None, 123, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes the requested filter set from the account with the given account</p>
<p class="toc_element">
<code><a href="#get">get(name=None, 123, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves the requested filter set for the account with the given account</p>
<p class="toc_element">
<code><a href="#list">list(ownerName=None, 123, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all filter sets for the account with the given account ID.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(ownerName=None, 123, body, isTransient=None, x__xgafv=None)</code>
<pre>Creates the specified filter set for the account with the given account ID.
Args:
ownerName: string, Name of the owner (bidder or account) of the filter set to be created.
For example:
- For a bidder-level filter set for bidder 123: `bidders/123`
- For an account-level filter set for the buyer account representing bidder
123: `bidders/123/accounts/123`
- For an account-level filter set for the child seat buyer account 456
whose bidder is 123: `bidders/123/accounts/456` (required)
body: object, The request body. (required)
The object takes the form of:
{ # A set of filters that is applied to a request for data.
# Within a filter set, an AND operation is performed across the filters
# represented by each field. An OR operation is performed across the filters
# represented by the multiple values of a repeated field, e.g.,
# "format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR
# seller_network_id=56)".
"timeSeriesGranularity": "A String", # The granularity of time intervals if a time series breakdown is desired;
# optional.
"name": "A String", # A user-defined name of the filter set. Filter set names must be unique
# globally and match one of the patterns:
#
# - `bidders/*/filterSets/*` (for accessing bidder-level troubleshooting
# data)
# - `bidders/*/accounts/*/filterSets/*` (for accessing account-level
# troubleshooting data)
#
# This field is required in create operations.
"creativeId": "A String", # The ID of the creative on which to filter; optional. This field may be set
# only for a filter set that accesses account-level troubleshooting data,
# i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*`
# pattern.
"relativeDateRange": { # A relative date range, specified by an offset and a duration. # A relative date range, defined by an offset from today and a duration.
# Interpreted relative to Pacific time zone.
# The supported range of dates begins 30 days before today and ends today,
# i.e., the limits for these values are:
# offset_days >= 0
# duration_days >= 1
# offset_days + duration_days <= 30
"durationDays": 42, # The number of days in the requested date range, e.g., for a range spanning
# today: 1. For a range spanning the last 7 days: 7.
"offsetDays": 42, # The end date of the filter set, specified as the number of days before
# today, e.g., for a range where the last date is today: 0.
},
"publisherIdentifiers": [ # For Open Bidding partners only.
# The list of publisher identifiers on which to filter; may be empty.
# The filters represented by multiple publisher identifiers are ORed
# together.
"A String",
],
"breakdownDimensions": [ # The set of dimensions along which to break down the response; may be empty.
# If multiple dimensions are requested, the breakdown is along the Cartesian
# product of the requested dimensions.
"A String",
],
"dealId": "A String", # The ID of the deal on which to filter; optional. This field may be set
# only for a filter set that accesses account-level troubleshooting data,
# i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*`
# pattern.
"environment": "A String", # The environment on which to filter; optional.
"platforms": [ # The list of platforms on which to filter; may be empty. The filters
# represented by multiple platforms are ORed together (i.e., if non-empty,
# results must match any one of the platforms).
"A String",
],
"absoluteDateRange": { # An absolute date range, specified by its start date and end date. # An absolute date range, defined by a start date and an end date.
# Interpreted relative to Pacific time zone.
# The supported range of dates begins 30 days before today and ends today.
# Validity checked upon filter set creation. If a filter set with an absolute
# date range is run at a later date more than 30 days after start_date, it will
# fail.
"startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The start date of the range (inclusive).
# Must be within the 30 days leading up to current date, and must be equal to
# or before end_date.
# and time zone are either specified elsewhere or are not significant. The date
# is relative to the Proleptic Gregorian Calendar. This can represent:
#
# * A full date, with non-zero year, month and day values
# * A month and day value, with a zero year, e.g. an anniversary
# * A year on its own, with zero month and day values
# * A year and month value, with a zero day, e.g. a credit card expiration date
#
# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
# a year.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
# if specifying a year by itself or a year and month where the day is not
# significant.
"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
# month and day.
},
"endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The end date of the range (inclusive).
# Must be within the 30 days leading up to current date, and must be equal to
# or after start_date.
# and time zone are either specified elsewhere or are not significant. The date
# is relative to the Proleptic Gregorian Calendar. This can represent:
#
# * A full date, with non-zero year, month and day values
# * A month and day value, with a zero year, e.g. an anniversary
# * A year on its own, with zero month and day values
# * A year and month value, with a zero day, e.g. a credit card expiration date
#
# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
# a year.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
# if specifying a year by itself or a year and month where the day is not
# significant.
"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
# month and day.
},
},
"formats": [ # The list of formats on which to filter; may be empty. The filters
# represented by multiple formats are ORed together (i.e., if non-empty,
# results must match any one of the formats).
"A String",
],
"realtimeTimeRange": { # An open-ended realtime time range specified by the start timestamp. # An open-ended realtime time range, defined by the aggregation start
# timestamp.
# For filter sets that specify a realtime time range RTB metrics continue to
# be aggregated throughout the lifetime of the filter set.
"startTimestamp": "A String", # The start timestamp of the real-time RTB metrics aggregation.
},
"sellerNetworkIds": [ # For Authorized Buyers only.
# The list of IDs of the seller (publisher) networks on which to filter;
# may be empty. The filters represented by multiple seller network IDs are
# ORed together (i.e., if non-empty, results must match any one of the
# publisher networks). See
# [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids)
# file for the set of existing seller network IDs.
42,
],
}
isTransient: boolean, Whether the filter set is transient, or should be persisted indefinitely.
By default, filter sets are not transient.
If transient, it will be available for at least 1 hour after creation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A set of filters that is applied to a request for data.
# Within a filter set, an AND operation is performed across the filters
# represented by each field. An OR operation is performed across the filters
# represented by the multiple values of a repeated field, e.g.,
# "format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR
# seller_network_id=56)".
"timeSeriesGranularity": "A String", # The granularity of time intervals if a time series breakdown is desired;
# optional.
"name": "A String", # A user-defined name of the filter set. Filter set names must be unique
# globally and match one of the patterns:
#
# - `bidders/*/filterSets/*` (for accessing bidder-level troubleshooting
# data)
# - `bidders/*/accounts/*/filterSets/*` (for accessing account-level
# troubleshooting data)
#
# This field is required in create operations.
"creativeId": "A String", # The ID of the creative on which to filter; optional. This field may be set
# only for a filter set that accesses account-level troubleshooting data,
# i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*`
# pattern.
"relativeDateRange": { # A relative date range, specified by an offset and a duration. # A relative date range, defined by an offset from today and a duration.
# Interpreted relative to Pacific time zone.
# The supported range of dates begins 30 days before today and ends today,
# i.e., the limits for these values are:
# offset_days >= 0
# duration_days >= 1
# offset_days + duration_days <= 30
"durationDays": 42, # The number of days in the requested date range, e.g., for a range spanning
# today: 1. For a range spanning the last 7 days: 7.
"offsetDays": 42, # The end date of the filter set, specified as the number of days before
# today, e.g., for a range where the last date is today: 0.
},
"publisherIdentifiers": [ # For Open Bidding partners only.
# The list of publisher identifiers on which to filter; may be empty.
# The filters represented by multiple publisher identifiers are ORed
# together.
"A String",
],
"breakdownDimensions": [ # The set of dimensions along which to break down the response; may be empty.
# If multiple dimensions are requested, the breakdown is along the Cartesian
# product of the requested dimensions.
"A String",
],
"dealId": "A String", # The ID of the deal on which to filter; optional. This field may be set
# only for a filter set that accesses account-level troubleshooting data,
# i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*`
# pattern.
"environment": "A String", # The environment on which to filter; optional.
"platforms": [ # The list of platforms on which to filter; may be empty. The filters
# represented by multiple platforms are ORed together (i.e., if non-empty,
# results must match any one of the platforms).
"A String",
],
"absoluteDateRange": { # An absolute date range, specified by its start date and end date. # An absolute date range, defined by a start date and an end date.
# Interpreted relative to Pacific time zone.
# The supported range of dates begins 30 days before today and ends today.
# Validity checked upon filter set creation. If a filter set with an absolute
# date range is run at a later date more than 30 days after start_date, it will
# fail.
"startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The start date of the range (inclusive).
# Must be within the 30 days leading up to current date, and must be equal to
# or before end_date.
# and time zone are either specified elsewhere or are not significant. The date
# is relative to the Proleptic Gregorian Calendar. This can represent:
#
# * A full date, with non-zero year, month and day values
# * A month and day value, with a zero year, e.g. an anniversary
# * A year on its own, with zero month and day values
# * A year and month value, with a zero day, e.g. a credit card expiration date
#
# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
# a year.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
# if specifying a year by itself or a year and month where the day is not
# significant.
"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
# month and day.
},
"endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The end date of the range (inclusive).
# Must be within the 30 days leading up to current date, and must be equal to
# or after start_date.
# and time zone are either specified elsewhere or are not significant. The date
# is relative to the Proleptic Gregorian Calendar. This can represent:
#
# * A full date, with non-zero year, month and day values
# * A month and day value, with a zero year, e.g. an anniversary
# * A year on its own, with zero month and day values
# * A year and month value, with a zero day, e.g. a credit card expiration date
#
# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
# a year.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
# if specifying a year by itself or a year and month where the day is not
# significant.
"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
# month and day.
},
},
"formats": [ # The list of formats on which to filter; may be empty. The filters
# represented by multiple formats are ORed together (i.e., if non-empty,
# results must match any one of the formats).
"A String",
],
"realtimeTimeRange": { # An open-ended realtime time range specified by the start timestamp. # An open-ended realtime time range, defined by the aggregation start
# timestamp.
# For filter sets that specify a realtime time range RTB metrics continue to
# be aggregated throughout the lifetime of the filter set.
"startTimestamp": "A String", # The start timestamp of the real-time RTB metrics aggregation.
},
"sellerNetworkIds": [ # For Authorized Buyers only.
# The list of IDs of the seller (publisher) networks on which to filter;
# may be empty. The filters represented by multiple seller network IDs are
# ORed together (i.e., if non-empty, results must match any one of the
# publisher networks). See
# [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids)
# file for the set of existing seller network IDs.
42,
],
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name=None, 123, x__xgafv=None)</code>
<pre>Deletes the requested filter set from the account with the given account
ID.
Args:
name: string, Full name of the resource to delete.
For example:
- For a bidder-level filter set for bidder 123:
`bidders/123/filterSets/abc`
- For an account-level filter set for the buyer account representing bidder
123: `bidders/123/accounts/123/filterSets/abc`
- For an account-level filter set for the child seat buyer account 456
whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
#
# service Foo {
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# }
#
# The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name=None, 123, x__xgafv=None)</code>
<pre>Retrieves the requested filter set for the account with the given account
ID.
Args:
name: string, Full name of the resource being requested.
For example:
- For a bidder-level filter set for bidder 123:
`bidders/123/filterSets/abc`
- For an account-level filter set for the buyer account representing bidder
123: `bidders/123/accounts/123/filterSets/abc`
- For an account-level filter set for the child seat buyer account 456
whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A set of filters that is applied to a request for data.
# Within a filter set, an AND operation is performed across the filters
# represented by each field. An OR operation is performed across the filters
# represented by the multiple values of a repeated field, e.g.,
# "format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR
# seller_network_id=56)".
"timeSeriesGranularity": "A String", # The granularity of time intervals if a time series breakdown is desired;
# optional.
"name": "A String", # A user-defined name of the filter set. Filter set names must be unique
# globally and match one of the patterns:
#
# - `bidders/*/filterSets/*` (for accessing bidder-level troubleshooting
# data)
# - `bidders/*/accounts/*/filterSets/*` (for accessing account-level
# troubleshooting data)
#
# This field is required in create operations.
"creativeId": "A String", # The ID of the creative on which to filter; optional. This field may be set
# only for a filter set that accesses account-level troubleshooting data,
# i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*`
# pattern.
"relativeDateRange": { # A relative date range, specified by an offset and a duration. # A relative date range, defined by an offset from today and a duration.
# Interpreted relative to Pacific time zone.
# The supported range of dates begins 30 days before today and ends today,
# i.e., the limits for these values are:
# offset_days >= 0
# duration_days >= 1
# offset_days + duration_days <= 30
"durationDays": 42, # The number of days in the requested date range, e.g., for a range spanning
# today: 1. For a range spanning the last 7 days: 7.
"offsetDays": 42, # The end date of the filter set, specified as the number of days before
# today, e.g., for a range where the last date is today: 0.
},
"publisherIdentifiers": [ # For Open Bidding partners only.
# The list of publisher identifiers on which to filter; may be empty.
# The filters represented by multiple publisher identifiers are ORed
# together.
"A String",
],
"breakdownDimensions": [ # The set of dimensions along which to break down the response; may be empty.
# If multiple dimensions are requested, the breakdown is along the Cartesian
# product of the requested dimensions.
"A String",
],
"dealId": "A String", # The ID of the deal on which to filter; optional. This field may be set
# only for a filter set that accesses account-level troubleshooting data,
# i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*`
# pattern.
"environment": "A String", # The environment on which to filter; optional.
"platforms": [ # The list of platforms on which to filter; may be empty. The filters
# represented by multiple platforms are ORed together (i.e., if non-empty,
# results must match any one of the platforms).
"A String",
],
"absoluteDateRange": { # An absolute date range, specified by its start date and end date. # An absolute date range, defined by a start date and an end date.
# Interpreted relative to Pacific time zone.
# The supported range of dates begins 30 days before today and ends today.
# Validity checked upon filter set creation. If a filter set with an absolute
# date range is run at a later date more than 30 days after start_date, it will
# fail.
"startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The start date of the range (inclusive).
# Must be within the 30 days leading up to current date, and must be equal to
# or before end_date.
# and time zone are either specified elsewhere or are not significant. The date
# is relative to the Proleptic Gregorian Calendar. This can represent:
#
# * A full date, with non-zero year, month and day values
# * A month and day value, with a zero year, e.g. an anniversary
# * A year on its own, with zero month and day values
# * A year and month value, with a zero day, e.g. a credit card expiration date
#
# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
# a year.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
# if specifying a year by itself or a year and month where the day is not
# significant.
"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
# month and day.
},
"endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The end date of the range (inclusive).
# Must be within the 30 days leading up to current date, and must be equal to
# or after start_date.
# and time zone are either specified elsewhere or are not significant. The date
# is relative to the Proleptic Gregorian Calendar. This can represent:
#
# * A full date, with non-zero year, month and day values
# * A month and day value, with a zero year, e.g. an anniversary
# * A year on its own, with zero month and day values
# * A year and month value, with a zero day, e.g. a credit card expiration date
#
# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
# a year.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
# if specifying a year by itself or a year and month where the day is not
# significant.
"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
# month and day.
},
},
"formats": [ # The list of formats on which to filter; may be empty. The filters
# represented by multiple formats are ORed together (i.e., if non-empty,
# results must match any one of the formats).
"A String",
],
"realtimeTimeRange": { # An open-ended realtime time range specified by the start timestamp. # An open-ended realtime time range, defined by the aggregation start
# timestamp.
# For filter sets that specify a realtime time range RTB metrics continue to
# be aggregated throughout the lifetime of the filter set.
"startTimestamp": "A String", # The start timestamp of the real-time RTB metrics aggregation.
},
"sellerNetworkIds": [ # For Authorized Buyers only.
# The list of IDs of the seller (publisher) networks on which to filter;
# may be empty. The filters represented by multiple seller network IDs are
# ORed together (i.e., if non-empty, results must match any one of the
# publisher networks). See
# [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids)
# file for the set of existing seller network IDs.
42,
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(ownerName=None, 123, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all filter sets for the account with the given account ID.
Args:
ownerName: string, Name of the owner (bidder or account) of the filter sets to be listed.
For example:
- For a bidder-level filter set for bidder 123: `bidders/123`
- For an account-level filter set for the buyer account representing bidder
123: `bidders/123/accounts/123`
- For an account-level filter set for the child seat buyer account 456
whose bidder is 123: `bidders/123/accounts/456` (required)
pageSize: integer, Requested page size. The server may return fewer results than requested.
If unspecified, the server will pick an appropriate default.
pageToken: string, A token identifying a page of results the server should return.
Typically, this is the value of
ListFilterSetsResponse.nextPageToken
returned from the previous call to the
accounts.filterSets.list
method.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for listing filter sets.
"nextPageToken": "A String", # A token to retrieve the next page of results.
# Pass this value in the
# ListFilterSetsRequest.pageToken
# field in the subsequent call to the
# accounts.filterSets.list
# method to retrieve the next page of results.
"filterSets": [ # The filter sets belonging to the buyer.
{ # A set of filters that is applied to a request for data.
# Within a filter set, an AND operation is performed across the filters
# represented by each field. An OR operation is performed across the filters
# represented by the multiple values of a repeated field, e.g.,
# "format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR
# seller_network_id=56)".
"timeSeriesGranularity": "A String", # The granularity of time intervals if a time series breakdown is desired;
# optional.
"name": "A String", # A user-defined name of the filter set. Filter set names must be unique
# globally and match one of the patterns:
#
# - `bidders/*/filterSets/*` (for accessing bidder-level troubleshooting
# data)
# - `bidders/*/accounts/*/filterSets/*` (for accessing account-level
# troubleshooting data)
#
# This field is required in create operations.
"creativeId": "A String", # The ID of the creative on which to filter; optional. This field may be set
# only for a filter set that accesses account-level troubleshooting data,
# i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*`
# pattern.
"relativeDateRange": { # A relative date range, specified by an offset and a duration. # A relative date range, defined by an offset from today and a duration.
# Interpreted relative to Pacific time zone.
# The supported range of dates begins 30 days before today and ends today,
# i.e., the limits for these values are:
# offset_days >= 0
# duration_days >= 1
# offset_days + duration_days <= 30
"durationDays": 42, # The number of days in the requested date range, e.g., for a range spanning
# today: 1. For a range spanning the last 7 days: 7.
"offsetDays": 42, # The end date of the filter set, specified as the number of days before
# today, e.g., for a range where the last date is today: 0.
},
"publisherIdentifiers": [ # For Open Bidding partners only.
# The list of publisher identifiers on which to filter; may be empty.
# The filters represented by multiple publisher identifiers are ORed
# together.
"A String",
],
"breakdownDimensions": [ # The set of dimensions along which to break down the response; may be empty.
# If multiple dimensions are requested, the breakdown is along the Cartesian
# product of the requested dimensions.
"A String",
],
"dealId": "A String", # The ID of the deal on which to filter; optional. This field may be set
# only for a filter set that accesses account-level troubleshooting data,
# i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*`
# pattern.
"environment": "A String", # The environment on which to filter; optional.
"platforms": [ # The list of platforms on which to filter; may be empty. The filters
# represented by multiple platforms are ORed together (i.e., if non-empty,
# results must match any one of the platforms).
"A String",
],
"absoluteDateRange": { # An absolute date range, specified by its start date and end date. # An absolute date range, defined by a start date and an end date.
# Interpreted relative to Pacific time zone.
# The supported range of dates begins 30 days before today and ends today.
# Validity checked upon filter set creation. If a filter set with an absolute
# date range is run at a later date more than 30 days after start_date, it will
# fail.
"startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The start date of the range (inclusive).
# Must be within the 30 days leading up to current date, and must be equal to
# or before end_date.
# and time zone are either specified elsewhere or are not significant. The date
# is relative to the Proleptic Gregorian Calendar. This can represent:
#
# * A full date, with non-zero year, month and day values
# * A month and day value, with a zero year, e.g. an anniversary
# * A year on its own, with zero month and day values
# * A year and month value, with a zero day, e.g. a credit card expiration date
#
# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
# a year.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
# if specifying a year by itself or a year and month where the day is not
# significant.
"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
# month and day.
},
"endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The end date of the range (inclusive).
# Must be within the 30 days leading up to current date, and must be equal to
# or after start_date.
# and time zone are either specified elsewhere or are not significant. The date
# is relative to the Proleptic Gregorian Calendar. This can represent:
#
# * A full date, with non-zero year, month and day values
# * A month and day value, with a zero year, e.g. an anniversary
# * A year on its own, with zero month and day values
# * A year and month value, with a zero day, e.g. a credit card expiration date
#
# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
# a year.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
# if specifying a year by itself or a year and month where the day is not
# significant.
"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
# month and day.
},
},
"formats": [ # The list of formats on which to filter; may be empty. The filters
# represented by multiple formats are ORed together (i.e., if non-empty,
# results must match any one of the formats).
"A String",
],
"realtimeTimeRange": { # An open-ended realtime time range specified by the start timestamp. # An open-ended realtime time range, defined by the aggregation start
# timestamp.
# For filter sets that specify a realtime time range RTB metrics continue to
# be aggregated throughout the lifetime of the filter set.
"startTimestamp": "A String", # The start timestamp of the real-time RTB metrics aggregation.
},
"sellerNetworkIds": [ # For Authorized Buyers only.
# The list of IDs of the seller (publisher) networks on which to filter;
# may be empty. The filters represented by multiple seller network IDs are
# ORed together (i.e., if non-empty, results must match any one of the
# publisher networks). See
# [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids)
# file for the set of existing seller network IDs.
42,
],
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|