Armazenar Recurso

Artigo
11/13/2024

Nota

O recurso loja está disponível apenas para participantes de versão beta fechada. Para obter informações sobre como participar no programa closed-beta ou open-beta, contacte o gestor de conta.

Todos os elementos de programação e documentação da Store estão sujeitos a alterações durante a versão beta.

Utilize o recurso Loja para gerir as lojas pertencentes ao utilizador. Pode adicionar lojas, obter uma loja específica ou obter todas as lojas pertencentes ao utilizador. Saiba mais.

Base URI

Segue-se o URI base ao qual acrescenta os modelos .

https://content.api.ads.microsoft.com/v9.1/bmc

Por exemplo, para adicionar uma loja ou obter uma lista de lojas pertencentes ao utilizador, utilize o seguinte ponto final:

https://content.api.ads.microsoft.com/v9.1/bmc/stores

Modelos

Estes são os modelos que acrescenta ao URI base para criar um ponto final HTTP.

/stores template

Verbo HTTP	Descrição	Recurso
POST	Adiciona uma loja. Aplicam-se os seguintes limites e estão sujeitos a alterações: Um cliente pode adicionar um máximo de 14 lojas que especificam o mesmo URL de loja. Um cliente pode adicionar um máximo de 1024 lojas.	Pedido: ArmazenarCriar Resposta: Armazenar
GET	Obtém uma lista de lojas pertencentes ao utilizador.	Pedido: N/D Resposta: StoreCollection

Modelo /stores/{merchantId}

Verbo HTTP	Descrição	Recurso
GET	Obtém o arquivo especificado. Defina `{merchantId}` para o ID da loja que pretende obter.	Pedido: N/D Resposta: Armazenar

Parâmetros de consulta

O pedido pode incluir os seguintes parâmetros de consulta:

Parâmetro	Descrição
dry-run	Opcional. Utilize para testar ou depurar a sua aplicação. As chamadas que incluem este parâmetro não afetam os dados de produção (os arquivos não são adicionados); no entanto, a resposta conterá quaisquer erros gerados pela chamada. Considere as seguintes limitações ao utilizar este parâmetro. As operações de adição não devolvem IDs. O serviço não gera nem devolve mensagens de erro secundárias, tais como qualidade de dados, problemas editoriais e validações relacionadas com a base de dados. Para obter mais informações sobre como testar a sua aplicação, consulte Sandbox.

Parâmetro

Descrição

dry-run

Opcional. Utilize para testar ou depurar a sua aplicação. As chamadas que incluem este parâmetro não afetam os dados de produção (os arquivos não são adicionados); no entanto, a resposta conterá quaisquer erros gerados pela chamada.

Considere as seguintes limitações ao utilizar este parâmetro.

As operações de adição não devolvem IDs.
O serviço não gera nem devolve mensagens de erro secundárias, tais como qualidade de dados, problemas editoriais e validações relacionadas com a base de dados.

Para obter mais informações sobre como testar a sua aplicação, consulte Sandbox.

Cabeçalhos

Seguem-se os cabeçalhos de pedido e resposta.

Cabeçalho	Descrição
AuthenticationToken	Cabeçalho do pedido. Defina este cabeçalho para um token de acesso OAuth. Para obter informações sobre como obter um token de acesso, consulte Autenticar as suas credenciais.
Tipo de Conteúdo	Cabeçalho do pedido. Todos os pedidos POST têm de especificar este cabeçalho e tem de ser definido como `application/json`.
CustomerAccountId	Cabeçalho do pedido. O ID de conta de qualquer conta que gere em nome do cliente especificado no `CustomerId` cabeçalho. Não importa a conta que especificar. Especifique este cabeçalho apenas se gerir uma conta em nome do cliente.
CustomerId	Cabeçalho do pedido. O ID de cliente do cliente cuja loja gere. Especifique este cabeçalho apenas se gerir a loja em nome do cliente. Se definir este cabeçalho, também tem de definir o `CustomerAccountId` cabeçalho.
DeveloperToken	Cabeçalho do pedido. O token de programador da aplicação cliente. Cada pedido tem de incluir este cabeçalho. Para obter informações sobre como obter um token, consulte Tem as credenciais do Microsoft Advertising e o token de programador?
WebRequestActivityId	Cabeçalho de resposta. O ID da entrada de registo que contém os detalhes do pedido. Deve sempre capturar este ID se ocorrer um erro. Se não conseguir determinar e resolver o problema, inclua este ID juntamente com as outras informações que fornecer à equipa de Suporte.

