FloodlightConfigurations

Para ver uma lista de métodos deste recurso, consulte o final desta página.

Representações de recursos

Contém as propriedades de uma configuração do Floodlight.

{
  "kind": "dfareporting#floodlightConfiguration",
  "id": long,
  "idDimensionValue": dimensionValues Resource,
  "accountId": long,
  "subaccountId": long,
  "advertiserId": long,
  "advertiserIdDimensionValue": dimensionValues Resource,
  "firstDayOfWeek": string,
  "lookbackConfiguration": {
    "clickDuration": integer,
    "postImpressionActivitiesDuration": integer
  },
  "naturalSearchConversionAttributionOption": string,
  "omnitureSettings": {
    "omnitureIntegrationEnabled": boolean,
    "omnitureCostDataEnabled": boolean
  },
  "exposureToConversionEnabled": boolean,
  "tagSettings": {
    "dynamicTagEnabled": boolean,
    "imageTagEnabled": boolean
  },
  "userDefinedVariableConfigurations": [
    {
      "variableType": string,
      "dataType": string,
      "reportName": string
    }
  ],
  "analyticsDataSharingEnabled": boolean,
  "inAppAttributionTrackingEnabled": boolean,
  "thirdPartyAuthenticationTokens": [
    {
      "name": string,
      "value": string
    }
  ],
  "customViewabilityMetric": {
    "id": long,
    "name": string,
    "configuration": {
      "viewabilityPercent": integer,
      "audible": boolean,
      "timeMillis": integer,
      "timePercent": integer
    }
  }
}
Nome da propriedade Valor Descrição Notas
accountId long ID da conta dessa configuração do Floodlight. Este é um campo somente leitura que pode ser deixado em branco.
advertiserId long ID do anunciante principal da configuração do Floodlight.
advertiserIdDimensionValue nested object É o valor da dimensão do ID do anunciante. Este é um campo somente leitura gerado automaticamente.
analyticsDataSharingEnabled boolean Indica se os dados do anunciante são compartilhados com o Google Analytics.
customViewabilityMetric nested object Métrica de visibilidade personalizada para a configuração do Floodlight.
customViewabilityMetric.configuration nested object Configuração da métrica de visibilidade personalizada.
customViewabilityMetric.configuration.audible boolean Indica se o vídeo precisa ser audível para contar uma impressão.
customViewabilityMetric.configuration.timeMillis integer O tempo em milissegundos em que o vídeo deve ser reproduzido para que a métrica de visibilidade personalizada conte uma impressão. Se isso e timePercent forem especificados, o primeiro dos dois será usado.
customViewabilityMetric.configuration.timePercent integer A porcentagem de vídeo que precisa ser reproduzida para que a métrica de visibilidade personalizada conte uma impressão. Se isso e timeMillis forem especificados, o primeiro dos dois será usado.
customViewabilityMetric.configuration.viewabilityPercent integer A porcentagem de vídeo que precisa aparecer na tela para que métrica de visibilidade personalizada conte uma impressão.
customViewabilityMetric.id long ID da métrica de visibilidade personalizada.
customViewabilityMetric.name string É o nome da métrica de visibilidade personalizada.
exposureToConversionEnabled boolean Indica se o relatório de exposição à conversão está ativado. Ele mostra informações detalhadas de caminho sobre até dez das exposições de anúncio mais recentes visualizadas por um usuário antes da conversão.
firstDayOfWeek string Dia que será considerado o primeiro dia da semana nos relatórios. Este campo é obrigatório.

Os valores aceitáveis são:
  • "MONDAY"
  • "SUNDAY"
id long ID dessa configuração do Floodlight. Este é um campo somente leitura gerado automaticamente.
idDimensionValue nested object Valor da dimensão do ID dessa configuração do Floodlight. Este é um campo somente leitura gerado automaticamente.
inAppAttributionTrackingEnabled boolean Indica se o acompanhamento de atribuição no app está ativado.
kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#floodlightConfiguration".
lookbackConfiguration nested object Configurações da janela de lookback para essa configuração do Floodlight.
lookbackConfiguration.clickDuration integer Janela de lookback, em dias, desde a última vez que determinado usuário clicou em um dos seus anúncios. Se você digitar "0", os cliques não serão considerados como eventos iniciadores de rastreamento do Floodlight. Se você deixar este campo em branco, será usado o valor padrão de sua conta. Os valores aceitos vão de 0 a 90, inclusive.
lookbackConfiguration.postImpressionActivitiesDuration integer Janela de lookback, em dias, desde a última vez que determinado usuário visualizou um dos seus anúncios. Se você digitar "0", as impressões não serão consideradas como eventos iniciadores de rastreamento Floodlight. Se você deixar este campo em branco, será usado o valor padrão de sua conta. Os valores aceitos vão de 0 a 90, inclusive.
naturalSearchConversionAttributionOption string Tipos de opções de atribuição para conversões de pesquisa natural.

