Pular para o conteúdo principal
Uma campanha é um anúncio que não parte de uma das suas publicações. Use-a para formatos como anúncios de pesquisa, em que você define um orçamento, uma estratégia de lances e a segmentação, e a rede cria os anúncios. Para promover uma publicação que você já publicou, use Impulsionar publicação.
O Google aceita campanhas. Veja Campanhas de pesquisa do Google e Campanhas Performance Max do Google para o que é específico do Google. As outras redes recusam uma solicitação de campanha com code: 101, e details informa o motivo. No Facebook, por exemplo, a mensagem é campaignCreation is not supported on facebook.

Endpoints

{platform} é a rede de anúncios. {id} é o ID da campanha retornado quando você a criou. Você só pode ler e alterar campanhas criadas pela Ayrshare pelo mesmo perfil de usuário.

Parâmetros de cabeçalho

string
obrigatório
Obrigatório para criar uma campanha. Envie um novo valor único, como um UUID, para cada nova campanha. Se você repetir uma solicitação com a mesma chave, a Ayrshare retorna a primeira resposta, marcada com idempotentReplayed: true, e não cria nada novo. Você também pode enviar a chave no corpo como idempotencyKey. Se enviar as duas, elas devem ser iguais.

Criar uma campanha

POST /ads/{platform}/campaigns Novas campanhas começam como paused, a menos que você envie status: "active", então nada é gasto até que você decida iniciar.
string
obrigatório
A conta de anúncios na qual criar a campanha.
string
obrigatório
O nome da campanha, de 1 a 255 caracteres.
string
obrigatório
O tipo de campanha: search ou performanceMax. Cada rede suporta apenas alguns tipos. Um tipo que a rede não suporta responde code: 101 e lista os tipos suportados.
object
obrigatório
object
obrigatório
boolean
obrigatório
Se a campanha é publicidade política na UE. Você deve sempre enviá-lo. A Ayrshare nunca o preenche por você.
object
object
Cada rede suporta apenas algumas opções de segmentação. Um campo que a rede não suporta responde code: 101.
string
padrão:"paused"
active ou paused.
object
Opções para uma única rede, sob o nome dessa rede, por exemplo { "facebook": { ... } }. Opções para qualquer outra rede respondem code: 101.
Uma criação bem-sucedida responde status: "success", o campaignId e o estado da própria campanha como campaignStatus (active ou paused). A obtenção e a atualização respondem da mesma forma.

Obter uma campanha

GET /ads/{platform}/campaigns/{id} Retorna a campanha conforme informada pela rede. Uma campanha que não é sua, ou que não existe, responde code: 400.

Atualizar uma campanha

PUT /ads/{platform}/campaigns/{id} Envie pelo menos um destes campos. Você não pode alterar type, accountId ou euPoliticalAdvertising depois de criar a campanha.
string
O novo nome da campanha.
string
active ou paused. Uma solicitação que envia apenas status: "paused" não é bloqueada quando a Ayrshare pausou os anúncios nessa rede. Ela ainda precisa de uma rede vinculada e ainda pode falhar se a própria rede estiver fora do ar.
object
{ "amount": number }: o novo valor a gastar por dia.
object
{ "end": string }: a nova data de término, no mesmo formato de schedule.start. Deve ser posterior ao início da campanha. Uma rede que programa dias inteiros, como o Google, também aceita o mesmo dia do início.

Erros

Estes erros trazem um code da Ayrshare: Uma criação também pode responder com um destes status HTTP. O corpo não tem code, apenas { "action": "createAdCampaign", "status": "error", "message": "..." }: