PlacementGroups

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

Representações de recursos

Contém as propriedades de um pacote ou roadblock.

{
  "kind": "dfareporting#placementGroup",
  "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,
  "directorySiteId": long,
  "directorySiteIdDimensionValue": dimensionValues Resource,
  "archived": 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
  },
  "placementGroupType": string,
  "contentCategoryId": long,
  "placementStrategyId": long,
  "comment": string,
  "childPlacementIds": [
    long
  ],
  "primaryPlacementId": long,
  "primaryPlacementIdDimensionValue": dimensionValues Resource,
  "createInfo": {
    "time": long
  },
  "lastModifiedInfo": {
    "time": long
  },
  "externalId": string
}
Nome da propriedade Valor Descrição Notas
accountId long ID da conta desse grupo de posições. Este é um campo somente leitura que pode ser deixado em branco.
advertiserId long ID do anunciante desse grupo de posições. Este é um campo obrigatório na inserção.
advertiserIdDimensionValue nested object É o valor da dimensão do ID do anunciante. Este é um campo somente leitura gerado automaticamente.
archived boolean Indica se esse grupo de posições está arquivado.
campaignId long ID da campanha desse grupo de posições. Este 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.
childPlacementIds[] list IDs das posições atribuídas a esse grupo de posições. Este é um campo somente leitura gerado automaticamente.
comment string Comentários para esse grupo de posições.
contentCategoryId long ID da categoria de conteúdo atribuída a esse grupo de posições.
createInfo nested object Informações sobre a criação desse grupo de posições. Este é um campo somente leitura.
createInfo.time long É o carimbo de data/hora da última mudança em milissegundos desde a época.
directorySiteId long ID do site do diretório associado a esse grupo de posições. Ao inserir, é necessário definir este campo ou o campo site_id para especificar o site associado a esse grupo de posições. 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 ID externo dessa posição.
id long ID desse grupo de posições. Este é um campo somente leitura gerado automaticamente.
idDimensionValue nested object Valor da dimensão do ID do grupo de posições. Este é um campo somente leitura gerado automaticamente.
kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#placementGroup".
lastModifiedInfo nested object Informações sobre a modificação mais recente desse grupo de posições. Este é um campo somente leitura.
lastModifiedInfo.time long É o carimbo de data/hora da última mudança em milissegundos desde a época.
name string Nome desse grupo de posições. Este campo é obrigatório e deve ter menos de 256 caracteres.
placementGroupType string Tipo desse grupo de posições. Um pacote é um grupo simples de posições que atua como uma única faixa de preços para um grupo de tags. Um roadblock é um grupo de posições que não só atua como uma única faixa de preços, mas também pressupõe que todas as tags incluídas nele serão veiculadas ao mesmo tempo. Um roadblock exige que uma das posições a ele seja marcada como principal para a geração de relatórios. Este campo é obrigatório na inserção.

Os valores aceitáveis são:
  • "PLACEMENT_PACKAGE"
  • "PLACEMENT_ROADBLOCK"
placementStrategyId long ID da estratégia de posicionamento atribuída a esse grupo de posições.
pricingSchedule nested object Programação de preços desse grupo de posições. Este campo é obrigatório na inserção.
pricingSchedule.capCostOption string 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.
primaryPlacementId long ID da posição primária, usada para calcular o custo de mídia de um roadblock (grupo de posições). Modificar este campo modificará automaticamente o campo primary em todas as posições derivadas de roadblock afetados.
primaryPlacementIdDimensionValue nested object É o valor da dimensão do ID da posição principal. Este é um campo somente leitura gerado automaticamente.
siteId long ID do site associado a esse grupo de posições. Ao inserir, é necessário definir este campo ou o campo directorySiteId para especificar o site associado a esse grupo de posições. 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.
subaccountId long ID da subconta desse grupo de posições. Este é um campo somente leitura que pode ser deixado em branco.

Métodos

get
Recebe um grupo de posições pelo ID.
insert
Insere um novo grupo de posições.
list
Recupera uma lista de grupos de posições, possivelmente filtrada. Este método é compatível com paginação.
patch
Atualiza um grupo de posições existente. Este método é compatível com a semântica de patch.
update
Atualiza um grupo de posições existente.