Os valores aceitáveis são:
  • "EXCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION"
  • "INCLUDE_NATURAL_SEARCH_CONVERSION_ATTRIBUTION"
  • "INCLUDE_NATURAL_SEARCH_TIERED_CONVERSION_ATTRIBUTION"
omnitureSettings nested object Configurações para integração do Campaign Manager Omniture.
omnitureSettings.omnitureCostDataEnabled boolean Indica se os dados de custo da posição serão enviados para o Omniture. Essa propriedade só poderá ser ativada se omnitureIntegrationEnabled for verdadeiro.
omnitureSettings.omnitureIntegrationEnabled boolean Indica se a integração do Omniture está ativada. Essa propriedade pode ser ativada somente quando a configuração da conta "Veiculação avançada de anúncios" estiver ativada.
subaccountId long ID da subconta dessa configuração do Floodlight. Este é um campo somente leitura que pode ser deixado em branco.
tagSettings nested object Configurações para tags dinâmicas e de imagem do Floodlight.
tagSettings.dynamicTagEnabled boolean Indica se as tags dinâmicas do Floodlight estão ativadas.
tagSettings.imageTagEnabled boolean Indica se as tags de imagem estão ativadas.
thirdPartyAuthenticationTokens[] list Lista de tokens de autenticação de terceiros ativados para essa configuração.
thirdPartyAuthenticationTokens[].name string Nome do token de autenticação de terceiros.
thirdPartyAuthenticationTokens[].value string Valor do token de autenticação de terceiros. Este é um campo somente leitura gerado automaticamente.
userDefinedVariableConfigurations[] list Lista de variáveis definidas pelo usuário ativadas para essa configuração.
userDefinedVariableConfigurations[].dataType string Tipo de dados da variável. Este campo é obrigatório.

Os valores aceitáveis são:
  • "NUMBER"
  • "STRING"
userDefinedVariableConfigurations[].reportName string Nome fácil de usar para a variável que aparecerá nos relatórios. Este campo é obrigatório, precisa ter menos de 64 caracteres e não pode conter os seguintes caracteres: ""<>".
userDefinedVariableConfigurations[].variableType string Nome da variável na tag. Este campo é obrigatório.

Os valores aceitáveis são:
  • "U1"
  • "U10"
  • "U100"
  • "U11"
  • "U12"
  • "U13"
  • "U14"
  • "U15"
  • "U16"
  • "U17"
  • "U18"
  • "U19"
  • "U2"
  • "U20"
  • "U21"
  • "U22"
  • "U23"
  • "U24"
  • "U25"
  • "U26"
  • "U27"
  • "U28"
  • "U29"
  • "U3"
  • "U30"
  • "U31"
  • "U32"
  • "U33"
  • "U34"
  • "U35"
  • "U36"
  • "U37"
  • "U38"
  • "U39"
  • "U4"
  • "U40"
  • "U41"
  • "U42"
  • "U43"
  • "U44"
  • "U45"
  • "U46"
  • "U47"
  • "U48"
  • "U49"
  • "U5"
  • "U50"
  • "U51"
  • "U52"
  • "U53"
  • "U54"
  • "U55"
  • "U56"
  • "U57"
  • "U58"
  • "U59"
  • "U6"
  • "U60"
  • "U61"
  • "U62"
  • "U63"
  • "U64"
  • "U65"
  • "U66"
  • "U67"
  • "U68"
  • "U69"
  • "U7"
  • "U70"
  • "U71"
  • "U72"
  • "U73"
  • "U74"
  • "U75"
  • "U76"
  • "U77"
  • "U78"
  • "U79"
  • "U8"
  • "U80"
  • "U81"
  • "U82"
  • "U83"
  • "U84"
  • "U85"
  • "U86"
  • "U87"
  • "U88"
  • "U89"
  • "U9"
  • "U90"
  • "U91"
  • "U92"
  • "U93"
  • "U94"
  • "U95"
  • "U96"
  • "U97"
  • "U98"
  • "U99"

Métodos

get
Recebe uma configuração do Floodlight pelo ID.
list
Recupera uma lista de configurações do Floodlight, possivelmente filtrada.
patch
Atualiza uma configuração existente do Floodlight. Esse método é compatível com a semântica de patch.
update
Atualiza uma configuração existente do Floodlight.