Sites

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

Representações do recurso

Contém as propriedades de um site.

{
  "kind": "dfareporting#site",
  "id": long,
  "idDimensionValue": dimensionValues Resource,
  "keyName": string,
  "name": string,
  "accountId": long,
  "subaccountId": long,
  "approved": boolean,
  "siteSettings": {
    "disableNewCookie": boolean,
    "tagSetting": {
      "additionalKeyValues": string,
      "includeClickTracking": boolean,
      "includeClickThroughUrls": boolean,
      "keywordOption": string
    },
    "activeViewOptOut": boolean,
    "adBlockingOptOut": boolean,
    "videoActiveViewOptOutTemplate": boolean,
    "vpaidAdapterChoiceTemplate": string
  },
  "siteContacts": [
    {
      "id": long,
      "email": string,
      "firstName": string,
      "lastName": string,
      "title": string,
      "address": string,
      "phone": string,
      "contactType": string
    }
  ],
  "directorySiteId": long,
  "directorySiteIdDimensionValue": dimensionValues Resource,
  "videoSettings": {
    "kind": "dfareporting#siteVideoSettings",
    "companionSettings": {
      "kind": "dfareporting#siteCompanionSetting",
      "companionsDisabled": boolean,
      "enabledSizes": [
        sizes Resource
      ],
      "imageOnly": boolean
    },
    "transcodeSettings": {
      "kind": "dfareporting#siteTranscodeSetting",
      "enabledVideoFormats": [
        integer
      ]
    },
    "skippableSettings": {
      "kind": "dfareporting#siteSkippableSetting",
      "skippable": boolean,
      "skipOffset": {
        "offsetSeconds": integer,
        "offsetPercentage": integer
      },
      "progressOffset": {
        "offsetSeconds": integer,
        "offsetPercentage": integer
      }
    },
    "orientation": string,
    "obaSettings": {
      "resourceUrl": string,
      "xPosition": string,
      "yPosition": string,
      "size": sizes Resource,
      "program": string,
      "iconClickThroughUrl": string,
      "iconClickTrackingUrl": string,
      "iconViewTrackingUrl": string
    },
    "obaEnabled": boolean
  }
}
Nome da propriedade Valor Descrição Notas
accountId long É o ID da conta desse site. Este é um campo somente leitura que pode ser deixado em branco.
approved boolean Indica se o site foi aprovado.
directorySiteId long Site de diretório associado a esse site. Este é um campo obrigatório que é somente leitura após a inserção.
directorySiteIdDimensionValue nested object Valor da dimensão do ID do site do diretório. Este é um campo somente leitura gerado automaticamente.
id long É o ID desse site. Este é um campo somente leitura gerado automaticamente.
idDimensionValue nested object É o valor da dimensão do ID desse site. Este é um campo somente leitura gerado automaticamente.
keyName string Nome da chave do site. Este é um campo somente leitura gerado automaticamente.
kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#site".
name string É o nome desse site. Este é um campo obrigatório. Precisa ter menos de 128 caracteres. Se o site estiver em uma subconta, o nome terá que ser exclusivo entre os sites da mesma subconta. Se esse site for de nível superior, o nome terá que ser exclusivo entre os sites de nível superior da mesma conta.
siteContacts[] list Contatos do site.
siteContacts[].address string Endereço do contato desse site.
siteContacts[].contactType string Tipo de contato do site.

Os valores aceitáveis são:
  • "SALES_PERSON"
  • "TRAFFICKER"
