REST Resource: accounts.regions

Ressource: Region

Stellt eine geografische Region dar, die Sie mit den Diensten RegionalInventory und ShippingSettings als Ziel verwenden können. Sie können Regionen als Sammlungen von Postleitzahlen definieren oder in einigen Ländern vordefinierte geografische Ziele verwenden. 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 definiert.

geotargetArea

object (GeoTargetArea)

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

regionalInventoryEligible

boolean

Nur Ausgabe. Gibt an, ob die Region in der Konfiguration für regionales Inventar verwendet werden kann.

shippingEligible

boolean

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

displayName

string

Optional. Der Anzeigename der Region.

PostalCodeArea

Eine Liste von Postleitzahlen, die das Gebiet definiert. Hinweis: Auf alle mit Postleitzahlen definierten Regionen kann über die Ressource ShippingSettings.postalCodeGroups des Kontos zugegriffen werden.

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

string

Erforderlich. CLDR-Regionscode 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 im Formatpräfix*, das die einschließende Untergrenze des Bereichs angibt, mit dem das Gebiet definiert wird. Beispielwerte: 94108, 9410*, 9*.

end

string

Optional. Eine Postleitzahl oder ein Muster im Format prefix*, das die einschließende Obergrenze des Bereichs angibt, mit dem das Gebiet definiert wird. Sie muss dieselbe Länge wie „postCodeRangeBegin“ haben: Wenn „postCodeRangeBegin“ eine Postleitzahl ist, muss „postCodeRangeEnd“ auch eine Postleitzahl sein. Wenn postalCodeRangeBegin ein Muster ist, muss „postCodeRangeEnd“ ein Muster mit derselben Präfixlänge sein. Optional: Wenn nichts festgelegt ist, wird das Gebiet als alle Postleitzahlen definiert, die mit „postCodeRangeBegin“ übereinstimmen.

GeoTargetArea

Eine Liste von geografischen Zielen, die das Gebiet definiert.

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

string (int64 format)

Erforderlich. Eine nicht leere Liste mit Standort-IDs. Sie müssen alle denselben Standorttyp haben (z. B. Bundesland).

Methoden

create

Erstellt eine Regionsdefinition in Ihrem Merchant Center-Konto.

delete

Löscht eine Regionsdefinition aus Ihrem Merchant Center-Konto.

get

Ruft eine in Ihrem Merchant Center-Konto definierte Region ab.

list

Listet die Regionen in Ihrem Merchant Center-Konto auf.

patch

Aktualisiert eine Regionsdefinition in Ihrem Merchant Center-Konto.