A API Campaign Manager 360 v3.4 foi descontinuada e será desativada em 24 de dezembro de 2021. Até essa data, todos os usuários precisam migrar para uma versão mais recente da API.

Reports.compatibleFields

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

Representações do recurso

Representa um recurso Report.

{
  "kind": "dfareporting#report",
  "id": long,
  "etag": etag,
  "lastModifiedTime": unsigned long,
  "ownerProfileId": long,
  "accountId": long,
  "subAccountId": long,
  "name": string,
  "fileName": string,
  "format": string,
  "type": string,
  "criteria": {
    "dateRange": {
      "kind": "dfareporting#dateRange",
      "startDate": date,
      "endDate": date,
      "relativeDateRange": string
    },
    "dimensions": [
      {
        "kind": "dfareporting#sortedDimension",
        "name": string,
        "sortOrder": string
      }
    ],
    "metricNames": [
      string
    ],
    "dimensionFilters": [
      dimensionValues Resource
    ],
    "activities": {
      "kind": "dfareporting#activities",
      "filters": [
        dimensionValues Resource
      ],
      "metricNames": [
        string
      ]
    },
    "customRichMediaEvents": {
      "kind": "dfareporting#customRichMediaEvents",
      "filteredEventIds": [
        dimensionValues Resource
      ]
    }
  },
  "pathToConversionCriteria": {
    "dateRange": {
      "kind": "dfareporting#dateRange",
      "startDate": date,
      "endDate": date,
      "relativeDateRange": string
    },
    "floodlightConfigId": dimensionValues Resource,
    "activityFilters": [
      dimensionValues Resource
    ],
    "conversionDimensions": [
      {
        "kind": "dfareporting#sortedDimension",
        "name": string,
        "sortOrder": string
      }
    ],
    "perInteractionDimensions": [
      {
        "kind": "dfareporting#sortedDimension",
        "name": string,
        "sortOrder": string
      }
    ],
    "metricNames": [
      string
    ],
    "customFloodlightVariables": [
      {
        "kind": "dfareporting#sortedDimension",
        "name": string,
        "sortOrder": string
      }
    ],
    "customRichMediaEvents": [
      dimensionValues Resource
    ],
    "reportProperties": {
      "clicksLookbackWindow": integer,
      "impressionsLookbackWindow": integer,
      "maximumInteractionGap": integer,
      "maximumClickInteractions": integer,
      "maximumImpressionInteractions": integer,
      "includeAttributedIPConversions": boolean,
      "includeUnattributedIPConversions": boolean,
      "includeUnattributedCookieConversions": boolean,
      "pivotOnInteractionPath": boolean
    }
  },
  "reachCriteria": {
    "enableAllDimensionCombinations": boolean,
    "dateRange": {
      "kind": "dfareporting#dateRange",
      "startDate": date,
      "endDate": date,
      "relativeDateRange": string
    },
    "dimensions": [
      {
        "kind": "dfareporting#sortedDimension",
        "name": string,
        "sortOrder": string
      }
    ],
    "metricNames": [
      string
    ],
    "reachByFrequencyMetricNames": [
      string
    ],
    "dimensionFilters": [
      dimensionValues Resource
    ],
    "activities": {
      "kind": "dfareporting#activities",
      "filters": [
        dimensionValues Resource
      ],
      "metricNames": [
        string
      ]
    },
    "customRichMediaEvents": {
      "kind": "dfareporting#customRichMediaEvents",
      "filteredEventIds": [
        dimensionValues Resource
      ]
    }
  },
  "crossDimensionReachCriteria": {
    "dateRange": {
      "kind": "dfareporting#dateRange",
      "startDate": date,
      "endDate": date,
      "relativeDateRange": string
    },
    "dimension": string,
    "pivoted": boolean,
    "dimensionFilters": [
      dimensionValues Resource
    ],
    "breakdown": [
      {
        "kind": "dfareporting#sortedDimension",
        "name": string,
        "sortOrder": string
      }
    ],
    "metricNames": [
      string
    ],
    "overlapMetricNames": [
      string
    ]
  },
  "floodlightCriteria": {
    "dateRange": {
      "kind": "dfareporting#dateRange",
      "startDate": date,
      "endDate": date,
      "relativeDateRange": string
    },
    "floodlightConfigId": dimensionValues Resource,
    "dimensionFilters": [
      dimensionValues Resource
    ],
    "reportProperties": {
      "includeAttributedIPConversions": boolean,
      "includeUnattributedIPConversions": boolean,
      "includeUnattributedCookieConversions": boolean
    },
    "dimensions": [
      {
        "kind": "dfareporting#sortedDimension",
        "name": string,
        "sortOrder": string
      }
    ],
    "metricNames": [
      string
    ],
    "customRichMediaEvents": [
      dimensionValues Resource
    ]
  },
  "pathCriteria": {
    "dateRange": {
      "kind": "dfareporting#dateRange",
      "startDate": date,
      "endDate": date,
      "relativeDateRange": string
    },
    "floodlightConfigId": dimensionValues Resource,
    "activityFilters": [
      dimensionValues Resource
    ],
    "customChannelGrouping": {
      "kind": "dfareporting#channelGrouping",
      "name": string,
      "fallbackName": string,
      "rules": [
        {
          "kind": "dfareporting#channelGroupingRule",
          "name": string,
          "disjunctiveMatchStatements": [
            {
              "kind": "dfareporting#disjunctiveMatchStatement",
              "eventFilters": [
                {
                  "kind": "dfareporting#eventFilter",
                  "dimensionFilter": {
                    "kind": "dfareporting#pathReportDimensionValue",
                    "dimensionName": string,
                    "values": [
                      string
                    ],
                    "ids": [
                      string
                    ],
                    "matchType": string
                  }
                }
              ]
            }
          ]
        }
      ]
    },
    "pathFilters": [
      {
        "kind": "dfaReporting#pathFilter",
        "eventFilters": [
          {
            "kind": "dfareporting#eventFilter",
            "dimensionFilter": {
              "kind": "dfareporting#pathReportDimensionValue",
              "dimensionName": string,
              "values": [
                string
              ],
              "ids": [
                string
              ],
              "matchType": string
            }
          }
        ],
        "pathMatchPosition": string
      }
    ],
    "dimensions": [
      {
        "kind": "dfareporting#sortedDimension",
        "name": string,
        "sortOrder": string
      }
    ],
    "metricNames": [
      string
    ]
  },
  "pathAttributionCriteria": {
    "dateRange": {
      "kind": "dfareporting#dateRange",
      "startDate": date,
      "endDate": date,
      "relativeDateRange": string
    },
    "floodlightConfigId": dimensionValues Resource,
    "activityFilters": [
      dimensionValues Resource
    ],
    "customChannelGrouping": {
      "kind": "dfareporting#channelGrouping",
      "name": string,
      "fallbackName": string,
      "rules": [
        {
          "kind": "dfareporting#channelGroupingRule",
          "name": string,
          "disjunctiveMatchStatements": [
            {
              "kind": "dfareporting#disjunctiveMatchStatement",
              "eventFilters": [
                {
                  "kind": "dfareporting#eventFilter",
                  "dimensionFilter": {
                    "kind": "dfareporting#pathReportDimensionValue",
                    "dimensionName": string,
                    "values": [
                      string
                    ],
                    "ids": [
                      string
                    ],
                    "matchType": string
                  }
                }
              ]
            }
          ]
        }
      ]
    },
    "pathFilters": [
      {
        "kind": "dfaReporting#pathFilter",
        "eventFilters": [
          {
            "kind": "dfareporting#eventFilter",
            "dimensionFilter": {
              "kind": "dfareporting#pathReportDimensionValue",
              "dimensionName": string,
              "values": [
                string
              ],
              "ids": [
                string
              ],
              "matchType": string
            }
          }
        ],
        "pathMatchPosition": string
      }
    ],
    "dimensions": [
      {
        "kind": "dfareporting#sortedDimension",
        "name": string,
        "sortOrder": string
      }
    ],
    "metricNames": [
      string
    ]
  },
  "schedule": {
    "active": boolean,
    "repeats": string,
    "every": integer,
    "repeatsOnWeekDays": [
      string
    ],
    "startDate": date,
    "expirationDate": date,
    "runsOnDayOfMonth": string
  },
  "delivery": {
    "emailOwner": boolean,
    "emailOwnerDeliveryType": string,
    "message": string,
    "recipients": [
      {
        "kind": "dfareporting#recipient",
        "email": string,
        "deliveryType": string
      }
    ]
  }
}
Nome da propriedade Valor Descrição Observações
accountId long É o ID da conta a que esse relatório pertence.
criteria object São os critérios para um relatório do tipo "STANDARD".
criteria.activities nested object É o grupo de atividades.
criteria.activities.filters[] list Lista dos filtros de atividades. Os valores de dimensão precisam ser todos do tipo "dfa:activity" ou "dfa:activityGroup". gravável
criteria.activities.kind string É o tipo de recurso. Neste caso, dfareporting#activities.
criteria.activities.metricNames[] list É a lista de nomes das métricas de atividade do Floodlight. gravável
criteria.customRichMediaEvents nested object Grupo de eventos personalizados de rich media.
criteria.customRichMediaEvents.filteredEventIds[] list Lista dos IDs de evento personalizado de rich media. Os valores de dimensão precisam ser todos do tipo dfa:richMediaEventTypeIdAndName. gravável
criteria.customRichMediaEvents.kind string É o tipo de recurso. Neste caso, dfareporting#customRichMediaEvents.
criteria.dateRange nested object É o período que precisa ser incluído na geração desse relatório.
criteria.dateRange.endDate date É a data de término do período, inclusive. Uma string no formato: "aaaa-MM-dd". gravável
criteria.dateRange.kind string É o tipo de recurso. Neste caso, dfareporting#dateRange.
criteria.dateRange.relativeDateRange string É o período relativo a quando o relatório é gerado.

