REST Resource: properties

Recurso: propriedade

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

propertyType

enum (PropertyType)

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

createTime

string (Timestamp format)

Apenas saída. Horário em que a entidade foi criada originalmente.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, 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. Horário em que os campos de payload da entidade foram atualizados pela última vez.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, 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 movimentação de propriedades pode ser usada para alterar o pai. Formato: accounts/{account}, propriedades/{property} Exemplo: "accounts/100", "properties/101"

displayName

string

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

O tamanho máximo permitido para o 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. Caso o fuso horário siga 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. Ela não é aplicada de forma retroativa.

Formato: https://www.iana.org/time-zones (link em inglês). 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, a hora em que a propriedade foi enviada para a lixeira. Se não for definida, a propriedade não vai estar na lixeira.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, 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 essa propriedade na lixeira será excluída permanentemente. Se não for definida, a propriedade não vai estar na lixeira nem está programada para ser excluída.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, 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 do formato da conta mãe: 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 Automotivo
BUSINESS_AND_INDUSTRIAL_MARKETS Mercados comercial e industrial
FINANCE Finanças
HEALTHCARE Saúde
TECHNOLOGY Tecnologia
TRAVEL Viagem
OTHER Outros
ARTS_AND_ENTERTAINMENT Artes e entretenimento
BEAUTY_AND_FITNESS Beleza e condicionamento físico
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

Diversos níveis de serviço do 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 paga do Google Analytics.

Métodos

acknowledgeUserDataCollection

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

create

Cria uma propriedade do "GA4" com o local e os atributos especificados.

createConnectedSiteTag

Cria uma tag do site conectada para uma propriedade do Universal Analytics.

createRollupProperty

Criar uma propriedade de visualização completa e todas as vinculações de origem dela.

createSubproperty

Crie uma subpropriedade e um filtro de eventos nela que se apliquem à subpropriedade criada.

delete

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

deleteConnectedSiteTag

Exclui uma tag do site conectada de uma propriedade do Universal Analytics.

fetchAutomatedGa4ConfigurationOptOut

Busca o status de desativação do processo de configuração automatizada do GA4 para uma propriedade do UA.

fetchConnectedGa4Property

Com uma propriedade do UA especificada, pesquisa a propriedade do GA4 conectada a ela.

get

Procurar uma única propriedade "GA4".

getAttributionSettings

Procura um Singleton do AttributionSettings.

getDataRetentionSettings

Retorna as configurações de retenção de dados do singleton desta propriedade.

getGoogleSignalsSettings

Procurar as configurações dos Indicadores do Google de uma propriedade.

list

Retorna Propriedades filhas na conta pai especificada.

listConnectedSiteTags

Lista as tags do site conectadas de uma propriedade do Universal Analytics.

patch

Atualiza uma propriedade.

runAccessReport

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

setAutomatedGa4ConfigurationOptOut

Define o status de desativação do processo de configuração automatizada do GA4 para uma propriedade do UA.

updateAttributionSettings

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

updateDataRetentionSettings

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

updateGoogleSignalsSettings

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