Package google.shopping.merchant.conversions.v1beta

Índice

ConversionSourcesService

Serviço para gerenciar origens de conversão de uma conta do comerciante.

CreateConversionSource

rpc CreateConversionSource(CreateConversionSourceRequest) returns (ConversionSource)

Cria uma nova origem da conversão.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
DeleteConversionSource

rpc DeleteConversionSource(DeleteConversionSourceRequest) returns (Empty)

Arquiva uma origem de conversão existente. Se a origem da conversão for um destino do Merchant Center, ela poderá ser recuperada por 30 dias. Se a origem da conversão for uma vinculação do Google Analytics, ela será excluída imediatamente, e poderá ser restaurada criando uma nova.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
GetConversionSource

rpc GetConversionSource(GetConversionSourceRequest) returns (ConversionSource)

Busca uma origem da conversão.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
ListConversionSources

rpc ListConversionSources(ListConversionSourcesRequest) returns (ListConversionSourcesResponse)

Recupera a lista de origens de conversão às quais o autor da chamada tem acesso.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
UndeleteConversionSource

rpc UndeleteConversionSource(UndeleteConversionSourceRequest) returns (ConversionSource)

Reativa uma origem de conversão arquivada. Disponível somente para origens de conversão de destino do Merchant Center.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.
UpdateConversionSource

rpc UpdateConversionSource(UpdateConversionSourceRequest) returns (ConversionSource)

Atualiza as informações de uma origem de conversão existente. Disponível apenas para origens de conversão de destino do Merchant Center.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/content

Para mais informações, consulte a Visão geral do OAuth 2.0.

AttributionSettings

Representa as configurações de atribuição para origens de conversão que recebem dados de pré-atribuição.

Campos
attribution_lookback_window_days

int32

Obrigatório. Janelas de lookback (em dias) usadas para atribuição nesta fonte. Os valores aceitos são 7, 30, 40.
attribution_model

AttributionModel

Obrigatório. Modelo de atribuição.
conversion_type[]

ConversionType

Imutável. Lista não ordenada. Lista com os diferentes tipos de conversão em que um evento de conversão pode ser classificado. Um tipo "compra" padrão será criado automaticamente se a lista estiver vazia no momento da criação.

AttributionModel

O modelo de atribuição usado para esta fonte. Oferecemos suporte ao mesmo conjunto de modelos oferecido pelo Google Analytics 4, conforme descrito em: https://support.google.com/analytics/answer/10596866.

Tipos enumerados
ATTRIBUTION_MODEL_UNSPECIFIED Modelo não especificado.
CROSS_CHANNEL_LAST_CLICK Modelo de último clique em vários canais.
ADS_PREFERRED_LAST_CLICK Modelo de último clique com preferência pelo Google Ads
CROSS_CHANNEL_DATA_DRIVEN Modelo baseado em dados cross-channel.
CROSS_CHANNEL_FIRST_CLICK Modelo de primeiro clique em vários canais
CROSS_CHANNEL_LINEAR Modelo linear em vários canais.
CROSS_CHANNEL_POSITION_BASED Modelo baseado na posição em vários canais.
CROSS_CHANNEL_TIME_DECAY Modelo de iminência da conversão em vários canais.

ConversionType

Mensagem que representa um tipo de evento de conversão

Campos
name

string

Apenas saída. Nome do evento de conversão, como vai ser informado pelo cliente.
report

bool

Apenas saída. Opção que indica se o tipo deve ser incluído nos relatórios do Merchant Center.

ConversionSource

Representa uma origem da conversão de propriedade de uma conta do comerciante. Uma conta do comerciante pode ter até 200 origens de conversão.

Campos
name

string

Apenas saída. Identificador. Gerado pela API Content após a criação de um novo ConversionSource. Formato: [a-z]{4}:.+ Os quatro caracteres antes dos dois-pontos representam o tipo de origem da conversão. O conteúdo após os dois-pontos representa o ID da origem da conversão nesse tipo. O ID de duas origens de conversão pode ser o mesmo em tipos diferentes. Os seguintes tipos de prefixo são suportados: - galk: para origens GoogleAnalyticsLink. - mcdn: para origens do MerchantCenterDestination.
state

State

Apenas saída. Estado atual dessa origem de conversão. Não pode ser editado pela API.
expire_time

Timestamp