Os valores aceitáveis são os seguintes:
  • "LAST_14_DAYS"
  • "LAST_24_MONTHS"
  • "LAST_30_DAYS"
  • "LAST_365_DAYS"
  • "LAST_60_DAYS"
  • "LAST_7_DAYS"
  • "LAST_90_DAYS"
  • "MONTH_TO_DATE"
  • "PREVIOUS_MONTH"
  • "PREVIOUS_QUARTER"
  • "PREVIOUS_WEEK"
  • "PREVIOUS_YEAR"
  • "QUARTER_TO_DATE"
  • "TODAY"
  • "WEEK_TO_DATE"
  • "YEAR_TO_DATE"
  • "YESTERDAY"
gravável
criteria.dateRange.startDate date A data de início do período, inclusive. Uma string no formato: "aaaa-MM-dd". gravável
criteria.dimensionFilters[] list A lista dos filtros que serão usados nas dimensões.

Filtros para diferentes dimensões usam AND, filtros para a mesma dimensão são agrupados e usam OR.

gravável
criteria.dimensions[] list A lista de dimensões padrão que o relatório deve incluir. gravável
criteria.dimensions[].kind string É o tipo de recurso. Neste caso, dfareporting#sortedDimension.
criteria.dimensions[].name string É o nome da dimensão.
criteria.dimensions[].sortOrder string É uma ordem de classificação opcional para a coluna de dimensão.

