REST Resource: accounts.regions

Recurso: região

Representa uma região geográfica que pode ser usada como destino com os serviços RegionalInventory e ShippingSettings. É possível definir regiões como conjuntos de códigos postais ou, em alguns países, usando segmentações por área geográfica predefinidas. Saiba mais em Configurar regiões .

Representação JSON 
{
  "name": string,
  "postalCodeArea": {
    object (PostalCodeArea)
  },
  "geotargetArea": {
    object (GeoTargetArea)
  },
  "regionalInventoryEligible": boolean,
  "shippingEligible": boolean,
  "displayName": string
}
Campos
name

string

Identificador. O nome do recurso da região. Formato: accounts/{account}/regions/{region}
postalCodeArea

object (PostalCodeArea)

Opcional. Uma lista de códigos postais que define a área da região.
geotargetArea

object (GeoTargetArea)

Opcional. Uma lista de segmentações geográficas que define a área da região.
regionalInventoryEligible

boolean

Apenas saída. Indica se a região está qualificada para uso na configuração do inventário regional.
shippingEligible

boolean

Apenas saída. Indica se a região está qualificada para uso na configuração dos serviços de frete.
displayName

string

Opcional. O nome de exibição da região.

PostalCodeArea

Uma lista de códigos postais que define a área da região. Observação: todas as regiões definidas usando códigos postais podem ser acessadas por meio do recurso ShippingSettings.postalCodeGroups da conta.

Representação JSON 
{
  "regionCode": string,
  "postalCodes": [
    {
      object (PostalCodeRange)
    }
  ]
}
Campos
regionCode

string

Obrigatório. Código do território CLDR ou o país a que o grupo de códigos postais se aplica.
postalCodes[]

object (PostalCodeRange)

Obrigatório. Um intervalo de códigos postais.

PostalCodeRange

Um intervalo de códigos postais que define a área da região.

Representação JSON 
{
  "begin": string,
  "end": string
}
Campos
begin

string

Obrigatório. Um código postal ou um padrão de formato prefixo* que indica o limite inferior inclusivo do intervalo que define a área. Exemplos de valores: 94108, 9410*, 9*.
end

string

Opcional. Um código postal ou um padrão no formato prefix*, que indica o limite superior inclusivo do intervalo que define a área. Ele deve ter o mesmo comprimento que postalCodeRangeBegin: se postalCodeRangeBegin é um código postal, então postalCodeRangeEnd precisa ser código postal também. Se postalCodeRangeBegin é um padrão, postalCodeRangeEnd precisa ser padrão com o mesmo comprimento de prefixo. Opcional: se não for definida, a área será definida como sendo todos os códigos postais correspondentes a postalCodeRangeBegin.

GeoTargetArea

Uma lista de segmentações geográficas que define a área da região.

Representação JSON 
{
  "geotargetCriteriaIds": [
    string
  ]
}
Campos
geotargetCriteriaIds[]

string (int64 format)

Obrigatório. Uma lista não vazia de IDs de locais. Todos eles precisam ser do mesmo tipo de local (por exemplo, estado).

Métodos

create

 Cria uma definição de região na sua conta do Merchant Center.

delete

 Exclui uma definição de região da sua conta do Merchant Center.

get

 Recupera uma região definida na sua conta do Merchant Center.

list

 Lista as regiões na sua conta do Merchant Center.

patch

 Atualiza uma definição de região na sua conta do Merchant Center.