REST Resource: accounts.programs

Ressource: Programm

Definiert die Teilnahme an einem bestimmten Programm für das angegebene Konto.

Programme bieten einen Mechanismus zum Hinzufügen von Funktionen zu Händlerkonten. Ein typisches Beispiel dafür ist das Programm Produkteinträge, mit dem Produkte aus dem Shop eines Händlers kostenlos auf Google präsentiert werden können.

JSON-Darstellung 
{
  "name": string,
  "documentationUri": string,
  "state": enum (State),
  "activeRegionCodes": [
    string
  ],
  "unmetRequirements": [
    {
      object (Requirement)
    }
  ]
}
Felder
name

string

Kennung. Der Ressourcenname des Programms. Format: accounts/{account}/programs/{program}
documentationUri

string

Nur Ausgabe. Die URL einer Merchant Center-Hilfeseite, auf der das Programm beschrieben wird.
state

enum (State)

Nur Ausgabe. Der Teilnahmestatus des Kontos am Programm.
activeRegionCodes[]

string

Nur Ausgabe. Die Regionen, in denen das Konto aktiv am Programm teilnimmt. Als aktive Regionen gelten Regionen, in denen alle Programmanforderungen für die Regionen erfüllt sind.

Regionscodes werden durch den CLDR definiert. Dies ist entweder ein Land, in dem das Programm speziell für dieses Land gilt, oder 001, wenn das Programm weltweit gilt.
unmetRequirements[]

object (Requirement)

Nur Ausgabe. Die Anforderungen, die das Konto noch nicht erfüllt hat und die sich auf die Teilnahme am Programm auswirken.

Status

Mögliche Programmteilnahmestatus für das Konto.

Enums
STATE_UNSPECIFIED Standardwert Dieser Wert wird nicht verwendet.
NOT_ELIGIBLE Das Konto ist nicht zur Teilnahme am Programm berechtigt.
ELIGIBLE Das Konto ist zur Teilnahme am Programm berechtigt.
ENABLED Das Programm ist für das Konto aktiviert.

Anforderung

Definiert eine Anforderung für die Teilnahme am Programm.

JSON-Darstellung 
{
  "title": string,
  "documentationUri": string,
  "affectedRegionCodes": [
    string
  ]
}
Felder
title

string

Nur Ausgabe. Name der Anforderung.
documentationUri

string

Nur Ausgabe. Die URL einer Hilfeseite, auf der die Anforderung beschrieben wird.
affectedRegionCodes[]

string

Nur Ausgabe. Die Regionen, die derzeit von dieser Anforderung betroffen sind, werden nicht erfüllt.

Regionscodes werden durch den CLDR definiert. Dies ist entweder ein Land, in dem das Programm speziell für dieses Land gilt, oder 001, wenn das Programm weltweit gilt.

Methoden

disable

 Deaktivierung der Teilnahme am angegebenen Programm für das Konto.

enable

 Für das Konto die Teilnahme am angegebenen Programm aktivieren.

get

 Ruft das angegebene Programm für das Konto ab.

list

 Ruft alle Programme für das Konto ab.