Os valores aceitáveis são os seguintes:
  • "ASCENDING"
  • "DESCENDING"
criteria.metricNames[] list É a lista dos nomes de métricas que o relatório deve incluir. gravável
crossDimensionReachCriteria object Os critérios para um relatório do tipo "CROSS_DIMENSION_REACH". gravável
crossDimensionReachCriteria.breakdown[] list A lista de dimensões que o relatório deve incluir. gravável
crossDimensionReachCriteria.breakdown[].kind string É o tipo de recurso. Neste caso, dfareporting#sortedDimension.
crossDimensionReachCriteria.breakdown[].name string É o nome da dimensão.
crossDimensionReachCriteria.breakdown[].sortOrder string É uma ordem de classificação opcional para a coluna de dimensão.

Os valores aceitáveis são os seguintes:
  • "ASCENDING"
  • "DESCENDING"
crossDimensionReachCriteria.dateRange nested object É o período que precisa ser incluído na geração deste relatório. gravável
crossDimensionReachCriteria.dateRange.endDate date A data de término do período, inclusive. Uma string no formato: "aaaa-MM-dd". gravável
crossDimensionReachCriteria.dateRange.kind string É o tipo de recurso. Neste caso, dfareporting#dateRange.
crossDimensionReachCriteria.dateRange.relativeDateRange string É o período relativo a quando o relatório é gerado.

Os valores aceitáveis são os seguintes:
  • "LAST_14_DAYS"
  • "LAST_24_MONTHS"
  • "LAST_30_DAYS"
  • "LAST_365_DAYS"
  • "LAST_60_DAYS"
  • "LAST_7_DAYS"
  • "LAST_90_DAYS"
  • "MONTH_TO_DATE"
  • "PREVIOUS_MONTH"
  • "PREVIOUS_QUARTER"
  • "PREVIOUS_WEEK"
  • "PREVIOUS_YEAR"
  • "QUARTER_TO_DATE"
  • "TODAY"
  • "WEEK_TO_DATE"
  • "YEAR_TO_DATE"
  • "YESTERDAY"
gravável
crossDimensionReachCriteria.dateRange.startDate date A data de início do período, inclusive. Uma string no formato: "aaaa-MM-dd". gravável
crossDimensionReachCriteria.dimension string É a opção da dimensão.

Os valores aceitáveis são os seguintes:
  • "ADVERTISER"
  • "CAMPAIGN"
  • "SITE_BY_ADVERTISER"
  • "SITE_BY_CAMPAIGN"
gravável
crossDimensionReachCriteria.dimensionFilters[] list A lista dos filtros que serão usados nas dimensões. gravável
crossDimensionReachCriteria.metricNames[] list A lista dos nomes de métricas que o relatório deve incluir. gravável
crossDimensionReachCriteria.overlapMetricNames[] list A lista de nomes das métricas de sobreposição que o relatório deve incluir. gravável
crossDimensionReachCriteria.pivoted boolean Se o relatório é dinâmico ou não. O padrão é true. gravável
delivery object As configurações de entrega de relatórios por e-mail. gravável
delivery.emailOwner boolean Se o relatório deve ser enviado por e-mail ao proprietário do relatório. gravável
delivery.emailOwnerDeliveryType string É o tipo de entrega para o proprietário que receberá o relatório, se ativado.

Os valores aceitáveis são os seguintes:
  • "ATTACHMENT"
  • "LINK"
gravável
delivery.message string A mensagem que será enviada em cada e-mail. gravável
delivery.recipients[] list A lista dos destinatários para os quais enviar o relatório por e-mail. gravável
delivery.recipients[].deliveryType string É o tipo de entrega ao destinatário.

Os valores aceitáveis são os seguintes:
  • "ATTACHMENT"
  • "LINK"
gravável
delivery.recipients[].email string O endereço de e-mail do destinatário. gravável
delivery.recipients[].kind string É o tipo de recurso. Neste caso, dfareporting#recipient.
etag etag É a ETag desta resposta para fins de armazenamento em cache.
fileName string É o nome de arquivo usado ao gerar os arquivos de relatório. gravável
floodlightCriteria object São os critérios para um relatório do tipo "FLOODLIGHT".
floodlightCriteria.customRichMediaEvents[] list A lista de eventos rich media personalizados a ser incluída.
floodlightCriteria.dateRange nested object É o período que precisa ser incluído na geração deste relatório.
floodlightCriteria.dateRange.endDate date É a data de término do período, inclusive. Uma string no formato: "aaaa-MM-dd". gravável
floodlightCriteria.dateRange.kind string É o tipo de recurso. Neste caso, dfareporting#dateRange.
floodlightCriteria.dateRange.relativeDateRange string É o período relativo a quando o relatório é gerado.

Os valores aceitáveis são os seguintes:
  • "LAST_14_DAYS"
  • "LAST_24_MONTHS"
  • "LAST_30_DAYS"
  • "LAST_365_DAYS"
  • "LAST_60_DAYS"
  • "LAST_7_DAYS"
  • "LAST_90_DAYS"
  • "MONTH_TO_DATE"
  • "PREVIOUS_MONTH"
  • "PREVIOUS_QUARTER"
  • "PREVIOUS_WEEK"
  • "PREVIOUS_YEAR"
  • "QUARTER_TO_DATE"
  • "TODAY"
  • "WEEK_TO_DATE"
  • "YEAR_TO_DATE"
  • "YESTERDAY"
gravável
floodlightCriteria.dateRange.startDate date A data de início do período, inclusive. Uma string no formato: "aaaa-MM-dd". gravável
floodlightCriteria.dimensionFilters[] list A lista dos filtros que serão usados nas dimensões.

