REST Resource: accounts.regions

Ressource: Region

Stellt eine geografische Region dar, die Sie sowohl mit den RegionalInventory- als auch den ShippingSettings-Diensten als Ziel verwenden können. Sie können Regionen als Sammlungen von Postleitzahlen oder in einigen Ländern mithilfe von vordefinierten Geozielen definieren. Weitere Informationen finden Sie unter Regionen einrichten .

JSON-Darstellung
{
  "name": string,
  "postalCodeArea": {
    object (PostalCodeArea)
  },
  "geotargetArea": {
    object (GeoTargetArea)
  },
  "regionalInventoryEligible": boolean,
  "shippingEligible": boolean,
  "displayName": string
}
Felder
name

string

Kennung. Der Ressourcenname der Region. Format: accounts/{account}/regions/{region}

postalCodeArea

object (PostalCodeArea)

Optional. Eine Liste von Postleitzahlen, die das Gebiet der Region definiert.

geotargetArea

object (GeoTargetArea)

Optional. Eine Liste von geografischen Zielen, die das Gebiet der Region definiert.

regionalInventoryEligible

boolean

Nur Ausgabe. Gibt an, ob die Region in der Konfiguration des regionalen Inventars verwendet werden kann.

shippingEligible

boolean

Nur Ausgabe. Gibt an, ob die Region in der Konfiguration der Versandservices verwendet werden kann.

displayName

string

Optional. Der Anzeigename der Region.

PostalCodeArea

Eine Liste von Postleitzahlen, die das Gebiet der Region definiert. Hinweis: Auf alle Regionen, die anhand von Postleitzahlen definiert sind, kann über die ShippingSettings.postalCodeGroups-Ressource des Kontos zugegriffen werden.

JSON-Darstellung
{
  "regionCode": string,
  "postalCodes": [
    {
      object (PostalCodeRange)
    }
  ]
}
Felder
regionCode

string

Erforderlich. CLDR-Regionalcode oder das Land, für das die Postleitzahlengruppe gilt.

postalCodes[]

object (PostalCodeRange)

Erforderlich. Einen Postleitzahlenbereich.

PostalCodeRange

Ein Postleitzahlenbereich, der die Region definiert.

JSON-Darstellung
{
  "begin": string,
  "end": string
}
Felder
begin

string

Erforderlich. Eine Postleitzahl oder ein Muster vom Typ „präfix*“, das die untere Grenze des Bereichs angibt, der das Gebiet definiert. Beispiele: 94108, 9410*, 9*.

end

string

Optional. Eine Postleitzahl oder ein Muster vom Typ prefix*, das die Obergrenze des Bereichs angibt, der das Gebiet definiert. Sie muss dieselbe Länge wie „postalCodeRangeBegin“ haben: Wenn „postalCodeRangeBegin“ eine Postleitzahl ist, muss „postalCodeRangeEnd“ auch eine Postleitzahl sein. Wenn „postalCodeRangeBegin“ ein Muster ist, muss „postalCodeRangeEnd“ ein Muster mit derselben Präfixlänge sein. Optional: Wenn nicht festgelegt, wird das Gebiet als alle Postleitzahlen definiert, die mit „postalCodeRangeBegin“ übereinstimmen.

GeoTargetArea

Eine Liste von geografischen Zielen, die das Gebiet der Region definiert.

JSON-Darstellung
{
  "geotargetCriteriaIds": [
    string
  ]
}
Felder
geotargetCriteriaIds[]

string (int64 format)

Erforderlich. Eine nicht leere Liste von Zielgebiets-IDs. Sie müssen alle vom selben Standorttyp sein (z. B. Bundesland).

Methoden

create

Erstellt eine Regionsdefinition in Ihrem Merchant Center-Konto.

delete

Eine Regionsdefinition wird aus Ihrem Merchant Center-Konto gelöscht.

get

Hier wird eine in Ihrem Merchant Center-Konto definierte Region abgerufen.

list

Hier werden die Regionen in Ihrem Merchant Center-Konto aufgeführt.

patch

Aktualisiert eine Regionsdefinition in Ihrem Merchant Center-Konto.