REST Resource: projects.locations.consumerEnforcementActions

Ressource: ConsumerEnforcementAction

Stellt eine Partnermaßnahme zur Durchsetzung der Händlervereinbarung des Partners dar.

JSON-Darstellung
{
  "name": string,
  "uid": string,
  "etag": string,
  "state": enum (State),
  "createTime": string,
  "updateTime": string,
  "succeedTime": string,
  "displayName": string,
  "labels": {
    string: string,
    ...
  },
  "consumerScope": {
    object (ConsumerScope)
  },
  "productScope": {
    object (ProductScope)
  },
  "denyReason": {
    object (DenyReason)
  },

  // Union field action can be only one of the following:
  "projectAccessRestrictionAction": {
    object (ProjectAccessRestrictionConfig)
  }
  // End of list of possible types for union field action.
}
Felder
name

string

ID. Name der ConsumerEnforcementAction-Ressource.

Format: projects/{project}/locations/{location}/consumerEnforcementActions/{consumerEnforcementAction}

uid

string

Nur Ausgabe. Eindeutige Kennung der Ressource.

etag

string

Diese Prüfsumme wird vom Server anhand des Werts anderer Felder berechnet und kann bei Aktualisierungs- und Löschanfragen gesendet werden, um sicherzustellen, dass der Client vor dem Fortfahren einen aktuellen Wert hat.

state

enum (State)

Nur Ausgabe. Der aktuelle Lebenszyklusstatus der Ressource.

createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel für die Erstellung der Ressource.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"

updateTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel der letzten Aktualisierung der Ressource.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"

succeedTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel für den Zeitpunkt, zu dem die Durchsetzungsmaßnahme erfolgreich war.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

displayName

string

Optional. Für Menschen lesbarer Anzeigename der Ressource. Die maximale Länge beträgt 63 Zeichen.

labels

map (key: string, value: string)

Optional. Benutzerdefinierte Labels für die Ressource.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

consumerScope

object (ConsumerScope)

Erforderlich. Nicht veränderbar. Umfang der Durchsetzungsmaßnahme für den Nutzer.

productScope

object (ProductScope)

Erforderlich. Nicht veränderbar. Produktbereich der Durchsetzungsmaßnahme.

denyReason

object (DenyReason)

Nur Ausgabe. Grund für die Ablehnung. Wird angezeigt, wenn der Ressourcenstatus DENIED ist.

Union-Feld action. Erforderlich. Die konfigurierte Erzwingungsaktion. Für action ist nur einer der folgenden Werte zulässig:
projectAccessRestrictionAction

object (ProjectAccessRestrictionConfig)

Optional. Nicht veränderbar. Beschränkt den Produktzugriff für Nutzerprojekte.

ProjectAccessRestrictionConfig

Konfiguration für eine Zugriffsbeschränkung, die für Nutzerprojekte gilt.

Wenn eine Zugriffsbeschränkung für ein Projekt gilt, kann das Projekt nicht als Clientprojekt in Anfragen verwendet werden, mit denen auf Dienste zugegriffen wird, die von den entsprechenden Produkten bereitgestellt werden. Die Zugriffsbeschränkung ist nicht destruktiv und ändert den Beschaffungsstatus des Nutzers nicht. Der Zugriff auf das Nutzerprojekt wird automatisch wiederhergestellt, wenn die Einschränkung gelöscht wird oder nicht mehr für ein Projekt gilt.

JSON-Darstellung
{
  "falsePositiveGuardDisabled": boolean
}
Felder
falsePositiveGuardDisabled

boolean

Optional. Steuert, ob Google Maßnahmen gegen falsch positive Ergebnisse ergreift.

