パブリッシャー

このAPIエンドポイントは、コンタクトが定義されているアカウントでのみ使用できます。 パブリッシャーは、現在のアカウントとプレゼンテーションを共有している他のアカウントです。 このオプションは、一部のCUSTOMサブスクリプションプランでのみご利用いただけます。詳細はお問い合わせください。

パブリッシャー リスト

Publishers APIは、各パブリッシャーの詳細を返します:

URL: https://orbitvu.co/api/v1/publishers [.json|.xml]

返される値

[
    {
        "id": 1,
        "name": "ORBITVU",
        "email": "example@orbitvu.pl",
        "url": "https://orbitvu.co/api/v1/publishers/1/",
        "shares_url": "https://orbitvu.co/api/api/v1/publishers/1/shares"
    },
    {
        "id": 2,
        "name": "ORBITVU 2",
        "email": "example+2@orbitvu.com",
        "url": "https://orbitvu.co/api/v1/publishers/2/",
        "shares_url": "https://orbitvu.co/api/v1/publishers/2/shares"
    }
]

検索 ( Searching )

  • exact

    特定のフィールドとの完全一致によるパブリッシャーの検索: id, name, email,  例:

  • # match publisher with id == 1
    https://orbitvu.co/api/v1/publishers.json?id=1
    
    # match publisher with email example@orbitvu.com
    https://orbitvu.co/api/v1/publishers.json?email=example@orbitvu.com
  • ilike - single

    名前 (name)、電子メール (email) のいずれかで特定のパターンを含むパブリッシャーを検索:

    # match all publishers with name or email containing 'A123' or 'a123'
    https://orbitvu.co/api/v1/publishers/?search=A123

並び替え ( Ordering )

idname で並び替え:

# ascending

https://orbitvu.co/api/v1/publishers/?ordering=id

# descending

https://orbitvu.co/api/v1/publishers/?ordering=-id

パブリッシャーの詳細

特定のパブリッシャーの詳細は以下を参照:

URL: https://orbitvu.co/api/v1/publishers/<id>/ [.json|.xml]

返されるデータの例:

{
    "id": 1,
    "name": "ORBITVU",
    "email": "example@orbitvu.com",
    "url": "https://orbitvu.co/api/v1/publishers/1/",
    "shares_url": "https://orbitvu.co/api/v1/publishers/1/shares/"
}

shares_url はコンタクトに対して定義された shares_url に似ています。詳細は コチラこちらを参照ください。