Placements

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

Representações de recursos

Contém as propriedades de uma posição.

{
  "kind": "dfareporting#placement",
  "id": long,
  "idDimensionValue": dimensionValues Resource,
  "accountId": long,
  "subaccountId": long,
  "advertiserId": long,
  "advertiserIdDimensionValue": dimensionValues Resource,
  "campaignId": long,
  "campaignIdDimensionValue": dimensionValues Resource,
  "name": string,
  "siteId": long,
  "siteIdDimensionValue": dimensionValues Resource,
  "keyName": string,
  "directorySiteId": long,
  "directorySiteIdDimensionValue": dimensionValues Resource,
  "paymentSource": string,
  "compatibility": string,
  "size": sizes Resource,
  "additionalSizes": [
    sizes Resource
  ],
  "archived": boolean,
  "paymentApproved": boolean,
  "pricingSchedule": {
    "testingStartDate": date,
    "startDate": date,
    "endDate": date,
    "pricingType": string,
    "capCostOption": string,
    "flighted": boolean,
    "pricingPeriods": [
      {
        "startDate": date,
        "endDate": date,
        "units": long,
        "rateOrCostNanos": long,
        "pricingComment": string
      }
    ],
    "floodlightActivityId": long
  },
  "placementGroupId": long,
  "placementGroupIdDimensionValue": dimensionValues Resource,
  "primary": boolean,
  "tagSetting": {
    "additionalKeyValues": string,
    "includeClickTracking": boolean,
    "includeClickThroughUrls": boolean,
    "keywordOption": string
  },
  "tagFormats": [
    string
  ],
  "contentCategoryId": long,
  "placementStrategyId": long,
  "lookbackConfiguration": {
    "clickDuration": integer,
    "postImpressionActivitiesDuration": integer
  },
  "comment": string,
  "status": string,
  "publisherUpdateInfo": {
    "time": long
  },
  "createInfo": {
    "time": long
  },
  "lastModifiedInfo": {
    "time": long
  },
  "sslRequired": boolean,
  "externalId": string,
  "videoSettings": {
    "kind": "dfareporting#videoSettings",
    "companionSettings": {
      "kind": "dfareporting#companionSetting",
      "companionsDisabled": boolean,
      "enabledSizes": [
        sizes Resource
      ],
      "imageOnly": boolean
    },
    "transcodeSettings": {
      "kind": "dfareporting#transcodeSetting",
      "enabledVideoFormats": [
        integer
      ]
    },
    "skippableSettings": {
      "kind": "dfareporting#skippableSetting",
      "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
  },
  "videoActiveViewOptOut": boolean,
  "vpaidAdapterChoice": string,
  "adBlockingOptOut": boolean
}
Nome da propriedade Valor Descrição Observações
accountId long É o ID da conta desta posição. Este campo pode ser deixado em branco.
adBlockingOptOut boolean Indica se esta posição desativa o bloqueio de anúncios. Quando definido como verdadeiro, o bloqueio de anúncios é desativado nesta posição. Quando definido como falso, as configurações da campanha e do site se aplicam.
additionalSizes[] list São tamanhos adicionais associados a esta posição. Ao inserir ou atualizar uma posição, somente o campo ID de tamanho é usado.
advertiserId long É o ID do anunciante desta posição. Este campo pode ser deixado em branco.
advertiserIdDimensionValue nested object É o valor da dimensão do ID do anunciante. Este é um campo somente leitura gerado automaticamente.
archived boolean Indica se esta posição está arquivada.
campaignId long É o ID da campanha desta posição. Este é um campo obrigatório na inserção.
campaignIdDimensionValue nested object É o valor da dimensão do ID da campanha. Este é um campo somente leitura gerado automaticamente.
comment string São comentários para esta posição.
compatibility string É a compatibilidade de posição. DISPLAY e DISPLAY_INTERSTITIAL referem-se à renderização em computadores, dispositivos móveis ou apps para dispositivos móveis para anúncios normais ou intersticiais, respectivamente. APP e APP_INTERSTITIAL não são mais permitidos para novas inserções de posição. Em vez disso, use DISPLAY ou DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refere-se à renderização de anúncios em vídeo in-stream desenvolvidos com o padrão VAST. Este campo é obrigatório na inserção.

Os valores aceitáveis são os seguintes:
  • "APP"
  • "APP_INTERSTITIAL"
  • "DISPLAY"
  • "DISPLAY_INTERSTITIAL"
  • "IN_STREAM_AUDIO"
  • "IN_STREAM_VIDEO"
contentCategoryId long É o ID da categoria de conteúdo atribuída a esta posição.
createInfo nested object São informações sobre a criação desta posição. Este é um campo somente leitura.
createInfo.time long É o carimbo de data/hora da última mudança em milissegundos desde a época.
directorySiteId long É o ID do site do diretório desta posição. Ao inserir, é necessário definir este campo ou o campo siteId para especificar o site associado a esta posição. 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.
externalId string É o ID externo desta posição.
id long É o ID desta posição. Este é um campo somente leitura gerado automaticamente.
idDimensionValue nested object É o valor da dimensão do ID desta posição. Este é um campo somente leitura gerado automaticamente.
keyName string É o nome da chave desta posição. Este é um campo somente leitura gerado automaticamente.
kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#placement".
lastModifiedInfo nested object São informações sobre a modificação mais recente desta posição. Este é um campo somente leitura.
lastModifiedInfo.time long É o carimbo de data/hora da última mudança em milissegundos desde a época.
lookbackConfiguration nested object São as configurações da janela de lookback desta posição.
lookbackConfiguration.clickDuration integer É a 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 da sua conta. Os valores aceitos vão de 0 a 90, inclusive.
lookbackConfiguration.postImpressionActivitiesDuration integer É a 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 da sua conta. Os valores aceitos vão de 0 a 90, inclusive.
name string É o nome desta posição. Este campo é obrigatório e precisa ter no máximo 256 caracteres.
paymentApproved boolean Indica se o pagamento desta posição foi aprovado. Este é um campo somente leitura relevante somente em posições pagas pelo editor.
paymentSource string É a origem do pagamento desta posição. Este é um campo obrigatório que é somente leitura após a inserção.

Os valores aceitáveis são os seguintes:
  • "PLACEMENT_AGENCY_PAID"
  • "PLACEMENT_PUBLISHER_PAID"
placementGroupId long É o ID do grupo desta posição, se aplicável.
placementGroupIdDimensionValue nested object É o valor da dimensão do ID do grupo de posições. Este é um campo somente leitura gerado automaticamente.
placementStrategyId long É o ID da estratégia de posicionamento atribuída a esta posição.
pricingSchedule nested object É a programação de preços desta posição. Este campo é obrigatório na inserção, especificamente os subcampos startDate, endDate e pricingType.
pricingSchedule.capCostOption string É a opção para limitar custo da posição.

Os valores aceitáveis são:
  • "CAP_COST_CUMULATIVE"
  • "CAP_COST_MONTHLY"
  • "CAP_COST_NONE"
pricingSchedule.endDate date Data de término da posição. Esta data precisa ser posterior ou igual à data de início da posição, mas não pode ser posterior à data de término da campanha. Por exemplo, se você definir 25/06/2015 como a data tanto de início quanto de término, a data efetiva da posição será somente esse dia. Não defina as horas, os minutos e os segundos da data de término ou isso resultará em um erro. Este campo é obrigatório na inserção.
pricingSchedule.flighted boolean Indica se essa posição é em flights. Se for definido como verdadeiro, os períodos de preço serão calculados automaticamente.
pricingSchedule.floodlightActivityId long ID da atividade do Floodlight associada a essa posição. Este campo precisa ser definido quando o tipo de preço da posição for definido como PRICING_TYPE_CPA.
pricingSchedule.pricingPeriods[] list Períodos de preços dessa posição.
pricingSchedule.pricingPeriods[].endDate date Data de término do período de preços. Esta data precisa ser posterior ou igual à data de início do período de preços, mas não pode ser posterior à data de término da posição. A data de término do período pode ser igual à data de início. Por exemplo, se você definir 25/06/2015 como a data tanto de início quanto de término, a data efetiva da do período de preços será somente esse dia. Não defina as horas, os minutos e os segundos da data de término ou isso resultará em um erro.
pricingSchedule.pricingPeriods[].pricingComment string Comentários a esse período de preços.
pricingSchedule.pricingPeriods[].rateOrCostNanos long Taxa ou custo desse período de preços em nanos, ou seja, multiplicado por 1000000000. Os valores aceitos vão de 0 a 1000000000000000000, inclusive.
pricingSchedule.pricingPeriods[].startDate date Data de início do período de preços. Essa data precisa ser posterior ou igual à data de início da posição. Não defina as horas, os minutos e os segundos da data de início ou isso resultará em um erro.
pricingSchedule.pricingPeriods[].units long Unidades desse período de preços. Os valores aceitos vão de 0 a 10000000000, inclusive.
pricingSchedule.pricingType string Tipo de preço da posição. Este campo é obrigatório na inserção.

Os valores aceitáveis são:
  • "PRICING_TYPE_CPA"
  • "PRICING_TYPE_CPC"
  • "PRICING_TYPE_CPM"
  • "PRICING_TYPE_CPM_ACTIVEVIEW"
  • "PRICING_TYPE_FLAT_RATE_CLICKS"
  • "PRICING_TYPE_FLAT_RATE_IMPRESSIONS"
pricingSchedule.startDate date Data de início da posição. Essa data precisa ser posterior ou igual à data de início da campanha. Não defina as horas, os minutos e os segundos da data de início ou isso resultará em um erro. Este campo é obrigatório na inserção.
pricingSchedule.testingStartDate date Data de início do teste dessa posição. Não defina as horas, os minutos e os segundos da data de início ou isso resultará em um erro.
primary boolean Indica se esta posição é a principal em um roadblock (grupo de posições). Não é possível mudar este campo de verdadeiro para falso. Se este campo for definido como verdadeiro, primary será definido automaticamente na posição primária original do roadblock como falso. Nesse caso, ele definirá o campo primaryPlacementId do roadblock como o ID dessa posição automaticamente.
publisherUpdateInfo nested object São informações sobre a última atualização do editor. Este é um campo somente leitura.
publisherUpdateInfo.time long É o carimbo de data/hora da última mudança em milissegundos desde a época.
siteId long É o ID do site associado a esta posição. Ao inserir, é necessário definir este campo ou o campo directorySiteId para especificar o site associado a esta posição. Este é um campo obrigatório que é somente leitura após a inserção.
siteIdDimensionValue nested object Valor da dimensão do ID do site. Este é um campo somente leitura gerado automaticamente.
size nested object É o tamanho associado a esta posição. Ao inserir ou atualizar uma posição, somente o campo ID de tamanho é usado. Este campo é obrigatório na inserção.
sslRequired boolean Indica se os criativos atribuídos a esta posição precisam ser compatíveis com SSL.
status string É o status da posição de terceiros.

Os valores aceitáveis são os seguintes:
  • "ACKNOWLEDGE_ACCEPTANCE":
    o anunciante recebeu a aceitação da taxa de veiculação do anúncio para a posição..
  • "ACKNOWLEDGE_REJECTION":
    o anunciante recebeu a rejeição da taxa de veiculação do anúncio para a posição.
  • "DRAFT": a posição ainda não foi revisada pelo editor.
  • "PAYMENT_ACCEPTED":
    a taxa de veiculação do anúncio para a posição foi aceita pelo editor.
  • "PAYMENT_REJECTED":
    a taxa de veiculação do anúncio para a posição foi rejeitada pelo editor.
  • "PENDING_REVIEW":
    a posição ainda não foi revisada pelo editor.
subaccountId long É o ID da subconta desta posição. Este campo pode ser deixado em branco.
tagFormats[] list São os formatos de tag a serem gerados para esta posição. Este campo é obrigatório na inserção.

Os valores aceitáveis são os seguintes:

  • "PLACEMENT_TAG_STANDARD"
  • "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
  • "PLACEMENT_TAG_IFRAME_ILAYER"
  • "PLACEMENT_TAG_INTERNAL_REDIRECT"
  • "PLACEMENT_TAG_JAVASCRIPT"
  • "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
  • "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
  • "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
  • "PLACEMENT_TAG_CLICK_COMMANDS"
  • "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
  • "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3"
  • "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4"
  • "PLACEMENT_TAG_TRACKING"
  • "PLACEMENT_TAG_TRACKING_IFRAME"
  • "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
tagSetting nested object São as configurações de tag desta posição.
tagSetting.additionalKeyValues string São 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.
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.
tagSetting.includeClickTracking boolean Indica se a string de rastreamento de cliques precisa ser incluída nas tags.
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"
videoActiveViewOptOut boolean Indica se a verificação e o Active View estão desativados para criativos de vídeo in-stream desta posição. A mesma configuração videoActiveViewOptOut existe no nível do site. A desativação ocorrerá se uma dessas configurações for definida como verdadeira. Elas são diferentes de DirectorySites.settings.activeViewOptOut ou Sites.siteSettings.activeViewOptOut, que se aplicam somente aos anúncios de display. No entanto, Accounts.activeViewOptOut desativa a verificação e o Active View do tráfego de vídeo e dos anúncios de display.
videoSettings nested object É uma coleção de configurações que afetam os criativos de vídeo nesta posição. Aplicável a posições compatíveis com IN_STREAM_VIDEO.
videoSettings.companionSettings nested object São as configurações dos criativos complementares aos vídeos desta posição.
videoSettings.companionSettings.companionsDisabled boolean Indica se os complementares estão desativados nesta posição.
videoSettings.companionSettings.enabledSizes[] list É a lista de permissões dos tamanhos dos complementares para esta posição. 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#companionSetting".
videoSettings.kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#videoSettings".
videoSettings.obaEnabled boolean Indica se os ícones da OBA estão ativados nesta posição.
videoSettings.obaSettings nested object São as configurações do ícone da OBA dos vídeos desta posição. Se esse objeto for fornecido, as configurações da OBA no nível do criativo serão modificadas.
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 industrial 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 É a orientação de uma posição de vídeo. Se esse valor for definido, a posição retornará recursos que correspondam à orientação especificada.

Os valores aceitáveis são os seguintes:
  • "ANY"
  • "LANDSCAPE"
  • "PORTRAIT"
videoSettings.skippableSettings nested object São as configurações que indicam se os criativos de vídeo exibidos nesta posição são puláveis. Se esse objeto for fornecido, as configurações no nível do criativo serão modificadas.
videoSettings.skippableSettings.kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#skippableSetting".
videoSettings.skippableSettings.progressOffset nested object É o tempo de execução do vídeo necessário nesta posição para que conte 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, inclusive.
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, inclusive.
videoSettings.skippableSettings.skipOffset nested object É o tempo de exibição dos vídeos desta posição 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, inclusive.
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, inclusive.
videoSettings.skippableSettings.skippable boolean Indica se o usuário pode pular criativos desta posição.
videoSettings.transcodeSettings nested object São as configurações de transcodificação dos criativos de vídeos desta posição. Se esse objeto for fornecido, as configurações no nível do criativo serão modificadas.
videoSettings.transcodeSettings.enabledVideoFormats[] list É a lista de permissões de formatos de vídeo desta posição. 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#transcodeSetting".
vpaidAdapterChoice string É a configuração do adaptador VPAID desta posição. Controla o formato VPAID que o adaptador de medição usará nos criativos em vídeo atribuídos a esta posição.

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 os seguintes:
  • "BOTH"
  • "DEFAULT"
  • "FLASH"
  • "HTML5"

Métodos

generatetags
Gera tags para uma posição.
get
Recebe uma posição por ID.
insert
Insere uma nova posição.
list
Recupera uma lista de posições, possivelmente filtrada. Esse método é compatível com paginação.
patch
Atualiza uma posição existente. Esse método é compatível com a semântica de patch.
update
Atualiza uma posição existente.