Wenn diese Option aktiviert ist, schützt Google vor störenden Maßnahmen zur Durchsetzung, die sich aus Falsch-Positiv-Ergebnissen von Verstößen gegen die Anbietervereinbarung oder einer unbeabsichtigten, zu weit gefassten Durchsetzung durch den Partner ergeben könnten. Google trifft auf Grundlage der Google zur Verfügung stehenden Informationen eine eigene Entscheidung darüber, ob die Durchsetzungsmaßnahme fortgesetzt werden soll, und kann die Durchsetzungsmaßnahme nach eigenem Ermessen ablehnen. Google kann nach eigenem Ermessen Details zur Grundlage seiner Entscheidung angeben, wenn eine beantragte Durchsetzungsmaßnahme abgelehnt wird. Google ist jedoch nicht dazu verpflichtet und kann Entscheidungen auf Grundlage von Informationen treffen, die nicht mit dem Partner geteilt werden können. Wenn der Partner mit der Entscheidung nicht einverstanden ist, kann er ohne die Schutzfunktion eine neue Durchsetzungsmaßnahme ergreifen.

Bundesland

Stellt den Lebenszyklusstatus der Durchsetzungsmaßnahme dar.

Dieser Enum können in Zukunft neue Werte hinzugefügt werden.

Enums
STATE_UNSPECIFIED Nicht angegebener Zustand. Nicht in Verwendung.
RUNNING

Die Maßnahme wird ausgeführt. Dies ist der ursprüngliche Status der Ressource, der während der Ausführung des consumerEnforcementActions.create-Vorgangs mit langer Ausführungszeit beibehalten wird.

Wenn der Vorgang abgebrochen wird oder anderweitig endet, bevor die Durchsetzung erfolgt, wird die Ressource entfernt. Andernfalls wird der Ressourcenstatus nach Abschluss des Vorgangs in einen der folgenden Status aufgelöst.

  • Wenn die Maßnahme akzeptiert und erfolgreich angewendet wird, ändert sich der Status nach Abschluss in SUCCEEDED.
  • Wenn die Durchsetzungsmaßnahme abgelehnt wird, wechselt der Status nach Abschluss zu DENIED.
  • Wenn die Maßnahme nach der teilweisen Anwendung der Durchsetzungseffekte fehlschlägt, wird der Status in FAILED geändert, um den inkonsistenten teilweisen Durchsetzungsstatus widerzuspiegeln.
SUCCEEDED Die Maßnahme wurde akzeptiert und erfolgreich angewendet. Alle laufenden Auswirkungen der Maßnahme sind aktiv.
DENIED Die Durchsetzungsmaßnahme wurde aus dem in denyReason genannten Grund nicht akzeptiert und ist nicht in Kraft getreten.
FAILED Ein Statusübergang ist aufgrund eines vorübergehenden oder internen Systemfehlers fehlgeschlagen. Das Durchsetzungsverhalten kann inkonsistent sein. Wenn Sie eine Ressource in diesem Status löschen, werden alle laufenden Auswirkungen entfernt.

ConsumerScope

Gibt die Zielressourcenentität des Nutzers für die Durchsetzungsmaßnahme an.

JSON-Darstellung
{

  // Union field target_consumer_entity can be only one of the following:
  "project": string,
  "billingAccount": string,
  "organization": string
  // End of list of possible types for union field target_consumer_entity.
}
Felder
Union-Feld target_consumer_entity Erforderlich. Es muss genau eine Zielressourcen-ID festgelegt werden. Für target_consumer_entity ist nur einer der folgenden Werte zulässig:
project

string

Zielt auf eine einzelne Projektressource ab. Der Umfang der Maßnahme beschränkt sich auf das angegebene Projekt.

Muss zum Zeitpunkt der Erstellung der Durchsetzungsmaßnahme vorhanden sein. Muss im Format „project_number“ angegeben werden.

Format: projects/{project_number}

billingAccount

string

Zielt auf eine Rechnungskontoressource ab. Die Maßnahmen zur Durchsetzung umfassen das Rechnungskonto und alle damit verknüpften Projekte.

