REST Resource: properties.dataStreams.sKAdNetworkConversionValueSchema

Ressource: SKAdNetworkConversionValueSchema

SKAdNetwork-Conversion-Wert-Schema eines iOS-Streams.

JSON-Darstellung
{
  "name": string,
  "postbackWindowOne": {
    object (PostbackWindow)
  },
  "postbackWindowTwo": {
    object (PostbackWindow)
  },
  "postbackWindowThree": {
    object (PostbackWindow)
  },
  "applyConversionValues": boolean
}
Felder
name

string

ID. Ressourcenname des Schemas. Dieses Element ist nur ein untergeordnetes Element eines iOS-Streams und es kann höchstens ein solches untergeordnetes Element unter einem iOS-Stream geben. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema

postbackWindowOne

object (PostbackWindow)

Erforderlich. Die Einstellungen für den Conversion-Wert für den ersten Postback-Zeitraum. Sie unterscheiden sich von den Werten für Postback-Fenster 2 und 3 dadurch, dass sie einen detaillierten Conversion-Wert (einen numerischen Wert) enthalten.

Conversion-Werte für dieses Postback-Fenster müssen festgelegt werden. Die anderen Fenster sind optional und übernehmen möglicherweise die Einstellungen dieses Fensters, wenn sie nicht festgelegt oder deaktiviert sind.

postbackWindowTwo

object (PostbackWindow)

Die Einstellungen für den Conversion-Wert für den zweiten Postback-Zeitraum.

Dieses Feld sollte nur konfiguriert werden, wenn für dieses Postback-Fenster unterschiedliche Conversion-Werte definiert werden müssen.

Wenn „enable_postback_window_settings“ für dieses Postback-Fenster auf „false“ gesetzt ist, werden die Werte aus „postbackWindowOne“ verwendet.

postbackWindowThree

object (PostbackWindow)

Die Einstellungen für den Conversion-Wert für den dritten Postback-Zeitraum.

Dieses Feld sollte nur festgelegt werden, wenn der Nutzer für diesen Postback-Zeitraum unterschiedliche Conversion-Werte definiert hat. Es ist zulässig, Fenster 3 zu konfigurieren, ohne Fenster 2 festzulegen. Wenn die Einstellungen für Fenster 1 und 2 festgelegt sind und „enable_postback_window_settings“ für dieses Postback-Fenster auf „false“ gesetzt ist, werden die Einstellungen aus „postbackWindowTwo“ übernommen.

applyConversionValues

boolean

Wenn diese Option aktiviert ist, werden mit dem Google Analytics SDK Conversion-Werte anhand dieser Schemadefinition festgelegt und das Schema wird in alle Google Ads-Konten exportiert, die mit dieser Property verknüpft sind. Wenn diese Option deaktiviert ist, werden mit dem GA SDK keine Conversion-Werte automatisch festgelegt und das Schema wird auch nicht in Google Ads exportiert.

PostbackWindow

Einstellungen für einen SKAdNetwork-Conversion-Postback-Zeitraum.

JSON-Darstellung
{
  "conversionValues": [
    {
      object (ConversionValues)
    }
  ],
  "postbackWindowSettingsEnabled": boolean
}
Felder
conversionValues[]

object (ConversionValues)

Die Reihenfolge des wiederholten Felds wird verwendet, um die Einstellungen für den Conversion-Wert zu priorisieren. Einträge mit niedrigerem Index haben eine höhere Priorität. Die erste Einstellung für den Conversion-Wert, die als „wahr“ ausgewertet wird, wird ausgewählt. Es muss mindestens einen Eintrag enthalten, wenn „enable_postback_window_settings“ auf „true“ gesetzt ist. Sie darf maximal 128 Einträge enthalten.

postbackWindowSettingsEnabled

boolean

Wenn „enable_postback_window_settings“ auf „true“ gesetzt ist, müssen „conversionValues“ angegeben werden. Sie werden verwendet, um festzulegen, wann und wie der Conversion-Wert auf einem Clientgerät festgelegt und das Schema in verknüpfte Google Ads-Konten exportiert wird. Wenn „false“, werden die Einstellungen nicht verwendet, aber beibehalten, falls sie in Zukunft verwendet werden. Das muss für „postbackWindowOne“ immer zutreffen.

ConversionValues

Einstellungen für den Conversion-Wert für einen Postback-Zeitraum für das SKAdNetwork-Conversion-Wert-Schema.

