Metas

O recurso de metas descreve uma meta para um dos perfis do usuário.

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

Representações do recurso

Modelo JSON para o recurso de metas do Google Analytics.

{
  "id": string,
  "kind": "analytics#goal",
  "selfLink": string,
  "accountId": string,
  "webPropertyId": string,
  "internalWebPropertyId": string,
  "profileId": string,
  "name": string,
  "value": float,
  "active": boolean,
  "type": string,
  "created": datetime,
  "updated": datetime,
  "parentLink": {
    "type": "analytics#profile",
    "href": string
  },
  "urlDestinationDetails": {
    "url": string,
    "caseSensitive": boolean,
    "matchType": string,
    "firstStepRequired": boolean,
    "steps": [
      {
        "number": integer,
        "name": string,
        "url": string
      }
    ]
  },
  "visitTimeOnSiteDetails": {
    "comparisonType": string,
    "comparisonValue": long
  },
  "visitNumPagesDetails": {
    "comparisonType": string,
    "comparisonValue": long
  },
  "eventDetails": {
    "useEventValue": boolean,
    "eventConditions": [
      {
        "type": string,
        "matchType": string,
        "expression": string,
        "comparisonType": string,
        "comparisonValue": long
      }
    ]
  }
}
Nome da propriedade Valor Descrição Observações
accountId string ID da conta à qual essa meta pertence.
active boolean Determina se essa meta está ativa.
created datetime Horário de criação da meta.
eventDetails object Detalhes sobre a meta para o tipo EVENT.
eventDetails.eventConditions[] list Lista de condições de eventos.
eventDetails.eventConditions[].comparisonType string Tipo de comparação. Os valores possíveis são LESS_THAN, GREATER_THAN ou EQUAL.
eventDetails.eventConditions[].comparisonValue long Valor usado para a comparação.
eventDetails.eventConditions[].expression string Expressão usada para a correspondência.
eventDetails.eventConditions[].matchType string Tipo de correspondência a ser executada. Os valores possíveis são REGEXP, BEGINS_WITH ou EXACT.
eventDetails.eventConditions[].type string Tipo da condição do evento. Os valores possíveis são CATEGORY, ACTION, LABEL ou VALUE.
eventDetails.useEventValue boolean Determina se o valor do evento deve ser usado como valor para essa meta.
id string ID da meta
internalWebPropertyId string ID interno da propriedade da Web à qual a meta pertence.
kind string Tipo de recurso de uma meta do Google Analytics.
name string Nome da meta.
parentLink.href string Link para a vista da propriedade (perfil) à qual a meta pertence.
parentLink.type string O valor é "analytics#profile".
profileId string ID da vista da propriedade (perfil) à qual a meta pertence.
type string Tipo de meta. Os valores possíveis são URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES e EVENT.
updated datetime Horário da última modificação da meta.
urlDestinationDetails object Detalhes da meta do tipo URL_DESTINATION.
urlDestinationDetails.caseSensitive boolean Determina se o URL da meta precisa corresponder exatamente à formatação de letras maiúsculas e minúsculas dos URLs visitados.
urlDestinationDetails.firstStepRequired boolean Determina se a primeira etapa da meta é necessária.
urlDestinationDetails.matchType string Tipo de correspondência do URL da meta. Os possíveis valores são HEAD, EXACT ou REGEX.
urlDestinationDetails.steps[] list Lista de etapas configuradas para esse funil de meta.
urlDestinationDetails.steps[].name string Nome da etapa.
urlDestinationDetails.steps[].number integer Número da etapa.
urlDestinationDetails.steps[].url string URL da etapa.
urlDestinationDetails.url string URL da meta.
value float Valor da meta.
visitNumPagesDetails object Detalhes da meta do tipo VISIT_NUM_PAGES.
visitNumPagesDetails.comparisonType string Tipo de comparação. Os valores possíveis são LESS_THAN, GREATER_THAN ou EQUAL.
visitNumPagesDetails.comparisonValue long Valor usado para a comparação.
visitTimeOnSiteDetails object Detalhes da meta do tipo VISIT_TIME_ON_SITE.
visitTimeOnSiteDetails.comparisonType string Tipo de comparação. Os valores possíveis são LESS_THAN ou GREATER_THAN.
visitTimeOnSiteDetails.comparisonValue long Valor usado para a comparação.
webPropertyId string ID da propriedade da Web à qual essa meta pertence. O ID da propriedade da Web tem o formato UA-XXXXX-YY.

Métodos

get
Indica uma meta à qual o usuário tem acesso.
insert
Cria uma nova meta.
list
Lista as metas às quais o usuário tem acesso.
patch
Atualiza uma meta existente. Esse método é compatível com a semântica de patch.
update
Atualiza uma meta existente.