Dieser Bereich ist dynamisch. Alle Effekte, die zum Zeitpunkt der Erstellung der Durchsetzungsmaßnahme angewendet werden, werden auf die Entitäten im entsprechenden Bereich angewendet. Alle laufenden Auswirkungen der Durchsetzungsmaßnahme gelten für die betroffenen Einheiten zum jeweiligen Zeitpunkt.

Muss zum Zeitpunkt der Erstellung der Durchsetzungsmaßnahme vorhanden sein. Dieses Feld kann nicht verwendet werden, um ein übergeordnetes Reseller-Rechnungskonto als Ziel zu verwenden.

Format: billingAccounts/{billingAccount}

organization

string

Zielt auf eine Organisationsressource ab. Die Maßnahmen zur Durchsetzung umfassen alle Projekte in der Organisation sowie alle Rechnungskonten in der Organisation und alle Projekte, die mit diesen Rechnungskonten verknüpft sind.

Dieser Bereich ist dynamisch. Alle Effekte, die zum Zeitpunkt der Erstellung der Durchsetzungsmaßnahme angewendet werden, werden auf die Entitäten im entsprechenden Bereich angewendet. Alle laufenden Auswirkungen der Durchsetzungsmaßnahme gelten für die betroffenen Einheiten zum jeweiligen Zeitpunkt.

Muss zum Zeitpunkt der Erstellung der Durchsetzungsmaßnahme vorhanden sein.

Format: organizations/{organization}

ProductScope

Definiert den Produktbereich der Durchsetzungsmaßnahme.

JSON-Darstellung
{
  "aiplatformPublisherId": string
}
Felder
aiplatformPublisherId

string

Optional. Gilt für alle verwalteten Modellprodukte in AI Platform Model Garden, die der angegebenen Publisher-ID untergeordnet sind.

Im AI Platform Model Garden wird der Modell-Publisher durch ein publisher_id gekennzeichnet. Partner mit Produkten, die in Model Garden verfügbar sind, erhalten bei der ersten Registrierung eine eindeutige Publisher-ID. Es kann nur die eigene Publisher-ID eines Partners angegeben werden. Wenn Sie Ihre Publisher-ID nicht kennen, wenden Sie sich an den Partnersupport.

Format: {publisher_id} (z.B. google).

DenyReason

Erklärung, warum keine Durchsetzungsmaßnahme ergriffen wurde.

JSON-Darstellung
{
  "reasonCode": enum (ReasonCode),
  "detailMessage": string
}
Felder
reasonCode

enum (ReasonCode)

Nur Ausgabe. Der Ursachencode. Immer vorhanden, wenn die Durchsetzung abgelehnt wird.

detailMessage

string

Nur Ausgabe. Optionale zusätzliche menschenlesbare Nachricht, in der erklärt wird, warum die Durchsetzungsmaßnahme abgelehnt wurde.

ReasonCode

Code, der angibt, warum die Durchsetzungsmaßnahme von Google abgelehnt wurde.

Enums
REASON_CODE_UNSPECIFIED Nicht angegebene Ursache. Nicht in Verwendung.
EXEMPT Das Ziel-Consumer-Unternehmen (oder ein untergeordnetes Unternehmen in der Unternehmenshierarchie) ist von der API-initiierten Anwendung der angeforderten Durchsetzungsmaßnahme ausgenommen. Wenden Sie sich an Google, um die Durchsetzung gegenüber dem Nutzer fortzusetzen.
FALSE_POSITIVE_GUARD Die Durchsetzungsmaßnahme wurde abgelehnt, da der Modus für den Schutz vor Falschmeldungen angefordert wurde und der Schutz vor Falschmeldungen ausgelöst wurde.

Methoden

create

Erstellt eine ConsumerEnforcementAction-Ressource.

delete

Löscht eine ConsumerEnforcementAction-Ressource.

get

Ruft eine ConsumerEnforcementAction-Ressource anhand des Namens ab.

list

Listet ConsumerEnforcementActions unter einem übergeordneten Standort auf.

patch

Aktualisiert eine vorhandene ConsumerEnforcementAction-Ressource.