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
|
<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="content_v2_1.html">Content API for Shopping</a> . <a href="content_v2_1.accounts.html">accounts</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="content_v2_1.accounts.credentials.html">credentials()</a></code>
</p>
<p class="firstline">Returns the credentials Resource.</p>
<p class="toc_element">
<code><a href="content_v2_1.accounts.labels.html">labels()</a></code>
</p>
<p class="firstline">Returns the labels Resource.</p>
<p class="toc_element">
<code><a href="content_v2_1.accounts.returncarrier.html">returncarrier()</a></code>
</p>
<p class="firstline">Returns the returncarrier Resource.</p>
<p class="toc_element">
<code><a href="#authinfo">authinfo(x__xgafv=None)</a></code></p>
<p class="firstline">Returns information about the authenticated user.</p>
<p class="toc_element">
<code><a href="#claimwebsite">claimwebsite(merchantId, accountId, overwrite=None, x__xgafv=None)</a></code></p>
<p class="firstline">Claims the website of a Merchant Center sub-account. Merchant accounts with approved third-party CSSs aren't required to claim a website.</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="#custombatch">custombatch(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.</p>
<p class="toc_element">
<code><a href="#delete">delete(merchantId, accountId, force=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a Merchant Center sub-account.</p>
<p class="toc_element">
<code><a href="#get">get(merchantId, accountId, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a Merchant Center account.</p>
<p class="toc_element">
<code><a href="#insert">insert(merchantId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a Merchant Center sub-account.</p>
<p class="toc_element">
<code><a href="#link">link(merchantId, accountId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId.</p>
<p class="toc_element">
<code><a href="#list">list(merchantId, label=None, maxResults=None, name=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the sub-accounts in your Merchant Center account.</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="#listlinks">listlinks(merchantId, accountId, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the list of accounts linked to your Merchant Center account.</p>
<p class="toc_element">
<code><a href="#listlinks_next">listlinks_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#requestphoneverification">requestphoneverification(merchantId, accountId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Request verification code to start phone verification.</p>
<p class="toc_element">
<code><a href="#update">update(merchantId, accountId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a Merchant Center account. Any fields that are not provided are deleted from the resource.</p>
<p class="toc_element">
<code><a href="#updatelabels">updatelabels(merchantId, accountId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates labels that are assigned to the Merchant Center account by CSS user.</p>
<p class="toc_element">
<code><a href="#verifyphonenumber">verifyphonenumber(merchantId, accountId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Validates verification code to verify phone number for the account. If successful this will overwrite the value of `accounts.businessinformation.phoneNumber`. Only verified phone number will replace an existing verified phone number.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="authinfo">authinfo(x__xgafv=None)</code>
<pre>Returns information about the authenticated user.
Args:
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"accountIdentifiers": [ # The account identifiers corresponding to the authenticated user. - For an individual account: only the merchant ID is defined - For an aggregator: only the aggregator ID is defined - For a subaccount of an MCA: both the merchant ID and the aggregator ID are defined.
{
"aggregatorId": "A String", # The aggregator ID, set for aggregators and subaccounts (in that case, it represents the aggregator of the subaccount).
"merchantId": "A String", # The merchant account ID, set for individual accounts and subaccounts.
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#accountsAuthInfoResponse`".
}</pre>
</div>
<div class="method">
<code class="details" id="claimwebsite">claimwebsite(merchantId, accountId, overwrite=None, x__xgafv=None)</code>
<pre>Claims the website of a Merchant Center sub-account. Merchant accounts with approved third-party CSSs aren't required to claim a website.
Args:
merchantId: string, The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account. (required)
accountId: string, The ID of the account whose website is claimed. (required)
overwrite: boolean, Only available to selected merchants, for example multi-client accounts (MCAs) and their sub-accounts. When set to `True`, this option removes any existing claim on the requested website and replaces it with a claim from the account that makes the request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#accountsClaimWebsiteResponse`".
}</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="custombatch">custombatch(body=None, x__xgafv=None)</code>
<pre>Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.
Args:
body: object, The request body.
The object takes the form of:
{
"entries": [ # The request entries to be processed in the batch.
{ # A batch entry encoding a single non-batch accounts request.
"account": { # Account data. After the creation of a new account it may take a few minutes before it's fully operational. The methods delete, insert, and update require the admin role. # The account to create or update. Only defined if the method is `insert` or `update`.
"accountManagement": "A String", # Output only. How the account is managed. Acceptable values are: - "`manual`" - "`automatic`"
"adsLinks": [ # Linked Ads accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the Ads interface or through the Google Ads API. To delete an active link, or to cancel a link request, remove it from the list.
{
"adsId": "A String", # Customer ID of the Ads account.
"status": "A String", # Status of the link between this Merchant Center account and the Ads account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google Ads or `pending` if it's pending approval. Upon insertion, it represents the *intended* status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending. Acceptable values are: - "`active`" - "`pending`"
},
],
"adultContent": True or False, # Indicates whether the merchant sells adult content.
"automaticImprovements": { # The automatic improvements of the account can be used to automatically update items, improve images and shipping. # The automatic improvements of the account can be used to automatically update items, improve images and shipping. Each section inside AutomaticImprovements is updated separately.
"imageImprovements": { # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) This field is only updated (cleared) if provided.
"accountImageImprovementsSettings": { # Settings for the Automatic Image Improvements. # Determines how the images should be automatically updated. If this field is not present, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
"allowAutomaticImageImprovements": True or False, # Enables automatic image improvements.
},
"effectiveAllowAutomaticImageImprovements": True or False, # Output only. The effective value of allow_automatic_image_improvements. If account_image_improvements_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
},
"itemUpdates": { # Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. # Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. This field is only updated (cleared) if provided.
"accountItemUpdatesSettings": { # Settings for the Automatic Item Updates. # Determines which attributes of the items should be automatically updated. If this field is not present, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
"allowAvailabilityUpdates": True or False, # If availability updates are enabled, any previous availability values get overwritten if Google finds an out-of-stock annotation on the offer's page. If additionally `allow_availability_updates` field is set to true, values get overwritten if Google finds an in-stock annotation on the offer’s page.
"allowConditionUpdates": True or False, # If condition updates are enabled, Google always updates item condition with the condition detected from the details of your product.
"allowPriceUpdates": True or False, # If price updates are enabled, Google always updates the active price with the crawled information.
"allowStrictAvailabilityUpdates": True or False, # If allow_availability_updates is enabled, items are automatically updated in all your Shopping target countries. By default, availability updates will only be applied to items that are 'out of stock' on your website but 'in stock' on Shopping. Set this to true to also update items that are 'in stock' on your website, but 'out of stock' on Google Shopping. In order for this field to have an effect, you must also allow availability updates.
},
"effectiveAllowAvailabilityUpdates": True or False, # Output only. The effective value of allow_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowConditionUpdates": True or False, # Output only. The effective value of allow_condition_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowPriceUpdates": True or False, # Output only. The effective value of allow_price_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowStrictAvailabilityUpdates": True or False, # Output only. The effective value of allow_strict_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
},
"shippingImprovements": { # Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: * Delivery address of an order * Current handling time and shipping time settings * Estimated weekdays or business days * Parcel tracking data # Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: - Delivery address of an order - Current handling time and shipping time settings - Estimated weekdays or business days - Parcel tracking data This field is only updated (cleared) if provided.
"allowShippingImprovements": True or False, # Enables automatic shipping improvements.
},
},
"automaticLabelIds": [ # Automatically created label IDs that are assigned to the account by CSS Center.
"A String",
],
"businessIdentity": { # The [business identity attributes](https://support.google.com/merchants/answer/10342414) can be used to self-declare attributes that let customers know more about your business. # The business identity attributes can be used to self-declare attributes that let customers know more about your business.
"blackOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being black-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"includeForPromotions": True or False, # Required. By setting this field, your business may be included in promotions for all the selected attributes. If you clear this option, it won't affect your identification with any of the attributes. For this field to be set, the merchant must self identify with at least one of the `AccountIdentityType`. If none are included, the request will be considered invalid.
"latinoOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being latino-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"smallBusiness": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as a small business. This optional field is only available for merchants with a business country set to "US". It is also not allowed for marketplaces, but it is allowed to marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"veteranOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being veteran-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"womenOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being women-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
},
"businessInformation": { # The business information of the account.
"address": { # The address of the business. Use `\n` to add a second address line.
"country": "A String", # CLDR country code (for example, "US"). All MCA sub-accounts inherit the country of their parent MCA by default, however the country can be updated for individual sub-accounts.
"locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (for example, neighborhoods or suburbs).
"postalCode": "A String", # Postal code or ZIP (for example, "94043").
"region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
"streetAddress": "A String", # Street-level part of the address. Use `\n` to add a second line.
},
"customerService": { # The customer service information of the business.
"email": "A String", # Customer service email.
"phoneNumber": "A String", # Customer service phone number.
"url": "A String", # Customer service URL.
},
"koreanBusinessRegistrationNumber": "A String", # The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. This field will only be updated if explicitly set.
"phoneNumber": "A String", # The phone number of the business in [E.164](https://en.wikipedia.org/wiki/E.164) format. This can only be updated if a verified phone number is not already set. To replace a verified phone number use the `Accounts.requestphoneverification` and `Accounts.verifyphonenumber`.
"phoneVerificationStatus": "A String", # Verification status of the phone number of the business. This status is read only and can be updated only by successful phone verification. Acceptable values are: - "`verified`" - "`unverified`"
},
"conversionSettings": { # Settings for conversion tracking. # Settings for conversion tracking.
"freeListingsAutoTaggingEnabled": True or False, # When enabled, free listing URLs have a parameter to enable conversion tracking for products owned by the current merchant account. See [auto-tagging](https://support.google.com/merchants/answer/11127659).
},
"cssId": "A String", # ID of CSS the account belongs to.
"googleMyBusinessLink": { # The Business Profile which is linked or in the process of being linked with the Merchant Center account.
"gmbAccountId": "A String", # The ID of the Business Profile. If this is provided, then `gmbEmail` is ignored. The value of this field should match the `accountId` used by the Business Profile API.
"gmbEmail": "A String", # The Business Profile email address of a specific account within a Business Profile. A sample account within a Business Profile could be a business account with set of locations, managed under the Business Profile.
"status": "A String", # Status of the link between this Merchant Center account and the Business Profile. Acceptable values are: - "`active`" - "`pending`"
},
"id": "A String", # Required. 64-bit Merchant Center account ID.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`".
"labelIds": [ # Manually created label IDs that are assigned to the account by CSS.
"A String",
],
"name": "A String", # Required. Display name for the account.
"sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
"users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
{
"admin": True or False, # Whether user is an admin.
"emailAddress": "A String", # User's email address.
"orderManager": True or False, # Whether user is an order manager.
"paymentsAnalyst": True or False, # Whether user can access payment statements.
"paymentsManager": True or False, # Whether user can manage payment settings.
"readOnly": True or False, # Optional. Whether user has standard read-only access.
"reportingManager": True or False, # Whether user is a reporting manager. This role is equivalent to the Performance and insights role in Merchant Center.
},
],
"websiteUrl": "A String", # The merchant's website.
"youtubeChannelLinks": [ # Linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list.
{
"channelId": "A String", # Channel ID.
"status": "A String", # Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it's pending approval. Upon insertion, it represents the *intended* status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
},
],
},
"accountId": "A String", # The ID of the targeted account. Only defined if the method is not `insert`.
"batchId": 42, # An entry ID, unique within the batch request.
"force": True or False, # Whether the account should be deleted if the account has offers. Only applicable if the method is `delete`.
"labelIds": [ # Label IDs for the 'updatelabels' request.
"A String",
],
"linkRequest": { # Details about the `link` request.
"action": "A String", # Action to perform for this link. The `"request"` action is only available to select merchants. Acceptable values are: - "`approve`" - "`remove`" - "`request`"
"linkType": "A String", # Type of the link between the two accounts. Acceptable values are: - "`channelPartner`" - "`eCommercePlatform`" - "`paymentServiceProvider`" - "`localProductManager`"
"linkedAccountId": "A String", # The ID of the linked account.
"services": [ # Provided services. Acceptable values are: - "`shoppingAdsProductManagement`" - "`shoppingActionsProductManagement`" - "`shoppingActionsOrderManagement`" - "`paymentProcessing`" - "`localProductManagement`"
"A String",
],
},
"merchantId": "A String", # The ID of the managing account.
"method": "A String", # The method of the batch entry. Acceptable values are: - "`claimWebsite`" - "`delete`" - "`get`" - "`insert`" - "`link`" - "`update`"
"overwrite": True or False, # Only applicable if the method is `claimwebsite`. Indicates whether or not to take the claim from another account in case there is a conflict.
"view": "A String", # Controls which fields are visible. Only applicable if the method is 'get'.
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"entries": [ # The result of the execution of the batch requests.
{ # A batch entry encoding a single non-batch accounts response.
"account": { # Account data. After the creation of a new account it may take a few minutes before it's fully operational. The methods delete, insert, and update require the admin role. # The retrieved, created, or updated account. Not defined if the method was `delete`, `claimwebsite` or `link`.
"accountManagement": "A String", # Output only. How the account is managed. Acceptable values are: - "`manual`" - "`automatic`"
"adsLinks": [ # Linked Ads accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the Ads interface or through the Google Ads API. To delete an active link, or to cancel a link request, remove it from the list.
{
"adsId": "A String", # Customer ID of the Ads account.
"status": "A String", # Status of the link between this Merchant Center account and the Ads account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google Ads or `pending` if it's pending approval. Upon insertion, it represents the *intended* status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending. Acceptable values are: - "`active`" - "`pending`"
},
],
"adultContent": True or False, # Indicates whether the merchant sells adult content.
"automaticImprovements": { # The automatic improvements of the account can be used to automatically update items, improve images and shipping. # The automatic improvements of the account can be used to automatically update items, improve images and shipping. Each section inside AutomaticImprovements is updated separately.
"imageImprovements": { # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) This field is only updated (cleared) if provided.
"accountImageImprovementsSettings": { # Settings for the Automatic Image Improvements. # Determines how the images should be automatically updated. If this field is not present, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
"allowAutomaticImageImprovements": True or False, # Enables automatic image improvements.
},
"effectiveAllowAutomaticImageImprovements": True or False, # Output only. The effective value of allow_automatic_image_improvements. If account_image_improvements_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
},
"itemUpdates": { # Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. # Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. This field is only updated (cleared) if provided.
"accountItemUpdatesSettings": { # Settings for the Automatic Item Updates. # Determines which attributes of the items should be automatically updated. If this field is not present, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
"allowAvailabilityUpdates": True or False, # If availability updates are enabled, any previous availability values get overwritten if Google finds an out-of-stock annotation on the offer's page. If additionally `allow_availability_updates` field is set to true, values get overwritten if Google finds an in-stock annotation on the offer’s page.
"allowConditionUpdates": True or False, # If condition updates are enabled, Google always updates item condition with the condition detected from the details of your product.
"allowPriceUpdates": True or False, # If price updates are enabled, Google always updates the active price with the crawled information.
"allowStrictAvailabilityUpdates": True or False, # If allow_availability_updates is enabled, items are automatically updated in all your Shopping target countries. By default, availability updates will only be applied to items that are 'out of stock' on your website but 'in stock' on Shopping. Set this to true to also update items that are 'in stock' on your website, but 'out of stock' on Google Shopping. In order for this field to have an effect, you must also allow availability updates.
},
"effectiveAllowAvailabilityUpdates": True or False, # Output only. The effective value of allow_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowConditionUpdates": True or False, # Output only. The effective value of allow_condition_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowPriceUpdates": True or False, # Output only. The effective value of allow_price_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowStrictAvailabilityUpdates": True or False, # Output only. The effective value of allow_strict_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
},
"shippingImprovements": { # Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: * Delivery address of an order * Current handling time and shipping time settings * Estimated weekdays or business days * Parcel tracking data # Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: - Delivery address of an order - Current handling time and shipping time settings - Estimated weekdays or business days - Parcel tracking data This field is only updated (cleared) if provided.
"allowShippingImprovements": True or False, # Enables automatic shipping improvements.
},
},
"automaticLabelIds": [ # Automatically created label IDs that are assigned to the account by CSS Center.
"A String",
],
"businessIdentity": { # The [business identity attributes](https://support.google.com/merchants/answer/10342414) can be used to self-declare attributes that let customers know more about your business. # The business identity attributes can be used to self-declare attributes that let customers know more about your business.
"blackOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being black-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"includeForPromotions": True or False, # Required. By setting this field, your business may be included in promotions for all the selected attributes. If you clear this option, it won't affect your identification with any of the attributes. For this field to be set, the merchant must self identify with at least one of the `AccountIdentityType`. If none are included, the request will be considered invalid.
"latinoOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being latino-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"smallBusiness": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as a small business. This optional field is only available for merchants with a business country set to "US". It is also not allowed for marketplaces, but it is allowed to marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"veteranOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being veteran-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"womenOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being women-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
},
"businessInformation": { # The business information of the account.
"address": { # The address of the business. Use `\n` to add a second address line.
"country": "A String", # CLDR country code (for example, "US"). All MCA sub-accounts inherit the country of their parent MCA by default, however the country can be updated for individual sub-accounts.
"locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (for example, neighborhoods or suburbs).
"postalCode": "A String", # Postal code or ZIP (for example, "94043").
"region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
"streetAddress": "A String", # Street-level part of the address. Use `\n` to add a second line.
},
"customerService": { # The customer service information of the business.
"email": "A String", # Customer service email.
"phoneNumber": "A String", # Customer service phone number.
"url": "A String", # Customer service URL.
},
"koreanBusinessRegistrationNumber": "A String", # The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. This field will only be updated if explicitly set.
"phoneNumber": "A String", # The phone number of the business in [E.164](https://en.wikipedia.org/wiki/E.164) format. This can only be updated if a verified phone number is not already set. To replace a verified phone number use the `Accounts.requestphoneverification` and `Accounts.verifyphonenumber`.
"phoneVerificationStatus": "A String", # Verification status of the phone number of the business. This status is read only and can be updated only by successful phone verification. Acceptable values are: - "`verified`" - "`unverified`"
},
"conversionSettings": { # Settings for conversion tracking. # Settings for conversion tracking.
"freeListingsAutoTaggingEnabled": True or False, # When enabled, free listing URLs have a parameter to enable conversion tracking for products owned by the current merchant account. See [auto-tagging](https://support.google.com/merchants/answer/11127659).
},
"cssId": "A String", # ID of CSS the account belongs to.
"googleMyBusinessLink": { # The Business Profile which is linked or in the process of being linked with the Merchant Center account.
"gmbAccountId": "A String", # The ID of the Business Profile. If this is provided, then `gmbEmail` is ignored. The value of this field should match the `accountId` used by the Business Profile API.
"gmbEmail": "A String", # The Business Profile email address of a specific account within a Business Profile. A sample account within a Business Profile could be a business account with set of locations, managed under the Business Profile.
"status": "A String", # Status of the link between this Merchant Center account and the Business Profile. Acceptable values are: - "`active`" - "`pending`"
},
"id": "A String", # Required. 64-bit Merchant Center account ID.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`".
"labelIds": [ # Manually created label IDs that are assigned to the account by CSS.
"A String",
],
"name": "A String", # Required. Display name for the account.
"sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
"users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
{
"admin": True or False, # Whether user is an admin.
"emailAddress": "A String", # User's email address.
"orderManager": True or False, # Whether user is an order manager.
"paymentsAnalyst": True or False, # Whether user can access payment statements.
"paymentsManager": True or False, # Whether user can manage payment settings.
"readOnly": True or False, # Optional. Whether user has standard read-only access.
"reportingManager": True or False, # Whether user is a reporting manager. This role is equivalent to the Performance and insights role in Merchant Center.
},
],
"websiteUrl": "A String", # The merchant's website.
"youtubeChannelLinks": [ # Linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list.
{
"channelId": "A String", # Channel ID.
"status": "A String", # Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it's pending approval. Upon insertion, it represents the *intended* status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
},
],
},
"batchId": 42, # The ID of the request entry this entry responds to.
"errors": { # A list of errors returned by a failed batch entry. # A list of errors for failed custombatch entries. *Note:* Schema errors fail the whole request.
"code": 42, # The HTTP status of the first error in `errors`.
"errors": [ # A list of errors.
{ # An error returned by the API.
"domain": "A String", # The domain of the error.
"message": "A String", # A description of the error.
"reason": "A String", # The error code.
},
],
"message": "A String", # The message of the first error in `errors`.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#accountsCustomBatchResponseEntry`"
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#accountsCustomBatchResponse`".
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(merchantId, accountId, force=None, x__xgafv=None)</code>
<pre>Deletes a Merchant Center sub-account.
Args:
merchantId: string, The ID of the managing account. This must be a multi-client account, and accountId must be the ID of a sub-account of this account. (required)
accountId: string, The ID of the account. (required)
force: boolean, Option to delete sub-accounts with products. The default value is false.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="get">get(merchantId, accountId, view=None, x__xgafv=None)</code>
<pre>Retrieves a Merchant Center account.
Args:
merchantId: string, The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account. (required)
accountId: string, The ID of the account. (required)
view: string, Controls which fields will be populated. Acceptable values are: "merchant" and "css". The default value is "merchant".
Allowed values
MERCHANT - Default. View is populated with Merchant Center fields.
CSS - View is populated with Comparison Shopping Services fields.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Account data. After the creation of a new account it may take a few minutes before it's fully operational. The methods delete, insert, and update require the admin role.
"accountManagement": "A String", # Output only. How the account is managed. Acceptable values are: - "`manual`" - "`automatic`"
"adsLinks": [ # Linked Ads accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the Ads interface or through the Google Ads API. To delete an active link, or to cancel a link request, remove it from the list.
{
"adsId": "A String", # Customer ID of the Ads account.
"status": "A String", # Status of the link between this Merchant Center account and the Ads account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google Ads or `pending` if it's pending approval. Upon insertion, it represents the *intended* status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending. Acceptable values are: - "`active`" - "`pending`"
},
],
"adultContent": True or False, # Indicates whether the merchant sells adult content.
"automaticImprovements": { # The automatic improvements of the account can be used to automatically update items, improve images and shipping. # The automatic improvements of the account can be used to automatically update items, improve images and shipping. Each section inside AutomaticImprovements is updated separately.
"imageImprovements": { # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) This field is only updated (cleared) if provided.
"accountImageImprovementsSettings": { # Settings for the Automatic Image Improvements. # Determines how the images should be automatically updated. If this field is not present, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
"allowAutomaticImageImprovements": True or False, # Enables automatic image improvements.
},
"effectiveAllowAutomaticImageImprovements": True or False, # Output only. The effective value of allow_automatic_image_improvements. If account_image_improvements_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
},
"itemUpdates": { # Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. # Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. This field is only updated (cleared) if provided.
"accountItemUpdatesSettings": { # Settings for the Automatic Item Updates. # Determines which attributes of the items should be automatically updated. If this field is not present, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
"allowAvailabilityUpdates": True or False, # If availability updates are enabled, any previous availability values get overwritten if Google finds an out-of-stock annotation on the offer's page. If additionally `allow_availability_updates` field is set to true, values get overwritten if Google finds an in-stock annotation on the offer’s page.
"allowConditionUpdates": True or False, # If condition updates are enabled, Google always updates item condition with the condition detected from the details of your product.
"allowPriceUpdates": True or False, # If price updates are enabled, Google always updates the active price with the crawled information.
"allowStrictAvailabilityUpdates": True or False, # If allow_availability_updates is enabled, items are automatically updated in all your Shopping target countries. By default, availability updates will only be applied to items that are 'out of stock' on your website but 'in stock' on Shopping. Set this to true to also update items that are 'in stock' on your website, but 'out of stock' on Google Shopping. In order for this field to have an effect, you must also allow availability updates.
},
"effectiveAllowAvailabilityUpdates": True or False, # Output only. The effective value of allow_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowConditionUpdates": True or False, # Output only. The effective value of allow_condition_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowPriceUpdates": True or False, # Output only. The effective value of allow_price_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowStrictAvailabilityUpdates": True or False, # Output only. The effective value of allow_strict_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
},
"shippingImprovements": { # Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: * Delivery address of an order * Current handling time and shipping time settings * Estimated weekdays or business days * Parcel tracking data # Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: - Delivery address of an order - Current handling time and shipping time settings - Estimated weekdays or business days - Parcel tracking data This field is only updated (cleared) if provided.
"allowShippingImprovements": True or False, # Enables automatic shipping improvements.
},
},
"automaticLabelIds": [ # Automatically created label IDs that are assigned to the account by CSS Center.
"A String",
],
"businessIdentity": { # The [business identity attributes](https://support.google.com/merchants/answer/10342414) can be used to self-declare attributes that let customers know more about your business. # The business identity attributes can be used to self-declare attributes that let customers know more about your business.
"blackOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being black-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"includeForPromotions": True or False, # Required. By setting this field, your business may be included in promotions for all the selected attributes. If you clear this option, it won't affect your identification with any of the attributes. For this field to be set, the merchant must self identify with at least one of the `AccountIdentityType`. If none are included, the request will be considered invalid.
"latinoOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being latino-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"smallBusiness": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as a small business. This optional field is only available for merchants with a business country set to "US". It is also not allowed for marketplaces, but it is allowed to marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"veteranOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being veteran-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"womenOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being women-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
},
"businessInformation": { # The business information of the account.
"address": { # The address of the business. Use `\n` to add a second address line.
"country": "A String", # CLDR country code (for example, "US"). All MCA sub-accounts inherit the country of their parent MCA by default, however the country can be updated for individual sub-accounts.
"locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (for example, neighborhoods or suburbs).
"postalCode": "A String", # Postal code or ZIP (for example, "94043").
"region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
"streetAddress": "A String", # Street-level part of the address. Use `\n` to add a second line.
},
"customerService": { # The customer service information of the business.
"email": "A String", # Customer service email.
"phoneNumber": "A String", # Customer service phone number.
"url": "A String", # Customer service URL.
},
"koreanBusinessRegistrationNumber": "A String", # The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. This field will only be updated if explicitly set.
"phoneNumber": "A String", # The phone number of the business in [E.164](https://en.wikipedia.org/wiki/E.164) format. This can only be updated if a verified phone number is not already set. To replace a verified phone number use the `Accounts.requestphoneverification` and `Accounts.verifyphonenumber`.
"phoneVerificationStatus": "A String", # Verification status of the phone number of the business. This status is read only and can be updated only by successful phone verification. Acceptable values are: - "`verified`" - "`unverified`"
},
"conversionSettings": { # Settings for conversion tracking. # Settings for conversion tracking.
"freeListingsAutoTaggingEnabled": True or False, # When enabled, free listing URLs have a parameter to enable conversion tracking for products owned by the current merchant account. See [auto-tagging](https://support.google.com/merchants/answer/11127659).
},
"cssId": "A String", # ID of CSS the account belongs to.
"googleMyBusinessLink": { # The Business Profile which is linked or in the process of being linked with the Merchant Center account.
"gmbAccountId": "A String", # The ID of the Business Profile. If this is provided, then `gmbEmail` is ignored. The value of this field should match the `accountId` used by the Business Profile API.
"gmbEmail": "A String", # The Business Profile email address of a specific account within a Business Profile. A sample account within a Business Profile could be a business account with set of locations, managed under the Business Profile.
"status": "A String", # Status of the link between this Merchant Center account and the Business Profile. Acceptable values are: - "`active`" - "`pending`"
},
"id": "A String", # Required. 64-bit Merchant Center account ID.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`".
"labelIds": [ # Manually created label IDs that are assigned to the account by CSS.
"A String",
],
"name": "A String", # Required. Display name for the account.
"sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
"users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
{
"admin": True or False, # Whether user is an admin.
"emailAddress": "A String", # User's email address.
"orderManager": True or False, # Whether user is an order manager.
"paymentsAnalyst": True or False, # Whether user can access payment statements.
"paymentsManager": True or False, # Whether user can manage payment settings.
"readOnly": True or False, # Optional. Whether user has standard read-only access.
"reportingManager": True or False, # Whether user is a reporting manager. This role is equivalent to the Performance and insights role in Merchant Center.
},
],
"websiteUrl": "A String", # The merchant's website.
"youtubeChannelLinks": [ # Linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list.
{
"channelId": "A String", # Channel ID.
"status": "A String", # Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it's pending approval. Upon insertion, it represents the *intended* status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(merchantId, body=None, x__xgafv=None)</code>
<pre>Creates a Merchant Center sub-account.
Args:
merchantId: string, The ID of the managing account. This must be a multi-client account. (required)
body: object, The request body.
The object takes the form of:
{ # Account data. After the creation of a new account it may take a few minutes before it's fully operational. The methods delete, insert, and update require the admin role.
"accountManagement": "A String", # Output only. How the account is managed. Acceptable values are: - "`manual`" - "`automatic`"
"adsLinks": [ # Linked Ads accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the Ads interface or through the Google Ads API. To delete an active link, or to cancel a link request, remove it from the list.
{
"adsId": "A String", # Customer ID of the Ads account.
"status": "A String", # Status of the link between this Merchant Center account and the Ads account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google Ads or `pending` if it's pending approval. Upon insertion, it represents the *intended* status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending. Acceptable values are: - "`active`" - "`pending`"
},
],
"adultContent": True or False, # Indicates whether the merchant sells adult content.
"automaticImprovements": { # The automatic improvements of the account can be used to automatically update items, improve images and shipping. # The automatic improvements of the account can be used to automatically update items, improve images and shipping. Each section inside AutomaticImprovements is updated separately.
"imageImprovements": { # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) This field is only updated (cleared) if provided.
"accountImageImprovementsSettings": { # Settings for the Automatic Image Improvements. # Determines how the images should be automatically updated. If this field is not present, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
"allowAutomaticImageImprovements": True or False, # Enables automatic image improvements.
},
"effectiveAllowAutomaticImageImprovements": True or False, # Output only. The effective value of allow_automatic_image_improvements. If account_image_improvements_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
},
"itemUpdates": { # Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. # Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. This field is only updated (cleared) if provided.
"accountItemUpdatesSettings": { # Settings for the Automatic Item Updates. # Determines which attributes of the items should be automatically updated. If this field is not present, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
"allowAvailabilityUpdates": True or False, # If availability updates are enabled, any previous availability values get overwritten if Google finds an out-of-stock annotation on the offer's page. If additionally `allow_availability_updates` field is set to true, values get overwritten if Google finds an in-stock annotation on the offer’s page.
"allowConditionUpdates": True or False, # If condition updates are enabled, Google always updates item condition with the condition detected from the details of your product.
"allowPriceUpdates": True or False, # If price updates are enabled, Google always updates the active price with the crawled information.
"allowStrictAvailabilityUpdates": True or False, # If allow_availability_updates is enabled, items are automatically updated in all your Shopping target countries. By default, availability updates will only be applied to items that are 'out of stock' on your website but 'in stock' on Shopping. Set this to true to also update items that are 'in stock' on your website, but 'out of stock' on Google Shopping. In order for this field to have an effect, you must also allow availability updates.
},
"effectiveAllowAvailabilityUpdates": True or False, # Output only. The effective value of allow_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowConditionUpdates": True or False, # Output only. The effective value of allow_condition_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowPriceUpdates": True or False, # Output only. The effective value of allow_price_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowStrictAvailabilityUpdates": True or False, # Output only. The effective value of allow_strict_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
},
"shippingImprovements": { # Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: * Delivery address of an order * Current handling time and shipping time settings * Estimated weekdays or business days * Parcel tracking data # Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: - Delivery address of an order - Current handling time and shipping time settings - Estimated weekdays or business days - Parcel tracking data This field is only updated (cleared) if provided.
"allowShippingImprovements": True or False, # Enables automatic shipping improvements.
},
},
"automaticLabelIds": [ # Automatically created label IDs that are assigned to the account by CSS Center.
"A String",
],
"businessIdentity": { # The [business identity attributes](https://support.google.com/merchants/answer/10342414) can be used to self-declare attributes that let customers know more about your business. # The business identity attributes can be used to self-declare attributes that let customers know more about your business.
"blackOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being black-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"includeForPromotions": True or False, # Required. By setting this field, your business may be included in promotions for all the selected attributes. If you clear this option, it won't affect your identification with any of the attributes. For this field to be set, the merchant must self identify with at least one of the `AccountIdentityType`. If none are included, the request will be considered invalid.
"latinoOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being latino-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"smallBusiness": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as a small business. This optional field is only available for merchants with a business country set to "US". It is also not allowed for marketplaces, but it is allowed to marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"veteranOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being veteran-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"womenOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being women-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
},
"businessInformation": { # The business information of the account.
"address": { # The address of the business. Use `\n` to add a second address line.
"country": "A String", # CLDR country code (for example, "US"). All MCA sub-accounts inherit the country of their parent MCA by default, however the country can be updated for individual sub-accounts.
"locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (for example, neighborhoods or suburbs).
"postalCode": "A String", # Postal code or ZIP (for example, "94043").
"region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
"streetAddress": "A String", # Street-level part of the address. Use `\n` to add a second line.
},
"customerService": { # The customer service information of the business.
"email": "A String", # Customer service email.
"phoneNumber": "A String", # Customer service phone number.
"url": "A String", # Customer service URL.
},
"koreanBusinessRegistrationNumber": "A String", # The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. This field will only be updated if explicitly set.
"phoneNumber": "A String", # The phone number of the business in [E.164](https://en.wikipedia.org/wiki/E.164) format. This can only be updated if a verified phone number is not already set. To replace a verified phone number use the `Accounts.requestphoneverification` and `Accounts.verifyphonenumber`.
"phoneVerificationStatus": "A String", # Verification status of the phone number of the business. This status is read only and can be updated only by successful phone verification. Acceptable values are: - "`verified`" - "`unverified`"
},
"conversionSettings": { # Settings for conversion tracking. # Settings for conversion tracking.
"freeListingsAutoTaggingEnabled": True or False, # When enabled, free listing URLs have a parameter to enable conversion tracking for products owned by the current merchant account. See [auto-tagging](https://support.google.com/merchants/answer/11127659).
},
"cssId": "A String", # ID of CSS the account belongs to.
"googleMyBusinessLink": { # The Business Profile which is linked or in the process of being linked with the Merchant Center account.
"gmbAccountId": "A String", # The ID of the Business Profile. If this is provided, then `gmbEmail` is ignored. The value of this field should match the `accountId` used by the Business Profile API.
"gmbEmail": "A String", # The Business Profile email address of a specific account within a Business Profile. A sample account within a Business Profile could be a business account with set of locations, managed under the Business Profile.
"status": "A String", # Status of the link between this Merchant Center account and the Business Profile. Acceptable values are: - "`active`" - "`pending`"
},
"id": "A String", # Required. 64-bit Merchant Center account ID.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`".
"labelIds": [ # Manually created label IDs that are assigned to the account by CSS.
"A String",
],
"name": "A String", # Required. Display name for the account.
"sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
"users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
{
"admin": True or False, # Whether user is an admin.
"emailAddress": "A String", # User's email address.
"orderManager": True or False, # Whether user is an order manager.
"paymentsAnalyst": True or False, # Whether user can access payment statements.
"paymentsManager": True or False, # Whether user can manage payment settings.
"readOnly": True or False, # Optional. Whether user has standard read-only access.
"reportingManager": True or False, # Whether user is a reporting manager. This role is equivalent to the Performance and insights role in Merchant Center.
},
],
"websiteUrl": "A String", # The merchant's website.
"youtubeChannelLinks": [ # Linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list.
{
"channelId": "A String", # Channel ID.
"status": "A String", # Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it's pending approval. Upon insertion, it represents the *intended* status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Account data. After the creation of a new account it may take a few minutes before it's fully operational. The methods delete, insert, and update require the admin role.
"accountManagement": "A String", # Output only. How the account is managed. Acceptable values are: - "`manual`" - "`automatic`"
"adsLinks": [ # Linked Ads accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the Ads interface or through the Google Ads API. To delete an active link, or to cancel a link request, remove it from the list.
{
"adsId": "A String", # Customer ID of the Ads account.
"status": "A String", # Status of the link between this Merchant Center account and the Ads account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google Ads or `pending` if it's pending approval. Upon insertion, it represents the *intended* status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending. Acceptable values are: - "`active`" - "`pending`"
},
],
"adultContent": True or False, # Indicates whether the merchant sells adult content.
"automaticImprovements": { # The automatic improvements of the account can be used to automatically update items, improve images and shipping. # The automatic improvements of the account can be used to automatically update items, improve images and shipping. Each section inside AutomaticImprovements is updated separately.
"imageImprovements": { # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) This field is only updated (cleared) if provided.
"accountImageImprovementsSettings": { # Settings for the Automatic Image Improvements. # Determines how the images should be automatically updated. If this field is not present, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
"allowAutomaticImageImprovements": True or False, # Enables automatic image improvements.
},
"effectiveAllowAutomaticImageImprovements": True or False, # Output only. The effective value of allow_automatic_image_improvements. If account_image_improvements_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
},
"itemUpdates": { # Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. # Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. This field is only updated (cleared) if provided.
"accountItemUpdatesSettings": { # Settings for the Automatic Item Updates. # Determines which attributes of the items should be automatically updated. If this field is not present, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
"allowAvailabilityUpdates": True or False, # If availability updates are enabled, any previous availability values get overwritten if Google finds an out-of-stock annotation on the offer's page. If additionally `allow_availability_updates` field is set to true, values get overwritten if Google finds an in-stock annotation on the offer’s page.
"allowConditionUpdates": True or False, # If condition updates are enabled, Google always updates item condition with the condition detected from the details of your product.
"allowPriceUpdates": True or False, # If price updates are enabled, Google always updates the active price with the crawled information.
"allowStrictAvailabilityUpdates": True or False, # If allow_availability_updates is enabled, items are automatically updated in all your Shopping target countries. By default, availability updates will only be applied to items that are 'out of stock' on your website but 'in stock' on Shopping. Set this to true to also update items that are 'in stock' on your website, but 'out of stock' on Google Shopping. In order for this field to have an effect, you must also allow availability updates.
},
"effectiveAllowAvailabilityUpdates": True or False, # Output only. The effective value of allow_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowConditionUpdates": True or False, # Output only. The effective value of allow_condition_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowPriceUpdates": True or False, # Output only. The effective value of allow_price_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowStrictAvailabilityUpdates": True or False, # Output only. The effective value of allow_strict_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
},
"shippingImprovements": { # Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: * Delivery address of an order * Current handling time and shipping time settings * Estimated weekdays or business days * Parcel tracking data # Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: - Delivery address of an order - Current handling time and shipping time settings - Estimated weekdays or business days - Parcel tracking data This field is only updated (cleared) if provided.
"allowShippingImprovements": True or False, # Enables automatic shipping improvements.
},
},
"automaticLabelIds": [ # Automatically created label IDs that are assigned to the account by CSS Center.
"A String",
],
"businessIdentity": { # The [business identity attributes](https://support.google.com/merchants/answer/10342414) can be used to self-declare attributes that let customers know more about your business. # The business identity attributes can be used to self-declare attributes that let customers know more about your business.
"blackOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being black-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"includeForPromotions": True or False, # Required. By setting this field, your business may be included in promotions for all the selected attributes. If you clear this option, it won't affect your identification with any of the attributes. For this field to be set, the merchant must self identify with at least one of the `AccountIdentityType`. If none are included, the request will be considered invalid.
"latinoOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being latino-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"smallBusiness": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as a small business. This optional field is only available for merchants with a business country set to "US". It is also not allowed for marketplaces, but it is allowed to marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"veteranOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being veteran-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"womenOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being women-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
},
"businessInformation": { # The business information of the account.
"address": { # The address of the business. Use `\n` to add a second address line.
"country": "A String", # CLDR country code (for example, "US"). All MCA sub-accounts inherit the country of their parent MCA by default, however the country can be updated for individual sub-accounts.
"locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (for example, neighborhoods or suburbs).
"postalCode": "A String", # Postal code or ZIP (for example, "94043").
"region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
"streetAddress": "A String", # Street-level part of the address. Use `\n` to add a second line.
},
"customerService": { # The customer service information of the business.
"email": "A String", # Customer service email.
"phoneNumber": "A String", # Customer service phone number.
"url": "A String", # Customer service URL.
},
"koreanBusinessRegistrationNumber": "A String", # The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. This field will only be updated if explicitly set.
"phoneNumber": "A String", # The phone number of the business in [E.164](https://en.wikipedia.org/wiki/E.164) format. This can only be updated if a verified phone number is not already set. To replace a verified phone number use the `Accounts.requestphoneverification` and `Accounts.verifyphonenumber`.
"phoneVerificationStatus": "A String", # Verification status of the phone number of the business. This status is read only and can be updated only by successful phone verification. Acceptable values are: - "`verified`" - "`unverified`"
},
"conversionSettings": { # Settings for conversion tracking. # Settings for conversion tracking.
"freeListingsAutoTaggingEnabled": True or False, # When enabled, free listing URLs have a parameter to enable conversion tracking for products owned by the current merchant account. See [auto-tagging](https://support.google.com/merchants/answer/11127659).
},
"cssId": "A String", # ID of CSS the account belongs to.
"googleMyBusinessLink": { # The Business Profile which is linked or in the process of being linked with the Merchant Center account.
"gmbAccountId": "A String", # The ID of the Business Profile. If this is provided, then `gmbEmail` is ignored. The value of this field should match the `accountId` used by the Business Profile API.
"gmbEmail": "A String", # The Business Profile email address of a specific account within a Business Profile. A sample account within a Business Profile could be a business account with set of locations, managed under the Business Profile.
"status": "A String", # Status of the link between this Merchant Center account and the Business Profile. Acceptable values are: - "`active`" - "`pending`"
},
"id": "A String", # Required. 64-bit Merchant Center account ID.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`".
"labelIds": [ # Manually created label IDs that are assigned to the account by CSS.
"A String",
],
"name": "A String", # Required. Display name for the account.
"sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
"users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
{
"admin": True or False, # Whether user is an admin.
"emailAddress": "A String", # User's email address.
"orderManager": True or False, # Whether user is an order manager.
"paymentsAnalyst": True or False, # Whether user can access payment statements.
"paymentsManager": True or False, # Whether user can manage payment settings.
"readOnly": True or False, # Optional. Whether user has standard read-only access.
"reportingManager": True or False, # Whether user is a reporting manager. This role is equivalent to the Performance and insights role in Merchant Center.
},
],
"websiteUrl": "A String", # The merchant's website.
"youtubeChannelLinks": [ # Linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list.
{
"channelId": "A String", # Channel ID.
"status": "A String", # Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it's pending approval. Upon insertion, it represents the *intended* status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="link">link(merchantId, accountId, body=None, x__xgafv=None)</code>
<pre>Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId.
Args:
merchantId: string, The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account. (required)
accountId: string, The ID of the account that should be linked. (required)
body: object, The request body.
The object takes the form of:
{
"action": "A String", # Action to perform for this link. The `"request"` action is only available to select merchants. Acceptable values are: - "`approve`" - "`remove`" - "`request`"
"eCommercePlatformLinkInfo": { # Additional information required for E_COMMERCE_PLATFORM link type. # Additional information required for `eCommercePlatform` link type.
"externalAccountId": "A String", # The id used by the third party service provider to identify the merchant.
},
"linkType": "A String", # Type of the link between the two accounts. Acceptable values are: - "`channelPartner`" - "`eCommercePlatform`" - "`paymentServiceProvider`"
"linkedAccountId": "A String", # The ID of the linked account.
"paymentServiceProviderLinkInfo": { # Additional information required for PAYMENT_SERVICE_PROVIDER link type. # Additional information required for `paymentServiceProvider` link type.
"externalAccountBusinessCountry": "A String", # The business country of the merchant account as identified by the third party service provider.
"externalAccountId": "A String", # The id used by the third party service provider to identify the merchant.
},
"services": [ # Acceptable values are: - "`shoppingAdsProductManagement`" - "`shoppingActionsProductManagement`" - "`shoppingActionsOrderManagement`" - "`paymentProcessing`"
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#accountsLinkResponse`".
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(merchantId, label=None, maxResults=None, name=None, pageToken=None, view=None, x__xgafv=None)</code>
<pre>Lists the sub-accounts in your Merchant Center account.
Args:
merchantId: string, The ID of the managing account. This must be a multi-client account. (required)
label: string, If view is set to "css", only return accounts that are assigned label with given ID.
maxResults: integer, The maximum number of accounts to return in the response, used for paging.
name: string, If set, only the accounts with the given name (case sensitive) will be returned.
pageToken: string, The token returned by the previous request.
view: string, Controls which fields will be populated. Acceptable values are: "merchant" and "css". The default value is "merchant".
Allowed values
MERCHANT - Default. View is populated with Merchant Center fields.
CSS - View is populated with Comparison Shopping Services fields.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#accountsListResponse`".
"nextPageToken": "A String", # The token for the retrieval of the next page of accounts.
"resources": [
{ # Account data. After the creation of a new account it may take a few minutes before it's fully operational. The methods delete, insert, and update require the admin role.
"accountManagement": "A String", # Output only. How the account is managed. Acceptable values are: - "`manual`" - "`automatic`"
"adsLinks": [ # Linked Ads accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the Ads interface or through the Google Ads API. To delete an active link, or to cancel a link request, remove it from the list.
{
"adsId": "A String", # Customer ID of the Ads account.
"status": "A String", # Status of the link between this Merchant Center account and the Ads account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google Ads or `pending` if it's pending approval. Upon insertion, it represents the *intended* status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending. Acceptable values are: - "`active`" - "`pending`"
},
],
"adultContent": True or False, # Indicates whether the merchant sells adult content.
"automaticImprovements": { # The automatic improvements of the account can be used to automatically update items, improve images and shipping. # The automatic improvements of the account can be used to automatically update items, improve images and shipping. Each section inside AutomaticImprovements is updated separately.
"imageImprovements": { # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) This field is only updated (cleared) if provided.
"accountImageImprovementsSettings": { # Settings for the Automatic Image Improvements. # Determines how the images should be automatically updated. If this field is not present, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
"allowAutomaticImageImprovements": True or False, # Enables automatic image improvements.
},
"effectiveAllowAutomaticImageImprovements": True or False, # Output only. The effective value of allow_automatic_image_improvements. If account_image_improvements_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
},
"itemUpdates": { # Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. # Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. This field is only updated (cleared) if provided.
"accountItemUpdatesSettings": { # Settings for the Automatic Item Updates. # Determines which attributes of the items should be automatically updated. If this field is not present, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
"allowAvailabilityUpdates": True or False, # If availability updates are enabled, any previous availability values get overwritten if Google finds an out-of-stock annotation on the offer's page. If additionally `allow_availability_updates` field is set to true, values get overwritten if Google finds an in-stock annotation on the offer’s page.
"allowConditionUpdates": True or False, # If condition updates are enabled, Google always updates item condition with the condition detected from the details of your product.
"allowPriceUpdates": True or False, # If price updates are enabled, Google always updates the active price with the crawled information.
"allowStrictAvailabilityUpdates": True or False, # If allow_availability_updates is enabled, items are automatically updated in all your Shopping target countries. By default, availability updates will only be applied to items that are 'out of stock' on your website but 'in stock' on Shopping. Set this to true to also update items that are 'in stock' on your website, but 'out of stock' on Google Shopping. In order for this field to have an effect, you must also allow availability updates.
},
"effectiveAllowAvailabilityUpdates": True or False, # Output only. The effective value of allow_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowConditionUpdates": True or False, # Output only. The effective value of allow_condition_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowPriceUpdates": True or False, # Output only. The effective value of allow_price_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowStrictAvailabilityUpdates": True or False, # Output only. The effective value of allow_strict_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
},
"shippingImprovements": { # Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: * Delivery address of an order * Current handling time and shipping time settings * Estimated weekdays or business days * Parcel tracking data # Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: - Delivery address of an order - Current handling time and shipping time settings - Estimated weekdays or business days - Parcel tracking data This field is only updated (cleared) if provided.
"allowShippingImprovements": True or False, # Enables automatic shipping improvements.
},
},
"automaticLabelIds": [ # Automatically created label IDs that are assigned to the account by CSS Center.
"A String",
],
"businessIdentity": { # The [business identity attributes](https://support.google.com/merchants/answer/10342414) can be used to self-declare attributes that let customers know more about your business. # The business identity attributes can be used to self-declare attributes that let customers know more about your business.
"blackOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being black-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"includeForPromotions": True or False, # Required. By setting this field, your business may be included in promotions for all the selected attributes. If you clear this option, it won't affect your identification with any of the attributes. For this field to be set, the merchant must self identify with at least one of the `AccountIdentityType`. If none are included, the request will be considered invalid.
"latinoOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being latino-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"smallBusiness": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as a small business. This optional field is only available for merchants with a business country set to "US". It is also not allowed for marketplaces, but it is allowed to marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"veteranOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being veteran-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"womenOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being women-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
},
"businessInformation": { # The business information of the account.
"address": { # The address of the business. Use `\n` to add a second address line.
"country": "A String", # CLDR country code (for example, "US"). All MCA sub-accounts inherit the country of their parent MCA by default, however the country can be updated for individual sub-accounts.
"locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (for example, neighborhoods or suburbs).
"postalCode": "A String", # Postal code or ZIP (for example, "94043").
"region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
"streetAddress": "A String", # Street-level part of the address. Use `\n` to add a second line.
},
"customerService": { # The customer service information of the business.
"email": "A String", # Customer service email.
"phoneNumber": "A String", # Customer service phone number.
"url": "A String", # Customer service URL.
},
"koreanBusinessRegistrationNumber": "A String", # The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. This field will only be updated if explicitly set.
"phoneNumber": "A String", # The phone number of the business in [E.164](https://en.wikipedia.org/wiki/E.164) format. This can only be updated if a verified phone number is not already set. To replace a verified phone number use the `Accounts.requestphoneverification` and `Accounts.verifyphonenumber`.
"phoneVerificationStatus": "A String", # Verification status of the phone number of the business. This status is read only and can be updated only by successful phone verification. Acceptable values are: - "`verified`" - "`unverified`"
},
"conversionSettings": { # Settings for conversion tracking. # Settings for conversion tracking.
"freeListingsAutoTaggingEnabled": True or False, # When enabled, free listing URLs have a parameter to enable conversion tracking for products owned by the current merchant account. See [auto-tagging](https://support.google.com/merchants/answer/11127659).
},
"cssId": "A String", # ID of CSS the account belongs to.
"googleMyBusinessLink": { # The Business Profile which is linked or in the process of being linked with the Merchant Center account.
"gmbAccountId": "A String", # The ID of the Business Profile. If this is provided, then `gmbEmail` is ignored. The value of this field should match the `accountId` used by the Business Profile API.
"gmbEmail": "A String", # The Business Profile email address of a specific account within a Business Profile. A sample account within a Business Profile could be a business account with set of locations, managed under the Business Profile.
"status": "A String", # Status of the link between this Merchant Center account and the Business Profile. Acceptable values are: - "`active`" - "`pending`"
},
"id": "A String", # Required. 64-bit Merchant Center account ID.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`".
"labelIds": [ # Manually created label IDs that are assigned to the account by CSS.
"A String",
],
"name": "A String", # Required. Display name for the account.
"sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
"users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
{
"admin": True or False, # Whether user is an admin.
"emailAddress": "A String", # User's email address.
"orderManager": True or False, # Whether user is an order manager.
"paymentsAnalyst": True or False, # Whether user can access payment statements.
"paymentsManager": True or False, # Whether user can manage payment settings.
"readOnly": True or False, # Optional. Whether user has standard read-only access.
"reportingManager": True or False, # Whether user is a reporting manager. This role is equivalent to the Performance and insights role in Merchant Center.
},
],
"websiteUrl": "A String", # The merchant's website.
"youtubeChannelLinks": [ # Linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list.
{
"channelId": "A String", # Channel ID.
"status": "A String", # Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it's pending approval. Upon insertion, it represents the *intended* status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
},
],
},
],
}</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="listlinks">listlinks(merchantId, accountId, maxResults=None, pageToken=None, x__xgafv=None)</code>
<pre>Returns the list of accounts linked to your Merchant Center account.
Args:
merchantId: string, The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account. (required)
accountId: string, The ID of the account for which to list links. (required)
maxResults: integer, The maximum number of links to return in the response, used for pagination. The minimum allowed value is 5 results per page. If provided value is lower than 5, it will be automatically increased to 5.
pageToken: string, The token returned by the previous request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#accountsListLinksResponse`".
"links": [ # The list of available links.
{
"linkedAccountId": "A String", # The ID of the linked account.
"services": [ # List of provided services.
{
"service": "A String", # Service provided to or by the linked account. Acceptable values are: - "`shoppingActionsOrderManagement`" - "`shoppingActionsProductManagement`" - "`shoppingAdsProductManagement`" - "`paymentProcessing`"
"status": "A String", # Status of the link Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
},
],
},
],
"nextPageToken": "A String", # The token for the retrieval of the next page of links.
}</pre>
</div>
<div class="method">
<code class="details" id="listlinks_next">listlinks_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="requestphoneverification">requestphoneverification(merchantId, accountId, body=None, x__xgafv=None)</code>
<pre>Request verification code to start phone verification.
Args:
merchantId: string, Required. The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. (required)
accountId: string, Required. The ID of the account. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for the RequestPhoneVerification method.
"languageCode": "A String", # Language code [IETF BCP 47 syntax](https://tools.ietf.org/html/bcp47) (for example, en-US). Language code is used to provide localized `SMS` and `PHONE_CALL`. Default language used is en-US if not provided.
"phoneNumber": "A String", # Phone number to be verified.
"phoneRegionCode": "A String", # Required. Two letter country code for the phone number, for example `CA` for Canadian numbers. See the [ISO 3166-1 alpha-2](https://wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) officially assigned codes.
"phoneVerificationMethod": "A String", # Verification method to receive verification code.
}
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 the RequestPhoneVerification method.
"verificationId": "A String", # The verification ID to use in subsequent calls to `verifyphonenumber`.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(merchantId, accountId, body=None, x__xgafv=None)</code>
<pre>Updates a Merchant Center account. Any fields that are not provided are deleted from the resource.
Args:
merchantId: string, The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account. (required)
accountId: string, The ID of the account. (required)
body: object, The request body.
The object takes the form of:
{ # Account data. After the creation of a new account it may take a few minutes before it's fully operational. The methods delete, insert, and update require the admin role.
"accountManagement": "A String", # Output only. How the account is managed. Acceptable values are: - "`manual`" - "`automatic`"
"adsLinks": [ # Linked Ads accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the Ads interface or through the Google Ads API. To delete an active link, or to cancel a link request, remove it from the list.
{
"adsId": "A String", # Customer ID of the Ads account.
"status": "A String", # Status of the link between this Merchant Center account and the Ads account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google Ads or `pending` if it's pending approval. Upon insertion, it represents the *intended* status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending. Acceptable values are: - "`active`" - "`pending`"
},
],
"adultContent": True or False, # Indicates whether the merchant sells adult content.
"automaticImprovements": { # The automatic improvements of the account can be used to automatically update items, improve images and shipping. # The automatic improvements of the account can be used to automatically update items, improve images and shipping. Each section inside AutomaticImprovements is updated separately.
"imageImprovements": { # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) This field is only updated (cleared) if provided.
"accountImageImprovementsSettings": { # Settings for the Automatic Image Improvements. # Determines how the images should be automatically updated. If this field is not present, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
"allowAutomaticImageImprovements": True or False, # Enables automatic image improvements.
},
"effectiveAllowAutomaticImageImprovements": True or False, # Output only. The effective value of allow_automatic_image_improvements. If account_image_improvements_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
},
"itemUpdates": { # Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. # Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. This field is only updated (cleared) if provided.
"accountItemUpdatesSettings": { # Settings for the Automatic Item Updates. # Determines which attributes of the items should be automatically updated. If this field is not present, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
"allowAvailabilityUpdates": True or False, # If availability updates are enabled, any previous availability values get overwritten if Google finds an out-of-stock annotation on the offer's page. If additionally `allow_availability_updates` field is set to true, values get overwritten if Google finds an in-stock annotation on the offer’s page.
"allowConditionUpdates": True or False, # If condition updates are enabled, Google always updates item condition with the condition detected from the details of your product.
"allowPriceUpdates": True or False, # If price updates are enabled, Google always updates the active price with the crawled information.
"allowStrictAvailabilityUpdates": True or False, # If allow_availability_updates is enabled, items are automatically updated in all your Shopping target countries. By default, availability updates will only be applied to items that are 'out of stock' on your website but 'in stock' on Shopping. Set this to true to also update items that are 'in stock' on your website, but 'out of stock' on Google Shopping. In order for this field to have an effect, you must also allow availability updates.
},
"effectiveAllowAvailabilityUpdates": True or False, # Output only. The effective value of allow_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowConditionUpdates": True or False, # Output only. The effective value of allow_condition_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowPriceUpdates": True or False, # Output only. The effective value of allow_price_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowStrictAvailabilityUpdates": True or False, # Output only. The effective value of allow_strict_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
},
"shippingImprovements": { # Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: * Delivery address of an order * Current handling time and shipping time settings * Estimated weekdays or business days * Parcel tracking data # Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: - Delivery address of an order - Current handling time and shipping time settings - Estimated weekdays or business days - Parcel tracking data This field is only updated (cleared) if provided.
"allowShippingImprovements": True or False, # Enables automatic shipping improvements.
},
},
"automaticLabelIds": [ # Automatically created label IDs that are assigned to the account by CSS Center.
"A String",
],
"businessIdentity": { # The [business identity attributes](https://support.google.com/merchants/answer/10342414) can be used to self-declare attributes that let customers know more about your business. # The business identity attributes can be used to self-declare attributes that let customers know more about your business.
"blackOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being black-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"includeForPromotions": True or False, # Required. By setting this field, your business may be included in promotions for all the selected attributes. If you clear this option, it won't affect your identification with any of the attributes. For this field to be set, the merchant must self identify with at least one of the `AccountIdentityType`. If none are included, the request will be considered invalid.
"latinoOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being latino-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"smallBusiness": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as a small business. This optional field is only available for merchants with a business country set to "US". It is also not allowed for marketplaces, but it is allowed to marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"veteranOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being veteran-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"womenOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being women-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
},
"businessInformation": { # The business information of the account.
"address": { # The address of the business. Use `\n` to add a second address line.
"country": "A String", # CLDR country code (for example, "US"). All MCA sub-accounts inherit the country of their parent MCA by default, however the country can be updated for individual sub-accounts.
"locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (for example, neighborhoods or suburbs).
"postalCode": "A String", # Postal code or ZIP (for example, "94043").
"region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
"streetAddress": "A String", # Street-level part of the address. Use `\n` to add a second line.
},
"customerService": { # The customer service information of the business.
"email": "A String", # Customer service email.
"phoneNumber": "A String", # Customer service phone number.
"url": "A String", # Customer service URL.
},
"koreanBusinessRegistrationNumber": "A String", # The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. This field will only be updated if explicitly set.
"phoneNumber": "A String", # The phone number of the business in [E.164](https://en.wikipedia.org/wiki/E.164) format. This can only be updated if a verified phone number is not already set. To replace a verified phone number use the `Accounts.requestphoneverification` and `Accounts.verifyphonenumber`.
"phoneVerificationStatus": "A String", # Verification status of the phone number of the business. This status is read only and can be updated only by successful phone verification. Acceptable values are: - "`verified`" - "`unverified`"
},
"conversionSettings": { # Settings for conversion tracking. # Settings for conversion tracking.
"freeListingsAutoTaggingEnabled": True or False, # When enabled, free listing URLs have a parameter to enable conversion tracking for products owned by the current merchant account. See [auto-tagging](https://support.google.com/merchants/answer/11127659).
},
"cssId": "A String", # ID of CSS the account belongs to.
"googleMyBusinessLink": { # The Business Profile which is linked or in the process of being linked with the Merchant Center account.
"gmbAccountId": "A String", # The ID of the Business Profile. If this is provided, then `gmbEmail` is ignored. The value of this field should match the `accountId` used by the Business Profile API.
"gmbEmail": "A String", # The Business Profile email address of a specific account within a Business Profile. A sample account within a Business Profile could be a business account with set of locations, managed under the Business Profile.
"status": "A String", # Status of the link between this Merchant Center account and the Business Profile. Acceptable values are: - "`active`" - "`pending`"
},
"id": "A String", # Required. 64-bit Merchant Center account ID.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`".
"labelIds": [ # Manually created label IDs that are assigned to the account by CSS.
"A String",
],
"name": "A String", # Required. Display name for the account.
"sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
"users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
{
"admin": True or False, # Whether user is an admin.
"emailAddress": "A String", # User's email address.
"orderManager": True or False, # Whether user is an order manager.
"paymentsAnalyst": True or False, # Whether user can access payment statements.
"paymentsManager": True or False, # Whether user can manage payment settings.
"readOnly": True or False, # Optional. Whether user has standard read-only access.
"reportingManager": True or False, # Whether user is a reporting manager. This role is equivalent to the Performance and insights role in Merchant Center.
},
],
"websiteUrl": "A String", # The merchant's website.
"youtubeChannelLinks": [ # Linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list.
{
"channelId": "A String", # Channel ID.
"status": "A String", # Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it's pending approval. Upon insertion, it represents the *intended* status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Account data. After the creation of a new account it may take a few minutes before it's fully operational. The methods delete, insert, and update require the admin role.
"accountManagement": "A String", # Output only. How the account is managed. Acceptable values are: - "`manual`" - "`automatic`"
"adsLinks": [ # Linked Ads accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the Ads interface or through the Google Ads API. To delete an active link, or to cancel a link request, remove it from the list.
{
"adsId": "A String", # Customer ID of the Ads account.
"status": "A String", # Status of the link between this Merchant Center account and the Ads account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google Ads or `pending` if it's pending approval. Upon insertion, it represents the *intended* status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending. Acceptable values are: - "`active`" - "`pending`"
},
],
"adultContent": True or False, # Indicates whether the merchant sells adult content.
"automaticImprovements": { # The automatic improvements of the account can be used to automatically update items, improve images and shipping. # The automatic improvements of the account can be used to automatically update items, improve images and shipping. Each section inside AutomaticImprovements is updated separately.
"imageImprovements": { # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) This field is only updated (cleared) if provided.
"accountImageImprovementsSettings": { # Settings for the Automatic Image Improvements. # Determines how the images should be automatically updated. If this field is not present, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
"allowAutomaticImageImprovements": True or False, # Enables automatic image improvements.
},
"effectiveAllowAutomaticImageImprovements": True or False, # Output only. The effective value of allow_automatic_image_improvements. If account_image_improvements_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
},
"itemUpdates": { # Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. # Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. This field is only updated (cleared) if provided.
"accountItemUpdatesSettings": { # Settings for the Automatic Item Updates. # Determines which attributes of the items should be automatically updated. If this field is not present, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
"allowAvailabilityUpdates": True or False, # If availability updates are enabled, any previous availability values get overwritten if Google finds an out-of-stock annotation on the offer's page. If additionally `allow_availability_updates` field is set to true, values get overwritten if Google finds an in-stock annotation on the offer’s page.
"allowConditionUpdates": True or False, # If condition updates are enabled, Google always updates item condition with the condition detected from the details of your product.
"allowPriceUpdates": True or False, # If price updates are enabled, Google always updates the active price with the crawled information.
"allowStrictAvailabilityUpdates": True or False, # If allow_availability_updates is enabled, items are automatically updated in all your Shopping target countries. By default, availability updates will only be applied to items that are 'out of stock' on your website but 'in stock' on Shopping. Set this to true to also update items that are 'in stock' on your website, but 'out of stock' on Google Shopping. In order for this field to have an effect, you must also allow availability updates.
},
"effectiveAllowAvailabilityUpdates": True or False, # Output only. The effective value of allow_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowConditionUpdates": True or False, # Output only. The effective value of allow_condition_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowPriceUpdates": True or False, # Output only. The effective value of allow_price_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
"effectiveAllowStrictAvailabilityUpdates": True or False, # Output only. The effective value of allow_strict_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
},
"shippingImprovements": { # Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: * Delivery address of an order * Current handling time and shipping time settings * Estimated weekdays or business days * Parcel tracking data # Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: - Delivery address of an order - Current handling time and shipping time settings - Estimated weekdays or business days - Parcel tracking data This field is only updated (cleared) if provided.
"allowShippingImprovements": True or False, # Enables automatic shipping improvements.
},
},
"automaticLabelIds": [ # Automatically created label IDs that are assigned to the account by CSS Center.
"A String",
],
"businessIdentity": { # The [business identity attributes](https://support.google.com/merchants/answer/10342414) can be used to self-declare attributes that let customers know more about your business. # The business identity attributes can be used to self-declare attributes that let customers know more about your business.
"blackOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being black-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"includeForPromotions": True or False, # Required. By setting this field, your business may be included in promotions for all the selected attributes. If you clear this option, it won't affect your identification with any of the attributes. For this field to be set, the merchant must self identify with at least one of the `AccountIdentityType`. If none are included, the request will be considered invalid.
"latinoOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being latino-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"smallBusiness": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as a small business. This optional field is only available for merchants with a business country set to "US". It is also not allowed for marketplaces, but it is allowed to marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"veteranOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being veteran-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
"womenOwned": { # The account identity type used to specify attributes. # Specifies whether the business identifies itself as being women-owned. This optional field is only available for merchants with a business country set to "US". This field is not allowed for marketplaces or marketplace sellers.
"selfIdentified": True or False, # Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.
},
},
"businessInformation": { # The business information of the account.
"address": { # The address of the business. Use `\n` to add a second address line.
"country": "A String", # CLDR country code (for example, "US"). All MCA sub-accounts inherit the country of their parent MCA by default, however the country can be updated for individual sub-accounts.
"locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (for example, neighborhoods or suburbs).
"postalCode": "A String", # Postal code or ZIP (for example, "94043").
"region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
"streetAddress": "A String", # Street-level part of the address. Use `\n` to add a second line.
},
"customerService": { # The customer service information of the business.
"email": "A String", # Customer service email.
"phoneNumber": "A String", # Customer service phone number.
"url": "A String", # Customer service URL.
},
"koreanBusinessRegistrationNumber": "A String", # The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. This field will only be updated if explicitly set.
"phoneNumber": "A String", # The phone number of the business in [E.164](https://en.wikipedia.org/wiki/E.164) format. This can only be updated if a verified phone number is not already set. To replace a verified phone number use the `Accounts.requestphoneverification` and `Accounts.verifyphonenumber`.
"phoneVerificationStatus": "A String", # Verification status of the phone number of the business. This status is read only and can be updated only by successful phone verification. Acceptable values are: - "`verified`" - "`unverified`"
},
"conversionSettings": { # Settings for conversion tracking. # Settings for conversion tracking.
"freeListingsAutoTaggingEnabled": True or False, # When enabled, free listing URLs have a parameter to enable conversion tracking for products owned by the current merchant account. See [auto-tagging](https://support.google.com/merchants/answer/11127659).
},
"cssId": "A String", # ID of CSS the account belongs to.
"googleMyBusinessLink": { # The Business Profile which is linked or in the process of being linked with the Merchant Center account.
"gmbAccountId": "A String", # The ID of the Business Profile. If this is provided, then `gmbEmail` is ignored. The value of this field should match the `accountId` used by the Business Profile API.
"gmbEmail": "A String", # The Business Profile email address of a specific account within a Business Profile. A sample account within a Business Profile could be a business account with set of locations, managed under the Business Profile.
"status": "A String", # Status of the link between this Merchant Center account and the Business Profile. Acceptable values are: - "`active`" - "`pending`"
},
"id": "A String", # Required. 64-bit Merchant Center account ID.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#account`".
"labelIds": [ # Manually created label IDs that are assigned to the account by CSS.
"A String",
],
"name": "A String", # Required. Display name for the account.
"sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
"users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
{
"admin": True or False, # Whether user is an admin.
"emailAddress": "A String", # User's email address.
"orderManager": True or False, # Whether user is an order manager.
"paymentsAnalyst": True or False, # Whether user can access payment statements.
"paymentsManager": True or False, # Whether user can manage payment settings.
"readOnly": True or False, # Optional. Whether user has standard read-only access.
"reportingManager": True or False, # Whether user is a reporting manager. This role is equivalent to the Performance and insights role in Merchant Center.
},
],
"websiteUrl": "A String", # The merchant's website.
"youtubeChannelLinks": [ # Linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list.
{
"channelId": "A String", # Channel ID.
"status": "A String", # Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it's pending approval. Upon insertion, it represents the *intended* status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="updatelabels">updatelabels(merchantId, accountId, body=None, x__xgafv=None)</code>
<pre>Updates labels that are assigned to the Merchant Center account by CSS user.
Args:
merchantId: string, The ID of the managing account. (required)
accountId: string, The ID of the account whose labels are updated. (required)
body: object, The request body.
The object takes the form of:
{
"labelIds": [ # The IDs of labels that should be assigned to the account.
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#accountsUpdateLabelsResponse`".
}</pre>
</div>
<div class="method">
<code class="details" id="verifyphonenumber">verifyphonenumber(merchantId, accountId, body=None, x__xgafv=None)</code>
<pre>Validates verification code to verify phone number for the account. If successful this will overwrite the value of `accounts.businessinformation.phoneNumber`. Only verified phone number will replace an existing verified phone number.
Args:
merchantId: string, Required. The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. (required)
accountId: string, Required. The ID of the account. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for the VerifyPhoneNumber method.
"phoneVerificationMethod": "A String", # Verification method used to receive verification code.
"verificationCode": "A String", # The verification code that was sent to the phone number for validation.
"verificationId": "A String", # The verification ID returned by `requestphoneverification`.
}
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 the VerifyPhoneNumber method.
"verifiedPhoneNumber": "A String", # Verified phone number if verification is successful. This phone number can only be replaced by another verified phone number.
}</pre>
</div>
</body></html>
|