REST Resource: properties

Recurso: propriedade

Uma mensagem de recurso que representa uma propriedade do Google Analytics.

Representação JSON
{
  "name": string,
  "propertyType": enum (PropertyType),
  "createTime": string,
  "updateTime": string,
  "parent": string,
  "displayName": string,
  "industryCategory": enum (IndustryCategory),
  "timeZone": string,
  "currencyCode": string,
  "serviceLevel": enum (ServiceLevel),
  "deleteTime": string,
  "expireTime": string,
  "account": string
}
Campos
name

string

Apenas saída. Nome do recurso dessa propriedade. Formato: properties/{property_id}. Exemplo: "properties/1000"

propertyType

enum (PropertyType)

Imutável. O tipo de propriedade para este recurso "Property". Ao criar uma propriedade, se o tipo for "PROPERTY_TYPE_UNSPECIFIED", "ORDINARY_PROPERTY" será implícito.

createTime

string (Timestamp format)

Apenas saída. Hora em que a entidade foi criada originalmente.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Apenas saída. Hora em que os campos de payload da entidade foram atualizados pela última vez.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

parent

string

Imutável. Nome do recurso do pai lógico desta propriedade.

Observação: a interface de movimentação de propriedades pode ser usada para mudar o pai. Formato: accounts/{account}, properties/{property}. Exemplo: "accounts/100", "properties/101"

displayName

string

Obrigatório. Nome de exibição legível para essa propriedade.

O comprimento máximo permitido do nome de exibição é de 100 unidades de código UTF-16.

industryCategory

enum (IndustryCategory)

Setor associado a esta propriedade. Exemplo: AUTOMOTIVE, FOOD_AND_DRINK

timeZone

string

Obrigatório. Fuso horário dos relatórios, usado como o limite do dia para os relatórios, seja qual for a origem dos dados. Se o fuso horário seguir o horário de verão, o Google Analytics fará os ajustes automaticamente.

OBSERVAÇÃO: a mudança do fuso horário só afeta dados posteriores, não sendo aplicada de forma retroativa.

Formato: https://www.iana.org/time-zones Exemplo: "America/Los_Angeles"

currencyCode

string

O tipo de moeda usado em relatórios que envolvem valores monetários.

Formato: https://en.wikipedia.org/wiki/ISO_4217. Exemplos: "USD", "EUR", "JPY"

serviceLevel

enum (ServiceLevel)

Apenas saída. O nível de serviço do Google Analytics que se aplica a essa propriedade.

deleteTime

string (Timestamp format)

Apenas saída. Se definido, o horário em que essa propriedade foi movida para a lixeira. Se não estiver definido, a propriedade não estará na lixeira.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

expireTime

string (Timestamp format)

Apenas saída. Se definido, o horário em que essa propriedade na lixeira será excluída permanentemente. Se não estiver definido, a propriedade não estará na lixeira e não será excluída.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

account

string

Imutável. O nome do recurso da conta principal. Formato: accounts/{account_id}. Exemplo: "accounts/123"

PropertyType

Tipos de recursos do Property.

Enums
PROPERTY_TYPE_UNSPECIFIED Tipo de propriedade desconhecido ou não especificado
PROPERTY_TYPE_ORDINARY Propriedade comum do Google Analytics
PROPERTY_TYPE_SUBPROPERTY Subpropriedade do Google Analytics
PROPERTY_TYPE_ROLLUP Propriedade de visualização completa do Google Analytics

IndustryCategory

A categoria selecionada para essa propriedade, usada para comparativos de mercado do setor.

Enums
INDUSTRY_CATEGORY_UNSPECIFIED Categoria do setor não especificada
AUTOMOTIVE Automóveis
BUSINESS_AND_INDUSTRIAL_MARKETS Mercados comercial e industrial
FINANCE Finanças
HEALTHCARE Saúde
TECHNOLOGY Tecnologia
TRAVEL Viagem
OTHER Outro
ARTS_AND_ENTERTAINMENT Artes e entretenimento
BEAUTY_AND_FITNESS Beleza e bem-estar
BOOKS_AND_LITERATURE Livros e literatura
FOOD_AND_DRINK Alimentos e bebidas
GAMES Jogos
HOBBIES_AND_LEISURE Hobbies e lazer
HOME_AND_GARDEN Casa e jardim
INTERNET_AND_TELECOM Internet e telecomunicações
LAW_AND_GOVERNMENT Legislação e governo
NEWS Notícias
ONLINE_COMMUNITIES Comunidades on-line
PEOPLE_AND_SOCIETY Pessoas e sociedade
PETS_AND_ANIMALS Animais de estimação e outros animais
REAL_ESTATE Imóveis
REFERENCE Referência
SCIENCE Ciência
SPORTS Esportes
JOBS_AND_EDUCATION Empregos e educação
SHOPPING Shopping

ServiceLevel

Vários níveis de serviço para o Google Analytics.

Enums
SERVICE_LEVEL_UNSPECIFIED O nível de serviço não foi especificado ou é inválido.
GOOGLE_ANALYTICS_STANDARD A versão padrão do Google Analytics.
GOOGLE_ANALYTICS_360 A versão paga e premium do Google Analytics.

Métodos

acknowledgeUserDataCollection

Confirma os termos de coleta de dados do usuário para a propriedade especificada.

create

Cria uma propriedade do Google Analytics com o local e os atributos especificados.

createRollupProperty

Crie uma propriedade de visualização completa e todos os links de origem dela.

delete

Marca a propriedade de destino como excluída de maneira reversível (ou seja, "movida para a lixeira") e a retorna.

get

Pesquisa por uma única propriedade do GA.

getAttributionSettings

Pesquisa por um singleton AttributionSettings.

getDataRetentionSettings

Retorna as configurações de retenção de dados singleton para esta propriedade.

getGoogleSignalsSettings

Pesquisa as configurações dos Indicadores do Google para uma propriedade.

getReportingIdentitySettings

Retorna as configurações de identidade de relatórios para essa propriedade.

list

Retorna as propriedades filhas na conta principal especificada.

patch

Atualiza uma propriedade.

provisionSubproperty

Crie uma subpropriedade e um filtro de eventos que se aplique a ela.

runAccessReport

Retorna um relatório personalizado de registros de acesso a dados.

submitUserDeletion

Envia uma solicitação de exclusão de usuário para uma propriedade.

updateAttributionSettings

Atualiza as configurações de atribuição em uma propriedade.

updateDataRetentionSettings

Atualiza as configurações de retenção de dados singleton para esta propriedade.

updateGoogleSignalsSettings

Atualiza as configurações dos Indicadores do Google para uma propriedade.