siteContacts[].email string Endereço de e-mail do contato desse site. Este campo é obrigatório.
siteContacts[].firstName string Nome do contato desse site.
siteContacts[].id long É o ID do contato desse site. Este é um campo somente leitura gerado automaticamente.
siteContacts[].lastName string Sobrenome do contato desse site.
siteContacts[].phone string Número de telefone principal do contato do site.
siteContacts[].title string Título ou designação do contato do site.
siteSettings nested object Configurações de todo o site.
siteSettings.activeViewOptOut boolean Indica se os criativos Active View estão desativados para esse site.
siteSettings.adBlockingOptOut boolean Indica se esse site desativa o bloqueio de anúncios. Quando definido como verdadeiro, o bloqueio de anúncios é desativado para todas as posições no site, independentemente das configurações de posições individuais. Quando definido como falso, as configurações da campanha e da posição se aplicam.
siteSettings.disableNewCookie boolean Indica se novos cookies estão desativados para esse site.
siteSettings.tagSetting nested object Configurações para tags dinâmicas e de imagem do Floodlight.
siteSettings.tagSetting.additionalKeyValues string Chaves-valor adicionais a serem incluídas nas tags. Cada par de chaves-valor precisa estar no formato key=value. Os pares precisam ser separados por ponto e vírgula (;). Chaves e valores não podem incluir vírgulas. Por exemplo, id=2;color=red é um valor válido para este campo.
siteSettings.tagSetting.includeClickThroughUrls boolean Indica se URLs da página de destino estáticos precisam ser incluídos nas tags. Esta configuração se aplica somente a posições.
siteSettings.tagSetting.includeClickTracking boolean Indica se a string de rastreamento de cliques precisa ser incluída nas tags.
siteSettings.tagSetting.keywordOption string É a opção que especifica como as palavras-chave são incorporadas às tags de anúncio. Esta configuração pode ser usada para especificar se marcadores de palavras-chave são inseridos nas tags de posicionamento deste site. Os editores podem adicionar palavras-chave a esses marcadores posteriormente.

Os valores aceitáveis são os seguintes:
  • "GENERATE_SEPARATE_TAG_FOR_EACH_KEYWORD"
  • "IGNORE"
  • "PLACEHOLDER_WITH_LIST_OF_KEYWORDS"
siteSettings.videoActiveViewOptOutTemplate boolean Indica se a Verificação e o ActiveView para criativos de vídeo in-stream estão desativados por padrão para novas posições criadas nesse site. Este valor será usado para preencher o campo placement.videoActiveViewOptOut, quando nenhum valor for especificado para a nova posição.
siteSettings.vpaidAdapterChoiceTemplate string Configuração padrão do adaptador VPAID para novas posições criadas nesse site. Este valor será usado para preencher o campo placements.vpaidAdapterChoice, quando nenhum valor for especificado para a nova posição. Controla qual formato VPAID o adaptador de medição usará para criativos de vídeo in-stream atribuídos à posição. Geralmente, as especificações do editor determinam esta configuração. Para criativos VPAID, o formato do adaptador será compatível com o formato VPAID. Os criativos VPAID em HTML5 usam o adaptador HTML5.

Observação: o Flash não é mais compatível. Agora, este campo tem como padrão HTML5 quando os seguintes valores forem fornecidos: FLASH e BOTH.

Os valores aceitáveis são:
  • "BOTH"
  • "DEFAULT"
  • "FLASH"
  • "HTML5"
