REST Resource: properties

Recurso: propriedade

Uma mensagem de recurso que representa uma propriedade do GA4 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: propriedades/{property_id} Exemplo: "properties/1000"
propertyType

enum (PropertyType)

Imutável. O tipo de propriedade desse recurso de propriedade. Ao criar uma propriedade, se o tipo for "PROPERTY_TYPE_UNSPECIFIED", então "ORDINARY_PROPERTY" estará implícito.
createTime

string (Timestamp format)

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

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

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

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
parent

string

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

Observação: a interface de usuário de mudança de propriedade pode ser usada para alterar o pai. Formato: accounts/{account}, properties/{property} Exemplo: "accounts/100", "properties/101"
displayName

string

Obrigatório. Nome de exibição legível por humanos para esta 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 relatórios, independentemente da origem dos dados. Se o fuso horário respeitar o horário de verão, o Google Analytics fará os ajustes automaticamente.

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

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" e "JPY"
serviceLevel

enum (ServiceLevel)

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

string (Timestamp format)

Apenas saída. Se definido, o horário em que esta propriedade foi enviada para a lixeira. Se a política não for definida, a propriedade não estará na lixeira.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
expireTime

string (Timestamp format)

Apenas saída. Se definido, o horário em que esta propriedade na lixeira será excluída permanentemente. Se a política não for definida, a propriedade não estará na lixeira e não será excluída.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
account

string

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

PropertyType

Tipos de recursos de propriedade.

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

IndustryCategory

A categoria selecionada para essa propriedade, usada para comparações de mercado.

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 Compras

ServiceLevel

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

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

Métodos

acknowledgeUserDataCollection

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

create

 Cria um "GA4" com o local e os atributos especificados.

delete

 Marca a propriedade target como excluída de forma reversível (ou seja: "lixeira") e a retorna.

get

 Pesquise um único GA4 Propriedade.

getDataRetentionSettings

 Retorna as configurações de retenção de dados do Singleton para essa propriedade.

list

 Retorna as propriedades filho na conta pai especificada.

patch

 Atualiza uma propriedade.

runAccessReport

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

updateDataRetentionSettings

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