JSON-Darstellung
{
  "displayName": string,
  "coarseValue": enum (CoarseValue),
  "eventMappings": [
    {
      object (EventMapping)
    }
  ],
  "lockEnabled": boolean,
  "fineValue": integer
}
Felder
displayName

string

Anzeigename des SKAdNetwork-Conversion-Werts. Die maximal zulässige Länge des Anzeigenamens beträgt 50 UTF‑16-Codeeinheiten.

coarseValue

enum (CoarseValue)

Erforderlich. Ein grober Conversion-Wert.

Dieser Wert ist nicht zwangsläufig eindeutig.

eventMappings[]

object (EventMapping)

Ereignisbedingungen, die erfüllt sein müssen, damit dieser Conversion-Wert erreicht wird. Die Bedingungen in dieser Liste werden mit UND verknüpft. Wenn das Postback-Zeitfenster aktiviert ist, muss es mindestens einen und maximal drei Einträge enthalten.

lockEnabled

boolean

Bei „true“ sollte das SDK diesen Conversion-Wert für das aktuelle Postback-Zeitfenster verwenden.

fineValue

integer

Der detaillierte Conversion-Wert. Dies gilt nur für das erste Postback-Zeitfenster. Gültige Werte sind [0,63], beide einschließlich. Es muss für Postback-Fenster 1 festgelegt werden und darf nicht für Postback-Fenster 2 und 3 festgelegt werden. Dieser Wert ist nicht zwangsläufig eindeutig.

Wenn die Konfiguration für das erste Postback-Fenster für das zweite oder dritte Postback-Fenster wiederverwendet wird, hat dieses Feld keine Auswirkungen.

CoarseValue

Der grobe Conversion-Wert, der beim SDK-Aufruf „updatePostbackConversionValue“ festgelegt wird, wenn die Bedingungen für „ConversionValues.event_mappings“ erfüllt sind. Weitere Informationen finden Sie unter SKAdNetwork.CoarseConversionValue.

Enums
COARSE_VALUE_UNSPECIFIED Der grobe Wert wurde nicht angegeben.
COARSE_VALUE_LOW Grober Wert „Niedrig“.
COARSE_VALUE_MEDIUM Grober Wert des Mediums.
COARSE_VALUE_HIGH Grober Wert von „hoch“.

EventMapping

Bedingungen für Ereigniseinstellungen, die mit einem Ereignis übereinstimmen müssen.

JSON-Darstellung
{
  "eventName": string,
  "minEventCount": string,
  "maxEventCount": string,
  "minEventValue": number,
  "maxEventValue": number
}
Felder
eventName

string

Erforderlich. Name des Google Analytics-Ereignisses. Es muss immer festgelegt werden. Der Anzeigename darf maximal 40 UTF‑16-Codeeinheiten lang sein.

minEventCount

string (int64 format)

Mindestens einer der folgenden vier Mindest-/Höchstwerte muss festgelegt sein. Die festgelegten Werte werden mit AND verknüpft, um ein Ereignis zu qualifizieren. Die Mindestanzahl, wie oft das Ereignis eingetreten ist. Wenn diese Option nicht festgelegt ist, wird die Mindestanzahl von Ereignissen nicht geprüft.

maxEventCount

string (int64 format)

Die maximale Anzahl, wie oft das Ereignis eingetreten ist. Wenn dieser Wert nicht festgelegt ist, wird die maximale Anzahl von Ereignissen nicht geprüft.

minEventValue

number

Der Mindestumsatz, der durch das Ereignis generiert wurde. Die Währung für den Umsatz wird auf Property-Ebene definiert. Wenn dieser Wert nicht festgelegt ist, wird der Mindestwert für Ereignisse nicht geprüft.

maxEventValue

number

Der maximale Umsatz, der durch das Ereignis generiert wurde. Die Währung für den Umsatz wird auf Property-Ebene definiert. Wenn nicht festgelegt, wird der maximale Ereigniswert nicht geprüft.

Methoden

create

Erstellt ein SKAdNetworkConversionValueSchema.

delete

Löscht das Ziel-SKAdNetworkConversionValueSchema.

get

Sucht ein einzelnes SKAdNetworkConversionValueSchema nach.

list

Listet SKAdNetworkConversionValueSchema für einen Stream auf.

patch

Aktualisiert ein SKAdNetworkConversionValueSchema.