REST Resource: properties.dataStreams.sKAdNetworkConversionValueSchema

Recurso: SKAdNetworkConversionValueSchema

Esquema de valor da conversão da SKAdNetwork de um fluxo do iOS.

Representação JSON
{
  "name": string,
  "postbackWindowOne": {
    object (PostbackWindow)
  },
  "postbackWindowTwo": {
    object (PostbackWindow)
  },
  "postbackWindowThree": {
    object (PostbackWindow)
  },
  "applyConversionValues": boolean
}
Campos
name

string

Apenas saída. Nome do recurso do esquema. Ele será filho APENAS de um stream do iOS, e pode haver no máximo um filho desse tipo em um fluxo do iOS. Formato: Properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema

postbackWindowOne

object (PostbackWindow)

Obrigatório. As configurações do valor da conversão para a primeira janela de postback. Eles diferem dos valores da janela de postback dois e três porque contêm um valor de conversão granular "Fine" (um valor numérico).

É preciso definir os valores de conversão para essa janela de postback. As outras janelas são opcionais e podem herdar as configurações desta se não definidas ou desativadas.

postbackWindowTwo

object (PostbackWindow)

As configurações do valor da conversão para a segunda janela de postback.

Esse campo só deverá ser configurado se for necessário definir valores de conversão diferentes para essa janela de postback.

Se enable_postback_window_settings for definida como falsa nessa janela de postback, os valores de postbackWindowOne serão usados.

postbackWindowThree

object (PostbackWindow)

As configurações do valor da conversão para a terceira janela de postback.

Esse campo só deverá ser definido se o usuário tiver escolhido definir valores de conversão diferentes para essa janela de postback. É permitido configurar a janela 3 sem definir a janela 2. Caso as configurações das janelas 1 e 2 sejam definidas e enable_postback_window_settings esta janela de postback seja definida como "false", o esquema vai herdar as configurações de postbackWindowTwo.

applyConversionValues

boolean

Se ativado, o SDK do GA vai definir valores de conversão usando essa definição de esquema, que será exportado para todas as contas do Google Ads vinculadas a essa propriedade. Se desativado, o SDK do GA não vai definir automaticamente os valores de conversão, e o esquema não vai ser exportado para o Google Ads.

PostbackWindow

Configurações para uma janela de postback de conversão da SKAdNetwork.

Representação JSON
{
  "conversionValues": [
    {
      object (ConversionValues)
    }
  ],
  "postbackWindowSettingsEnabled": boolean
}
Campos
conversionValues[]

object (ConversionValues)

A ordem do campo repetido será usada para priorizar as configurações do valor da conversão. As entradas indexadas mais baixas têm prioridade maior. A primeira configuração de valor da conversão avaliada como verdadeira será selecionada. Ela precisa ter pelo menos uma entrada se enable_postback_window_settings estiver definida como "true". Pode ter no máximo 128 entradas.

postbackWindowSettingsEnabled

boolean

Se enable_postback_window_settings for verdadeira, o conversionValues precisará ser preenchido e será usado para determinar quando e como definir o valor da conversão em um dispositivo cliente e exportar o esquema para contas vinculadas do Google Ads. Se for definido como "false", as configurações não serão usadas, mas serão mantidas caso possam ser usadas no futuro. Isso precisa ser sempre verdadeiro para postbackWindowOne.

ConversionValues

Configurações do valor da conversão para uma janela de postback para o esquema de valor da conversão da SKAdNetwork.

Representação JSON
{
  "displayName": string,
  "coarseValue": enum (CoarseValue),
  "eventMappings": [
    {
      object (EventMapping)
    }
  ],
  "lockEnabled": boolean,
  "fineValue": integer
}
Campos
displayName

string

Nome de exibição do valor da conversão da SKAdNetwork. O comprimento máximo permitido para o nome de exibição é de 50 unidades de código UTF-16.

coarseValue

enum (CoarseValue)

Obrigatório. Um valor de conversão aproximado.

Não é garantido que esse valor seja exclusivo.

eventMappings[]

object (EventMapping)

Condições de evento que precisam ser atendidas para que esse valor de conversão seja alcançado. As condições nessa lista são unidas por AND. Ela precisa ter no mínimo uma entrada e no máximo três entradas, se a janela de postback estiver ativada.

lockEnabled

boolean

Se for verdadeiro, o SDK vai usar esse valor de conversão na janela de postback atual.

fineValue

integer

O valor da conversão detalhado. Isso se aplica somente à primeira janela de postback. Seus valores válidos são [0,63], ambos inclusivos. Ele precisa ser definido para as janelas de postback 1, e não para as 2 e 3. Não é garantido que esse valor seja exclusivo.

Se a configuração da primeira janela de postback for reutilizada na segunda ou na terceira, esse campo não terá efeito.

CoarseValue

O valor aproximado da conversão definido na chamada do SDK updatePostbackConversionValue quando as condições ConversionValues.event_mappings são atendidas. Para mais informações, consulte SKAdNetwork.CoarseConversionValue.

Enums
COARSE_VALUE_UNSPECIFIED Valor aproximado não especificado.
COARSE_VALUE_LOW Valor aproximado de baixo.
COARSE_VALUE_MEDIUM Valor aproximado da mídia.
COARSE_VALUE_HIGH Valor aproximado de alto.

EventMapping

Condições de configuração do evento para corresponder a um evento.

Representação JSON
{
  "eventName": string,
  "minEventCount": string,
  "maxEventCount": string,
  "minEventValue": number,
  "maxEventValue": number
}
Campos
eventName

string

Obrigatório. Nome do evento do GA4. Ele precisa ser definido sempre. O tamanho máximo permitido para o nome de exibição é de 40 unidades de código UTF-16.

minEventCount

string (int64 format)

Pelo menos um dos quatro valores mínimos/máximos a seguir precisa ser definido. Os valores definidos serão unidos por AND para qualificar um evento. O número mínimo de vezes que o evento ocorreu. Se deixada sem definição, a contagem mínima de eventos não será verificada.

maxEventCount

string (int64 format)

O número máximo de vezes que o evento ocorreu. Se deixada sem definição, a contagem máxima de eventos não será verificada.

minEventValue

number

A receita mínima gerada devido ao evento. A moeda da receita vai ser definida no nível da propriedade. Se não for definido, o valor mínimo do evento não será verificado.

maxEventValue

number

A receita máxima gerada devido ao evento. A moeda da receita vai ser definida no nível da propriedade. Se não for definido, o valor máximo do evento não será verificado.

Métodos

create

Cria um SKAdNetworkConversionValueSchema.

delete

Exclui o SKAdNetworkConversionValueSchema desejado.

get

Procura um único SKAdNetworkConversionValueSchema.

list

Lista SKAdNetworkConversionValueSchema em um fluxo.

patch

Atualiza um SKAdNetworkConversionValueSchema.