Apenas saída. O horário em que uma origem de conversão arquivada é excluída permanentemente e não está mais disponível para cancelamento.
controller

Controller

Apenas saída. Controlador da origem da conversão.
Campo de união source_data. Obrigatório. Dados de origem da conversão específicos para cada tipo diferente de origem. source_data só pode ser de um dos seguintes tipos:
merchant_center_destination

MerchantCenterDestination

Origem da conversão do tipo "Destino da tag do Merchant Center".

Controlador

Entidade que controla a origem da conversão.

Tipos enumerados
CONTROLLER_UNSPECIFIED Valor padrão. Esse valor não é usado.
MERCHANT Controlado pelo comerciante que é proprietário da origem da conversão.
YOUTUBE_AFFILIATES Controlado pelo programa de afiliados do YouTube.

Estado

Representa o estado da origem da conversão.

Tipos enumerados
STATE_UNSPECIFIED A origem da conversão não tem um estado não especificado.
ACTIVE A origem da conversão é totalmente funcional.
ARCHIVED A origem da conversão foi arquivada nos últimos 30 dias e não está funcionando no momento. Podem ser restaurados usando o método de cancelamento de exclusão.
PENDING A criação da origem da conversão começou, mas ainda não foi concluída.

CreateConversionSourceRequest

Mensagem de solicitação para o método CreateConversionSource.

Campos
parent

string

Obrigatório. A conta do comerciante que será proprietária da nova origem da conversão. Formato: accounts/{account}
conversion_source

ConversionSource

Obrigatório. A descrição da origem da conversão. Um novo ID será atribuído automaticamente a ele no momento da criação.

DeleteConversionSourceRequest

Mensagem de solicitação para o método DeleteConversionSource.

Campos
name

string

Obrigatório. O nome da origem de conversão a ser excluída. Formato: accounts/{account}/conversionSources/{conversion_source}

GetConversionSourceRequest

Mensagem de solicitação para o método GetConversionSource.

Campos
name

string

Obrigatório. O nome da origem de conversão a ser buscada. Formato: accounts/{account}/conversionsources/{conversion_source}

ListConversionSourcesRequest

Mensagem de solicitação para o método ListConversionSources.

Campos
parent

string

Obrigatório. A conta do comerciante que é proprietária do conjunto de origens de conversão. Formato: accounts/{account}
page_size

int32

Opcional. O número máximo de origens de conversão a serem retornadas em uma página. Se nenhum page_size for especificado, 100 será usado como o valor padrão. O valor máximo é 200. Valores acima de 200 serão convertidos para 200. Independentemente da paginação, no máximo 200 origens de conversão são retornadas no total.
page_token

string

Opcional. Token da página.
show_deleted

bool

Opcional. Mostrar opção excluída (arquivada).

ListConversionSourcesResponse

Mensagem de resposta para o método ListConversionSources.

Campos
conversion_sources[]

ConversionSource

Lista de origens de conversão.
next_page_token

string

Token a ser usado para buscar a próxima página de resultados.

MerchantCenterDestination

As origens de "Destino do Merchant Center" podem ser usadas para enviar eventos de conversão de uma loja on-line com uma tag do Google diretamente à conta do Merchant Center em que a origem foi criada.

Campos
destination

string

Apenas saída. ID de destino do Merchant Center.
attribution_settings

AttributionSettings

Obrigatório. Configurações de atribuição usadas para o destino do Merchant Center.
display_name

string

Obrigatório. Nome de exibição especificado pelo comerciante para o destino. Esse nome identifica a origem da conversão na interface do Merchant Center. com até 64 caracteres.
currency_code

string

Obrigatório. Código de moeda de três letras (ISO 4217). O código da moeda define em qual moeda as conversões enviadas para esse destino serão informadas no Merchant Center.

UndeleteConversionSourceRequest

Mensagem de solicitação para o método UndeleteConversionSource.

Campos
name

string

Obrigatório. O nome da origem de conversão que terá a exclusão cancelada. Formato: accounts/{account}/conversionSources/{conversion_source}

UpdateConversionSourceRequest

Mensagem de solicitação para o método UpdateConversionSource.

Campos
conversion_source

ConversionSource

Obrigatório. A nova versão dos dados da origem da conversão. Formato: accounts/{account}/conversionSources/{conversion_source}
update_mask

FieldMask

Obrigatório. Lista de campos sendo atualizados.