Returns the accounttax Resource.
Returns the homepage Resource.
Returns the issues Resource.
Returns the onlineReturnPolicies Resource.
Returns the programs Resource.
Returns the regions Resource.
Returns the shippingSettings Resource.
termsOfServiceAgreementStates()
Returns the termsOfServiceAgreementStates Resource.
Returns the users Resource.
Close httplib2 connections.
createAndConfigure(body=None, x__xgafv=None)
Creates a standalone Merchant Center account with additional configuration. Adds the user that makes the request as an admin for the new account.
Deletes the specified account regardless of its type: standalone, MCA or sub-account. Deleting an MCA leads to the deletion of all of its sub-accounts. Executing this method requires admin access.
Retrieves an account from your Merchant Center account. After inserting, updating, or deleting an account, it may take several minutes before changes take effect.
getBusinessIdentity(name, x__xgafv=None)
Retrieves the business identity of an account.
getBusinessInfo(name, x__xgafv=None)
Retrieves the business info of an account.
getHomepage(name, x__xgafv=None)
Retrieves a store's homepage.
getShippingSettings(name, x__xgafv=None)
Retrieve shipping setting information.
list(filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on.
listSubaccounts(provider, pageSize=None, pageToken=None, x__xgafv=None)
List all sub-accounts for a given multi client account. This is a convenience wrapper for the more powerful `ListAccounts` method. This method will produce the same results as calling `ListsAccounts` with the following filter: `relationship(providerId={parent} AND service(type="ACCOUNT_AGGREGATION"))`
Retrieves the next page of results.
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates an account regardless of its type: standalone, MCA or sub-account. Executing this method requires admin access.
updateBusinessIdentity(name, body=None, updateMask=None, x__xgafv=None)
Updates the business identity of an account. Executing this method requires admin access.
updateBusinessInfo(name, body=None, updateMask=None, x__xgafv=None)
Updates the business info of an account. Executing this method requires admin access.
updateHomepage(name, body=None, updateMask=None, x__xgafv=None)
Updates a store's homepage. Executing this method requires admin access.
close()
Close httplib2 connections.
createAndConfigure(body=None, x__xgafv=None)
Creates a standalone Merchant Center account with additional configuration. Adds the user that makes the request as an admin for the new account. Args: body: object, The request body. The object takes the form of: { # Request message for the `CreateAndConfigureAccount` method. "acceptTermsOfService": { # Reference to a Terms of Service resource. # Optional. The Terms of Service (ToS) to be accepted immediately upon account creation. "name": "A String", # Required. The resource name of the terms of service version. "regionCode": "A String", # Required. Region code as defined by [CLDR](https://cldr.unicode.org/). This is either a country when the ToS applies specifically to that country or `001` when it applies globally. }, "account": { # An account. # Required. The account to be created. "accountId": "A String", # Output only. The ID of the account. "accountName": "A String", # Required. A human-readable name of the account. See [store name](https://support.google.com/merchants/answer/160556) and [business name](https://support.google.com/merchants/answer/12159159) for more information. "adultContent": True or False, # Whether this account contains adult content. "languageCode": "A String", # Required. The account's [BCP-47 language code](https://tools.ietf.org/html/bcp47), such as `en-US` or `sr-Latn`. "name": "A String", # Identifier. The resource name of the account. Format: `accounts/{account}` "testAccount": True or False, # Output only. Whether this is a test account. "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The time zone of the account. On writes, `time_zone` sets both the `reporting_time_zone` and the `display_time_zone`. For reads, `time_zone` always returns the `display_time_zone`. If `display_time_zone` doesn't exist for your account, `time_zone` is empty. "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". }, }, "service": [ # Optional. If specified, an account service between the account to be created and the provider account is initialized as part of the creation. { # Additional instructions to add account services during creation of the account. "accountAggregation": { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } # The provider is an aggregator for the account. }, "provider": "A String", # Optional. The provider of the service. Format: `accounts/{account}` }, ], "users": [ # Optional. Users to be added to the account. { # Request message for the `CreateUser` method. "parent": "A String", # Required. The resource name of the account for which a user will be created. Format: `accounts/{account}` "user": { # A [user](https://support.google.com/merchants/answer/12160472). # Required. The user to create. "accessRights": [ # Optional. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has. "A String", ], "name": "A String", # Identifier. The resource name of the user. Format: `accounts/{account}/user/{email}` Use `me` to refer to your own email address, for example `accounts/{account}/users/me`. "state": "A String", # Output only. The state of the user. }, "userId": "A String", # Required. The email address of the user (for example, `john.doe@gmail.com`). }, ], } x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # An account. "accountId": "A String", # Output only. The ID of the account. "accountName": "A String", # Required. A human-readable name of the account. See [store name](https://support.google.com/merchants/answer/160556) and [business name](https://support.google.com/merchants/answer/12159159) for more information. "adultContent": True or False, # Whether this account contains adult content. "languageCode": "A String", # Required. The account's [BCP-47 language code](https://tools.ietf.org/html/bcp47), such as `en-US` or `sr-Latn`. "name": "A String", # Identifier. The resource name of the account. Format: `accounts/{account}` "testAccount": True or False, # Output only. Whether this is a test account. "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The time zone of the account. On writes, `time_zone` sets both the `reporting_time_zone` and the `display_time_zone`. For reads, `time_zone` always returns the `display_time_zone`. If `display_time_zone` doesn't exist for your account, `time_zone` is empty. "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". }, }
delete(name, x__xgafv=None)
Deletes the specified account regardless of its type: standalone, MCA or sub-account. Deleting an MCA leads to the deletion of all of its sub-accounts. Executing this method requires admin access. Args: name: string, Required. The name of the account to delete. Format: `accounts/{account}` (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } }
get(name, x__xgafv=None)
Retrieves an account from your Merchant Center account. After inserting, updating, or deleting an account, it may take several minutes before changes take effect. Args: name: string, Required. The name of the account to retrieve. Format: `accounts/{account}` (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # An account. "accountId": "A String", # Output only. The ID of the account. "accountName": "A String", # Required. A human-readable name of the account. See [store name](https://support.google.com/merchants/answer/160556) and [business name](https://support.google.com/merchants/answer/12159159) for more information. "adultContent": True or False, # Whether this account contains adult content. "languageCode": "A String", # Required. The account's [BCP-47 language code](https://tools.ietf.org/html/bcp47), such as `en-US` or `sr-Latn`. "name": "A String", # Identifier. The resource name of the account. Format: `accounts/{account}` "testAccount": True or False, # Output only. Whether this is a test account. "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The time zone of the account. On writes, `time_zone` sets both the `reporting_time_zone` and the `display_time_zone`. For reads, `time_zone` always returns the `display_time_zone`. If `display_time_zone` doesn't exist for your account, `time_zone` is empty. "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". }, }
getBusinessIdentity(name, x__xgafv=None)
Retrieves the business identity of an account. Args: name: string, Required. The resource name of the business identity. Format: `accounts/{account}/businessIdentity` (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # Collection of information related to the [identity of a business](https://support.google.com/merchants/answer/12564247). "blackOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being black-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers. "identityDeclaration": "A String", # Required. The declaration of identity for this attribute. }, "latinoOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being latino-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers. "identityDeclaration": "A String", # Required. The declaration of identity for this attribute. }, "name": "A String", # Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity` "promotionsConsent": "A String", # Optional. Whether the identity attributes may be used for promotions. "smallBusiness": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as a small business. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces. "identityDeclaration": "A String", # Required. The declaration of identity for this attribute. }, "veteranOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being veteran-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers. "identityDeclaration": "A String", # Required. The declaration of identity for this attribute. }, "womenOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being women-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers. "identityDeclaration": "A String", # Required. The declaration of identity for this attribute. }, }
getBusinessInfo(name, x__xgafv=None)
Retrieves the business info of an account. Args: name: string, Required. The resource name of the business info. Format: `accounts/{account}/businessInfo` (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # Collection of information related to a business. "address": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Optional. The address of the business. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated. "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en". "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines. "organization": "A String", # Optional. The name of the organization at the address. "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.). "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information. "A String", ], "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions. "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. }, "customerService": { # Customer service information. # Optional. The customer service of the business. "email": "A String", # Optional. The email address where customer service may be reached. "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Optional. The phone number where customer service may be called. "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes "extension": "A String", # The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future. "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (e.g. "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (e.g. US and CA). # A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code "number": "A String", # Required. The short code digits, without a leading plus ('+') or country calling code, e.g. "611". "regionCode": "A String", # Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB". Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag }, }, "uri": "A String", # Optional. The URI where customer service may be found. }, "name": "A String", # Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo` "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Output only. The phone number of the business. "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes "extension": "A String", # The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future. "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (e.g. "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (e.g. US and CA). # A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code "number": "A String", # Required. The short code digits, without a leading plus ('+') or country calling code, e.g. "611". "regionCode": "A String", # Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB". Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag }, }, "phoneVerificationState": "A String", # Output only. The phone verification state of the business. }
getHomepage(name, x__xgafv=None)
Retrieves a store's homepage. Args: name: string, Required. The name of the homepage to retrieve. Format: `accounts/{account}/homepage` (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # A store's homepage. "claimed": True or False, # Output only. Whether the homepage is claimed. See https://support.google.com/merchants/answer/176793. "name": "A String", # Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage` "uri": "A String", # Required. The URI (typically a URL) of the store's homepage. }
getShippingSettings(name, x__xgafv=None)
Retrieve shipping setting information. Args: name: string, Required. The name of the shipping setting to retrieve. Format: `accounts/{account}/shippingsetting` (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # The merchant account's [shipping setting]((https://support.google.com/merchants/answer/6069284). "etag": "A String", # Required. This field is used for avoid async issue. Make sure shipping setting data didn't change between get call and insert call. The user should do following steps: 1. Set etag field as empty string for initial shipping setting creation. 2. After initial creation, call get method to obtain an etag and current shipping setting data before call insert. 3. Modify to wanted shipping setting information. 4. Call insert method with the wanted shipping setting information with the etag obtained from step 2. 5. If shipping setting data changed between step 2 and step 4. Insert request will fail because the etag changes every time the shipping setting data changes. User should repeate step 2-4 with the new etag. "name": "A String", # Identifier. The resource name of the shipping setting. Format: `accounts/{account}/shippingSetting` "services": [ # Optional. The target account's list of services. { # Shipping service. "active": True or False, # Required. A boolean exposing the active status of the shipping service. "currencyCode": "A String", # The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups. "deliveryCountries": [ # Required. The CLDR territory code of the countries to which the service applies. "A String", ], "deliveryTime": { # Time spent in various aspects from order to the delivery of the product. # Required. Time spent in various aspects from order to the delivery of the product. "cutoffTime": { # Business days cutoff time definition. # Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST. "hour": 42, # Required. Hour of the cutoff time until which an order has to be placed to be processed in the same day. "minute": 42, # Required. Minute of the cutoff time until which an order has to be placed to be processed in the same day. "timeZone": "A String", # Required. [Timezone identifier](https://developers.google.com/adwords/api/docs/appendix/codes-formats#timezone-ids) For example "Europe/Zurich". }, "handlingBusinessDayConfig": { # Business days of the warehouse. # The business days during which orders can be handled. If not provided, Monday to Friday business days will be assumed. "businessDays": [ # Required. Regular business days. May not be empty. "A String", ], }, "maxHandlingDays": 42, # Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to `min_handling_days`. "maxTransitDays": 42, # Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to `min_transit_days`. "minHandlingDays": 42, # Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. "minTransitDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either `min_transit_days`, `max_transit_days` or `transit_time_table` must be set, but not both. "transitBusinessDayConfig": { # Business days of the warehouse. # The business days during which orders can be in-transit. If not provided, Monday to Friday business days will be assumed. "businessDays": [ # Required. Regular business days. May not be empty. "A String", ], }, "transitTimeTable": { # Transit time table, number of business days spent in transit based on row and column dimensions. Either `min_transit_days`, `max_transit_days` or `transit_time_table` can be set, but not both. # Transit time table, number of business days spent in transit based on row and column dimensions. Either `min_transit_days`, `max_transit_days` or `transit_time_table` can be set, but not both. "postalCodeGroupNames": [ # Required. A list of region names Region.name . The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. "A String", ], "rows": [ # Required. If there's only one dimension set of `postal_code_group_names` or `transit_time_labels`, there are multiple rows each with one value for that dimension. If there are two dimensions, each row corresponds to a `postal_code_group_names`, and columns (values) to a `transit_time_labels`. { # If there's only one dimension set of `postal_code_group_names` or `transit_time_labels`, there are multiple rows each with one value for that dimension. If there are two dimensions, each row corresponds to a `postal_code_group_names`, and columns (values) to a `transit_time_labels`. "values": [ # Required. Transit time range (min-max) in business days. { # Transit time range (min-max) in business days. "maxTransitDays": 42, # Must be greater than or equal to `min_transit_days`. "minTransitDays": 42, # Minimum transit time range in business days. 0 means same day delivery, 1 means next day delivery. }, ], }, ], "transitTimeLabels": [ # Required. A list of transit time labels. The last value can be `"all other labels"`. Example: `["food", "electronics", "all other labels"]`. "A String", ], }, "warehouseBasedDeliveryTimes": [ # Optional. Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in delivery time should be set. { # Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in `delivery_time` should be set. "carrier": "A String", # Required. Carrier, such as `"UPS"` or `"Fedex"`. "carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`. The name of the service must be in the eddSupportedServices list. "warehouse": "A String", # Required. Warehouse name. This should match warehouse }, ], }, "loyaltyPrograms": [ # Optional. Loyalty programs that this shipping service is limited to. { # [Loyalty program](https://support.google.com/merchants/answer/12922446) provided by a merchant. "loyaltyProgramTiers": [ # Optional. Loyalty program tier of this shipping service. { # Subset of a merchants loyalty program. "tierLabel": "A String", # The tier label [tier_label] sub-attribute differentiates offer level benefits between each tier. This value is also set in your program settings in Merchant Center, and is required for data source changes even if your loyalty program only has 1 tier. }, ], "programLabel": "A String", # This is the loyalty program label set in your loyalty program settings in Merchant Center. This sub-attribute allows Google to map your loyalty program to eligible offers. }, ], "minimumOrderValue": { # The price represented as a number and currency. # Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, "minimumOrderValueTable": { # Table of per store minimum order values for the pickup fulfillment type. # Table of per store minimum order values for the pickup fulfillment type. Cannot be set together with minimum_order_value. "storeCodeSetWithMovs": [ # Required. A list of store code sets sharing the same minimum order value (MOV). At least two sets are required and the last one must be empty, which signifies 'MOV for all other stores'. Each store code can only appear once across all the sets. All prices within a service must have the same currency. { # A list of store code sets sharing the same minimum order value. At least two sets are required and the last one must be empty, which signifies 'MOV for all other stores'. Each store code can only appear once across all the sets. All prices within a service must have the same currency. "storeCodes": [ # Optional. A list of unique store codes or empty for the catch all. "A String", ], "value": { # The price represented as a number and currency. # The minimum order value for the given stores. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, }, ], }, "rateGroups": [ # Optional. Shipping rate group definitions. Only the last one is allowed to have an empty `applicable_shipping_labels`, which means "everything else". The other `applicable_shipping_labels` must not overlap. { # Shipping rate group definitions. Only the last one is allowed to have an empty `applicable_shipping_labels`, which means "everything else". The other `applicable_shipping_labels` must not overlap. "applicableShippingLabels": [ # Required. A list of [shipping labels](https://support.google.com/merchants/answer/6324504) defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. "A String", ], "carrierRates": [ # Optional. A list of carrier rates that can be referred to by `main_table` or `single_value`. { # A list of carrier rates that can be referred to by `main_table` or `single_value`. "carrier": "A String", # Required. Carrier service, such as `"UPS"` or `"Fedex"`. "carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`. "flatAdjustment": { # The price represented as a number and currency. # Optional. Additive shipping rate modifier. Can be negative. For example `{ "amount_micros": 1, "currency_code" : "USD" }` adds $1 to the rate, `{ "amount_micros": -3, "currency_code" : "USD" }` removes $3 from the rate. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, "name": "A String", # Required. Name of the carrier rate. Must be unique per rate group. "originPostalCode": "A String", # Required. Shipping origin for this carrier rate. "percentageAdjustment": "A String", # Optional. Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example `"5.4"` increases the rate by 5.4%, `"-3"` decreases the rate by 3%. }, ], "mainTable": { # A table defining the rate group, when `single_value` is not expressive enough. # A table defining the rate group, when `single_value` is not expressive enough. Can only be set if `single_value` is not set. "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `num_items`, `postal_code_group_names`, or `location` must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension. "locations": [ # Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set. { # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set. "locationIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (For example, state). "A String", ], }, ], "numberOfItems": [ # Required. A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set. "A String", ], "postalCodeGroupNames": [ # Required. A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set. "A String", ], "prices": [ # Required. A list of inclusive order price upper bounds. The last price's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set. { # The price represented as a number and currency. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, ], "weights": [ # Required. A list of inclusive order weight upper bounds. The last weight's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set. { # The weight represented as the value in string and the unit. "amountMicros": "A String", # Required. The weight represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 kg = 1000000 micros). This field can also be set as infinity by setting to -1. This field only support -1 and positive value. "unit": "A String", # Required. The weight unit. Acceptable values are: kg and lb }, ], }, "name": "A String", # Name of the table. Required for subtables, ignored for the main table. "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `num_items`, `postal_code_group_names`, or `location` must be set. # Required. Headers of the table's rows. "locations": [ # Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set. { # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set. "locationIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (For example, state). "A String", ], }, ], "numberOfItems": [ # Required. A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set. "A String", ], "postalCodeGroupNames": [ # Required. A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set. "A String", ], "prices": [ # Required. A list of inclusive order price upper bounds. The last price's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set. { # The price represented as a number and currency. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, ], "weights": [ # Required. A list of inclusive order weight upper bounds. The last weight's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set. { # The weight represented as the value in string and the unit. "amountMicros": "A String", # Required. The weight represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 kg = 1000000 micros). This field can also be set as infinity by setting to -1. This field only support -1 and positive value. "unit": "A String", # Required. The weight unit. Acceptable values are: kg and lb }, ], }, "rows": [ # Required. The list of rows that constitute the table. Must have the same length as `row_headers`. { # Include a list of cells. "cells": [ # Required. The list of cells that constitute the row. Must have the same length as `columnHeaders` for two-dimensional tables, a length of 1 for one-dimensional tables. { # The single value of a rate group or the value of a rate group table's cell. Exactly one of `no_shipping`, `flat_rate`, `price_percentage`, `carrier_rateName`, `subtable_name` must be set. "carrierRate": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set. "flatRate": { # The price represented as a number and currency. # A flat rate. Can only be set if all other fields are not set. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, "noShipping": True or False, # If true, then the product can't be shipped. Must be true when set, can only be set if all other fields are not set. "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (For example, `"5.4"`). Can only be set if all other fields are not set. "subtable": "A String", # The name of a subtable. Can only be set in table cells (For example, not for single values), and only if all other fields are not set. }, ], }, ], }, "name": "A String", # Optional. Name of the rate group. If set has to be unique within shipping service. "singleValue": { # The single value of a rate group or the value of a rate group table's cell. Exactly one of `no_shipping`, `flat_rate`, `price_percentage`, `carrier_rateName`, `subtable_name` must be set. # The value of the rate group (For example flat rate $10). Can only be set if `main_table` and `subtables` are not set. "carrierRate": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set. "flatRate": { # The price represented as a number and currency. # A flat rate. Can only be set if all other fields are not set. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, "noShipping": True or False, # If true, then the product can't be shipped. Must be true when set, can only be set if all other fields are not set. "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (For example, `"5.4"`). Can only be set if all other fields are not set. "subtable": "A String", # The name of a subtable. Can only be set in table cells (For example, not for single values), and only if all other fields are not set. }, "subtables": [ # Optional. A list of subtables referred to by `main_table`. Can only be set if `main_table` is set. { # A table defining the rate group, when `single_value` is not expressive enough. "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `num_items`, `postal_code_group_names`, or `location` must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension. "locations": [ # Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set. { # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set. "locationIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (For example, state). "A String", ], }, ], "numberOfItems": [ # Required. A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set. "A String", ], "postalCodeGroupNames": [ # Required. A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set. "A String", ], "prices": [ # Required. A list of inclusive order price upper bounds. The last price's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set. { # The price represented as a number and currency. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, ], "weights": [ # Required. A list of inclusive order weight upper bounds. The last weight's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set. { # The weight represented as the value in string and the unit. "amountMicros": "A String", # Required. The weight represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 kg = 1000000 micros). This field can also be set as infinity by setting to -1. This field only support -1 and positive value. "unit": "A String", # Required. The weight unit. Acceptable values are: kg and lb }, ], }, "name": "A String", # Name of the table. Required for subtables, ignored for the main table. "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `num_items`, `postal_code_group_names`, or `location` must be set. # Required. Headers of the table's rows. "locations": [ # Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set. { # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set. "locationIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (For example, state). "A String", ], }, ], "numberOfItems": [ # Required. A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set. "A String", ], "postalCodeGroupNames": [ # Required. A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set. "A String", ], "prices": [ # Required. A list of inclusive order price upper bounds. The last price's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set. { # The price represented as a number and currency. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, ], "weights": [ # Required. A list of inclusive order weight upper bounds. The last weight's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set. { # The weight represented as the value in string and the unit. "amountMicros": "A String", # Required. The weight represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 kg = 1000000 micros). This field can also be set as infinity by setting to -1. This field only support -1 and positive value. "unit": "A String", # Required. The weight unit. Acceptable values are: kg and lb }, ], }, "rows": [ # Required. The list of rows that constitute the table. Must have the same length as `row_headers`. { # Include a list of cells. "cells": [ # Required. The list of cells that constitute the row. Must have the same length as `columnHeaders` for two-dimensional tables, a length of 1 for one-dimensional tables. { # The single value of a rate group or the value of a rate group table's cell. Exactly one of `no_shipping`, `flat_rate`, `price_percentage`, `carrier_rateName`, `subtable_name` must be set. "carrierRate": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set. "flatRate": { # The price represented as a number and currency. # A flat rate. Can only be set if all other fields are not set. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, "noShipping": True or False, # If true, then the product can't be shipped. Must be true when set, can only be set if all other fields are not set. "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (For example, `"5.4"`). Can only be set if all other fields are not set. "subtable": "A String", # The name of a subtable. Can only be set in table cells (For example, not for single values), and only if all other fields are not set. }, ], }, ], }, ], }, ], "serviceName": "A String", # Required. Free-form name of the service. Must be unique within target account. "shipmentType": "A String", # Type of locations this service ships orders to. "storeConfig": { # A list of stores your products are delivered from. This is only valid for the local delivery shipment type. # A list of stores your products are delivered from. This is only valid for the local delivery shipment type. "cutoffConfig": { # Configs related to local delivery ends for the day. # Configs related to local delivery ends for the day. "localCutoffTime": { # Time that local delivery ends for the day. # Time that local delivery ends for the day. "hour": "A String", # Hour local delivery orders must be placed by to process the same day. "minute": "A String", # Minute local delivery orders must be placed by to process the same day. }, "noDeliveryPostCutoff": True or False, # Merchants can opt-out of showing n+1 day local delivery when they have a shipping service configured to n day local delivery. For example, if the shipping service defines same-day delivery, and it's past the cut-off, setting this field to `true` results in the calculated shipping service rate returning `NO_DELIVERY_POST_CUTOFF`. In the same example, setting this field to `false` results in the calculated shipping time being one day. This is only for local delivery. "storeCloseOffsetHours": "A String", # Only valid with local delivery fulfillment. Represents cutoff time as the number of hours before store closing. Mutually exclusive with `local_cutoff_time`. }, "serviceRadius": { # Maximum delivery radius. This is only required for the local delivery shipment type. # Maximum delivery radius. This is only required for the local delivery shipment type. "unit": "A String", # Unit can differ based on country, it is parameterized to include miles and kilometers. "value": "A String", # Integer value of distance. }, "storeCodes": [ # Optional. A list of store codes that provide local delivery. If empty, then `all_stores` must be true. "A String", ], "storeServiceType": "A String", # Indicates whether all stores, or selected stores, listed by this merchant provide local delivery. }, }, ], "warehouses": [ # Optional. A list of warehouses which can be referred to in `services`. { # A fulfillment warehouse, which stores and handles inventory. Next tag: 7 "businessDayConfig": { # Business days of the warehouse. # Business days of the warehouse. If not set, will be Monday to Friday by default. "businessDays": [ # Required. Regular business days. May not be empty. "A String", ], }, "cutoffTime": { # The latest time of day that an order can be accepted and begin processing. Later orders will be processed in the next day. The time is based on the warehouse postal code. # Required. The latest time of day that an order can be accepted and begin processing. Later orders will be processed in the next day. The time is based on the warehouse postal code. "hour": 42, # Required. Hour of the cutoff time until which an order has to be placed to be processed in the same day by the warehouse. Hour is based on the timezone of warehouse. "minute": 42, # Required. Minute of the cutoff time until which an order has to be placed to be processed in the same day by the warehouse. Minute is based on the timezone of warehouse. }, "handlingDays": "A String", # Required. The number of days it takes for this warehouse to pack up and ship an item. This is on the warehouse level, but can be overridden on the offer level based on the attributes of an item. "name": "A String", # Required. The name of the warehouse. Must be unique within account. "shippingAddress": { # Shipping address of the warehouse. # Required. Shipping address of the warehouse. "administrativeArea": "A String", # Required. Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). "city": "A String", # Required. City, town or commune. May also include dependent localities or sublocalities (For example neighborhoods or suburbs). "postalCode": "A String", # Required. Postal code or ZIP (For example "94043"). "regionCode": "A String", # Required. [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) (For example "US"). "streetAddress": "A String", # Street-level part of the address. For example: `111w 31st Street`. }, }, ], }
list(filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on. Args: filter: string, Optional. Returns only accounts that match the [filter](/merchant/api/guides/accounts/filter). For more details, see the [filter syntax reference](/merchant/api/guides/accounts/filter-syntax). pageSize: integer, Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500. pageToken: string, Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token. 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 `ListAccounts` method. "accounts": [ # The accounts matching the `ListAccountsRequest`. { # An account. "accountId": "A String", # Output only. The ID of the account. "accountName": "A String", # Required. A human-readable name of the account. See [store name](https://support.google.com/merchants/answer/160556) and [business name](https://support.google.com/merchants/answer/12159159) for more information. "adultContent": True or False, # Whether this account contains adult content. "languageCode": "A String", # Required. The account's [BCP-47 language code](https://tools.ietf.org/html/bcp47), such as `en-US` or `sr-Latn`. "name": "A String", # Identifier. The resource name of the account. Format: `accounts/{account}` "testAccount": True or False, # Output only. Whether this is a test account. "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The time zone of the account. On writes, `time_zone` sets both the `reporting_time_zone` and the `display_time_zone`. For reads, `time_zone` always returns the `display_time_zone`. If `display_time_zone` doesn't exist for your account, `time_zone` is empty. "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". }, }, ], "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. }
listSubaccounts(provider, pageSize=None, pageToken=None, x__xgafv=None)
List all sub-accounts for a given multi client account. This is a convenience wrapper for the more powerful `ListAccounts` method. This method will produce the same results as calling `ListsAccounts` with the following filter: `relationship(providerId={parent} AND service(type="ACCOUNT_AGGREGATION"))` Args: provider: string, Required. The parent account. Format: `accounts/{account}` (required) pageSize: integer, Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500. pageToken: string, Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token. 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 `ListSubAccounts` method. "accounts": [ # The accounts for which the given parent account is an aggregator. { # An account. "accountId": "A String", # Output only. The ID of the account. "accountName": "A String", # Required. A human-readable name of the account. See [store name](https://support.google.com/merchants/answer/160556) and [business name](https://support.google.com/merchants/answer/12159159) for more information. "adultContent": True or False, # Whether this account contains adult content. "languageCode": "A String", # Required. The account's [BCP-47 language code](https://tools.ietf.org/html/bcp47), such as `en-US` or `sr-Latn`. "name": "A String", # Identifier. The resource name of the account. Format: `accounts/{account}` "testAccount": True or False, # Output only. Whether this is a test account. "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The time zone of the account. On writes, `time_zone` sets both the `reporting_time_zone` and the `display_time_zone`. For reads, `time_zone` always returns the `display_time_zone`. If `display_time_zone` doesn't exist for your account, `time_zone` is empty. "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". }, }, ], "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. }
listSubaccounts_next()
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.
list_next()
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.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates an account regardless of its type: standalone, MCA or sub-account. Executing this method requires admin access. Args: name: string, Identifier. The resource name of the account. Format: `accounts/{account}` (required) body: object, The request body. The object takes the form of: { # An account. "accountId": "A String", # Output only. The ID of the account. "accountName": "A String", # Required. A human-readable name of the account. See [store name](https://support.google.com/merchants/answer/160556) and [business name](https://support.google.com/merchants/answer/12159159) for more information. "adultContent": True or False, # Whether this account contains adult content. "languageCode": "A String", # Required. The account's [BCP-47 language code](https://tools.ietf.org/html/bcp47), such as `en-US` or `sr-Latn`. "name": "A String", # Identifier. The resource name of the account. Format: `accounts/{account}` "testAccount": True or False, # Output only. Whether this is a test account. "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The time zone of the account. On writes, `time_zone` sets both the `reporting_time_zone` and the `display_time_zone`. For reads, `time_zone` always returns the `display_time_zone`. If `display_time_zone` doesn't exist for your account, `time_zone` is empty. "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". }, } updateMask: string, Required. List of fields being updated. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # An account. "accountId": "A String", # Output only. The ID of the account. "accountName": "A String", # Required. A human-readable name of the account. See [store name](https://support.google.com/merchants/answer/160556) and [business name](https://support.google.com/merchants/answer/12159159) for more information. "adultContent": True or False, # Whether this account contains adult content. "languageCode": "A String", # Required. The account's [BCP-47 language code](https://tools.ietf.org/html/bcp47), such as `en-US` or `sr-Latn`. "name": "A String", # Identifier. The resource name of the account. Format: `accounts/{account}` "testAccount": True or False, # Output only. Whether this is a test account. "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The time zone of the account. On writes, `time_zone` sets both the `reporting_time_zone` and the `display_time_zone`. For reads, `time_zone` always returns the `display_time_zone`. If `display_time_zone` doesn't exist for your account, `time_zone` is empty. "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". }, }
updateBusinessIdentity(name, body=None, updateMask=None, x__xgafv=None)
Updates the business identity of an account. Executing this method requires admin access. Args: name: string, Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity` (required) body: object, The request body. The object takes the form of: { # Collection of information related to the [identity of a business](https://support.google.com/merchants/answer/12564247). "blackOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being black-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers. "identityDeclaration": "A String", # Required. The declaration of identity for this attribute. }, "latinoOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being latino-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers. "identityDeclaration": "A String", # Required. The declaration of identity for this attribute. }, "name": "A String", # Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity` "promotionsConsent": "A String", # Optional. Whether the identity attributes may be used for promotions. "smallBusiness": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as a small business. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces. "identityDeclaration": "A String", # Required. The declaration of identity for this attribute. }, "veteranOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being veteran-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers. "identityDeclaration": "A String", # Required. The declaration of identity for this attribute. }, "womenOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being women-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers. "identityDeclaration": "A String", # Required. The declaration of identity for this attribute. }, } updateMask: string, Required. List of fields being updated. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # Collection of information related to the [identity of a business](https://support.google.com/merchants/answer/12564247). "blackOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being black-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers. "identityDeclaration": "A String", # Required. The declaration of identity for this attribute. }, "latinoOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being latino-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers. "identityDeclaration": "A String", # Required. The declaration of identity for this attribute. }, "name": "A String", # Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity` "promotionsConsent": "A String", # Optional. Whether the identity attributes may be used for promotions. "smallBusiness": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as a small business. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces. "identityDeclaration": "A String", # Required. The declaration of identity for this attribute. }, "veteranOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being veteran-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers. "identityDeclaration": "A String", # Required. The declaration of identity for this attribute. }, "womenOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being women-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers. "identityDeclaration": "A String", # Required. The declaration of identity for this attribute. }, }
updateBusinessInfo(name, body=None, updateMask=None, x__xgafv=None)
Updates the business info of an account. Executing this method requires admin access. Args: name: string, Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo` (required) body: object, The request body. The object takes the form of: { # Collection of information related to a business. "address": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Optional. The address of the business. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated. "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en". "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines. "organization": "A String", # Optional. The name of the organization at the address. "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.). "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information. "A String", ], "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions. "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. }, "customerService": { # Customer service information. # Optional. The customer service of the business. "email": "A String", # Optional. The email address where customer service may be reached. "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Optional. The phone number where customer service may be called. "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes "extension": "A String", # The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future. "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (e.g. "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (e.g. US and CA). # A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code "number": "A String", # Required. The short code digits, without a leading plus ('+') or country calling code, e.g. "611". "regionCode": "A String", # Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB". Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag }, }, "uri": "A String", # Optional. The URI where customer service may be found. }, "name": "A String", # Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo` "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Output only. The phone number of the business. "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes "extension": "A String", # The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future. "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (e.g. "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (e.g. US and CA). # A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code "number": "A String", # Required. The short code digits, without a leading plus ('+') or country calling code, e.g. "611". "regionCode": "A String", # Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB". Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag }, }, "phoneVerificationState": "A String", # Output only. The phone verification state of the business. } updateMask: string, Required. List of fields being updated. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # Collection of information related to a business. "address": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Optional. The address of the business. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated. "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en". "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines. "organization": "A String", # Optional. The name of the organization at the address. "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.). "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information. "A String", ], "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions. "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. }, "customerService": { # Customer service information. # Optional. The customer service of the business. "email": "A String", # Optional. The email address where customer service may be reached. "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Optional. The phone number where customer service may be called. "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes "extension": "A String", # The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future. "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (e.g. "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (e.g. US and CA). # A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code "number": "A String", # Required. The short code digits, without a leading plus ('+') or country calling code, e.g. "611". "regionCode": "A String", # Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB". Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag }, }, "uri": "A String", # Optional. The URI where customer service may be found. }, "name": "A String", # Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo` "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Output only. The phone number of the business. "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes "extension": "A String", # The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future. "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (e.g. "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (e.g. US and CA). # A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code "number": "A String", # Required. The short code digits, without a leading plus ('+') or country calling code, e.g. "611". "regionCode": "A String", # Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB". Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag }, }, "phoneVerificationState": "A String", # Output only. The phone verification state of the business. }
updateHomepage(name, body=None, updateMask=None, x__xgafv=None)
Updates a store's homepage. Executing this method requires admin access. Args: name: string, Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage` (required) body: object, The request body. The object takes the form of: { # A store's homepage. "claimed": True or False, # Output only. Whether the homepage is claimed. See https://support.google.com/merchants/answer/176793. "name": "A String", # Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage` "uri": "A String", # Required. The URI (typically a URL) of the store's homepage. } updateMask: string, Required. List of fields being updated. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # A store's homepage. "claimed": True or False, # Output only. Whether the homepage is claimed. See https://support.google.com/merchants/answer/176793. "name": "A String", # Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage` "uri": "A String", # Required. The URI (typically a URL) of the store's homepage. }