Filtros para diferentes dimensões usam AND, filtros para a mesma dimensão são agrupados e usam OR.

gravável
floodlightCriteria.dimensions[] list A lista de dimensões que o relatório deve incluir. gravável
floodlightCriteria.dimensions[].kind string É o tipo de recurso. Neste caso, dfareporting#sortedDimension.
floodlightCriteria.dimensions[].name string É o nome da dimensão.
floodlightCriteria.dimensions[].sortOrder string É uma ordem de classificação opcional para a coluna de dimensão.

Os valores aceitáveis são os seguintes:
  • "ASCENDING"
  • "DESCENDING"
floodlightCriteria.floodlightConfigId nested object É o ID do Floodlight para os dados que você quer exibir no relatório. Todos os anunciantes associados a esse ID serão automaticamente adicionados. A dimensão do valor precisa ser "dfa:floodlightConfigId". gravável
floodlightCriteria.metricNames[] list A lista dos nomes de métricas que o relatório deve incluir. gravável
floodlightCriteria.reportProperties object As propriedades do relatório.
floodlightCriteria.reportProperties.includeAttributedIPConversions boolean Inclui conversões sem cookie, mas com um caminho de exposição.
floodlightCriteria.reportProperties.includeUnattributedCookieConversions boolean Inclui conversões de usuários com um cookie da DoubleClick, mas sem uma exposição. Isso significa que o usuário não clicou nem viu um anúncio do anunciante no grupo do Floodlight ou que a interação ocorreu fora da janela de lookback.
floodlightCriteria.reportProperties.includeUnattributedIPConversions boolean Inclui conversões sem cookies associados e sem exposições. Por essa razão, é impossível saber como o usuário foi exposto aos seus anúncios durante a janela de lookback anterior à conversão.
format string É o formato de saída do relatório. Se não for especificado, o formato padrão será "CSV". O formato real no arquivo de relatório concluído poderá ser diferente se, por exemplo, o tamanho do relatório exceder as capacidades do formato. Nesse caso, "CSV" será o formato substituto.

Os valores aceitáveis são os seguintes:
  • "CSV"
  • "EXCEL"
gravável
id long É o ID único que identifica esse recurso de relatório.
kind string É o tipo de recurso. Neste caso, dfareporting#report.
lastModifiedTime unsigned long É o carimbo de data/hora (em milissegundos desde a época) da última modificação desse relatório.
name string O nome do relatório. gravável
ownerProfileId long É o ID do perfil de usuário do proprietário deste relatório.
pathAttributionCriteria object São os critérios para um relatório do tipo "PATH_ATTRIBUTION".
pathAttributionCriteria.activityFilters[] list É a lista de valores "dfa:activity" para filtrar. gravável
pathAttributionCriteria.customChannelGrouping nested object É um agrupamento de canais.
pathAttributionCriteria.customChannelGrouping.fallbackName string É o nome substituto do ChannelGrouping.
pathAttributionCriteria.customChannelGrouping.kind string É o tipo de recurso. Neste caso, dfareporting#channelGrouping.
pathAttributionCriteria.customChannelGrouping.name string É o nome do ChannelGrouping.
pathAttributionCriteria.customChannelGrouping.rules[] list São as regras contidas neste agrupamento de canais.
pathAttributionCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[] list São as declarações de correspondência disjuntiva contidas nesta regra.
pathAttributionCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[] list São os filtros de evento contidos nesta declaração de correspondência disjuntiva.
pathAttributionCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter nested object É o filtro de dimensão contido neste EventFilter.
pathAttributionCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.dimensionName string É o nome da dimensão.
pathAttributionCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.ids[] list São os possíveis IDs associados ao valor, se disponíveis.
pathAttributionCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.kind string É o tipo de recurso. Neste caso, dfareporting#pathReportDimensionValue.
pathAttributionCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.matchType string Determina como é feita a correspondência do campo "valor" durante a filtragem. Se não for especificado, o padrão será "EXACT". Se definido como WILDCARD_EXPRESSION, '"*" é permitido como um marcador de posição para as sequências de caracteres de comprimento variável e pode ser escapado com uma barra invertida. Observação: somente as dimensões de pesquisa paga ("dfa:paidSearch*") permitem outro matchType que não EXACT.

Os valores aceitáveis são:
  • "BEGINS_WITH"
  • "CONTAINS"
  • "EXACT"
  • "WILDCARD_EXPRESSION"
pathAttributionCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.values[] list São os valores possíveis para a dimensão.
pathAttributionCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].kind string É o tipo de recurso. Neste caso, dfareporting#eventFilter.
pathAttributionCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].kind string É o tipo de recurso. Neste caso, dfareporting#disjunctiveMatchStatement.
pathAttributionCriteria.customChannelGrouping.rules[].kind string É o tipo de recurso. Neste caso, dfareporting#channelGroupingRule.
pathAttributionCriteria.customChannelGrouping.rules[].name string É o nome da regra.
pathAttributionCriteria.dateRange nested object É o período que precisa ser incluído na geração deste relatório.
pathAttributionCriteria.dateRange.endDate date É a data de término do período, inclusive. Uma string no formato: "aaaa-MM-dd". gravável
pathAttributionCriteria.dateRange.kind string É o tipo de recurso. Neste caso, dfareporting#dateRange.
pathAttributionCriteria.dateRange.relativeDateRange string É o período relativo a quando o relatório é gerado.