Objetos de pedido e resposta

Seguem-se os objetos de pedido e resposta utilizados pela API.

Objeto	Descrição
Erro	Define um erro.
ErrorResponse	Define o objeto de erro de nível superior.
Loja	Define uma loja no Microsoft Merchant Center.
StoreCollection	Define uma coleção de lojas no Microsoft Merchant Center.
LojaCriar	Define uma loja para adicionar ao Centro de Comerciantes da Microsoft.
StoreStatus	Define o estado do arquivo.

Erro

Define um erro.

Name	Valor	Tipo
código	O motivo pelo qual o pedido falhou. Por exemplo, o código é InvalidStoreNameErr se o `storeName` campo tiver falhado a validação.	Cadeia
Mensagem	Uma descrição do erro.	Cadeia

ErrorResponse

Define o objeto de erro de nível superior.

Name	Valor	Tipo
erros	Uma lista de erros que ocorreram durante o processamento do pedido.	Erro[]

Loja

Define uma loja no Microsoft Merchant Center.

Name	Valor	Tipo
isBlockAggregator	Um valor booleano que indica se pretende impedir que os agregadores sirvam anúncios da sua loja. Os agregadores consolidam ofertas de produtos de várias empresas, muitas vezes não relacionadas. Por predefinição, os agregadores podem incluir o seu catálogo nos anúncios. É verdade se quiser impedir que os seus produtos apareçam nos anúncios dos agregadores no Bing. Se tiver duas lojas (uma para o Estados Unidos e outra para o Reino Unido) que utilizem http://www.contoso.com e uma delas bloquear agregadores, ambas armazenam agregadores de blocos.	Booleano
isSslCheckout	Um valor Booleano que indica se o arquivo está ativado para SSL. Todas as lojas têm de ter páginas de início de sessão e finalização da compra SSL. É verdade se o site da loja estiver ativado para SSL.	Booleano
merchantId	O ID da loja.	Sem assinatura por extenso
notificationEmail	Uma lista de destinatários a receber e-mails de notificação. Os e-mails notificam-no quando a loja é aprovada ou se existem erros de validação na loja.	Cadeia[]
notificationLanguage	O idioma utilizado para escrever os e-mails de notificação. O idioma está no formato language-country<<>/region>. Por exemplo, en-US.	Cadeia
storeDescription	Uma descrição que descreve a utilização do arquivo.	Cadeia
storeName	O nome da loja.	Cadeia
storeStatus	O estado do arquivo.	StoreStatus
storeUrl	O URL de destino do arquivo. O URL de destino é a página Web para a qual as pessoas são direcionadas quando clicam no seu anúncio.	Cadeia

StoreCollection

Define uma lista de lojas.

Name	Valor	Tipo
lojas	Uma lista de lojas pertencentes ao utilizador.	Loja[]

LojaCriar

Define uma loja para adicionar ao Centro de Comerciantes da Microsoft.

