codocの貼付けタグで使える属性

ペイウォールの見た目や挙動をかえることができる、貼付けタグの属性について説明します。

貼付けタグについては大きく2種類あり、1つはcodocのスクリプトタグ、もうひとつは記事やサブスクリプションウィジェット等のcodocタグ(divタグ)となります。スクリプトタグは基本的にページ内のheadタグの中に1つだけ指定するものとなっています。codocタグはペイウォールを表示させたい場所等に張付けを行います。

属性については以下の要領で追加してください。(data-XXXX-YYYY=”値”)

//スクリプトタグ
<script src=’https://codoc.jp/js/cms.js data-usercode=”t0Fx1DCJdA” data-XXXX-YYYY=”値” defer></script>

//codocタグ(記事のタグ)
<div class=”codoc-entries” id=”codoc-entry-By1QWAl36Q” data-XXXX-YYYY=”値”></div></div>

codoc貼付けタグへの属性追加サンプル

スクリプトタグの属性

属性用途パラメーター
data-lang言語指定ja: 日本語, en: 英語
data-cssテーマ名・パスblue,red,green,black,dark,blue-square,red-square,green-square,black-square,dark-square,CSSのパス指定
data-usercodecodocユーザーコードユーザーコードを指定(必須)
data-connect-code外部連携コード外部連携コード(外部連携機能を利用する場合は必要| cms.js → cms-connect.js に変更必須)
data-connect-registration-mode登録モードdedicatedを指定した場合専用ユーザーモードに(要利用申請)
data-callback-json任意のタイミングで実効するjavascript関数をjsonで指定{ “init” : “”, “ready” : “”, “loggedIn” : “”, “afterGettingPaywall” : “”, “afterPassingPaywall” : “”}
スクリプトタグで利用できる属性

codocタグ(記事のタグ)の属性

属性用途パラメーター
data-entry-code記事コード記事コード(必須)
data-without-body本文(無料部分)を表示しない1: 表示しない
data-disable-scriptスクリプトを動作させないall: すべて不許可, または正規表現(^https\:\/\/(www\.instagram\.com|platform\.t
witter\.com))
data-support-messageサポート説明任意のテキストを指定
data-thanks-entry-message記事購入時のサンクスメッセージ任意のテキストを指定
data-thanks-subscription-messageサブスク購入時のサンクスメッセージ任意のテキストを指定
data-thanks-support-messageサポーと購入時のサンクスメッセージ任意のテキストを指定
data-subscription-messageサブスクリプションの説明任意のテキストを指定
data-login-button-textログインボタンテキスト任意のテキストを指定
data-entry-button-tex記事購入ボタンテキスト任意のテキストを指定
data-subscription-button-textサブスク購入ボタンテキスト任意のテキストを指定
data-support-button-textサポーと購入ボタンテキスト任意のテキストを指定
data-move-to-order-button-textモーダル内の決済ボタンテキスト任意のテキストを指定
data-support-price-button-textモーダル内のサポート価格ボタンテキスト任意のテキストを指定
data-support-modal-header-textモーダル内の〇〇さんをサポートのテキスト任意のテキストを指定
data-show-likeいいねを表示する1:表示 0:表示しない
data-show-copyrightPowered By等 が表示されてる箇所を非表示1:表示 0:表示しない
※この属性はcodoc pro のみ利用可能です
data-show-about-codochelpアイコンを非表示にする1:表示 0:表示しない
※この属性はcodoc pro のみ利用可能です
data-show-powered-byPowered By codocを表示する1:表示 0:表示しない
※この属性はcodoc pro のみ利用可能です
data-show-created-byCreated By を非表示にする1:表示 0:表示しない
※この属性はcodoc pro のみ利用可能です
data-show-pay-without-account-button会員登録しないで購入ボタンを表示1:表示する 0:表示しない
data-show-subscription-messageサブスクリプションの説明を表示1:表示する 0:表示しない
data-show-about-codoccodocについてを表示する1:表示 0:表示しない
data-script-after-getting-paywall無料部分ロード時に実行するjavascriptjavascript実装をそのまま記述
注意:廃止予定のため以下を利用してください
<script data-callback-json='{ afterGettingPaywall”: “globalFunctionName” }’>
data-script-after-passing-paywall有料部分ロード時に実行するjavascriptjavascript実装をそのまま記述
注意:廃止予定のため以下を利用してください
<script data-callback-json='{ afterPassingPaywall”: “globalFunctionName” }’>
data-paid-area-continue-text有料部分表示時の続きを読むテキスト任意のテキストを指定
data-show-paid-area-continue-text有料部分表示時の続きを読むテキスト1:常に表示する 0:初回のみ表示
data-paywall-url購入後に戻ってくるURL任意のURLを指定。デフォルトは window.location.href
data-logout-urlログアウト時に遷移するURL任意のURLを指定。デフォルトは window.reloadの挙動。reset を指定することで画面遷移しないでログアウト可能。
data-subscription-message-urlサブスクリプション説明のURL任意のURLを指定。デフォルトはサイト内の当該サブスクリプションページ。
data-session-windowログインや購入時の画面遷移open: 別ウィンドウ
href: 同一ウィンドウ(デフォルト)
data-scroll-to-body-afterログイン・購入後に続きを読むまでスクロールする1:する(デフォルト) 0: しない
data-alt-auth代替認証1:する 0:しない(デフォルト)
data-alt-auth-key代替認証用のキーアカウント画面で指定した代替認証ロジックで生成したハッシュ値
data-alt-auth-time代替認証用のUNIXTIME代替認証用のキーを生成したUNIXTIME
data-alt-auth-key-api-url代替認証のキーを生成するためのURLキーとUNIXTIMEをタグで指定しない場合に以下のjsonを出力するURLを指定。
{ “key”: $key, “time”: $time }
data-alt-auth-login-url代替認証時に変更可能なログインURL任意のURL
data-alt-auth-
paywall-url-query-name
代替認証用ログインURLの戻りURLパラメーター名任意の名前 デフォルトは paywall_url
記事タグで利用できる属性

WordPressプラグイン利用してる場合の属性追加

記事タグの属性についてはプラグインを利用してる場合、一律で指定することができます。

設定→ codoc → 「codocタグの属性」で指定したい属性を入力し、設定を保存してください。

まとめ

以上がcodocの貼付けタグで利用できる属性一覧となります。機能追加などあれば本記事にて更新していきます。ご質問がある方は当社サポートまでお問い合わせください。