subaccountId long É o ID da subconta desse site. Este é um campo somente leitura que pode ser deixado em branco.
videoSettings nested object Configurações de vídeo padrão para novas posições criadas nesse site. Este valor será usado para preencher o campo placements.videoSettings, quando nenhum valor for especificado para a nova posição.
videoSettings.companionSettings nested object Configurações dos criativos complementares aos vídeos desse site.
videoSettings.companionSettings.companionsDisabled boolean Indica se os complementares estão desativados para esse modelo de site.
videoSettings.companionSettings.enabledSizes[] list É a lista de permissões de tamanhos de complementares a serem veiculados por esse modelo de site. Caso esta lista seja definida como nula ou vazia, todos os tamanhos de complementares serão veiculados.
videoSettings.companionSettings.imageOnly boolean Indica se somente imagens estáticas serão veiculadas como complementares.
videoSettings.companionSettings.kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#siteCompanionSetting".
videoSettings.kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#siteVideoSettings".
videoSettings.obaEnabled boolean Indica se os ícones da OBA estão ativados nessa posição.
videoSettings.obaSettings nested object Configurações do ícone da OBA dos vídeos desse site. Funcionará como padrão para novas posições criadas nesse site.
videoSettings.obaSettings.iconClickThroughUrl string É o URL a ser redirecionado quando um ícone da OBA é clicado.
videoSettings.obaSettings.iconClickTrackingUrl string É o URL para rastrear o clique quando um ícone da OBA é clicado.
videoSettings.obaSettings.iconViewTrackingUrl string É o URL para rastrear a visualização quando um ícone da OBA é clicado.
videoSettings.obaSettings.program string Identifica a iniciativa do setor com que o ícone tem compatibilidade. Por exemplo, Opções de anúncios.
videoSettings.obaSettings.resourceUrl string É o URL do recurso do ícone da OBA. O Campaign Manager só é compatível com ícones de imagem e JavaScript. Saiba mais
videoSettings.obaSettings.size nested object É o tamanho do ícone da OBA.
videoSettings.obaSettings.xPosition string É a posição da coordenada x do ícone da OBA. Os valores aceitos são "left" (esquerda) ou "right" (direita).
videoSettings.obaSettings.yPosition string É a posição da coordenada y do ícone da OBA. Os valores aceitos são "top" (superior) ou "bottom" (inferior).
videoSettings.orientation string Orientação de um modelo de site usado para vídeo. Funcionará como padrão para novas posições criadas nesse site.

Os valores aceitáveis são:
  • "ANY"
  • "LANDSCAPE"
  • "PORTRAIT"
videoSettings.skippableSettings nested object Configurações que indicam se os criativos de vídeo exibidos nesse site são puláveis. Funcionará como padrão para novas posições criadas nesse site.
videoSettings.skippableSettings.kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#siteSkippableSetting".
videoSettings.skippableSettings.progressOffset nested object Tempo de exibição dos vídeos veiculados nesse modelo de site antes de contar uma visualização. Aplicável quando skippable é definido como verdadeiro.
videoSettings.skippableSettings.progressOffset.offsetPercentage integer É a duração, como uma porcentagem da duração do vídeo. Não defina quando offsetSeconds estiver definido. Os valores aceitáveis são de 0 a 100.
videoSettings.skippableSettings.progressOffset.offsetSeconds integer É a duração em segundos. Não defina quando offsetPercentage estiver definido. Os valores aceitáveis são de 0 a 86399.
videoSettings.skippableSettings.skipOffset nested object Tempo de exibição dos vídeos desse site antes que o botão "Pular" apareça. Aplicável quando skippable é definido como verdadeiro.
videoSettings.skippableSettings.skipOffset.offsetPercentage integer É a duração, como uma porcentagem da duração do vídeo. Não defina quando offsetSeconds estiver definido. Os valores aceitáveis são de 0 a 100.
videoSettings.skippableSettings.skipOffset.offsetSeconds integer É a duração em segundos. Não defina quando offsetPercentage estiver definido. Os valores aceitáveis são de 0 a 86399.
videoSettings.skippableSettings.skippable boolean Indica se o usuário pode pular criativos desse site. Funcionará como padrão para novas posições criadas nesse site.
videoSettings.transcodeSettings nested object Configurações para as transcodificações de criativos de vídeo veiculados nesse site. Funcionará como padrão para novas posições criadas nesse site.
videoSettings.transcodeSettings.enabledVideoFormats[] list É a lista de permissões de formatos de vídeo a serem veiculados nesse modelo de site. Caso esta lista seja definida como nula ou vazia, todos os formatos de vídeo serão veiculados.
videoSettings.transcodeSettings.kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#siteTranscodeSetting".

Métodos

get
Recebe um site por ID.
insert
Insere um novo site.
list
Recupera uma lista de sites, possivelmente filtrada. Esse método é compatível com paginação.
patch
Atualiza um site existente. Esse método é compatível com a semântica de patch.
update
Atualiza um site existente.