DELETE/api/v4/posts/{postId}

Gönderi silme

Bir sosyal medya gönderi kampanyasını kalıcı olarak siler ve yayımlandığı tüm sitelerden kaldırır.

API anahtarı gerektirir. Başlık biçimi ve anahtar yenileme için Kimlik doğrulama bölümüne bakın.

Parametreler

Yol

AdTürZorunluAçıklama
postIdstringzorunluBase64-encoded social post ID to delete (the `id` from a posts list or the create response).

Gövde

AdTürZorunluAçıklama
clientMutationIdstringisteğe bağlıOptional client-supplied token returned unchanged in the response, for correlating the request.

Örnek istek

Yapıştırmaya hazır gövde. Yer tutucu kimlikleri ve değerleri kendi değerlerinizle değiştirin.

Request body
{  "clientMutationId": "delete-44122-req-1"}

Yanıtlar

200Post deleted. `socialPostId` returns the deleted post's ID.
Response
{  "data": {    "deleteSocialPost": {      "success": true,      "socialPostId": "U29jaWFsUG9zdDo0NDEyMg=="    }  }}
401Unauthenticated, missing or invalid API key.

Belirtilen gönderi kampanyasını siler. Bu işlem kalıcıdır: gönderi Listings API'den kaldırılır ve ulaştığı tüm sitelerde (Google, Facebook) yayından kaldırılır. Yayındaki bir gönderiyi silmek, gönderiyi bağlı profillerden kaldırır; bu işlem geri alınamaz.

Kullanım senaryosu: hatalı bir duyuruyu geri çekme. Bir duyuru yanlış çalışma saatleriyle yayımlandıysa DELETE /posts/{postId} ile silin (gönderi listesindeki id değerini kullanarak), success: true değerini doğrulayın, ardından POST /posts ile düzeltilmiş bir duyuru yayımlayın. Bir kampanyayı tüm mağazalardan aynı anda kaldırmak için bunun yerine toplu kampanyayı toplu kampanya kimliğini kullanarak silin.

Notlar.

  • İstek gövdesi isteğe bağlıdır. clientMutationId değerini yalnızca istek ilişkilendirmesi için değerin değiştirilmeden döndürülmesini istiyorsanız gönderin; oluşturulan kod parçacığı bu değeri örnek olarak içerir.
  • Planlanmış yayın süresi dolmuş bir gönderi status: EXPIRED bildirebilir ve artık her bir sitede yayında olmayabilir, ancak gönderiyi silmek yine de onu Listings API'den kaldırır.
  • Zaten silinmiş veya bilinmeyen bir gönderiyi silmek, success: true yerine bir hata yanıtı ({"data":null,"errors":[...]}) döndürür.

Yazma işlemi: canlı hesapta yürütülmemiştir. Gösterilen istek ve yanıt API şemasından oluşturulmuştur.

Request
curl -X DELETE 'https://listingsapi.com/api/v4/posts/<postId>' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "clientMutationId": "delete-44122-req-1"  }'