Package google.shopping.merchant.conversions.v1beta

Índice

ConversionSourcesService

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

CreateConversionSource

rpc CreateConversionSource(CreateConversionSourceRequest) returns (ConversionSource)

Cria uma nova origem de 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. Se a origem da conversão for uma Destinação 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 de 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 a que 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)

Reativar uma origem de conversão arquivada. 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.
UpdateConversionSource

rpc UpdateConversionSource(UpdateConversionSourceRequest) returns (ConversionSource)

Atualiza as informações de uma origem de conversão. 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 fontes 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 e 40.
attribution_model

AttributionModel

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

ConversionType

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

AttributionModel

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

Enums
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 preferencial do Google Ads.
CROSS_CHANNEL_DATA_DRIVEN Modelo baseado em dados em vários canais.
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 com base na posição em vários canais.
CROSS_CHANNEL_TIME_DECAY Modelo de redução de tempo 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, conforme 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 de conversão pertencente a uma conta de comerciante. Uma conta de 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 diferentes pode ser o mesmo em tipos diferentes. Os seguintes prefixos de tipo são aceitos: - galk: para origens do Google Analytics Link. - mcdn: para origens MerchantCenterDestination.
state

State

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

Timestamp

Apenas saída. O período em que uma origem de conversão arquivada é excluída permanentemente e não pode ser restaurada.
controller

Controller

Apenas saída. Controlador da origem da conversão.
Campo de união source_data. Obrigatório. Dados da origem da conversão específicos para cada tipo de origem. source_data pode ser apenas de um dos tipos a seguir:
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.

Enums
CONTROLLER_UNSPECIFIED Valor padrão. Esse valor não é usado.
MERCHANT Controlada 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.

Enums
STATE_UNSPECIFIED A origem da conversão tem um estado não especificado.
ACTIVE A origem da conversão está totalmente funcional.
ARCHIVED A origem da conversão foi arquivada nos últimos 30 dias e não está funcional no momento. Pode ser restaurado usando o método de restauração.
PENDING A criação da origem de conversão foi iniciada, 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 de 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 na 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 da conversão a ser buscado. 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 da coleta 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 em 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 a 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 "Destino do Merchant Center" podem ser usadas para enviar eventos de conversão de uma loja on-line usando uma tag do Google diretamente para uma 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. É o nome que identifica a origem da conversão na interface do Merchant Center. Limitado a 64 caracteres.
currency_code

string

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

UndeleteConversionSourceRequest

Solicita uma mensagem para o método UndeleteConversionSource.

Campos
name

string

Obrigatório. O nome da origem da conversão que vai ser restaurada. 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

Opcional. Lista de campos que estão sendo atualizados.