Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="content_v2.html">Content API for Shopping</a> . <a href="content_v2.accounts.html">accounts</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
Nathaniel Manista | 5cbe5ba | 2015-03-10 23:29:22 +0000 | [diff] [blame] | 78 | <code><a href="#authinfo">authinfo()</a></code></p> |
| 79 | <p class="firstline">Returns information about the authenticated user.</p> |
| 80 | <p class="toc_element"> |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 81 | <code><a href="#claimwebsite">claimwebsite(merchantId, accountId, overwrite=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 82 | <p class="firstline">Claims the website of a Merchant Center sub-account.</p> |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 83 | <p class="toc_element"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 84 | <code><a href="#custombatch">custombatch(body=None, dryRun=None)</a></code></p> |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 85 | <p class="firstline">Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.</p> |
| 86 | <p class="toc_element"> |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 87 | <code><a href="#delete">delete(merchantId, accountId, dryRun=None, force=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 88 | <p class="firstline">Deletes a Merchant Center sub-account.</p> |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 89 | <p class="toc_element"> |
| 90 | <code><a href="#get">get(merchantId, accountId)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 91 | <p class="firstline">Retrieves a Merchant Center account.</p> |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 92 | <p class="toc_element"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 93 | <code><a href="#insert">insert(merchantId, body=None, dryRun=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 94 | <p class="firstline">Creates a Merchant Center sub-account.</p> |
| 95 | <p class="toc_element"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 96 | <code><a href="#link">link(merchantId, accountId, body=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 97 | <p class="firstline">Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId.</p> |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 98 | <p class="toc_element"> |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 99 | <code><a href="#list">list(merchantId, maxResults=None, pageToken=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 100 | <p class="firstline">Lists the sub-accounts in your Merchant Center account.</p> |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 101 | <p class="toc_element"> |
| 102 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 103 | <p class="firstline">Retrieves the next page of results.</p> |
| 104 | <p class="toc_element"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 105 | <code><a href="#update">update(merchantId, accountId, body=None, dryRun=None)</a></code></p> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 106 | <p class="firstline">Updates a Merchant Center account. Any fields that are not provided are deleted from the resource.</p> |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 107 | <h3>Method Details</h3> |
| 108 | <div class="method"> |
Nathaniel Manista | 5cbe5ba | 2015-03-10 23:29:22 +0000 | [diff] [blame] | 109 | <code class="details" id="authinfo">authinfo()</code> |
| 110 | <pre>Returns information about the authenticated user. |
| 111 | |
| 112 | Args: |
| 113 | |
| 114 | Returns: |
| 115 | An object of the form: |
| 116 | |
| 117 | { |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 118 | "accountIdentifiers": [ # The account identifiers corresponding to the authenticated user. |
Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 119 | # - For an individual account: only the merchant ID is defined |
| 120 | # - For an aggregator: only the aggregator ID is defined |
| 121 | # - For a subaccount of an MCA: both the merchant ID and the aggregator ID are defined. |
| 122 | { |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 123 | "aggregatorId": "A String", # The aggregator ID, set for aggregators and subaccounts (in that case, it represents the aggregator of the subaccount). |
| 124 | "merchantId": "A String", # The merchant account ID, set for individual accounts and subaccounts. |
Nathaniel Manista | 5cbe5ba | 2015-03-10 23:29:22 +0000 | [diff] [blame] | 125 | }, |
| 126 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 127 | "kind": "content#accountsAuthInfoResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accountsAuthInfoResponse". |
Nathaniel Manista | 5cbe5ba | 2015-03-10 23:29:22 +0000 | [diff] [blame] | 128 | }</pre> |
| 129 | </div> |
| 130 | |
| 131 | <div class="method"> |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 132 | <code class="details" id="claimwebsite">claimwebsite(merchantId, accountId, overwrite=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 133 | <pre>Claims the website of a Merchant Center sub-account. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 134 | |
| 135 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 136 | 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) |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 137 | accountId: string, The ID of the account whose website is claimed. (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 138 | overwrite: boolean, Only available to selected merchants. When set to `True`, this flag removes any existing claim on the requested website by another account and replaces it with a claim from this account. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 139 | |
| 140 | Returns: |
| 141 | An object of the form: |
| 142 | |
| 143 | { |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 144 | "kind": "content#accountsClaimWebsiteResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accountsClaimWebsiteResponse". |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 145 | }</pre> |
| 146 | </div> |
| 147 | |
| 148 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 149 | <code class="details" id="custombatch">custombatch(body=None, dryRun=None)</code> |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 150 | <pre>Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request. |
| 151 | |
| 152 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 153 | body: object, The request body. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 154 | The object takes the form of: |
| 155 | |
| 156 | { |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 157 | "entries": [ # The request entries to be processed in the batch. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 158 | { # A batch entry encoding a single non-batch accounts request. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 159 | "account": { # Account data. After the creation of a new account it may take a few minutes before it is 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`. |
| 160 | "adultContent": True or False, # Indicates whether the merchant sells adult content. |
| 161 | "adwordsLinks": [ # List of linked AdWords 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 AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list. |
| 162 | { |
| 163 | "adwordsId": "A String", # Customer ID of the AdWords account. |
| 164 | "status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google AdWords 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. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 165 | # |
| 166 | # Acceptable values are: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 167 | # - "`active`" |
| 168 | # - "`pending`" |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 169 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 170 | ], |
| 171 | "businessInformation": { # The business information of the account. |
| 172 | "address": { # The address of the business. |
| 173 | "country": "A String", # CLDR country code (e.g. "US"). |
| 174 | "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). |
| 175 | "postalCode": "A String", # Postal code or ZIP (e.g. "94043"). |
| 176 | "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). |
| 177 | "streetAddress": "A String", # Street-level part of the address. |
| 178 | }, |
| 179 | "customerService": { # The customer service information of the business. |
| 180 | "email": "A String", # Customer service email. |
| 181 | "phoneNumber": "A String", # Customer service phone number. |
| 182 | "url": "A String", # Customer service URL. |
| 183 | }, |
| 184 | "phoneNumber": "A String", # The phone number of the business. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 185 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 186 | "googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account. |
| 187 | "gmbEmail": "A String", # The GMB email address of which a specific account within a GMB account. A sample account within a GMB account could be a business account with set of locations, managed under the GMB account. |
| 188 | "status": "A String", # Status of the link between this Merchant Center account and the GMB account. |
| 189 | # |
| 190 | # Acceptable values are: |
| 191 | # - "`active`" |
| 192 | # - "`pending`" |
| 193 | }, |
| 194 | "id": "A String", # Required for update. Merchant Center account ID. |
| 195 | "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "`content#account`" |
| 196 | "name": "A String", # Required. Display name for the account. |
| 197 | "reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided. |
| 198 | "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account. |
| 199 | "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user. |
| 200 | { |
| 201 | "admin": True or False, # Whether user is an admin. |
| 202 | "emailAddress": "A String", # User's email address. |
| 203 | "orderManager": True or False, # Whether user is an order manager. |
| 204 | "paymentsAnalyst": True or False, # Whether user can access payment statements. |
| 205 | "paymentsManager": True or False, # Whether user can manage payment settings. |
| 206 | }, |
| 207 | ], |
| 208 | "websiteUrl": "A String", # The merchant's website. |
| 209 | "youtubeChannelLinks": [ # List of 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. |
| 210 | { |
| 211 | "channelId": "A String", # Channel ID. |
| 212 | "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. |
| 213 | }, |
| 214 | ], |
| 215 | }, |
| 216 | "accountId": "A String", # The ID of the targeted account. Only defined if the method is not `insert`. |
| 217 | "batchId": 42, # An entry ID, unique within the batch request. |
| 218 | "force": True or False, # Whether the account should be deleted if the account has offers. Only applicable if the method is `delete`. |
| 219 | "linkRequest": { # Details about the `link` request. |
| 220 | "action": "A String", # Action to perform for this link. The `"request"` action is only available to select merchants. |
| 221 | # |
| 222 | # Acceptable values are: |
| 223 | # - "`approve`" |
| 224 | # - "`remove`" |
| 225 | # - "`request`" |
| 226 | "linkType": "A String", # Type of the link between the two accounts. |
| 227 | # |
| 228 | # Acceptable values are: |
| 229 | # - "`channelPartner`" |
| 230 | # - "`eCommercePlatform`" |
| 231 | "linkedAccountId": "A String", # The ID of the linked account. |
| 232 | }, |
| 233 | "merchantId": "A String", # The ID of the managing account. |
| 234 | "method": "A String", # The method of the batch entry. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 235 | # |
| 236 | # Acceptable values are: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 237 | # - "`claimWebsite`" |
| 238 | # - "`delete`" |
| 239 | # - "`get`" |
| 240 | # - "`insert`" |
| 241 | # - "`link`" |
| 242 | # - "`update`" |
| 243 | "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. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 244 | }, |
| 245 | ], |
| 246 | } |
| 247 | |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 248 | dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 249 | |
| 250 | Returns: |
| 251 | An object of the form: |
| 252 | |
| 253 | { |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 254 | "entries": [ # The result of the execution of the batch requests. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 255 | { # A batch entry encoding a single non-batch accounts response. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 256 | "account": { # Account data. After the creation of a new account it may take a few minutes before it is 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`. |
| 257 | "adultContent": True or False, # Indicates whether the merchant sells adult content. |
| 258 | "adwordsLinks": [ # List of linked AdWords 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 AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list. |
| 259 | { |
| 260 | "adwordsId": "A String", # Customer ID of the AdWords account. |
| 261 | "status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google AdWords 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. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 262 | # |
| 263 | # Acceptable values are: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 264 | # - "`active`" |
| 265 | # - "`pending`" |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 266 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 267 | ], |
| 268 | "businessInformation": { # The business information of the account. |
| 269 | "address": { # The address of the business. |
| 270 | "country": "A String", # CLDR country code (e.g. "US"). |
| 271 | "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). |
| 272 | "postalCode": "A String", # Postal code or ZIP (e.g. "94043"). |
| 273 | "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). |
| 274 | "streetAddress": "A String", # Street-level part of the address. |
| 275 | }, |
| 276 | "customerService": { # The customer service information of the business. |
| 277 | "email": "A String", # Customer service email. |
| 278 | "phoneNumber": "A String", # Customer service phone number. |
| 279 | "url": "A String", # Customer service URL. |
| 280 | }, |
| 281 | "phoneNumber": "A String", # The phone number of the business. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 282 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 283 | "googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account. |
| 284 | "gmbEmail": "A String", # The GMB email address of which a specific account within a GMB account. A sample account within a GMB account could be a business account with set of locations, managed under the GMB account. |
| 285 | "status": "A String", # Status of the link between this Merchant Center account and the GMB account. |
| 286 | # |
| 287 | # Acceptable values are: |
| 288 | # - "`active`" |
| 289 | # - "`pending`" |
| 290 | }, |
| 291 | "id": "A String", # Required for update. Merchant Center account ID. |
| 292 | "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "`content#account`" |
| 293 | "name": "A String", # Required. Display name for the account. |
| 294 | "reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided. |
| 295 | "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account. |
| 296 | "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user. |
| 297 | { |
| 298 | "admin": True or False, # Whether user is an admin. |
| 299 | "emailAddress": "A String", # User's email address. |
| 300 | "orderManager": True or False, # Whether user is an order manager. |
| 301 | "paymentsAnalyst": True or False, # Whether user can access payment statements. |
| 302 | "paymentsManager": True or False, # Whether user can manage payment settings. |
| 303 | }, |
| 304 | ], |
| 305 | "websiteUrl": "A String", # The merchant's website. |
| 306 | "youtubeChannelLinks": [ # List of 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. |
| 307 | { |
| 308 | "channelId": "A String", # Channel ID. |
| 309 | "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. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 310 | }, |
| 311 | ], |
| 312 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 313 | "batchId": 42, # The ID of the request entry this entry responds to. |
| 314 | "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed. |
| 315 | "code": 42, # The HTTP status of the first error in `errors`. |
| 316 | "errors": [ # A list of errors. |
| 317 | { # An error returned by the API. |
| 318 | "domain": "A String", # The domain of the error. |
| 319 | "message": "A String", # A description of the error. |
| 320 | "reason": "A String", # The error code. |
| 321 | }, |
| 322 | ], |
| 323 | "message": "A String", # The message of the first error in `errors`. |
| 324 | }, |
| 325 | "kind": "content#accountsCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "`content#accountsCustomBatchResponseEntry`" |
| 326 | "linkStatus": "A String", # Deprecated. This field is never set. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 327 | # |
| 328 | # Acceptable values are: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 329 | # - "`active`" |
| 330 | # - "`inactive`" |
| 331 | # - "`pending`" |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 332 | }, |
| 333 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 334 | "kind": "content#accountsCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accountsCustomBatchResponse". |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 335 | }</pre> |
| 336 | </div> |
| 337 | |
| 338 | <div class="method"> |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 339 | <code class="details" id="delete">delete(merchantId, accountId, dryRun=None, force=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 340 | <pre>Deletes a Merchant Center sub-account. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 341 | |
| 342 | Args: |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 343 | 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) |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 344 | accountId: string, The ID of the account. (required) |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 345 | dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 346 | force: boolean, Flag to delete sub-accounts with products. The default value is false. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 347 | </pre> |
| 348 | </div> |
| 349 | |
| 350 | <div class="method"> |
| 351 | <code class="details" id="get">get(merchantId, accountId)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 352 | <pre>Retrieves a Merchant Center account. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 353 | |
| 354 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 355 | 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) |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 356 | accountId: string, The ID of the account. (required) |
| 357 | |
| 358 | Returns: |
| 359 | An object of the form: |
| 360 | |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 361 | { # Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, and update require the admin role. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 362 | "adultContent": True or False, # Indicates whether the merchant sells adult content. |
| 363 | "adwordsLinks": [ # List of linked AdWords 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 AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list. |
| 364 | { |
| 365 | "adwordsId": "A String", # Customer ID of the AdWords account. |
| 366 | "status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google AdWords 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. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 367 | # |
| 368 | # Acceptable values are: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 369 | # - "`active`" |
| 370 | # - "`pending`" |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 371 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 372 | ], |
| 373 | "businessInformation": { # The business information of the account. |
| 374 | "address": { # The address of the business. |
| 375 | "country": "A String", # CLDR country code (e.g. "US"). |
| 376 | "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). |
| 377 | "postalCode": "A String", # Postal code or ZIP (e.g. "94043"). |
| 378 | "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). |
| 379 | "streetAddress": "A String", # Street-level part of the address. |
| 380 | }, |
| 381 | "customerService": { # The customer service information of the business. |
| 382 | "email": "A String", # Customer service email. |
| 383 | "phoneNumber": "A String", # Customer service phone number. |
| 384 | "url": "A String", # Customer service URL. |
| 385 | }, |
| 386 | "phoneNumber": "A String", # The phone number of the business. |
| 387 | }, |
| 388 | "googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account. |
| 389 | "gmbEmail": "A String", # The GMB email address of which a specific account within a GMB account. A sample account within a GMB account could be a business account with set of locations, managed under the GMB account. |
| 390 | "status": "A String", # Status of the link between this Merchant Center account and the GMB account. |
| 391 | # |
| 392 | # Acceptable values are: |
| 393 | # - "`active`" |
| 394 | # - "`pending`" |
| 395 | }, |
| 396 | "id": "A String", # Required for update. Merchant Center account ID. |
| 397 | "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "`content#account`" |
| 398 | "name": "A String", # Required. Display name for the account. |
| 399 | "reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided. |
| 400 | "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account. |
| 401 | "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user. |
| 402 | { |
| 403 | "admin": True or False, # Whether user is an admin. |
| 404 | "emailAddress": "A String", # User's email address. |
| 405 | "orderManager": True or False, # Whether user is an order manager. |
| 406 | "paymentsAnalyst": True or False, # Whether user can access payment statements. |
| 407 | "paymentsManager": True or False, # Whether user can manage payment settings. |
| 408 | }, |
| 409 | ], |
| 410 | "websiteUrl": "A String", # The merchant's website. |
| 411 | "youtubeChannelLinks": [ # List of 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. |
| 412 | { |
| 413 | "channelId": "A String", # Channel ID. |
| 414 | "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. |
| 415 | }, |
| 416 | ], |
| 417 | }</pre> |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 418 | </div> |
| 419 | |
| 420 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 421 | <code class="details" id="insert">insert(merchantId, body=None, dryRun=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 422 | <pre>Creates a Merchant Center sub-account. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 423 | |
| 424 | Args: |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 425 | merchantId: string, The ID of the managing account. This must be a multi-client account. (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 426 | body: object, The request body. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 427 | The object takes the form of: |
| 428 | |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 429 | { # Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, and update require the admin role. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 430 | "adultContent": True or False, # Indicates whether the merchant sells adult content. |
| 431 | "adwordsLinks": [ # List of linked AdWords 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 AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list. |
| 432 | { |
| 433 | "adwordsId": "A String", # Customer ID of the AdWords account. |
| 434 | "status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google AdWords 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. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 435 | # |
| 436 | # Acceptable values are: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 437 | # - "`active`" |
| 438 | # - "`pending`" |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 439 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 440 | ], |
| 441 | "businessInformation": { # The business information of the account. |
| 442 | "address": { # The address of the business. |
| 443 | "country": "A String", # CLDR country code (e.g. "US"). |
| 444 | "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). |
| 445 | "postalCode": "A String", # Postal code or ZIP (e.g. "94043"). |
| 446 | "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). |
| 447 | "streetAddress": "A String", # Street-level part of the address. |
| 448 | }, |
| 449 | "customerService": { # The customer service information of the business. |
| 450 | "email": "A String", # Customer service email. |
| 451 | "phoneNumber": "A String", # Customer service phone number. |
| 452 | "url": "A String", # Customer service URL. |
| 453 | }, |
| 454 | "phoneNumber": "A String", # The phone number of the business. |
| 455 | }, |
| 456 | "googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account. |
| 457 | "gmbEmail": "A String", # The GMB email address of which a specific account within a GMB account. A sample account within a GMB account could be a business account with set of locations, managed under the GMB account. |
| 458 | "status": "A String", # Status of the link between this Merchant Center account and the GMB account. |
| 459 | # |
| 460 | # Acceptable values are: |
| 461 | # - "`active`" |
| 462 | # - "`pending`" |
| 463 | }, |
| 464 | "id": "A String", # Required for update. Merchant Center account ID. |
| 465 | "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "`content#account`" |
| 466 | "name": "A String", # Required. Display name for the account. |
| 467 | "reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided. |
| 468 | "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account. |
| 469 | "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user. |
| 470 | { |
| 471 | "admin": True or False, # Whether user is an admin. |
| 472 | "emailAddress": "A String", # User's email address. |
| 473 | "orderManager": True or False, # Whether user is an order manager. |
| 474 | "paymentsAnalyst": True or False, # Whether user can access payment statements. |
| 475 | "paymentsManager": True or False, # Whether user can manage payment settings. |
| 476 | }, |
| 477 | ], |
| 478 | "websiteUrl": "A String", # The merchant's website. |
| 479 | "youtubeChannelLinks": [ # List of 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. |
| 480 | { |
| 481 | "channelId": "A String", # Channel ID. |
| 482 | "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. |
| 483 | }, |
| 484 | ], |
| 485 | } |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 486 | |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 487 | dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 488 | |
| 489 | Returns: |
| 490 | An object of the form: |
| 491 | |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 492 | { # Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, and update require the admin role. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 493 | "adultContent": True or False, # Indicates whether the merchant sells adult content. |
| 494 | "adwordsLinks": [ # List of linked AdWords 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 AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list. |
| 495 | { |
| 496 | "adwordsId": "A String", # Customer ID of the AdWords account. |
| 497 | "status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google AdWords 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. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 498 | # |
| 499 | # Acceptable values are: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 500 | # - "`active`" |
| 501 | # - "`pending`" |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 502 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 503 | ], |
| 504 | "businessInformation": { # The business information of the account. |
| 505 | "address": { # The address of the business. |
| 506 | "country": "A String", # CLDR country code (e.g. "US"). |
| 507 | "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). |
| 508 | "postalCode": "A String", # Postal code or ZIP (e.g. "94043"). |
| 509 | "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). |
| 510 | "streetAddress": "A String", # Street-level part of the address. |
| 511 | }, |
| 512 | "customerService": { # The customer service information of the business. |
| 513 | "email": "A String", # Customer service email. |
| 514 | "phoneNumber": "A String", # Customer service phone number. |
| 515 | "url": "A String", # Customer service URL. |
| 516 | }, |
| 517 | "phoneNumber": "A String", # The phone number of the business. |
| 518 | }, |
| 519 | "googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account. |
| 520 | "gmbEmail": "A String", # The GMB email address of which a specific account within a GMB account. A sample account within a GMB account could be a business account with set of locations, managed under the GMB account. |
| 521 | "status": "A String", # Status of the link between this Merchant Center account and the GMB account. |
| 522 | # |
| 523 | # Acceptable values are: |
| 524 | # - "`active`" |
| 525 | # - "`pending`" |
| 526 | }, |
| 527 | "id": "A String", # Required for update. Merchant Center account ID. |
| 528 | "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "`content#account`" |
| 529 | "name": "A String", # Required. Display name for the account. |
| 530 | "reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided. |
| 531 | "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account. |
| 532 | "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user. |
| 533 | { |
| 534 | "admin": True or False, # Whether user is an admin. |
| 535 | "emailAddress": "A String", # User's email address. |
| 536 | "orderManager": True or False, # Whether user is an order manager. |
| 537 | "paymentsAnalyst": True or False, # Whether user can access payment statements. |
| 538 | "paymentsManager": True or False, # Whether user can manage payment settings. |
| 539 | }, |
| 540 | ], |
| 541 | "websiteUrl": "A String", # The merchant's website. |
| 542 | "youtubeChannelLinks": [ # List of 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. |
| 543 | { |
| 544 | "channelId": "A String", # Channel ID. |
| 545 | "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. |
| 546 | }, |
| 547 | ], |
| 548 | }</pre> |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 549 | </div> |
| 550 | |
| 551 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 552 | <code class="details" id="link">link(merchantId, accountId, body=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 553 | <pre>Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 554 | |
| 555 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 556 | 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) |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 557 | accountId: string, The ID of the account that should be linked. (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 558 | body: object, The request body. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 559 | The object takes the form of: |
| 560 | |
| 561 | { |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 562 | "action": "A String", # Action to perform for this link. The `"request"` action is only available to select merchants. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 563 | # |
| 564 | # Acceptable values are: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 565 | # - "`approve`" |
| 566 | # - "`remove`" |
| 567 | # - "`request`" |
| 568 | "linkType": "A String", # Type of the link between the two accounts. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 569 | # |
| 570 | # Acceptable values are: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 571 | # - "`channelPartner`" |
| 572 | # - "`eCommercePlatform`" |
| 573 | "linkedAccountId": "A String", # The ID of the linked account. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 574 | } |
| 575 | |
| 576 | |
| 577 | Returns: |
| 578 | An object of the form: |
| 579 | |
| 580 | { |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 581 | "kind": "content#accountsLinkResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accountsLinkResponse". |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 582 | }</pre> |
| 583 | </div> |
| 584 | |
| 585 | <div class="method"> |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 586 | <code class="details" id="list">list(merchantId, maxResults=None, pageToken=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 587 | <pre>Lists the sub-accounts in your Merchant Center account. |
| 588 | |
| 589 | Args: |
| 590 | merchantId: string, The ID of the managing account. This must be a multi-client account. (required) |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 591 | maxResults: integer, The maximum number of accounts to return in the response, used for paging. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 592 | pageToken: string, The token returned by the previous request. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 593 | |
| 594 | Returns: |
| 595 | An object of the form: |
| 596 | |
| 597 | { |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 598 | "kind": "content#accountsListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accountsListResponse". |
| 599 | "nextPageToken": "A String", # The token for the retrieval of the next page of accounts. |
| 600 | "resources": [ |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 601 | { # Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, and update require the admin role. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 602 | "adultContent": True or False, # Indicates whether the merchant sells adult content. |
| 603 | "adwordsLinks": [ # List of linked AdWords 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 AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list. |
| 604 | { |
| 605 | "adwordsId": "A String", # Customer ID of the AdWords account. |
| 606 | "status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google AdWords 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. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 607 | # |
| 608 | # Acceptable values are: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 609 | # - "`active`" |
| 610 | # - "`pending`" |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 611 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 612 | ], |
| 613 | "businessInformation": { # The business information of the account. |
| 614 | "address": { # The address of the business. |
| 615 | "country": "A String", # CLDR country code (e.g. "US"). |
| 616 | "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). |
| 617 | "postalCode": "A String", # Postal code or ZIP (e.g. "94043"). |
| 618 | "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). |
| 619 | "streetAddress": "A String", # Street-level part of the address. |
| 620 | }, |
| 621 | "customerService": { # The customer service information of the business. |
| 622 | "email": "A String", # Customer service email. |
| 623 | "phoneNumber": "A String", # Customer service phone number. |
| 624 | "url": "A String", # Customer service URL. |
| 625 | }, |
| 626 | "phoneNumber": "A String", # The phone number of the business. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 627 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 628 | "googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account. |
| 629 | "gmbEmail": "A String", # The GMB email address of which a specific account within a GMB account. A sample account within a GMB account could be a business account with set of locations, managed under the GMB account. |
| 630 | "status": "A String", # Status of the link between this Merchant Center account and the GMB account. |
| 631 | # |
| 632 | # Acceptable values are: |
| 633 | # - "`active`" |
| 634 | # - "`pending`" |
| 635 | }, |
| 636 | "id": "A String", # Required for update. Merchant Center account ID. |
| 637 | "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "`content#account`" |
| 638 | "name": "A String", # Required. Display name for the account. |
| 639 | "reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided. |
| 640 | "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account. |
| 641 | "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user. |
| 642 | { |
| 643 | "admin": True or False, # Whether user is an admin. |
| 644 | "emailAddress": "A String", # User's email address. |
| 645 | "orderManager": True or False, # Whether user is an order manager. |
| 646 | "paymentsAnalyst": True or False, # Whether user can access payment statements. |
| 647 | "paymentsManager": True or False, # Whether user can manage payment settings. |
| 648 | }, |
| 649 | ], |
| 650 | "websiteUrl": "A String", # The merchant's website. |
| 651 | "youtubeChannelLinks": [ # List of 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. |
| 652 | { |
| 653 | "channelId": "A String", # Channel ID. |
| 654 | "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. |
| 655 | }, |
| 656 | ], |
| 657 | }, |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 658 | ], |
| 659 | }</pre> |
| 660 | </div> |
| 661 | |
| 662 | <div class="method"> |
| 663 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 664 | <pre>Retrieves the next page of results. |
| 665 | |
| 666 | Args: |
| 667 | previous_request: The request for the previous page. (required) |
| 668 | previous_response: The response from the request for the previous page. (required) |
| 669 | |
| 670 | Returns: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 671 | A request object that you can call 'execute()' on to request the next |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 672 | page. Returns None if there are no more items in the collection. |
| 673 | </pre> |
| 674 | </div> |
| 675 | |
| 676 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 677 | <code class="details" id="update">update(merchantId, accountId, body=None, dryRun=None)</code> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 678 | <pre>Updates a Merchant Center account. Any fields that are not provided are deleted from the resource. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 679 | |
| 680 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 681 | 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) |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 682 | accountId: string, The ID of the account. (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 683 | body: object, The request body. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 684 | The object takes the form of: |
| 685 | |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 686 | { # Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, and update require the admin role. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 687 | "adultContent": True or False, # Indicates whether the merchant sells adult content. |
| 688 | "adwordsLinks": [ # List of linked AdWords 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 AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list. |
| 689 | { |
| 690 | "adwordsId": "A String", # Customer ID of the AdWords account. |
| 691 | "status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google AdWords 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. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 692 | # |
| 693 | # Acceptable values are: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 694 | # - "`active`" |
| 695 | # - "`pending`" |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 696 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 697 | ], |
| 698 | "businessInformation": { # The business information of the account. |
| 699 | "address": { # The address of the business. |
| 700 | "country": "A String", # CLDR country code (e.g. "US"). |
| 701 | "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). |
| 702 | "postalCode": "A String", # Postal code or ZIP (e.g. "94043"). |
| 703 | "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). |
| 704 | "streetAddress": "A String", # Street-level part of the address. |
| 705 | }, |
| 706 | "customerService": { # The customer service information of the business. |
| 707 | "email": "A String", # Customer service email. |
| 708 | "phoneNumber": "A String", # Customer service phone number. |
| 709 | "url": "A String", # Customer service URL. |
| 710 | }, |
| 711 | "phoneNumber": "A String", # The phone number of the business. |
| 712 | }, |
| 713 | "googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account. |
| 714 | "gmbEmail": "A String", # The GMB email address of which a specific account within a GMB account. A sample account within a GMB account could be a business account with set of locations, managed under the GMB account. |
| 715 | "status": "A String", # Status of the link between this Merchant Center account and the GMB account. |
| 716 | # |
| 717 | # Acceptable values are: |
| 718 | # - "`active`" |
| 719 | # - "`pending`" |
| 720 | }, |
| 721 | "id": "A String", # Required for update. Merchant Center account ID. |
| 722 | "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "`content#account`" |
| 723 | "name": "A String", # Required. Display name for the account. |
| 724 | "reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided. |
| 725 | "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account. |
| 726 | "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user. |
| 727 | { |
| 728 | "admin": True or False, # Whether user is an admin. |
| 729 | "emailAddress": "A String", # User's email address. |
| 730 | "orderManager": True or False, # Whether user is an order manager. |
| 731 | "paymentsAnalyst": True or False, # Whether user can access payment statements. |
| 732 | "paymentsManager": True or False, # Whether user can manage payment settings. |
| 733 | }, |
| 734 | ], |
| 735 | "websiteUrl": "A String", # The merchant's website. |
| 736 | "youtubeChannelLinks": [ # List of 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. |
| 737 | { |
| 738 | "channelId": "A String", # Channel ID. |
| 739 | "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. |
| 740 | }, |
| 741 | ], |
| 742 | } |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 743 | |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 744 | dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 745 | |
| 746 | Returns: |
| 747 | An object of the form: |
| 748 | |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 749 | { # Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, and update require the admin role. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 750 | "adultContent": True or False, # Indicates whether the merchant sells adult content. |
| 751 | "adwordsLinks": [ # List of linked AdWords 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 AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list. |
| 752 | { |
| 753 | "adwordsId": "A String", # Customer ID of the AdWords account. |
| 754 | "status": "A String", # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google AdWords 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. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 755 | # |
| 756 | # Acceptable values are: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 757 | # - "`active`" |
| 758 | # - "`pending`" |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 759 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 760 | ], |
| 761 | "businessInformation": { # The business information of the account. |
| 762 | "address": { # The address of the business. |
| 763 | "country": "A String", # CLDR country code (e.g. "US"). |
| 764 | "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). |
| 765 | "postalCode": "A String", # Postal code or ZIP (e.g. "94043"). |
| 766 | "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). |
| 767 | "streetAddress": "A String", # Street-level part of the address. |
| 768 | }, |
| 769 | "customerService": { # The customer service information of the business. |
| 770 | "email": "A String", # Customer service email. |
| 771 | "phoneNumber": "A String", # Customer service phone number. |
| 772 | "url": "A String", # Customer service URL. |
| 773 | }, |
| 774 | "phoneNumber": "A String", # The phone number of the business. |
| 775 | }, |
| 776 | "googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account. |
| 777 | "gmbEmail": "A String", # The GMB email address of which a specific account within a GMB account. A sample account within a GMB account could be a business account with set of locations, managed under the GMB account. |
| 778 | "status": "A String", # Status of the link between this Merchant Center account and the GMB account. |
| 779 | # |
| 780 | # Acceptable values are: |
| 781 | # - "`active`" |
| 782 | # - "`pending`" |
| 783 | }, |
| 784 | "id": "A String", # Required for update. Merchant Center account ID. |
| 785 | "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "`content#account`" |
| 786 | "name": "A String", # Required. Display name for the account. |
| 787 | "reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided. |
| 788 | "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account. |
| 789 | "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user. |
| 790 | { |
| 791 | "admin": True or False, # Whether user is an admin. |
| 792 | "emailAddress": "A String", # User's email address. |
| 793 | "orderManager": True or False, # Whether user is an order manager. |
| 794 | "paymentsAnalyst": True or False, # Whether user can access payment statements. |
| 795 | "paymentsManager": True or False, # Whether user can manage payment settings. |
| 796 | }, |
| 797 | ], |
| 798 | "websiteUrl": "A String", # The merchant's website. |
| 799 | "youtubeChannelLinks": [ # List of 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. |
| 800 | { |
| 801 | "channelId": "A String", # Channel ID. |
| 802 | "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. |
| 803 | }, |
| 804 | ], |
| 805 | }</pre> |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 806 | </div> |
| 807 | |
| 808 | </body></html> |