Name	Valor	Tipo	Obrigatório
isBlockAggregator	Um valor booleano que indica se pretende impedir que os agregadores sirvam anúncios da sua loja. Os agregadores consolidam ofertas de produtos de várias empresas, muitas vezes não relacionadas. Por predefinição, os agregadores podem incluir o seu catálogo nos anúncios. Defina como verdadeiro para impedir que os seus produtos apareçam nos anúncios dos agregadores no Bing. Se tiver duas lojas (uma para o Estados Unidos e outra para o Reino Unido) que utilizem http://www.contoso.com e uma delas bloquear agregadores, ambas armazenam agregadores de blocos. A predefinição é false.	Booleano	Não
isSslCheckout	Um valor Booleano que indica se o arquivo está ativado para SSL. Todas as lojas têm de ter páginas de início de sessão e finalização da compra SSL. Defina como verdadeiro se o site da loja estiver ativado para SSL. Se for falso , a loja não será reprovada. A predefinição é true.	Booleano	Não
notificationEmail	Uma lista de destinatários a receber e-mails de notificação. Os e-mails notificam-no quando a loja é aprovada ou se existem erros de validação na loja. O número máximo de endereços de e-mail que pode especificar é 14.	Cadeia[]	Sim
notificationLanguage	O idioma utilizado para escrever os e-mails de notificação. O idioma está no formato language-country<<>/region>. Seguem-se os possíveis valores não sensíveis a maiúsculas e minúsculas que pode especificar. en-US (inglês-Estados Unidos) en-AU (Inglês-Austrália) en-GB (Inglês-Reino Unido) fr-FR (Francês-França) de-DE (German-Germany) ja-JP (Japonês-Japão)	Cadeia	Sim
storeDescription	Uma descrição que descreve a utilização do arquivo. A descrição está limitada a um máximo de 350 carateres e pode conter apenas carateres alfanuméricos ([a-zA-Z0-9]).	Cadeia	Não
storeName	O nome da loja. Uma vez que o nome da loja aparece nos anúncios do produto, certifique-se de que utiliza um nome que representa com precisão o seu site. O nome tem de: Seja exclusivo no Centro de Comerciantes do Bing Não contém mais de 70 carateres Contenham apenas carateres alfanuméricos ([a-zA-Z0-9])	Cadeia	Sim
storeUrl	O URL de destino do arquivo. O URL de destino é a página Web para a qual as pessoas são direcionadas quando clicam no seu anúncio. O URL não pode redirecionar para outra localização. O URL tem de estar bem formado e ter um máximo de 1024 carateres. Tem de verificar e reclamar o URL do seu site. As lojas não serão reprovadas se a Microsoft não conseguir verificar se o seu site está em conformidade com o SSL. Os sites de comerciantes têm de ter páginas de início de sessão e finalização da compra SSL. Verifique se os certificados SSL são válidos.	Cadeia	Sim

StoreStatus

Define o estado do arquivo.

Name	Valor	Tipo
Mensagem	A razão pela qual a loja foi desaprovada. O objeto só inclui este campo se `status` for Desaprovado.	Cadeia
estado	O estado do arquivo. Seguem-se os valores possíveis. Aprovado Reprovado ManualReview Se a loja não estiver aprovada, veja `message` o motivo. Uma loja que foi inicialmente aprovada automaticamente pode passar de Aprovado para ManualReview. Não pode adicionar produtos a uma loja que esteja sob revisão manual e os produtos na loja não servirão. Consoante o motivo de desaprovação, poderá conseguir corrigir o problema com a aplicação Microsoft Ads. Caso contrário, terá de criar um novo arquivo com valores adequados.	Cadeia

Códigos de estado HTTP

Os pedidos podem devolver os seguintes códigos de estado HTTP.

Código de estado	Descrição
200	Sucesso.
201	A loja foi adicionada com êxito.
400	Pedido incorreto. O mais provável é que o corpo do pedido POST contenha dados inválidos ou tenha um formato incorreto.
401	Não autorizado. As credenciais do utilizador não são válidas.
404	Não encontrado. A loja pedida não foi encontrada.
500	Erro do servidor.

Códigos de erro

Os pedidos podem devolver os seguintes códigos de erro.

Código de erro	Descrição
AdultAdvertiserErr	Os anunciantes adultos podem não criar lojas.
DomainNotOwnedByCustomerErr	O domínio especificado no campo storeUrl não pertence ao cliente. Certifique-se de que o cliente verificou que é o proprietário do domínio.
DuplicateStoreNameErr	Existe outro arquivo com o nome de arquivo especificado; os nomes das lojas têm de ser exclusivos com o Centro de Comerciantes da Microsoft.
ExceededMaxStoresForCustomerErr	O cliente excedeu o número de lojas que pode criar. Para obter limites, veja Adicionar POST da loja.
ExceededMaxStoresForDestinationUrlErr	O cliente excedeu o número de lojas que pode criar com o mesmo URL de destino. Para obter limites, veja Adicionar POST da loja.
InvalidStoreDescriptionErr	A descrição da loja não é válida. Para obter limites, veja storeDescription.
InvalidStoreDestinationUrlErr	O URL de destino do arquivo que especificou no campo storeUrl não é válido.
InvalidStoreNameErr	O nome da loja não é válido. Para obter limites, veja storeName.
MarketNotSupportedErr	O mercado que especificou no campo notificationLanguage não é válido.
NoDomainsFoundForCustomerErr	Não existem domínios verificados pertencentes ao cliente.

Partilhar via