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 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577
|
<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="displayvideo_v2.html">Display & Video 360 API</a> . <a href="displayvideo_v2.advertisers.html">advertisers</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="displayvideo_v2.advertisers.assets.html">assets()</a></code>
</p>
<p class="firstline">Returns the assets Resource.</p>
<p class="toc_element">
<code><a href="displayvideo_v2.advertisers.campaigns.html">campaigns()</a></code>
</p>
<p class="firstline">Returns the campaigns Resource.</p>
<p class="toc_element">
<code><a href="displayvideo_v2.advertisers.channels.html">channels()</a></code>
</p>
<p class="firstline">Returns the channels Resource.</p>
<p class="toc_element">
<code><a href="displayvideo_v2.advertisers.creatives.html">creatives()</a></code>
</p>
<p class="firstline">Returns the creatives Resource.</p>
<p class="toc_element">
<code><a href="displayvideo_v2.advertisers.insertionOrders.html">insertionOrders()</a></code>
</p>
<p class="firstline">Returns the insertionOrders Resource.</p>
<p class="toc_element">
<code><a href="displayvideo_v2.advertisers.invoices.html">invoices()</a></code>
</p>
<p class="firstline">Returns the invoices Resource.</p>
<p class="toc_element">
<code><a href="displayvideo_v2.advertisers.lineItems.html">lineItems()</a></code>
</p>
<p class="firstline">Returns the lineItems Resource.</p>
<p class="toc_element">
<code><a href="displayvideo_v2.advertisers.locationLists.html">locationLists()</a></code>
</p>
<p class="firstline">Returns the locationLists Resource.</p>
<p class="toc_element">
<code><a href="displayvideo_v2.advertisers.manualTriggers.html">manualTriggers()</a></code>
</p>
<p class="firstline">Returns the manualTriggers Resource.</p>
<p class="toc_element">
<code><a href="displayvideo_v2.advertisers.negativeKeywordLists.html">negativeKeywordLists()</a></code>
</p>
<p class="firstline">Returns the negativeKeywordLists Resource.</p>
<p class="toc_element">
<code><a href="displayvideo_v2.advertisers.targetingTypes.html">targetingTypes()</a></code>
</p>
<p class="firstline">Returns the targetingTypes Resource.</p>
<p class="toc_element">
<code><a href="displayvideo_v2.advertisers.youtubeAdGroupAds.html">youtubeAdGroupAds()</a></code>
</p>
<p class="firstline">Returns the youtubeAdGroupAds Resource.</p>
<p class="toc_element">
<code><a href="displayvideo_v2.advertisers.youtubeAdGroups.html">youtubeAdGroups()</a></code>
</p>
<p class="firstline">Returns the youtubeAdGroups Resource.</p>
<p class="toc_element">
<code><a href="#audit">audit(advertiserId, readMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Audits an advertiser. Returns the counts of used entities per resource type under the advertiser provided. Used entities count towards their respective resource limit. See https://support.google.com/displayvideo/answer/6071450.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new advertiser. Returns the newly created advertiser if successful. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.</p>
<p class="toc_element">
<code><a href="#delete">delete(advertiserId, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an advertiser. Deleting an advertiser will delete all of its child resources, for example, campaigns, insertion orders and line items. A deleted advertiser cannot be recovered.</p>
<p class="toc_element">
<code><a href="#editAssignedTargetingOptions">editAssignedTargetingOptions(advertiserId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Edits targeting options under a single advertiser. The operation will delete the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptionsRequest.create_requests .</p>
<p class="toc_element">
<code><a href="#get">get(advertiserId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets an advertiser.</p>
<p class="toc_element">
<code><a href="#list">list(filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists advertisers that are accessible to the current user. The order is defined by the order_by parameter. A single partner_id is required. Cross-partner listing is not supported.</p>
<p class="toc_element">
<code><a href="#listAssignedTargetingOptions">listAssignedTargetingOptions(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists assigned targeting options of an advertiser across targeting types.</p>
<p class="toc_element">
<code><a href="#listAssignedTargetingOptions_next">listAssignedTargetingOptions_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(advertiserId, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing advertiser. Returns the updated advertiser if successful.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="audit">audit(advertiserId, readMask=None, x__xgafv=None)</code>
<pre>Audits an advertiser. Returns the counts of used entities per resource type under the advertiser provided. Used entities count towards their respective resource limit. See https://support.google.com/displayvideo/answer/6071450.
Args:
advertiserId: string, Required. The ID of the advertiser to audit. (required)
readMask: string, Optional. The specific fields to return. If no mask is specified, all fields in the response proto will be filled. Valid values are: * usedLineItemsCount * usedInsertionOrdersCount * usedCampaignsCount * channelsCount * negativelyTargetedChannelsCount * negativeKeywordListsCount * adGroupCriteriaCount * campaignCriteriaCount
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 AdvertiserService.AuditAdvertiser.
"adGroupCriteriaCount": "A String", # The number of individual targeting options from the following targeting types that are assigned to a line item under this advertiser. These individual targeting options count towards the limit of 4500000 ad group targeting options per advertiser. Qualifying Targeting types: * Channels, URLs, apps, and collections * Demographic * Google Audiences, including Affinity, Custom Affinity, and In-market audiences * Inventory source * Keyword * Mobile app category * User lists * Video targeting * Viewability
"campaignCriteriaCount": "A String", # The number of individual targeting options from the following targeting types that are assigned to a line item under this advertiser. These individual targeting options count towards the limit of 900000 campaign targeting options per advertiser. Qualifying Targeting types: * Position * Browser * Connection speed * Day and time * Device and operating system * Digital content label * Sensitive categories * Environment * Geography, including business chains and proximity * ISP * Language * Third-party verification
"channelsCount": "A String", # The number of channels created under this advertiser. These channels count towards the limit of 1000 channels per advertiser.
"negativeKeywordListsCount": "A String", # The number of negative keyword lists created under this advertiser. These negative keyword lists count towards the limit of 20 negative keyword lists per advertiser.
"negativelyTargetedChannelsCount": "A String", # The number of negatively targeted channels created under this advertiser. These negatively targeted channels count towards the limit of 5 negatively targeted channels per advertiser.
"usedCampaignsCount": "A String", # The number of ACTIVE and PAUSED campaigns under this advertiser. These campaigns count towards the limit of 9999 campaigns per advertiser.
"usedInsertionOrdersCount": "A String", # The number of ACTIVE, PAUSED and DRAFT insertion orders under this advertiser. These insertion orders count towards the limit of 9999 insertion orders per advertiser.
"usedLineItemsCount": "A String", # The number of ACTIVE, PAUSED, and DRAFT line items under this advertiser. These line items count towards the limit of 9999 line items per advertiser.
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(body=None, x__xgafv=None)</code>
<pre>Creates a new advertiser. Returns the newly created advertiser if successful. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.
Args:
body: object, The request body.
The object takes the form of:
{ # A single advertiser in Display & Video 360 (DV360).
"adServerConfig": { # Ad server related settings of an advertiser. # Required. Immutable. Ad server related settings of the advertiser.
"cmHybridConfig": { # Settings for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers. # The configuration for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers.
"cmAccountId": "A String", # Required. Immutable. Account ID of the CM360 Floodlight configuration linked with the DV360 advertiser.
"cmAdvertiserIds": [ # Output only. The set of CM360 Advertiser IDs sharing the CM360 Floodlight configuration.
"A String",
],
"cmFloodlightConfigId": "A String", # Required. Immutable. ID of the CM360 Floodlight configuration linked with the DV360 advertiser.
"cmFloodlightLinkingAuthorized": True or False, # Required. Immutable. By setting this field to `true`, you, on behalf of your company, authorize the sharing of information from the given Floodlight configuration to this Display & Video 360 advertiser.
"cmSyncableSiteIds": [ # A list of CM360 sites whose placements will be synced to DV360 as creatives. If absent or empty in CreateAdvertiser method, the system will automatically create a CM360 site. Removing sites from this list may cause DV360 creatives synced from CM360 to be deleted. At least one site must be specified.
"A String",
],
"dv360ToCmCostReportingEnabled": True or False, # Whether or not to report DV360 cost to CM360.
"dv360ToCmDataSharingEnabled": True or False, # Whether or not to include DV360 data in CM360 data transfer reports.
},
"thirdPartyOnlyConfig": { # Settings for advertisers that use third-party ad servers only. # The configuration for advertisers that use third-party ad servers only.
"pixelOrderIdReportingEnabled": True or False, # Whether or not order ID reporting for pixels is enabled. This value cannot be changed once set to `true`.
},
},
"advertiserId": "A String", # Output only. The unique ID of the advertiser. Assigned by the system.
"containsEuPoliticalAds": "A String", # Optional. Whether this advertiser contains line items that serve European Union political ads. If this field is set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING`, then the following will happen: * Any new line items created under this advertiser will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. * Any existing line items under this advertiser that do not have a set value be updated to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` within a day.
"creativeConfig": { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser.
"dynamicCreativeEnabled": True or False, # Whether or not the advertiser is enabled for dynamic creatives.
"iasClientId": "A String", # An ID for configuring campaign monitoring provided by Integral Ad Service (IAS). The DV360 system will append an IAS "Campaign Monitor" tag containing this ID to the creative tag.
"obaComplianceDisabled": True or False, # Whether or not to disable Google's About this Ad feature that adds badging (to identify the content as an ad) and transparency information (on interaction with About this Ad) to your ads for Online Behavioral Advertising (OBA) and regulatory requirements. About this Ad gives users greater control over the ads they see and helps you explain why they're seeing your ad. [Learn more](//support.google.com/displayvideo/answer/14315795). If you choose to set this field to `true`, note that ads served through Display & Video 360 must comply to the following: * Be Online Behavioral Advertising (OBA) compliant, as per your contract with Google Marketing Platform. * In the European Economic Area (EEA), include transparency information and a mechanism for users to report illegal content in ads. If using an alternative ad badging, transparency, and reporting solution, you must ensure it includes the required transparency information and illegal content flagging mechanism and that you notify Google of any illegal content reports using the appropriate [form](//support.google.com/legal/troubleshooter/1114905?sjid=6787484030557261960-EU#ts=2981967%2C2982031%2C12980091).
"videoCreativeDataSharingAuthorized": True or False, # By setting this field to `true`, you, on behalf of your company, authorize Google to use video creatives associated with this Display & Video 360 advertiser to provide reporting and features related to the advertiser's television campaigns. Applicable only when the advertiser has a CM360 hybrid ad server configuration.
},
"dataAccessConfig": { # Settings that control how advertiser related data may be accessed. # Settings that control how advertiser data may be accessed.
"sdfConfig": { # Structured Data Files (SDF) settings of an advertiser. # Structured Data Files (SDF) settings for the advertiser. If not specified, the SDF settings of the parent partner are used.
"overridePartnerSdfConfig": True or False, # Whether or not this advertiser overrides the SDF configuration of its parent partner. By default, an advertiser inherits the SDF configuration from the parent partner. To override the partner configuration, set this field to `true` and provide the new configuration in sdfConfig.
"sdfConfig": { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser. * Required when overridePartnerSdfConfig is `true`. * Output only when overridePartnerSdfConfig is `false`.
"adminEmail": "A String", # An administrator email address to which the SDF processing status reports will be sent.
"version": "A String", # Required. The version of SDF being used.
},
},
},
"displayName": "A String", # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes.
"entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion.
"generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser.
"currencyCode": "A String", # Required. Immutable. Advertiser's currency in ISO 4217 format. Accepted codes and the currencies they represent are: Currency Code : Currency Name * `ARS` : Argentine Peso * `AUD` : Australian Dollar * `BRL` : Brazilian Real * `CAD` : Canadian Dollar * `CHF` : Swiss Franc * `CLP` : Chilean Peso * `CNY` : Chinese Yuan * `COP` : Colombian Peso * `CZK` : Czech Koruna * `DKK` : Danish Krone * `EGP` : Egyption Pound * `EUR` : Euro * `GBP` : British Pound * `HKD` : Hong Kong Dollar * `HUF` : Hungarian Forint * `IDR` : Indonesian Rupiah * `ILS` : Israeli Shekel * `INR` : Indian Rupee * `JPY` : Japanese Yen * `KRW` : South Korean Won * `MXN` : Mexican Pesos * `MYR` : Malaysian Ringgit * `NGN` : Nigerian Naira * `NOK` : Norwegian Krone * `NZD` : New Zealand Dollar * `PEN` : Peruvian Nuevo Sol * `PLN` : Polish Zloty * `RON` : New Romanian Leu * `RUB` : Russian Ruble * `SEK` : Swedish Krona * `TRY` : Turkish Lira * `TWD` : New Taiwan Dollar * `USD` : US Dollar * `ZAR` : South African Rand
"domainUrl": "A String", # Required. The domain URL of the advertiser's primary website. The system will send this information to publishers that require website URL to associate a campaign with an advertiser. Provide a URL with no path or query string, beginning with `http:` or `https:`. For example, http://www.example.com
"timeZone": "A String", # Output only. The standard TZ database name of the advertiser's time zone. For example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones For CM360 hybrid advertisers, the time zone is the same as that of the associated CM360 account; for third-party only advertisers, the time zone is the same as that of the parent partner.
},
"integrationDetails": { # Integration details of an entry. # Integration details of the advertiser. Only integrationCode is currently applicable to advertiser. Other fields of IntegrationDetails are not supported and will be ignored if provided.
"details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
"integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
},
"name": "A String", # Output only. The resource name of the advertiser.
"partnerId": "A String", # Required. Immutable. The unique ID of the partner that the advertiser belongs to.
"prismaEnabled": True or False, # Whether integration with Mediaocean (Prisma) is enabled. By enabling this, you agree to the following: On behalf of my company, I authorize Mediaocean (Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser.
"servingConfig": { # Targeting settings related to ad serving of an advertiser. # Targeting settings related to ad serving of the advertiser.
"exemptTvFromViewabilityTargeting": True or False, # Whether or not connected TV devices are exempt from viewability targeting for all video line items under the advertiser.
},
"updateTime": "A String", # Output only. The timestamp when the advertiser was last updated. Assigned by the system.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A single advertiser in Display & Video 360 (DV360).
"adServerConfig": { # Ad server related settings of an advertiser. # Required. Immutable. Ad server related settings of the advertiser.
"cmHybridConfig": { # Settings for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers. # The configuration for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers.
"cmAccountId": "A String", # Required. Immutable. Account ID of the CM360 Floodlight configuration linked with the DV360 advertiser.
"cmAdvertiserIds": [ # Output only. The set of CM360 Advertiser IDs sharing the CM360 Floodlight configuration.
"A String",
],
"cmFloodlightConfigId": "A String", # Required. Immutable. ID of the CM360 Floodlight configuration linked with the DV360 advertiser.
"cmFloodlightLinkingAuthorized": True or False, # Required. Immutable. By setting this field to `true`, you, on behalf of your company, authorize the sharing of information from the given Floodlight configuration to this Display & Video 360 advertiser.
"cmSyncableSiteIds": [ # A list of CM360 sites whose placements will be synced to DV360 as creatives. If absent or empty in CreateAdvertiser method, the system will automatically create a CM360 site. Removing sites from this list may cause DV360 creatives synced from CM360 to be deleted. At least one site must be specified.
"A String",
],
"dv360ToCmCostReportingEnabled": True or False, # Whether or not to report DV360 cost to CM360.
"dv360ToCmDataSharingEnabled": True or False, # Whether or not to include DV360 data in CM360 data transfer reports.
},
"thirdPartyOnlyConfig": { # Settings for advertisers that use third-party ad servers only. # The configuration for advertisers that use third-party ad servers only.
"pixelOrderIdReportingEnabled": True or False, # Whether or not order ID reporting for pixels is enabled. This value cannot be changed once set to `true`.
},
},
"advertiserId": "A String", # Output only. The unique ID of the advertiser. Assigned by the system.
"containsEuPoliticalAds": "A String", # Optional. Whether this advertiser contains line items that serve European Union political ads. If this field is set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING`, then the following will happen: * Any new line items created under this advertiser will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. * Any existing line items under this advertiser that do not have a set value be updated to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` within a day.
"creativeConfig": { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser.
"dynamicCreativeEnabled": True or False, # Whether or not the advertiser is enabled for dynamic creatives.
"iasClientId": "A String", # An ID for configuring campaign monitoring provided by Integral Ad Service (IAS). The DV360 system will append an IAS "Campaign Monitor" tag containing this ID to the creative tag.
"obaComplianceDisabled": True or False, # Whether or not to disable Google's About this Ad feature that adds badging (to identify the content as an ad) and transparency information (on interaction with About this Ad) to your ads for Online Behavioral Advertising (OBA) and regulatory requirements. About this Ad gives users greater control over the ads they see and helps you explain why they're seeing your ad. [Learn more](//support.google.com/displayvideo/answer/14315795). If you choose to set this field to `true`, note that ads served through Display & Video 360 must comply to the following: * Be Online Behavioral Advertising (OBA) compliant, as per your contract with Google Marketing Platform. * In the European Economic Area (EEA), include transparency information and a mechanism for users to report illegal content in ads. If using an alternative ad badging, transparency, and reporting solution, you must ensure it includes the required transparency information and illegal content flagging mechanism and that you notify Google of any illegal content reports using the appropriate [form](//support.google.com/legal/troubleshooter/1114905?sjid=6787484030557261960-EU#ts=2981967%2C2982031%2C12980091).
"videoCreativeDataSharingAuthorized": True or False, # By setting this field to `true`, you, on behalf of your company, authorize Google to use video creatives associated with this Display & Video 360 advertiser to provide reporting and features related to the advertiser's television campaigns. Applicable only when the advertiser has a CM360 hybrid ad server configuration.
},
"dataAccessConfig": { # Settings that control how advertiser related data may be accessed. # Settings that control how advertiser data may be accessed.
"sdfConfig": { # Structured Data Files (SDF) settings of an advertiser. # Structured Data Files (SDF) settings for the advertiser. If not specified, the SDF settings of the parent partner are used.
"overridePartnerSdfConfig": True or False, # Whether or not this advertiser overrides the SDF configuration of its parent partner. By default, an advertiser inherits the SDF configuration from the parent partner. To override the partner configuration, set this field to `true` and provide the new configuration in sdfConfig.
"sdfConfig": { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser. * Required when overridePartnerSdfConfig is `true`. * Output only when overridePartnerSdfConfig is `false`.
"adminEmail": "A String", # An administrator email address to which the SDF processing status reports will be sent.
"version": "A String", # Required. The version of SDF being used.
},
},
},
"displayName": "A String", # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes.
"entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion.
"generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser.
"currencyCode": "A String", # Required. Immutable. Advertiser's currency in ISO 4217 format. Accepted codes and the currencies they represent are: Currency Code : Currency Name * `ARS` : Argentine Peso * `AUD` : Australian Dollar * `BRL` : Brazilian Real * `CAD` : Canadian Dollar * `CHF` : Swiss Franc * `CLP` : Chilean Peso * `CNY` : Chinese Yuan * `COP` : Colombian Peso * `CZK` : Czech Koruna * `DKK` : Danish Krone * `EGP` : Egyption Pound * `EUR` : Euro * `GBP` : British Pound * `HKD` : Hong Kong Dollar * `HUF` : Hungarian Forint * `IDR` : Indonesian Rupiah * `ILS` : Israeli Shekel * `INR` : Indian Rupee * `JPY` : Japanese Yen * `KRW` : South Korean Won * `MXN` : Mexican Pesos * `MYR` : Malaysian Ringgit * `NGN` : Nigerian Naira * `NOK` : Norwegian Krone * `NZD` : New Zealand Dollar * `PEN` : Peruvian Nuevo Sol * `PLN` : Polish Zloty * `RON` : New Romanian Leu * `RUB` : Russian Ruble * `SEK` : Swedish Krona * `TRY` : Turkish Lira * `TWD` : New Taiwan Dollar * `USD` : US Dollar * `ZAR` : South African Rand
"domainUrl": "A String", # Required. The domain URL of the advertiser's primary website. The system will send this information to publishers that require website URL to associate a campaign with an advertiser. Provide a URL with no path or query string, beginning with `http:` or `https:`. For example, http://www.example.com
"timeZone": "A String", # Output only. The standard TZ database name of the advertiser's time zone. For example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones For CM360 hybrid advertisers, the time zone is the same as that of the associated CM360 account; for third-party only advertisers, the time zone is the same as that of the parent partner.
},
"integrationDetails": { # Integration details of an entry. # Integration details of the advertiser. Only integrationCode is currently applicable to advertiser. Other fields of IntegrationDetails are not supported and will be ignored if provided.
"details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
"integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
},
"name": "A String", # Output only. The resource name of the advertiser.
"partnerId": "A String", # Required. Immutable. The unique ID of the partner that the advertiser belongs to.
"prismaEnabled": True or False, # Whether integration with Mediaocean (Prisma) is enabled. By enabling this, you agree to the following: On behalf of my company, I authorize Mediaocean (Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser.
"servingConfig": { # Targeting settings related to ad serving of an advertiser. # Targeting settings related to ad serving of the advertiser.
"exemptTvFromViewabilityTargeting": True or False, # Whether or not connected TV devices are exempt from viewability targeting for all video line items under the advertiser.
},
"updateTime": "A String", # Output only. The timestamp when the advertiser was last updated. Assigned by the system.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(advertiserId, x__xgafv=None)</code>
<pre>Deletes an advertiser. Deleting an advertiser will delete all of its child resources, for example, campaigns, insertion orders and line items. A deleted advertiser cannot be recovered.
Args:
advertiserId: string, The ID of the advertiser we need to delete. (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); }
}</pre>
</div>
<div class="method">
<code class="details" id="editAssignedTargetingOptions">editAssignedTargetingOptions(advertiserId, body=None, x__xgafv=None)</code>
<pre>Edits targeting options under a single advertiser. The operation will delete the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptionsRequest.create_requests .
Args:
advertiserId: string, Required. The ID of the advertiser. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for BulkEditAdvertiserAssignedTargetingOptions.
"createRequests": [ # The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_INVENTORY_MODE`
{ # A request listing which assigned targeting options of a given targeting type should be created and added.
"assignedTargetingOptions": [ # Required. The assigned targeting options to create and add.
{ # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
"ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`.
"ageRange": "A String", # Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
},
"appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
"displayName": "A String", # Output only. The display name of the app category.
"negative": True or False, # Indicates if this option is being negatively targeted.
"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
},
"appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`.
"appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
"appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
"displayName": "A String", # Output only. The display name of the app.
"negative": True or False, # Indicates if this option is being negatively targeted.
},
"assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
"assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`
"audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource.
"excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
"settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
{ # Details of Google audience targeting setting.
"googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
},
],
},
"includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only.
"settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
{ # Details of combined audience targeting setting.
"combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
},
],
},
"includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only.
"settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.
{ # Details of custom list targeting setting.
"customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.
},
],
},
"includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only.
"settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
{ # Details of Google audience targeting setting.
"googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
},
],
},
},
"audioContentTypeDetails": { # Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. # Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.
"audioContentType": "A String", # Required. The audio content type.
},
"authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
"authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.
"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
},
"browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`.
"displayName": "A String", # Output only. The display name of the browser.
"negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.
"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
},
"businessChainDetails": { # Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
"displayName": "A String", # Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
"proximityRadiusAmount": 3.14, # Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.
"proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.
},
"carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
"displayName": "A String", # Output only. The display name of the carrier or ISP.
"negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.
"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
},
"categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
"displayName": "A String", # Output only. The display name of the category.
"negative": True or False, # Indicates if this option is being negatively targeted.
"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
},
"channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`.
"channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
"negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
},
"contentDurationDetails": { # Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. # Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
"contentDuration": "A String", # Output only. The content duration.
"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
},
"contentGenreDetails": { # Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. # Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
"displayName": "A String", # Output only. The display name of the content genre.
"negative": True or False, # Indicates if this option is being negatively targeted.
"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
},
"contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
"adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
"contentInstreamPosition": "A String", # Required. The content instream position for video or audio ads.
},
"contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
"adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
"contentOutstreamPosition": "A String", # Required. The content outstream position.
},
"contentStreamTypeDetails": { # Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. # Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
"contentStreamType": "A String", # Output only. The content stream type.
"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
},
"dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`.
"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.
"endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
"startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
"timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting.
},
"deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
"displayName": "A String", # Output only. The display name of the device make and model.
"negative": True or False, # Indicates if this option is being negatively targeted.
"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
},
"deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
"deviceType": "A String", # Required. The display name of the device type.
"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.
},
"digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.
"excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED.
},
"environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
"environment": "A String", # Required. The serving environment.
},
"exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`.
"exchange": "A String", # Required. The enum value for the exchange.
},
"genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`.
"gender": "A String", # Required. The gender of the audience.
},
"geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`.
"displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
"geoRegionType": "A String", # Output only. The type of geographic region targeting.
"negative": True or False, # Indicates if this option is being negatively targeted.
"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
},
"householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
"householdIncome": "A String", # Required. The household income of the audience.
},
"inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.
"inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.
"inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
},
"inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
},
"keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned.
"keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
"negative": True or False, # Indicates if this option is being negatively targeted.
},
"languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`.
"displayName": "A String", # Output only. The display name of the language (e.g., "French").
"negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.
"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
},
"name": "A String", # Output only. The resource name for this assigned targeting option.
"nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
"contentPosition": "A String", # Required. The content position.
},
"negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource.
"negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
},
"omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`.
"omid": "A String", # Required. The type of Open Measurement enabled inventory.
},
"onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
"adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
"onScreenPosition": "A String", # Output only. The on screen position.
"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
},
"operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
"displayName": "A String", # Output only. The display name of the operating system.
"negative": True or False, # Indicates if this option is being negatively targeted.
"targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
},
"parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.
"parentalStatus": "A String", # Required. The parental status of the audience.
},
"poiDetails": { # Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. # POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`.
"displayName": "A String", # Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
"latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
"longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
"proximityRadiusAmount": 3.14, # Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.
"proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**
},
"proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
"proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
"proximityRadius": 3.14, # Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.
"proximityRadiusUnit": "A String", # Required. Radius distance units.
},
"regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
"negative": True or False, # Indicates if this option is being negatively targeted.
"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
},
"sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.
"excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
},
"sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
"sessionPosition": "A String", # The position where the ad will show in a session.
},
"subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
},
"targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.
"thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
"adloox": { # Details of Scope3 (previously known as Adloox) brand safety settings. # Third party brand verifier -- Scope3 (previously known as Adloox).
"excludedAdlooxCategories": [ # Scope3 categories to exclude.
"A String",
],
},
"doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
"appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
"avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.
"avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.
},
"avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.
"A String",
],
"brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.
"avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.
"avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.
"A String",
],
"avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.
"A String",
],
},
"customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic
"displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
"iab": "A String", # Target web and app inventory to maximize IAB viewable rate.
"viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.
},
"fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.
"avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.
"avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.
},
"videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
"playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.
"videoIab": "A String", # Target web inventory to maximize IAB viewable rate.
"videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.
},
},
"integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
"customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.
"A String",
],
"displayViewability": "A String", # Display Viewability section (applicable to display line items only).
"excludeUnrateable": True or False, # Brand Safety - **Unrateable**.
"excludedAdFraudRisk": "A String", # Ad Fraud settings.
"excludedAdultRisk": "A String", # Brand Safety - **Adult content**.
"excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.
"excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.
"excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.
"excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.
"excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.
"excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.
"excludedViolenceRisk": "A String", # Brand Safety - **Violence**.
"traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).
"videoViewability": "A String", # Video Viewability Section (applicable to video line items only).
},
},
"urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`.
"negative": True or False, # Indicates if this option is being negatively targeted.
"url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
},
"userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
"userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
},
"videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
"videoPlayerSize": "A String", # Required. The video player size.
},
"viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
"viewability": "A String", # Required. The predicted viewability percentage.
},
"youtubeChannelDetails": { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
"channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
"negative": True or False, # Indicates if this option is being negatively targeted.
},
"youtubeVideoDetails": { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
"negative": True or False, # Indicates if this option is being negatively targeted.
"videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
},
},
],
"targetingType": "A String", # Required. Identifies the type of this assigned targeting option.
},
],
"deleteRequests": [ # The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_INVENTORY_MODE`
{ # A request listing which assigned targeting options of a given targeting type should be deleted.
"assignedTargetingOptionIds": [ # Required. The assigned targeting option IDs to delete.
"A String",
],
"targetingType": "A String", # Required. Identifies the type of this assigned targeting option.
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"createdAssignedTargetingOptions": [ # The list of assigned targeting options that have been successfully created. This list will be absent if empty.
{ # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
"ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`.
"ageRange": "A String", # Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
},
"appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
"displayName": "A String", # Output only. The display name of the app category.
"negative": True or False, # Indicates if this option is being negatively targeted.
"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
},
"appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`.
"appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
"appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
"displayName": "A String", # Output only. The display name of the app.
"negative": True or False, # Indicates if this option is being negatively targeted.
},
"assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
"assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`
"audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource.
"excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
"settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
{ # Details of Google audience targeting setting.
"googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
},
],
},
"includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only.
"settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
{ # Details of combined audience targeting setting.
"combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
},
],
},
"includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only.
"settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.
{ # Details of custom list targeting setting.
"customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.
},
],
},
"includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only.
"settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
{ # Details of Google audience targeting setting.
"googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
},
],
},
},
"audioContentTypeDetails": { # Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. # Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.
"audioContentType": "A String", # Required. The audio content type.
},
"authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
"authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.
"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
},
"browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`.
"displayName": "A String", # Output only. The display name of the browser.
"negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.
"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
},
"businessChainDetails": { # Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
"displayName": "A String", # Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
"proximityRadiusAmount": 3.14, # Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.
"proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.
},
"carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
"displayName": "A String", # Output only. The display name of the carrier or ISP.
"negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.
"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
},
"categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
"displayName": "A String", # Output only. The display name of the category.
"negative": True or False, # Indicates if this option is being negatively targeted.
"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
},
"channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`.
"channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
"negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
},
"contentDurationDetails": { # Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. # Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
"contentDuration": "A String", # Output only. The content duration.
"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
},
"contentGenreDetails": { # Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. # Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
"displayName": "A String", # Output only. The display name of the content genre.
"negative": True or False, # Indicates if this option is being negatively targeted.
"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
},
"contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
"adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
"contentInstreamPosition": "A String", # Required. The content instream position for video or audio ads.
},
"contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
"adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
"contentOutstreamPosition": "A String", # Required. The content outstream position.
},
"contentStreamTypeDetails": { # Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. # Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
"contentStreamType": "A String", # Output only. The content stream type.
"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
},
"dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`.
"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.
"endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
"startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
"timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting.
},
"deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
"displayName": "A String", # Output only. The display name of the device make and model.
"negative": True or False, # Indicates if this option is being negatively targeted.
"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
},
"deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
"deviceType": "A String", # Required. The display name of the device type.
"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.
},
"digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.
"excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED.
},
"environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
"environment": "A String", # Required. The serving environment.
},
"exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`.
"exchange": "A String", # Required. The enum value for the exchange.
},
"genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`.
"gender": "A String", # Required. The gender of the audience.
},
"geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`.
"displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
"geoRegionType": "A String", # Output only. The type of geographic region targeting.
"negative": True or False, # Indicates if this option is being negatively targeted.
"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
},
"householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
"householdIncome": "A String", # Required. The household income of the audience.
},
"inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.
"inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.
"inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
},
"inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
},
"keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned.
"keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
"negative": True or False, # Indicates if this option is being negatively targeted.
},
"languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`.
"displayName": "A String", # Output only. The display name of the language (e.g., "French").
"negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.
"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
},
"name": "A String", # Output only. The resource name for this assigned targeting option.
"nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
"contentPosition": "A String", # Required. The content position.
},
"negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource.
"negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
},
"omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`.
"omid": "A String", # Required. The type of Open Measurement enabled inventory.
},
"onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
"adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
"onScreenPosition": "A String", # Output only. The on screen position.
"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
},
"operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
"displayName": "A String", # Output only. The display name of the operating system.
"negative": True or False, # Indicates if this option is being negatively targeted.
"targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
},
"parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.
"parentalStatus": "A String", # Required. The parental status of the audience.
},
"poiDetails": { # Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. # POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`.
"displayName": "A String", # Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
"latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
"longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
"proximityRadiusAmount": 3.14, # Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.
"proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**
},
"proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
"proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
"proximityRadius": 3.14, # Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.
"proximityRadiusUnit": "A String", # Required. Radius distance units.
},
"regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
"negative": True or False, # Indicates if this option is being negatively targeted.
"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
},
"sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.
"excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
},
"sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
"sessionPosition": "A String", # The position where the ad will show in a session.
},
"subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
},
"targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.
"thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
"adloox": { # Details of Scope3 (previously known as Adloox) brand safety settings. # Third party brand verifier -- Scope3 (previously known as Adloox).
"excludedAdlooxCategories": [ # Scope3 categories to exclude.
"A String",
],
},
"doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
"appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
"avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.
"avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.
},
"avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.
"A String",
],
"brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.
"avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.
"avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.
"A String",
],
"avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.
"A String",
],
},
"customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic
"displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
"iab": "A String", # Target web and app inventory to maximize IAB viewable rate.
"viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.
},
"fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.
"avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.
"avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.
},
"videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
"playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.
"videoIab": "A String", # Target web inventory to maximize IAB viewable rate.
"videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.
},
},
"integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
"customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.
"A String",
],
"displayViewability": "A String", # Display Viewability section (applicable to display line items only).
"excludeUnrateable": True or False, # Brand Safety - **Unrateable**.
"excludedAdFraudRisk": "A String", # Ad Fraud settings.
"excludedAdultRisk": "A String", # Brand Safety - **Adult content**.
"excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.
"excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.
"excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.
"excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.
"excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.
"excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.
"excludedViolenceRisk": "A String", # Brand Safety - **Violence**.
"traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).
"videoViewability": "A String", # Video Viewability Section (applicable to video line items only).
},
},
"urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`.
"negative": True or False, # Indicates if this option is being negatively targeted.
"url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
},
"userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
"userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
},
"videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
"videoPlayerSize": "A String", # Required. The video player size.
},
"viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
"viewability": "A String", # Required. The predicted viewability percentage.
},
"youtubeChannelDetails": { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
"channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
"negative": True or False, # Indicates if this option is being negatively targeted.
},
"youtubeVideoDetails": { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
"negative": True or False, # Indicates if this option is being negatively targeted.
"videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(advertiserId, x__xgafv=None)</code>
<pre>Gets an advertiser.
Args:
advertiserId: string, Required. The ID of the advertiser to fetch. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A single advertiser in Display & Video 360 (DV360).
"adServerConfig": { # Ad server related settings of an advertiser. # Required. Immutable. Ad server related settings of the advertiser.
"cmHybridConfig": { # Settings for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers. # The configuration for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers.
"cmAccountId": "A String", # Required. Immutable. Account ID of the CM360 Floodlight configuration linked with the DV360 advertiser.
"cmAdvertiserIds": [ # Output only. The set of CM360 Advertiser IDs sharing the CM360 Floodlight configuration.
"A String",
],
"cmFloodlightConfigId": "A String", # Required. Immutable. ID of the CM360 Floodlight configuration linked with the DV360 advertiser.
"cmFloodlightLinkingAuthorized": True or False, # Required. Immutable. By setting this field to `true`, you, on behalf of your company, authorize the sharing of information from the given Floodlight configuration to this Display & Video 360 advertiser.
"cmSyncableSiteIds": [ # A list of CM360 sites whose placements will be synced to DV360 as creatives. If absent or empty in CreateAdvertiser method, the system will automatically create a CM360 site. Removing sites from this list may cause DV360 creatives synced from CM360 to be deleted. At least one site must be specified.
"A String",
],
"dv360ToCmCostReportingEnabled": True or False, # Whether or not to report DV360 cost to CM360.
"dv360ToCmDataSharingEnabled": True or False, # Whether or not to include DV360 data in CM360 data transfer reports.
},
"thirdPartyOnlyConfig": { # Settings for advertisers that use third-party ad servers only. # The configuration for advertisers that use third-party ad servers only.
"pixelOrderIdReportingEnabled": True or False, # Whether or not order ID reporting for pixels is enabled. This value cannot be changed once set to `true`.
},
},
"advertiserId": "A String", # Output only. The unique ID of the advertiser. Assigned by the system.
"containsEuPoliticalAds": "A String", # Optional. Whether this advertiser contains line items that serve European Union political ads. If this field is set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING`, then the following will happen: * Any new line items created under this advertiser will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. * Any existing line items under this advertiser that do not have a set value be updated to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` within a day.
"creativeConfig": { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser.
"dynamicCreativeEnabled": True or False, # Whether or not the advertiser is enabled for dynamic creatives.
"iasClientId": "A String", # An ID for configuring campaign monitoring provided by Integral Ad Service (IAS). The DV360 system will append an IAS "Campaign Monitor" tag containing this ID to the creative tag.
"obaComplianceDisabled": True or False, # Whether or not to disable Google's About this Ad feature that adds badging (to identify the content as an ad) and transparency information (on interaction with About this Ad) to your ads for Online Behavioral Advertising (OBA) and regulatory requirements. About this Ad gives users greater control over the ads they see and helps you explain why they're seeing your ad. [Learn more](//support.google.com/displayvideo/answer/14315795). If you choose to set this field to `true`, note that ads served through Display & Video 360 must comply to the following: * Be Online Behavioral Advertising (OBA) compliant, as per your contract with Google Marketing Platform. * In the European Economic Area (EEA), include transparency information and a mechanism for users to report illegal content in ads. If using an alternative ad badging, transparency, and reporting solution, you must ensure it includes the required transparency information and illegal content flagging mechanism and that you notify Google of any illegal content reports using the appropriate [form](//support.google.com/legal/troubleshooter/1114905?sjid=6787484030557261960-EU#ts=2981967%2C2982031%2C12980091).
"videoCreativeDataSharingAuthorized": True or False, # By setting this field to `true`, you, on behalf of your company, authorize Google to use video creatives associated with this Display & Video 360 advertiser to provide reporting and features related to the advertiser's television campaigns. Applicable only when the advertiser has a CM360 hybrid ad server configuration.
},
"dataAccessConfig": { # Settings that control how advertiser related data may be accessed. # Settings that control how advertiser data may be accessed.
"sdfConfig": { # Structured Data Files (SDF) settings of an advertiser. # Structured Data Files (SDF) settings for the advertiser. If not specified, the SDF settings of the parent partner are used.
"overridePartnerSdfConfig": True or False, # Whether or not this advertiser overrides the SDF configuration of its parent partner. By default, an advertiser inherits the SDF configuration from the parent partner. To override the partner configuration, set this field to `true` and provide the new configuration in sdfConfig.
"sdfConfig": { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser. * Required when overridePartnerSdfConfig is `true`. * Output only when overridePartnerSdfConfig is `false`.
"adminEmail": "A String", # An administrator email address to which the SDF processing status reports will be sent.
"version": "A String", # Required. The version of SDF being used.
},
},
},
"displayName": "A String", # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes.
"entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion.
"generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser.
"currencyCode": "A String", # Required. Immutable. Advertiser's currency in ISO 4217 format. Accepted codes and the currencies they represent are: Currency Code : Currency Name * `ARS` : Argentine Peso * `AUD` : Australian Dollar * `BRL` : Brazilian Real * `CAD` : Canadian Dollar * `CHF` : Swiss Franc * `CLP` : Chilean Peso * `CNY` : Chinese Yuan * `COP` : Colombian Peso * `CZK` : Czech Koruna * `DKK` : Danish Krone * `EGP` : Egyption Pound * `EUR` : Euro * `GBP` : British Pound * `HKD` : Hong Kong Dollar * `HUF` : Hungarian Forint * `IDR` : Indonesian Rupiah * `ILS` : Israeli Shekel * `INR` : Indian Rupee * `JPY` : Japanese Yen * `KRW` : South Korean Won * `MXN` : Mexican Pesos * `MYR` : Malaysian Ringgit * `NGN` : Nigerian Naira * `NOK` : Norwegian Krone * `NZD` : New Zealand Dollar * `PEN` : Peruvian Nuevo Sol * `PLN` : Polish Zloty * `RON` : New Romanian Leu * `RUB` : Russian Ruble * `SEK` : Swedish Krona * `TRY` : Turkish Lira * `TWD` : New Taiwan Dollar * `USD` : US Dollar * `ZAR` : South African Rand
"domainUrl": "A String", # Required. The domain URL of the advertiser's primary website. The system will send this information to publishers that require website URL to associate a campaign with an advertiser. Provide a URL with no path or query string, beginning with `http:` or `https:`. For example, http://www.example.com
"timeZone": "A String", # Output only. The standard TZ database name of the advertiser's time zone. For example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones For CM360 hybrid advertisers, the time zone is the same as that of the associated CM360 account; for third-party only advertisers, the time zone is the same as that of the parent partner.
},
"integrationDetails": { # Integration details of an entry. # Integration details of the advertiser. Only integrationCode is currently applicable to advertiser. Other fields of IntegrationDetails are not supported and will be ignored if provided.
"details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
"integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
},
"name": "A String", # Output only. The resource name of the advertiser.
"partnerId": "A String", # Required. Immutable. The unique ID of the partner that the advertiser belongs to.
"prismaEnabled": True or False, # Whether integration with Mediaocean (Prisma) is enabled. By enabling this, you agree to the following: On behalf of my company, I authorize Mediaocean (Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser.
"servingConfig": { # Targeting settings related to ad serving of an advertiser. # Targeting settings related to ad serving of the advertiser.
"exemptTvFromViewabilityTargeting": True or False, # Whether or not connected TV devices are exempt from viewability targeting for all video line items under the advertiser.
},
"updateTime": "A String", # Output only. The timestamp when the advertiser was last updated. Assigned by the system.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)</code>
<pre>Lists advertisers that are accessible to the current user. The order is defined by the order_by parameter. A single partner_id is required. Cross-partner listing is not supported.
Args:
filter: string, Allows filtering by advertiser fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `advertiserId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All active advertisers under a partner: `entityStatus="ENTITY_STATUS_ACTIVE"` * All advertisers with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All advertisers with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
orderBy: string, Field by which to sort the list. Acceptable values are: * `advertiserId` (default) * `displayName` * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.
pageSize: integer, Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdvertisers` method. If not specified, the first page of results will be returned.
partnerId: string, Required. The ID of the partner that the fetched advertisers should all belong to. The system only supports listing advertisers for one partner at a time.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"advertisers": [ # The list of advertisers. This list will be absent if empty.
{ # A single advertiser in Display & Video 360 (DV360).
"adServerConfig": { # Ad server related settings of an advertiser. # Required. Immutable. Ad server related settings of the advertiser.
"cmHybridConfig": { # Settings for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers. # The configuration for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers.
"cmAccountId": "A String", # Required. Immutable. Account ID of the CM360 Floodlight configuration linked with the DV360 advertiser.
"cmAdvertiserIds": [ # Output only. The set of CM360 Advertiser IDs sharing the CM360 Floodlight configuration.
"A String",
],
"cmFloodlightConfigId": "A String", # Required. Immutable. ID of the CM360 Floodlight configuration linked with the DV360 advertiser.
"cmFloodlightLinkingAuthorized": True or False, # Required. Immutable. By setting this field to `true`, you, on behalf of your company, authorize the sharing of information from the given Floodlight configuration to this Display & Video 360 advertiser.
"cmSyncableSiteIds": [ # A list of CM360 sites whose placements will be synced to DV360 as creatives. If absent or empty in CreateAdvertiser method, the system will automatically create a CM360 site. Removing sites from this list may cause DV360 creatives synced from CM360 to be deleted. At least one site must be specified.
"A String",
],
"dv360ToCmCostReportingEnabled": True or False, # Whether or not to report DV360 cost to CM360.
"dv360ToCmDataSharingEnabled": True or False, # Whether or not to include DV360 data in CM360 data transfer reports.
},
"thirdPartyOnlyConfig": { # Settings for advertisers that use third-party ad servers only. # The configuration for advertisers that use third-party ad servers only.
"pixelOrderIdReportingEnabled": True or False, # Whether or not order ID reporting for pixels is enabled. This value cannot be changed once set to `true`.
},
},
"advertiserId": "A String", # Output only. The unique ID of the advertiser. Assigned by the system.
"containsEuPoliticalAds": "A String", # Optional. Whether this advertiser contains line items that serve European Union political ads. If this field is set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING`, then the following will happen: * Any new line items created under this advertiser will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. * Any existing line items under this advertiser that do not have a set value be updated to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` within a day.
"creativeConfig": { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser.
"dynamicCreativeEnabled": True or False, # Whether or not the advertiser is enabled for dynamic creatives.
"iasClientId": "A String", # An ID for configuring campaign monitoring provided by Integral Ad Service (IAS). The DV360 system will append an IAS "Campaign Monitor" tag containing this ID to the creative tag.
"obaComplianceDisabled": True or False, # Whether or not to disable Google's About this Ad feature that adds badging (to identify the content as an ad) and transparency information (on interaction with About this Ad) to your ads for Online Behavioral Advertising (OBA) and regulatory requirements. About this Ad gives users greater control over the ads they see and helps you explain why they're seeing your ad. [Learn more](//support.google.com/displayvideo/answer/14315795). If you choose to set this field to `true`, note that ads served through Display & Video 360 must comply to the following: * Be Online Behavioral Advertising (OBA) compliant, as per your contract with Google Marketing Platform. * In the European Economic Area (EEA), include transparency information and a mechanism for users to report illegal content in ads. If using an alternative ad badging, transparency, and reporting solution, you must ensure it includes the required transparency information and illegal content flagging mechanism and that you notify Google of any illegal content reports using the appropriate [form](//support.google.com/legal/troubleshooter/1114905?sjid=6787484030557261960-EU#ts=2981967%2C2982031%2C12980091).
"videoCreativeDataSharingAuthorized": True or False, # By setting this field to `true`, you, on behalf of your company, authorize Google to use video creatives associated with this Display & Video 360 advertiser to provide reporting and features related to the advertiser's television campaigns. Applicable only when the advertiser has a CM360 hybrid ad server configuration.
},
"dataAccessConfig": { # Settings that control how advertiser related data may be accessed. # Settings that control how advertiser data may be accessed.
"sdfConfig": { # Structured Data Files (SDF) settings of an advertiser. # Structured Data Files (SDF) settings for the advertiser. If not specified, the SDF settings of the parent partner are used.
"overridePartnerSdfConfig": True or False, # Whether or not this advertiser overrides the SDF configuration of its parent partner. By default, an advertiser inherits the SDF configuration from the parent partner. To override the partner configuration, set this field to `true` and provide the new configuration in sdfConfig.
"sdfConfig": { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser. * Required when overridePartnerSdfConfig is `true`. * Output only when overridePartnerSdfConfig is `false`.
"adminEmail": "A String", # An administrator email address to which the SDF processing status reports will be sent.
"version": "A String", # Required. The version of SDF being used.
},
},
},
"displayName": "A String", # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes.
"entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion.
"generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser.
"currencyCode": "A String", # Required. Immutable. Advertiser's currency in ISO 4217 format. Accepted codes and the currencies they represent are: Currency Code : Currency Name * `ARS` : Argentine Peso * `AUD` : Australian Dollar * `BRL` : Brazilian Real * `CAD` : Canadian Dollar * `CHF` : Swiss Franc * `CLP` : Chilean Peso * `CNY` : Chinese Yuan * `COP` : Colombian Peso * `CZK` : Czech Koruna * `DKK` : Danish Krone * `EGP` : Egyption Pound * `EUR` : Euro * `GBP` : British Pound * `HKD` : Hong Kong Dollar * `HUF` : Hungarian Forint * `IDR` : Indonesian Rupiah * `ILS` : Israeli Shekel * `INR` : Indian Rupee * `JPY` : Japanese Yen * `KRW` : South Korean Won * `MXN` : Mexican Pesos * `MYR` : Malaysian Ringgit * `NGN` : Nigerian Naira * `NOK` : Norwegian Krone * `NZD` : New Zealand Dollar * `PEN` : Peruvian Nuevo Sol * `PLN` : Polish Zloty * `RON` : New Romanian Leu * `RUB` : Russian Ruble * `SEK` : Swedish Krona * `TRY` : Turkish Lira * `TWD` : New Taiwan Dollar * `USD` : US Dollar * `ZAR` : South African Rand
"domainUrl": "A String", # Required. The domain URL of the advertiser's primary website. The system will send this information to publishers that require website URL to associate a campaign with an advertiser. Provide a URL with no path or query string, beginning with `http:` or `https:`. For example, http://www.example.com
"timeZone": "A String", # Output only. The standard TZ database name of the advertiser's time zone. For example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones For CM360 hybrid advertisers, the time zone is the same as that of the associated CM360 account; for third-party only advertisers, the time zone is the same as that of the parent partner.
},
"integrationDetails": { # Integration details of an entry. # Integration details of the advertiser. Only integrationCode is currently applicable to advertiser. Other fields of IntegrationDetails are not supported and will be ignored if provided.
"details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
"integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
},
"name": "A String", # Output only. The resource name of the advertiser.
"partnerId": "A String", # Required. Immutable. The unique ID of the partner that the advertiser belongs to.
"prismaEnabled": True or False, # Whether integration with Mediaocean (Prisma) is enabled. By enabling this, you agree to the following: On behalf of my company, I authorize Mediaocean (Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser.
"servingConfig": { # Targeting settings related to ad serving of an advertiser. # Targeting settings related to ad serving of the advertiser.
"exemptTvFromViewabilityTargeting": True or False, # Whether or not connected TV devices are exempt from viewability targeting for all video line items under the advertiser.
},
"updateTime": "A String", # Output only. The timestamp when the advertiser was last updated. Assigned by the system.
},
],
"nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAdvertisers` method to retrieve the next page of results.
}</pre>
</div>
<div class="method">
<code class="details" id="listAssignedTargetingOptions">listAssignedTargetingOptions(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists assigned targeting options of an advertiser across targeting types.
Args:
advertiserId: string, Required. The ID of the advertiser the line item belongs to. (required)
filter: string, Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=) operator`. Supported fields: * `targetingType` Examples: * targetingType with value TARGETING_TYPE_CHANNEL `targetingType="TARGETING_TYPE_CHANNEL"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
orderBy: string, Field by which to sort the list. Acceptable values are: * `targetingType` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`.
pageSize: integer, Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is '5000'. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
pageToken: string, A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListAdvertiserAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"assignedTargetingOptions": [ # The list of assigned targeting options. This list will be absent if empty.
{ # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
"ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`.
"ageRange": "A String", # Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
},
"appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
"displayName": "A String", # Output only. The display name of the app category.
"negative": True or False, # Indicates if this option is being negatively targeted.
"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
},
"appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`.
"appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
"appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
"displayName": "A String", # Output only. The display name of the app.
"negative": True or False, # Indicates if this option is being negatively targeted.
},
"assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
"assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`
"audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource.
"excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
"settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
{ # Details of Google audience targeting setting.
"googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
},
],
},
"includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only.
"settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
{ # Details of combined audience targeting setting.
"combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
},
],
},
"includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only.
"settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.
{ # Details of custom list targeting setting.
"customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.
},
],
},
"includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only.
"settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
{ # Details of Google audience targeting setting.
"googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
},
],
},
},
"audioContentTypeDetails": { # Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. # Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.
"audioContentType": "A String", # Required. The audio content type.
},
"authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
"authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.
"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
},
"browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`.
"displayName": "A String", # Output only. The display name of the browser.
"negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.
"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
},
"businessChainDetails": { # Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
"displayName": "A String", # Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
"proximityRadiusAmount": 3.14, # Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.
"proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.
},
"carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
"displayName": "A String", # Output only. The display name of the carrier or ISP.
"negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.
"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
},
"categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
"displayName": "A String", # Output only. The display name of the category.
"negative": True or False, # Indicates if this option is being negatively targeted.
"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
},
"channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`.
"channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
"negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
},
"contentDurationDetails": { # Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. # Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
"contentDuration": "A String", # Output only. The content duration.
"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
},
"contentGenreDetails": { # Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. # Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
"displayName": "A String", # Output only. The display name of the content genre.
"negative": True or False, # Indicates if this option is being negatively targeted.
"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
},
"contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
"adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
"contentInstreamPosition": "A String", # Required. The content instream position for video or audio ads.
},
"contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
"adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
"contentOutstreamPosition": "A String", # Required. The content outstream position.
},
"contentStreamTypeDetails": { # Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. # Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
"contentStreamType": "A String", # Output only. The content stream type.
"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
},
"dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`.
"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.
"endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
"startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
"timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting.
},
"deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
"displayName": "A String", # Output only. The display name of the device make and model.
"negative": True or False, # Indicates if this option is being negatively targeted.
"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
},
"deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
"deviceType": "A String", # Required. The display name of the device type.
"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.
},
"digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.
"excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED.
},
"environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
"environment": "A String", # Required. The serving environment.
},
"exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`.
"exchange": "A String", # Required. The enum value for the exchange.
},
"genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`.
"gender": "A String", # Required. The gender of the audience.
},
"geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`.
"displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
"geoRegionType": "A String", # Output only. The type of geographic region targeting.
"negative": True or False, # Indicates if this option is being negatively targeted.
"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
},
"householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
"householdIncome": "A String", # Required. The household income of the audience.
},
"inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.
"inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.
"inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
},
"inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
},
"keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned.
"keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
"negative": True or False, # Indicates if this option is being negatively targeted.
},
"languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`.
"displayName": "A String", # Output only. The display name of the language (e.g., "French").
"negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.
"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
},
"name": "A String", # Output only. The resource name for this assigned targeting option.
"nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
"contentPosition": "A String", # Required. The content position.
},
"negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource.
"negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
},
"omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`.
"omid": "A String", # Required. The type of Open Measurement enabled inventory.
},
"onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
"adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
"onScreenPosition": "A String", # Output only. The on screen position.
"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
},
"operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
"displayName": "A String", # Output only. The display name of the operating system.
"negative": True or False, # Indicates if this option is being negatively targeted.
"targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
},
"parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.
"parentalStatus": "A String", # Required. The parental status of the audience.
},
"poiDetails": { # Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. # POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`.
"displayName": "A String", # Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
"latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
"longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
"proximityRadiusAmount": 3.14, # Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.
"proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**
},
"proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
"proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
"proximityRadius": 3.14, # Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.
"proximityRadiusUnit": "A String", # Required. Radius distance units.
},
"regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
"negative": True or False, # Indicates if this option is being negatively targeted.
"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
},
"sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.
"excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
},
"sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
"sessionPosition": "A String", # The position where the ad will show in a session.
},
"subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
"targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
},
"targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.
"thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
"adloox": { # Details of Scope3 (previously known as Adloox) brand safety settings. # Third party brand verifier -- Scope3 (previously known as Adloox).
"excludedAdlooxCategories": [ # Scope3 categories to exclude.
"A String",
],
},
"doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
"appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
"avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.
"avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.
},
"avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.
"A String",
],
"brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.
"avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.
"avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.
"A String",
],
"avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.
"A String",
],
},
"customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic
"displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
"iab": "A String", # Target web and app inventory to maximize IAB viewable rate.
"viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.
},
"fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.
"avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.
"avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.
},
"videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
"playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.
"videoIab": "A String", # Target web inventory to maximize IAB viewable rate.
"videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.
},
},
"integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
"customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.
"A String",
],
"displayViewability": "A String", # Display Viewability section (applicable to display line items only).
"excludeUnrateable": True or False, # Brand Safety - **Unrateable**.
"excludedAdFraudRisk": "A String", # Ad Fraud settings.
"excludedAdultRisk": "A String", # Brand Safety - **Adult content**.
"excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.
"excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.
"excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.
"excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.
"excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.
"excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.
"excludedViolenceRisk": "A String", # Brand Safety - **Violence**.
"traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).
"videoViewability": "A String", # Video Viewability Section (applicable to video line items only).
},
},
"urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`.
"negative": True or False, # Indicates if this option is being negatively targeted.
"url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
},
"userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
"targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
"userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
},
"videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
"videoPlayerSize": "A String", # Required. The video player size.
},
"viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
"viewability": "A String", # Required. The predicted viewability percentage.
},
"youtubeChannelDetails": { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
"channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
"negative": True or False, # Indicates if this option is being negatively targeted.
},
"youtubeVideoDetails": { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
"negative": True or False, # Indicates if this option is being negatively targeted.
"videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
},
},
],
"nextPageToken": "A String", # A token identifying the next page of results. This value should be specified as the pageToken in a subsequent BulkListAdvertiserAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return.
}</pre>
</div>
<div class="method">
<code class="details" id="listAssignedTargetingOptions_next">listAssignedTargetingOptions_next()</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>
<div class="method">
<code class="details" id="list_next">list_next()</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>
<div class="method">
<code class="details" id="patch">patch(advertiserId, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates an existing advertiser. Returns the updated advertiser if successful.
Args:
advertiserId: string, Output only. The unique ID of the advertiser. Assigned by the system. (required)
body: object, The request body.
The object takes the form of:
{ # A single advertiser in Display & Video 360 (DV360).
"adServerConfig": { # Ad server related settings of an advertiser. # Required. Immutable. Ad server related settings of the advertiser.
"cmHybridConfig": { # Settings for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers. # The configuration for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers.
"cmAccountId": "A String", # Required. Immutable. Account ID of the CM360 Floodlight configuration linked with the DV360 advertiser.
"cmAdvertiserIds": [ # Output only. The set of CM360 Advertiser IDs sharing the CM360 Floodlight configuration.
"A String",
],
"cmFloodlightConfigId": "A String", # Required. Immutable. ID of the CM360 Floodlight configuration linked with the DV360 advertiser.
"cmFloodlightLinkingAuthorized": True or False, # Required. Immutable. By setting this field to `true`, you, on behalf of your company, authorize the sharing of information from the given Floodlight configuration to this Display & Video 360 advertiser.
"cmSyncableSiteIds": [ # A list of CM360 sites whose placements will be synced to DV360 as creatives. If absent or empty in CreateAdvertiser method, the system will automatically create a CM360 site. Removing sites from this list may cause DV360 creatives synced from CM360 to be deleted. At least one site must be specified.
"A String",
],
"dv360ToCmCostReportingEnabled": True or False, # Whether or not to report DV360 cost to CM360.
"dv360ToCmDataSharingEnabled": True or False, # Whether or not to include DV360 data in CM360 data transfer reports.
},
"thirdPartyOnlyConfig": { # Settings for advertisers that use third-party ad servers only. # The configuration for advertisers that use third-party ad servers only.
"pixelOrderIdReportingEnabled": True or False, # Whether or not order ID reporting for pixels is enabled. This value cannot be changed once set to `true`.
},
},
"advertiserId": "A String", # Output only. The unique ID of the advertiser. Assigned by the system.
"containsEuPoliticalAds": "A String", # Optional. Whether this advertiser contains line items that serve European Union political ads. If this field is set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING`, then the following will happen: * Any new line items created under this advertiser will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. * Any existing line items under this advertiser that do not have a set value be updated to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` within a day.
"creativeConfig": { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser.
"dynamicCreativeEnabled": True or False, # Whether or not the advertiser is enabled for dynamic creatives.
"iasClientId": "A String", # An ID for configuring campaign monitoring provided by Integral Ad Service (IAS). The DV360 system will append an IAS "Campaign Monitor" tag containing this ID to the creative tag.
"obaComplianceDisabled": True or False, # Whether or not to disable Google's About this Ad feature that adds badging (to identify the content as an ad) and transparency information (on interaction with About this Ad) to your ads for Online Behavioral Advertising (OBA) and regulatory requirements. About this Ad gives users greater control over the ads they see and helps you explain why they're seeing your ad. [Learn more](//support.google.com/displayvideo/answer/14315795). If you choose to set this field to `true`, note that ads served through Display & Video 360 must comply to the following: * Be Online Behavioral Advertising (OBA) compliant, as per your contract with Google Marketing Platform. * In the European Economic Area (EEA), include transparency information and a mechanism for users to report illegal content in ads. If using an alternative ad badging, transparency, and reporting solution, you must ensure it includes the required transparency information and illegal content flagging mechanism and that you notify Google of any illegal content reports using the appropriate [form](//support.google.com/legal/troubleshooter/1114905?sjid=6787484030557261960-EU#ts=2981967%2C2982031%2C12980091).
"videoCreativeDataSharingAuthorized": True or False, # By setting this field to `true`, you, on behalf of your company, authorize Google to use video creatives associated with this Display & Video 360 advertiser to provide reporting and features related to the advertiser's television campaigns. Applicable only when the advertiser has a CM360 hybrid ad server configuration.
},
"dataAccessConfig": { # Settings that control how advertiser related data may be accessed. # Settings that control how advertiser data may be accessed.
"sdfConfig": { # Structured Data Files (SDF) settings of an advertiser. # Structured Data Files (SDF) settings for the advertiser. If not specified, the SDF settings of the parent partner are used.
"overridePartnerSdfConfig": True or False, # Whether or not this advertiser overrides the SDF configuration of its parent partner. By default, an advertiser inherits the SDF configuration from the parent partner. To override the partner configuration, set this field to `true` and provide the new configuration in sdfConfig.
"sdfConfig": { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser. * Required when overridePartnerSdfConfig is `true`. * Output only when overridePartnerSdfConfig is `false`.
"adminEmail": "A String", # An administrator email address to which the SDF processing status reports will be sent.
"version": "A String", # Required. The version of SDF being used.
},
},
},
"displayName": "A String", # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes.
"entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion.
"generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser.
"currencyCode": "A String", # Required. Immutable. Advertiser's currency in ISO 4217 format. Accepted codes and the currencies they represent are: Currency Code : Currency Name * `ARS` : Argentine Peso * `AUD` : Australian Dollar * `BRL` : Brazilian Real * `CAD` : Canadian Dollar * `CHF` : Swiss Franc * `CLP` : Chilean Peso * `CNY` : Chinese Yuan * `COP` : Colombian Peso * `CZK` : Czech Koruna * `DKK` : Danish Krone * `EGP` : Egyption Pound * `EUR` : Euro * `GBP` : British Pound * `HKD` : Hong Kong Dollar * `HUF` : Hungarian Forint * `IDR` : Indonesian Rupiah * `ILS` : Israeli Shekel * `INR` : Indian Rupee * `JPY` : Japanese Yen * `KRW` : South Korean Won * `MXN` : Mexican Pesos * `MYR` : Malaysian Ringgit * `NGN` : Nigerian Naira * `NOK` : Norwegian Krone * `NZD` : New Zealand Dollar * `PEN` : Peruvian Nuevo Sol * `PLN` : Polish Zloty * `RON` : New Romanian Leu * `RUB` : Russian Ruble * `SEK` : Swedish Krona * `TRY` : Turkish Lira * `TWD` : New Taiwan Dollar * `USD` : US Dollar * `ZAR` : South African Rand
"domainUrl": "A String", # Required. The domain URL of the advertiser's primary website. The system will send this information to publishers that require website URL to associate a campaign with an advertiser. Provide a URL with no path or query string, beginning with `http:` or `https:`. For example, http://www.example.com
"timeZone": "A String", # Output only. The standard TZ database name of the advertiser's time zone. For example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones For CM360 hybrid advertisers, the time zone is the same as that of the associated CM360 account; for third-party only advertisers, the time zone is the same as that of the parent partner.
},
"integrationDetails": { # Integration details of an entry. # Integration details of the advertiser. Only integrationCode is currently applicable to advertiser. Other fields of IntegrationDetails are not supported and will be ignored if provided.
"details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
"integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
},
"name": "A String", # Output only. The resource name of the advertiser.
"partnerId": "A String", # Required. Immutable. The unique ID of the partner that the advertiser belongs to.
"prismaEnabled": True or False, # Whether integration with Mediaocean (Prisma) is enabled. By enabling this, you agree to the following: On behalf of my company, I authorize Mediaocean (Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser.
"servingConfig": { # Targeting settings related to ad serving of an advertiser. # Targeting settings related to ad serving of the advertiser.
"exemptTvFromViewabilityTargeting": True or False, # Whether or not connected TV devices are exempt from viewability targeting for all video line items under the advertiser.
},
"updateTime": "A String", # Output only. The timestamp when the advertiser was last updated. Assigned by the system.
}
updateMask: string, Required. The mask to control which fields to update.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A single advertiser in Display & Video 360 (DV360).
"adServerConfig": { # Ad server related settings of an advertiser. # Required. Immutable. Ad server related settings of the advertiser.
"cmHybridConfig": { # Settings for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers. # The configuration for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers.
"cmAccountId": "A String", # Required. Immutable. Account ID of the CM360 Floodlight configuration linked with the DV360 advertiser.
"cmAdvertiserIds": [ # Output only. The set of CM360 Advertiser IDs sharing the CM360 Floodlight configuration.
"A String",
],
"cmFloodlightConfigId": "A String", # Required. Immutable. ID of the CM360 Floodlight configuration linked with the DV360 advertiser.
"cmFloodlightLinkingAuthorized": True or False, # Required. Immutable. By setting this field to `true`, you, on behalf of your company, authorize the sharing of information from the given Floodlight configuration to this Display & Video 360 advertiser.
"cmSyncableSiteIds": [ # A list of CM360 sites whose placements will be synced to DV360 as creatives. If absent or empty in CreateAdvertiser method, the system will automatically create a CM360 site. Removing sites from this list may cause DV360 creatives synced from CM360 to be deleted. At least one site must be specified.
"A String",
],
"dv360ToCmCostReportingEnabled": True or False, # Whether or not to report DV360 cost to CM360.
"dv360ToCmDataSharingEnabled": True or False, # Whether or not to include DV360 data in CM360 data transfer reports.
},
"thirdPartyOnlyConfig": { # Settings for advertisers that use third-party ad servers only. # The configuration for advertisers that use third-party ad servers only.
"pixelOrderIdReportingEnabled": True or False, # Whether or not order ID reporting for pixels is enabled. This value cannot be changed once set to `true`.
},
},
"advertiserId": "A String", # Output only. The unique ID of the advertiser. Assigned by the system.
"containsEuPoliticalAds": "A String", # Optional. Whether this advertiser contains line items that serve European Union political ads. If this field is set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING`, then the following will happen: * Any new line items created under this advertiser will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. * Any existing line items under this advertiser that do not have a set value be updated to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` within a day.
"creativeConfig": { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser.
"dynamicCreativeEnabled": True or False, # Whether or not the advertiser is enabled for dynamic creatives.
"iasClientId": "A String", # An ID for configuring campaign monitoring provided by Integral Ad Service (IAS). The DV360 system will append an IAS "Campaign Monitor" tag containing this ID to the creative tag.
"obaComplianceDisabled": True or False, # Whether or not to disable Google's About this Ad feature that adds badging (to identify the content as an ad) and transparency information (on interaction with About this Ad) to your ads for Online Behavioral Advertising (OBA) and regulatory requirements. About this Ad gives users greater control over the ads they see and helps you explain why they're seeing your ad. [Learn more](//support.google.com/displayvideo/answer/14315795). If you choose to set this field to `true`, note that ads served through Display & Video 360 must comply to the following: * Be Online Behavioral Advertising (OBA) compliant, as per your contract with Google Marketing Platform. * In the European Economic Area (EEA), include transparency information and a mechanism for users to report illegal content in ads. If using an alternative ad badging, transparency, and reporting solution, you must ensure it includes the required transparency information and illegal content flagging mechanism and that you notify Google of any illegal content reports using the appropriate [form](//support.google.com/legal/troubleshooter/1114905?sjid=6787484030557261960-EU#ts=2981967%2C2982031%2C12980091).
"videoCreativeDataSharingAuthorized": True or False, # By setting this field to `true`, you, on behalf of your company, authorize Google to use video creatives associated with this Display & Video 360 advertiser to provide reporting and features related to the advertiser's television campaigns. Applicable only when the advertiser has a CM360 hybrid ad server configuration.
},
"dataAccessConfig": { # Settings that control how advertiser related data may be accessed. # Settings that control how advertiser data may be accessed.
"sdfConfig": { # Structured Data Files (SDF) settings of an advertiser. # Structured Data Files (SDF) settings for the advertiser. If not specified, the SDF settings of the parent partner are used.
"overridePartnerSdfConfig": True or False, # Whether or not this advertiser overrides the SDF configuration of its parent partner. By default, an advertiser inherits the SDF configuration from the parent partner. To override the partner configuration, set this field to `true` and provide the new configuration in sdfConfig.
"sdfConfig": { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser. * Required when overridePartnerSdfConfig is `true`. * Output only when overridePartnerSdfConfig is `false`.
"adminEmail": "A String", # An administrator email address to which the SDF processing status reports will be sent.
"version": "A String", # Required. The version of SDF being used.
},
},
},
"displayName": "A String", # Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes.
"entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion.
"generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser.
"currencyCode": "A String", # Required. Immutable. Advertiser's currency in ISO 4217 format. Accepted codes and the currencies they represent are: Currency Code : Currency Name * `ARS` : Argentine Peso * `AUD` : Australian Dollar * `BRL` : Brazilian Real * `CAD` : Canadian Dollar * `CHF` : Swiss Franc * `CLP` : Chilean Peso * `CNY` : Chinese Yuan * `COP` : Colombian Peso * `CZK` : Czech Koruna * `DKK` : Danish Krone * `EGP` : Egyption Pound * `EUR` : Euro * `GBP` : British Pound * `HKD` : Hong Kong Dollar * `HUF` : Hungarian Forint * `IDR` : Indonesian Rupiah * `ILS` : Israeli Shekel * `INR` : Indian Rupee * `JPY` : Japanese Yen * `KRW` : South Korean Won * `MXN` : Mexican Pesos * `MYR` : Malaysian Ringgit * `NGN` : Nigerian Naira * `NOK` : Norwegian Krone * `NZD` : New Zealand Dollar * `PEN` : Peruvian Nuevo Sol * `PLN` : Polish Zloty * `RON` : New Romanian Leu * `RUB` : Russian Ruble * `SEK` : Swedish Krona * `TRY` : Turkish Lira * `TWD` : New Taiwan Dollar * `USD` : US Dollar * `ZAR` : South African Rand
"domainUrl": "A String", # Required. The domain URL of the advertiser's primary website. The system will send this information to publishers that require website URL to associate a campaign with an advertiser. Provide a URL with no path or query string, beginning with `http:` or `https:`. For example, http://www.example.com
"timeZone": "A String", # Output only. The standard TZ database name of the advertiser's time zone. For example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones For CM360 hybrid advertisers, the time zone is the same as that of the associated CM360 account; for third-party only advertisers, the time zone is the same as that of the parent partner.
},
"integrationDetails": { # Integration details of an entry. # Integration details of the advertiser. Only integrationCode is currently applicable to advertiser. Other fields of IntegrationDetails are not supported and will be ignored if provided.
"details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
"integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
},
"name": "A String", # Output only. The resource name of the advertiser.
"partnerId": "A String", # Required. Immutable. The unique ID of the partner that the advertiser belongs to.
"prismaEnabled": True or False, # Whether integration with Mediaocean (Prisma) is enabled. By enabling this, you agree to the following: On behalf of my company, I authorize Mediaocean (Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser.
"servingConfig": { # Targeting settings related to ad serving of an advertiser. # Targeting settings related to ad serving of the advertiser.
"exemptTvFromViewabilityTargeting": True or False, # Whether or not connected TV devices are exempt from viewability targeting for all video line items under the advertiser.
},
"updateTime": "A String", # Output only. The timestamp when the advertiser was last updated. Assigned by the system.
}</pre>
</div>
</body></html>
|