Os valores aceitáveis são os seguintes:
  • "LAST_14_DAYS"
  • "LAST_24_MONTHS"
  • "LAST_30_DAYS"
  • "LAST_365_DAYS"
  • "LAST_60_DAYS"
  • "LAST_7_DAYS"
  • "LAST_90_DAYS"
  • "MONTH_TO_DATE"
  • "PREVIOUS_MONTH"
  • "PREVIOUS_QUARTER"
  • "PREVIOUS_WEEK"
  • "PREVIOUS_YEAR"
  • "QUARTER_TO_DATE"
  • "TODAY"
  • "WEEK_TO_DATE"
  • "YEAR_TO_DATE"
  • "YESTERDAY"
gravável
pathAttributionCriteria.dateRange.startDate date A data de início do período, inclusive. Uma string no formato: "aaaa-MM-dd". gravável
pathAttributionCriteria.dimensions[] list A lista de dimensões que o relatório deve incluir. gravável
pathAttributionCriteria.dimensions[].kind string É o tipo de recurso. Neste caso, dfareporting#sortedDimension.
pathAttributionCriteria.dimensions[].name string É o nome da dimensão.
pathAttributionCriteria.dimensions[].sortOrder string É uma ordem de classificação opcional para a coluna de dimensão.

Os valores aceitáveis são os seguintes:
  • "ASCENDING"
  • "DESCENDING"
pathAttributionCriteria.floodlightConfigId nested object É o ID do Floodlight para os dados que você quer exibir no relatório. Todos os anunciantes associados a esse ID serão automaticamente adicionados. A dimensão do valor precisa ser "dfa:floodlightConfigId". gravável
pathAttributionCriteria.metricNames[] list A lista dos nomes de métricas que o relatório deve incluir. gravável
pathAttributionCriteria.pathFilters[] list São os filtros de caminho.
pathAttributionCriteria.pathFilters[].eventFilters[] list São os filtros de evento no relatório de caminho.
pathAttributionCriteria.pathFilters[].eventFilters[].dimensionFilter nested object É o filtro de dimensão contido neste EventFilter.
pathAttributionCriteria.pathFilters[].eventFilters[].dimensionFilter.dimensionName string É o nome da dimensão.
pathAttributionCriteria.pathFilters[].eventFilters[].dimensionFilter.ids[] list São os possíveis IDs associados ao valor, se disponíveis.
pathAttributionCriteria.pathFilters[].eventFilters[].dimensionFilter.kind string É o tipo de recurso. Neste caso, dfareporting#pathReportDimensionValue.
pathAttributionCriteria.pathFilters[].eventFilters[].dimensionFilter.matchType string Determina como é feita a correspondência do campo "valor" durante a filtragem. Se não for especificado, o padrão será "EXACT". Se definido como WILDCARD_EXPRESSION, '"*" é permitido como um marcador de posição para as sequências de caracteres de comprimento variável e pode ser escapado com uma barra invertida. Observação: somente as dimensões de pesquisa paga ("dfa:paidSearch*") permitem outro matchType que não EXACT.

Os valores aceitáveis são:
  • "BEGINS_WITH"
  • "CONTAINS"
  • "EXACT"
  • "WILDCARD_EXPRESSION"
pathAttributionCriteria.pathFilters[].eventFilters[].dimensionFilter.values[] list São os valores possíveis para a dimensão.
pathAttributionCriteria.pathFilters[].eventFilters[].kind string É o tipo de recurso. Neste caso, dfareporting#eventFilter.
pathAttributionCriteria.pathFilters[].kind string É o tipo de recurso. Neste caso, dfareporting#pathFilter.
pathAttributionCriteria.pathFilters[].pathMatchPosition string Determina como é feita a correspondência do campo "valor" durante a filtragem. Se não for especificado, o padrão será "EXACT". Se definido como WILDCARD_EXPRESSION, '"*" é permitido como um marcador de posição para as sequências de caracteres de comprimento variável e pode ser escapado com uma barra invertida. Observação: somente as dimensões de pesquisa paga ("dfa:paidSearch*") permitem outro matchType que não EXACT.

Os valores aceitáveis são:
  • "ANY"
  • "FIRST"
  • "LAST"
  • "PATH_MATCH_POSITION_UNSPECIFIED"
pathCriteria object São os critérios para um relatório do tipo "PATH".
pathCriteria.activityFilters[] list É a lista de valores "dfa:activity" para filtrar. gravável
pathCriteria.customChannelGrouping nested object É um agrupamento de canais.
pathCriteria.customChannelGrouping.fallbackName string É o nome substituto do ChannelGrouping.
pathCriteria.customChannelGrouping.kind string É o tipo de recurso. Neste caso, dfareporting#channelGrouping.
pathCriteria.customChannelGrouping.name string É o nome do ChannelGrouping.
pathCriteria.customChannelGrouping.rules[] list São as regras contidas neste agrupamento de canais.
pathCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[] list São as declarações de correspondência disjuntiva contidas nesta regra.
pathCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[] list São os filtros de evento contidos nesta declaração de correspondência disjuntiva.
pathCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter nested object É o filtro de dimensão contido neste EventFilter.
pathCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.dimensionName string É o nome da dimensão.
pathCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.ids[] list São os possíveis IDs associados ao valor, se disponíveis.
pathCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.kind string É o tipo de recurso. Neste caso, dfareporting#pathReportDimensionValue.
pathCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.matchType string Determina como é feita a correspondência do campo "valor" durante a filtragem. Se não for especificado, o padrão será "EXACT". Se definido como WILDCARD_EXPRESSION, '"*" é permitido como um marcador de posição para as sequências de caracteres de comprimento variável e pode ser escapado com uma barra invertida. Observação: somente as dimensões de pesquisa paga ("dfa:paidSearch*") permitem outro matchType que não EXACT.

Os valores aceitáveis são:
  • "BEGINS_WITH"
  • "CONTAINS"
  • "EXACT"
  • "WILDCARD_EXPRESSION"
pathCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.values[] list São os valores possíveis para a dimensão.
pathCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].kind string É o tipo de recurso. Neste caso, dfareporting#eventFilter.
pathCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].kind string É o tipo de recurso. Neste caso, dfareporting#disjunctiveMatchStatement.
pathCriteria.customChannelGrouping.rules[].kind string É o tipo de recurso. Neste caso, dfareporting#channelGroupingRule.
pathCriteria.customChannelGrouping.rules[].name string É o nome da regra.
pathCriteria.dateRange nested object É o período que precisa ser incluído na geração deste relatório.
pathCriteria.dateRange.endDate date É a data de término do período, inclusive. Uma string no formato: "aaaa-MM-dd". gravável
pathCriteria.dateRange.kind string É o tipo de recurso. Neste caso, dfareporting#dateRange.
pathCriteria.dateRange.relativeDateRange string É o período relativo a quando o relatório é gerado.

Os valores aceitáveis são os seguintes:
  • "LAST_14_DAYS"
  • "LAST_24_MONTHS"
  • "LAST_30_DAYS"
  • "LAST_365_DAYS"
  • "LAST_60_DAYS"
  • "LAST_7_DAYS"
  • "LAST_90_DAYS"
  • "MONTH_TO_DATE"
  • "PREVIOUS_MONTH"
  • "PREVIOUS_QUARTER"
  • "PREVIOUS_WEEK"
  • "PREVIOUS_YEAR"
  • "QUARTER_TO_DATE"
  • "TODAY"
  • "WEEK_TO_DATE"
  • "YEAR_TO_DATE"
  • "YESTERDAY"
gravável
pathCriteria.dateRange.startDate date A data de início do período, inclusive. Uma string no formato: "aaaa-MM-dd". gravável
pathCriteria.dimensions[] list A lista de dimensões que o relatório deve incluir. gravável
pathCriteria.dimensions[].kind string É o tipo de recurso. Neste caso, dfareporting#sortedDimension.
pathCriteria.dimensions[].name string É o nome da dimensão.
pathCriteria.dimensions[].sortOrder string É uma ordem de classificação opcional para a coluna de dimensão.

Os valores aceitáveis são os seguintes:
  • "ASCENDING"
  • "DESCENDING"
pathCriteria.floodlightConfigId nested object É o ID do Floodlight para os dados que você quer exibir no relatório. Todos os anunciantes associados a esse ID serão automaticamente adicionados. A dimensão do valor precisa ser "dfa:floodlightConfigId". gravável
pathCriteria.metricNames[] list A lista dos nomes de métricas que o relatório deve incluir. gravável
pathCriteria.pathFilters[] list São os filtros de caminho.
pathCriteria.pathFilters[].eventFilters[] list São os filtros de evento no relatório de caminho.
pathCriteria.pathFilters[].eventFilters[].dimensionFilter nested object É o filtro de dimensão contido neste EventFilter.
pathCriteria.pathFilters[].eventFilters[].dimensionFilter.dimensionName string É o nome da dimensão.
pathCriteria.pathFilters[].eventFilters[].dimensionFilter.ids[] list São os possíveis IDs associados ao valor, se disponíveis.
pathCriteria.pathFilters[].eventFilters[].dimensionFilter.kind string É o tipo de recurso. Neste caso, dfareporting#pathReportDimensionValue.
pathCriteria.pathFilters[].eventFilters[].dimensionFilter.matchType string Determina como é feita a correspondência do campo "valor" durante a filtragem. Se não for especificado, o padrão será "EXACT". Se definido como WILDCARD_EXPRESSION, '"*" é permitido como um marcador de posição para as sequências de caracteres de comprimento variável e pode ser escapado com uma barra invertida. Observação: somente as dimensões de pesquisa paga ("dfa:paidSearch*") permitem outro matchType que não EXACT.

Os valores aceitáveis são:
  • "BEGINS_WITH"
  • "CONTAINS"
  • "EXACT"
  • "WILDCARD_EXPRESSION"
pathCriteria.pathFilters[].eventFilters[].dimensionFilter.values[] list São os valores possíveis para a dimensão.
pathCriteria.pathFilters[].eventFilters[].kind string É o tipo de recurso. Neste caso, dfareporting#eventFilter.
pathCriteria.pathFilters[].kind string É o tipo de recurso. Neste caso, dfareporting#pathFilter.
pathCriteria.pathFilters[].pathMatchPosition string Determina como é feita a correspondência do campo "valor" durante a filtragem. Se não for especificado, o padrão será "EXACT". Se definido como WILDCARD_EXPRESSION, '"*" é permitido como um marcador de posição para as sequências de caracteres de comprimento variável e pode ser escapado com uma barra invertida. Observação: somente as dimensões de pesquisa paga ("dfa:paidSearch*") permitem outro matchType que não EXACT.

Os valores aceitáveis são:
  • "ANY"
  • "FIRST"
  • "LAST"
  • "PATH_MATCH_POSITION_UNSPECIFIED"
pathToConversionCriteria object São os critérios para um relatório do tipo "PATH_TO_CONVERSION".
pathToConversionCriteria.activityFilters[] list É a lista de valores "dfa:activity" para filtrar. gravável
pathToConversionCriteria.conversionDimensions[] list A lista de dimensões de conversão que o relatório deve incluir. gravável
pathToConversionCriteria.conversionDimensions[].kind string É o tipo de recurso. Neste caso, dfareporting#sortedDimension.
pathToConversionCriteria.conversionDimensions[].name string É o nome da dimensão.
pathToConversionCriteria.conversionDimensions[].sortOrder string É uma ordem de classificação opcional para a coluna de dimensão.

