Liste yanıtlarını filtrele

Görüntülü Reklam Ağı ve Video 360 API, şunları toplu olarak almak için bir LIST yöntemi sağlar: kaynaklar. Bu LIST yöntemleri, genellikle bir filter sorgu parametresi. Bu parametreyi yalnızca aşağıdakine göre API kullanımınızı optimize etmek için kullanın: bulmanız gerekir.

Bu kılavuzda, filter parametresinin etkili şekilde nasıl kullanılacağı gösterilmektedir.

Filtre yapısı

filter parametre değeri, bir veya daha fazla kısıtlamadan oluşan bir dizedir. AND veya OR operatörleriyle birleştirilebilen ve toplu halde parantez içine alın.

Kısıtlamalar {field} {operator} {value} biçimindedir. Bir örnek:

entityStatus="ENTITY_STATUS_ACTIVE"

Filtre dizesi 500 karakterden uzun olamaz. Filtre dizeniz 500 karakteri aşıyorsa aşağıdakilerden birini yapın:

  • Mantığı birden fazla filtre dizesine bölün ve LIST isteklerini ayırın.
  • Filtre dizesindeki mantığın bir kısmını kaldırın ve kaynakları yerel olarak aldı.

Mantığın düzgün şekilde uygulandığından emin olmak için kısıtlama değerlerini tırnak içine alın.

LIST çağrılarını yardımcı olabilir.

Biçimlendirme hakkında daha fazla bilgi edinmek için Kısıtlamalar arasındaki mantık bölümüne bakın. dikkat edin.

Filtrelenebilir alanlar

Her LIST yönteminin filtrelenebilir alanları, yöntemin filter bölümünde listelenmiştir. parametre açıklaması. Çoğu durumda, belirli bir kaynak alt kümesi üzerinde standart alanlarında kullanabilirsiniz. Nadiren de olsa, kullanabileceğiniz ek alanlar bulunur yalnızca filtreleme için kullanılabilir.

Parametrenin açıklamasındaki her alan aşağıdakilerden en az birini destekler karşılaştırılabilir operatörler:

Karşılaştırılabilir Operatörler
EQUALS (=) Kaynak alanı değeri, verilen değere eşit.

Örnek: entityStatus="ENTITY_STATUS_ACTIVE"

LESS THAN OR EQUAL TO (<=) Kaynak alanı değeri, belirtilen değerden küçük veya bu değere eşit. Sık kullanılanlar karşılaştırabilirsiniz.

Örnek: updateTime<="2023-04-01T12:00:00Z"

GREATER THAN OR EQUAL TO (>=) Kaynak alanı değeri, belirtilen değerden büyük veya bu değere eşit. Sık kullanılanlar karşılaştırabilirsiniz.

Örnek: updateTime>="2023-03-01T12:00:00Z"

HAS (:) Kaynak alanı değeri, verilen değeri içeriyor. Kaynak alanı dizesinde, belirtilen değerin mevcut bir alt dize olup olmadığını kontrol eder. Öğe kaynak alanı bir diziyse, dizinin verilen değeri içerip içermediğini kontrol eder değer.

Örnek: lineItemIds:"1234"

Parametrenin açıklamasındaki alan için operatör belirtilmemişse yalnızca EQUALS (=) operatörünü kullanabilir. Bazı alanlar birden çok operatörü destekler.

Tarih ve saat gibi bazı filtrelenebilir alanlar için karşılaştırılabilir bir değerdir. Biçim, filter parametresinin açıklamasındaki alana girin.

Kısıtlamalar arasındaki mantık

birden fazla kısıtlamayı birleştirerek LIST isteği.

Genellikle birden çok kısıtlamayı AND ve OR ile birleştirebilirsiniz. mantıksal operatörler. Her LIST yöntemi hangi operatörleri desteklediğini belirtir. Bazı yöntemler yalnızca filter parametresinde tek bir kısıtlama kullanılmasını destekler.

AND ile filtre dizeleri oluştururken aşağıdaki kısıtlamaları göz önünde bulundurun veya OR mantıksal operatörleri:

  • AND, kısıtlama veya kısıtlama grupları arasında kullanılmalıdır. filtre uygulayabilirsiniz. İşte birkaç örnek:
    • updateTime>="2023-03-01T12:00:00Z" AND entityStatus="ENTITY_STATUS_ACTIVE"
    • updateTime>="2023-03-01T12:00:00Z" AND updateTime<="2023-04-01T12:00:00Z" AND (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • OR, aynı ölçüte göre filtrelenen bağımsız kısıtlamalar arasında kullanılmalıdır girin. Bir örnek verelim:
    • (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND (lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT" OR lineItemType="LINE_ITEM_TYPE_VIDEO_DEFAULT")
  • OR özelliğini, iki kısıtlama grubunu birleştirmek için kullanamazsınız. Çoklu kullan Bunun yerine, farklı filtre değerlerine sahip LIST istekleri. Örneğin, aşağıdaki ayrı LIST istekleri:

    • (lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT" AND insertionOrderId="123")
    • (lineItemType="LINE_ITEM_TYPE_VIDEO_DEFAULT" AND insertionOrderId="456")

    Bunları birleştirmek için OR operatörünü kullanmayın:

    (lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT" AND insertionOrderId="123") OR (lineItemType="LINE_ITEM_TYPE_VIDEO_DEFAULT" AND insertionOrderId="456")

  • Kısıtlamaları filtre dizesini girin. Örneğin, aşağıdaki filtre dizesi:

    updateTime>="2023-03-01T12:00:00Z" AND entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED" OR entityStatus="ENTITY_STATUS_DRAFT"

    şu şekilde yorumlanır:

    updateTime>="2023-03-01T12:00:00Z" AND (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED" OR entityStatus="ENTITY_STATUS_DRAFT")