Os valores aceitáveis são os seguintes:
  • "ASCENDING"
  • "DESCENDING"
pathToConversionCriteria.customFloodlightVariables[] list É a lista de variáveis personalizadas do Floodlight que o relatório deve incluir. gravável
pathToConversionCriteria.customFloodlightVariables[].kind string É o tipo de recurso. Neste caso, dfareporting#sortedDimension.
pathToConversionCriteria.customFloodlightVariables[].name string É o nome da dimensão.
pathToConversionCriteria.customFloodlightVariables[].sortOrder string É uma ordem de classificação opcional para a coluna de dimensão.

Os valores aceitáveis são os seguintes:
  • "ASCENDING"
  • "DESCENDING"
pathToConversionCriteria.customRichMediaEvents[] list É a lista de eventos personalizados de rich media a ser incluída.
pathToConversionCriteria.dateRange nested object É o período que precisa ser incluído na geração deste relatório.
pathToConversionCriteria.dateRange.endDate date É a data de término do período, inclusive. Uma string no formato: "aaaa-MM-dd". gravável
pathToConversionCriteria.dateRange.kind string É o tipo de recurso. Neste caso, dfareporting#dateRange.
pathToConversionCriteria.dateRange.relativeDateRange string É o período relativo a quando o relatório é gerado.

Os valores aceitáveis são os seguintes:
  • "LAST_14_DAYS"
  • "LAST_24_MONTHS"
  • "LAST_30_DAYS"
  • "LAST_365_DAYS"
  • "LAST_60_DAYS"
  • "LAST_7_DAYS"
  • "LAST_90_DAYS"
  • "MONTH_TO_DATE"
  • "PREVIOUS_MONTH"
  • "PREVIOUS_QUARTER"
  • "PREVIOUS_WEEK"
  • "PREVIOUS_YEAR"
  • "QUARTER_TO_DATE"
  • "TODAY"
  • "WEEK_TO_DATE"
  • "YEAR_TO_DATE"
  • "YESTERDAY"
gravável
pathToConversionCriteria.dateRange.startDate date A data de início do período, inclusive. Uma string no formato: "aaaa-MM-dd". gravável
pathToConversionCriteria.floodlightConfigId nested object É o ID do Floodlight para os dados que você quer exibir no relatório. Todos os anunciantes associados a esse ID serão automaticamente adicionados. A dimensão do valor precisa ser "dfa:floodlightConfigId". gravável
pathToConversionCriteria.metricNames[] list A lista dos nomes de métricas que o relatório deve incluir. gravável
pathToConversionCriteria.perInteractionDimensions[] list A lista de dimensões por interação que o relatório deve incluir. gravável
pathToConversionCriteria.perInteractionDimensions[].kind string É o tipo de recurso. Neste caso, dfareporting#sortedDimension.
pathToConversionCriteria.perInteractionDimensions[].name string É o nome da dimensão.
pathToConversionCriteria.perInteractionDimensions[].sortOrder string É uma ordem de classificação opcional para a coluna de dimensão.

Os valores aceitáveis são os seguintes:
  • "ASCENDING"
  • "DESCENDING"
pathToConversionCriteria.reportProperties object São as propriedades do relatório.
pathToConversionCriteria.reportProperties.clicksLookbackWindow integer O Campaign Manager 360 verifica se uma interação de clique ocorreu no período especificado antes de uma conversão. Por padrão, o valor é extraído do Floodlight, mas você pode inserir manualmente um valor personalizado. Valores válidos: entre 1 e 90.
pathToConversionCriteria.reportProperties.impressionsLookbackWindow integer O Campaign Manager 360 verifica se uma interação de impressão ocorreu no período especificado antes de uma conversão. Por padrão, o valor é extraído do Floodlight, mas você pode inserir manualmente um valor personalizado. Valores válidos: entre 1 e 90.
pathToConversionCriteria.reportProperties.includeAttributedIPConversions boolean Desativado: não tem efeito.
pathToConversionCriteria.reportProperties.includeUnattributedCookieConversions boolean Inclui conversões de usuários com um cookie da DoubleClick, mas sem uma exposição. Isso significa que o usuário não clicou nem viu um anúncio do anunciante no grupo do Floodlight ou que a interação ocorreu fora da janela de lookback.
pathToConversionCriteria.reportProperties.includeUnattributedIPConversions boolean Inclui conversões sem cookies associados e sem exposições. Por essa razão, é impossível saber como o usuário foi exposto aos seus anúncios durante a janela de lookback anterior à conversão.
pathToConversionCriteria.reportProperties.maximumClickInteractions integer É o número máximo de interações que será incluído no relatório. Os anunciantes que pagam pelos relatórios E2C recebem até 200 (100 cliques e 100 impressões). Se outro anunciante em sua rede pagar por relatórios E2C, você poderá ter até cinco exposições totais por relatório.
pathToConversionCriteria.reportProperties.maximumImpressionInteractions integer O número máximo de interações que será incluído no relatório. Os anunciantes que pagam pelos relatórios E2C recebem até 200 (100 cliques e 100 impressões). Se outro anunciante em sua rede pagar por relatórios E2C, você poderá ter até cinco exposições totais por relatório.
pathToConversionCriteria.reportProperties.maximumInteractionGap integer É o tempo máximo que pode ocorrer entre as interações (cliques ou impressões) pelo mesmo usuário. Valores válidos: entre 1 e 90.
pathToConversionCriteria.reportProperties.pivotOnInteractionPath boolean Ativa a dinamicidade no caminho de interação.
reachCriteria object São os critérios para um relatório do tipo "REACH".
reachCriteria.activities nested object É o grupo de atividades.
reachCriteria.activities.filters[] list Lista dos filtros de atividades. Os valores de dimensão precisam ser todos do tipo "dfa:activity" ou "dfa:activityGroup". gravável
reachCriteria.activities.kind string É o tipo de recurso. Neste caso, dfareporting#activities.
reachCriteria.activities.metricNames[] list É a lista de nomes das métricas de atividade do Floodlight. gravável
reachCriteria.customRichMediaEvents nested object Grupo de eventos personalizados de rich media.
reachCriteria.customRichMediaEvents.filteredEventIds[] list Lista dos IDs de evento personalizado de rich media. Os valores de dimensão precisam ser todos do tipo dfa:richMediaEventTypeIdAndName. gravável
reachCriteria.customRichMediaEvents.kind string É o tipo de recurso. Neste caso, dfareporting#customRichMediaEvents.
reachCriteria.dateRange nested object É o período que precisa ser incluído na geração deste relatório.
reachCriteria.dateRange.endDate date É a data de término do período, inclusive. Uma string no formato: "aaaa-MM-dd". gravável
reachCriteria.dateRange.kind string É o tipo de recurso. Neste caso, dfareporting#dateRange.
reachCriteria.dateRange.relativeDateRange string É o período relativo a quando o relatório é gerado.

Os valores aceitáveis são os seguintes:
  • "LAST_14_DAYS"
  • "LAST_24_MONTHS"
  • "LAST_30_DAYS"
  • "LAST_365_DAYS"
  • "LAST_60_DAYS"
  • "LAST_7_DAYS"
  • "LAST_90_DAYS"
  • "MONTH_TO_DATE"
  • "PREVIOUS_MONTH"
  • "PREVIOUS_QUARTER"
  • "PREVIOUS_WEEK"
  • "PREVIOUS_YEAR"
  • "QUARTER_TO_DATE"
  • "TODAY"
  • "WEEK_TO_DATE"
  • "YEAR_TO_DATE"
  • "YESTERDAY"
gravável
reachCriteria.dateRange.startDate date A data de início do período, inclusive. Uma string no formato: "aaaa-MM-dd". gravável
reachCriteria.dimensionFilters[] list A lista dos filtros que serão usados nas dimensões.

Filtros para diferentes dimensões usam AND, filtros para a mesma dimensão são agrupados e usam OR.

gravável
reachCriteria.dimensions[] list A lista de dimensões que o relatório deve incluir. gravável
reachCriteria.dimensions[].kind string É o tipo de recurso. Neste caso, dfareporting#sortedDimension.
reachCriteria.dimensions[].name string É o nome da dimensão.
reachCriteria.dimensions[].sortOrder string É uma ordem de classificação opcional para a coluna de dimensão.

Os valores aceitáveis são os seguintes:
  • "ASCENDING"
  • "DESCENDING"
reachCriteria.enableAllDimensionCombinations boolean Indica se todas as combinações de dimensões de alcance serão ativadas no relatório. Padroniza como falso. Se ativado, o período do relatório precisa ser nos últimos 42 dias. gravável
reachCriteria.metricNames[] list A lista dos nomes de métricas que o relatório deve incluir. gravável
reachCriteria.reachByFrequencyMetricNames[] list A lista de nomes das métricas de alcance por frequência que o relatório deve incluir. gravável
schedule object A programação do relatório. Só poderá ser definida se o "dateRange" do relatório for um período relativo e se o período relativo não for "TODAY". gravável
schedule.active boolean Se a programação está ativa ou não. Deve ser definida como true ou false. gravável
schedule.every integer Define a cada quantos dias, semanas ou meses o relatório deve ser gerado. Precisa ser definida quando "repeats" for "DAILY", "WEEKLY" ou "MONTHLY". gravável
schedule.expirationDate date A data de expiração na qual o relatório programado deixa de ser gerado. gravável
schedule.repeats string É o intervalo em que o relatório é repetido. Observação:
  • "DAILY" também requer que o campo "every" seja definido.
  • "WEEKLY" também requer que os campos "every" e "repeatsOnWeekDays" sejam definidos.
  • "MONTHLY" também requer que os campos "every" e "runsOnDayOfMonth" sejam definidos.
gravável
schedule.repeatsOnWeekDays[] list Lista dos dias da semana em que os relatórios programados "WEEKLY" devem ser gerados. gravável
schedule.runsOnDayOfMonth string Nos relatórios programados "MONTHLY", é a enumeração para definir se os relatórios devem ser repetidos no mesmo dia do mês como "startDate" ou no mesmo dia da semana no mês.

Exemplo: se "startDate" fosse segunda-feira, 2 de abril de 2012 (2012-04-02), "DAY_OF_MONTH" geraria os relatórios subsequentes no dia 2 de cada mês, e "WEEK_OF_MONTH" geraria relatórios subsequentes na primeira segunda-feira do mês.



Os valores aceitáveis são os seguintes:
  • "DAY_OF_MONTH"
  • "WEEK_OF_MONTH"
gravável
schedule.startDate date Data de início do período no qual os relatórios programados devem ser gerados. gravável
subAccountId long É o ID da subconta a que este relatório pertence, se aplicável.
type string É o tipo do relatório.

Os valores aceitáveis são os seguintes:
  • "CROSS_DIMENSION_REACH"
  • "FLOODLIGHT"
  • "PATH"
  • "PATH_ATTRIBUTION"
  • "PATH_TO_CONVERSION"
  • "REACH"
  • "STANDARD"

Métodos

query
Retorna os campos compatíveis a serem selecionados nas respectivas seções dos critérios de um relatório. Isso é feito de acordo com os campos já escolhidos na entrada do relatório e com as permissões do usuário.