新しい採用企業サブアカウントの作成

POST 
/v1/subaccounts

新しい採用企業サブアカウントを作成します。
リクエストでContent-Typeヘッダをapplication/jsonと 指定します。

OAuthのスコープ	アクセストークンの種類
employer.advertising.subaccount	employer パラメータを使わずに取得されたアクセストークン。

Request

application/json

Body

required

email stringrequired

サブアカウントのメールアドレス。

currencyCode stringrequired

サブアカウントのISO 4217通貨コード。キャンペーンの予算の指定と、サブアカウントへの請求はこの通貨で行われます。

language stringrequired

サブアカウントで使用されている2文字の言語コード。

employeeCount stringrequired

従業員数。可能な値は、1-49、50-149、150-249、250-499、500-749、750-999、1000+です

company string

指定がない場合は、新しく作成されるサブアカウントの会社名としてマスターアカウントの会社名が使用されます。

Responses

200

作成成功

application/json

Schema

Schema

meta

object

応答に関連するメタデータ。

status int32

常に応答のHTTPステータスコードと等しい値。

errors

object[]

リクエストを正常に処理できない原因となったエラー。エラーがなかった場合、値はnullです。

Array [

type string

エラーの名前。

description string

人間が読める形式での問題の説明。

]

rootLocation string

スポンサー求人APIのベースURL。

perPage int32

ページ付けされた結果を返すエンドポイントの場合、1つのページに返される実質的な最大エントリー数。この値は、perPageパラメータでリクエストした最大値より小さい場合があります。エンドポイントが返す結果が1つの場合や、ページ付けが行われない場合は、値はnullになります。

links

object[]

リクエストされたリソースに関連するリソース。

Array [

rel string

リクエストされたリソースと関連リソースの関係。次の値が一般的に使用されます。

• up：関連リソースはリクエストされたリソースを含むコレクション、またはリクエストされたリソースが付加されているエンティティ。
• next：ページ付けされた結果内で次のエントリーのページ。
• prev：ページ付けされた結果内で前のエントリーのページ。

ただし、この値は関係を説明する Campaign Infoのような任意の文字列の場合もあります。

href string

関連リソースのエンドポイントのURL。クエリの文字列パラメータを含む場合があります。完全なURLを取得するには、rootLocationにhrefを追加します。

]

data

object

id stringdeprecated

旧バージョンの採用企業ID。このフィールドは廃止されます。代わりにemployerIdを 使用してください。

company string

サブアカウントの名前。

email string

サブアカウントのメールアドレス。

currencyCode string

サブアカウントのISO 4217通貨コード。キャンペーンの予算の指定と、サブアカウントへの請求はこの通貨で行われます。

employerId string

Example (from schema)

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": {
    "company": "Indeed",
    "email": "admin@indeed.com",
    "currencyCode": "USD",
    "employerId": "68e7a7a549a5ce1e499c72a424253ca7"
  }
}

Example

{
  "meta": {
    "status": 200,
    "errors": null,
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": null
  },
  "data": {
    "id": "3141592653589793",
    "company": "Indeed",
    "email": "admin@indeed.com",
    "currencyCode": "USD",
    "employerId": "68e7a7a549a5ce1e499c72a424253ca7"
  }
}

400

リクエストパラメータの1つに問題がありました。通常、 description フィールドには、問題のあるパラメータの名前と、より詳細なエラーメッセージが格納されます。

他のエラータイプとは異なり、 meta.errors配列には複数のINVALID_REQUEST エラーが含まれる可能性があります（問題のあるリクエストパラメータごとに1つずつ）。

application/json

Schema

Schema

meta

object

応答に関連するメタデータ。

status int32

常に応答のHTTPステータスコードと等しい値。

errors

object[]

リクエストを正常に処理できない原因となったエラー。エラーがなかった場合、値はnullです。

Array [

type string

エラーの名前。

description string

人間が読める形式での問題の説明。

]

rootLocation string

スポンサー求人APIのベースURL。

perPage int32

ページ付けされた結果を返すエンドポイントの場合、1つのページに返される実質的な最大エントリー数。この値は、perPageパラメータでリクエストした最大値より小さい場合があります。エンドポイントが返す結果が1つの場合や、ページ付けが行われない場合は、値はnullになります。

links

object[]

リクエストされたリソースに関連するリソース。

Array [

rel string

リクエストされたリソースと関連リソースの関係。次の値が一般的に使用されます。

• up：関連リソースはリクエストされたリソースを含むコレクション、またはリクエストされたリソースが付加されているエンティティ。
• next：ページ付けされた結果内で次のエントリーのページ。
• prev：ページ付けされた結果内で前のエントリーのページ。

ただし、この値は関係を説明する Campaign Infoのような任意の文字列の場合もあります。

href string

関連リソースのエンドポイントのURL。クエリの文字列パラメータを含む場合があります。完全なURLを取得するには、rootLocationにhrefを追加します。

]

data object

Example (from schema)

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": null
}

Example

{
  "meta": {
    "status": 400,
    "errors": [
      {
        "type": "INVALID_LANGUAGE",
        "description": "Invalid language"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": [
      {
        "rel": "up",
        "href": "/v1/subaccounts"
      }
    ]
  },
  "data": null
}

401

次の理由で、リクエストに有効なアクセストークンが含まれていませんでした。

• Authorizationヘッダーが存在しない、または形式に誤りがあった。必ずAuthorizationHTTPヘッダーでアクセストークンを送信し、値のヘッダーにBearerというワードとスペースを使用してください。たとえば、アクセストークンがXYZならば、リクエストにはAuthorization: Bearer XYZ というヘッダーを含める必要があります。
• アクセストークンの形式に誤りがあった。HTTPリクエストを手動で作成してAPIをテストしている場合は、リクエストにアクセストークンをコピーする際に、アクセストークンの先頭や末尾の文字を誤って削除したり、余分な文字を含めたりしていないことを確認してください。
• アクセストークンが期限切れになっている。アクセストークンは1時間（3,600秒）のみ有効です。期限が切れた後は、リフレッシュトークン（3-legged OAuth）を使用して別のアクセストークンを取得する必要があります。

application/json

Schema

Schema

meta

object

応答に関連するメタデータ。

status int32

常に応答のHTTPステータスコードと等しい値。

errors

object[]

リクエストを正常に処理できない原因となったエラー。エラーがなかった場合、値はnullです。

Array [

type string

エラーの名前。

description string

人間が読める形式での問題の説明。

]

rootLocation string

スポンサー求人APIのベースURL。

perPage int32

ページ付けされた結果を返すエンドポイントの場合、1つのページに返される実質的な最大エントリー数。この値は、perPageパラメータでリクエストした最大値より小さい場合があります。エンドポイントが返す結果が1つの場合や、ページ付けが行われない場合は、値はnullになります。

links

object[]

リクエストされたリソースに関連するリソース。

Array [

rel string

リクエストされたリソースと関連リソースの関係。次の値が一般的に使用されます。

• up：関連リソースはリクエストされたリソースを含むコレクション、またはリクエストされたリソースが付加されているエンティティ。
• next：ページ付けされた結果内で次のエントリーのページ。
• prev：ページ付けされた結果内で前のエントリーのページ。

ただし、この値は関係を説明する Campaign Infoのような任意の文字列の場合もあります。

href string

関連リソースのエンドポイントのURL。クエリの文字列パラメータを含む場合があります。完全なURLを取得するには、rootLocationにhrefを追加します。

]

data object

Example (from schema)

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": null
}

Example

{
  "meta": {
    "status": 401,
    "errors": [
      {
        "type": "INVALID_TOKEN",
        "description": "Invalid OAuth access token."
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": null
  },
  "data": null
}

403

アクセストークンは有効でしたが、このAPIでは使用できません。詳しくは、 meta.errors で返されるエラーを調べてください。

エラーのタイプ	意味とよくある原因
INSUFFICIENT_SCOPE	このAPIエンドポイントに必要なスコープがアクセストークンに設定されていませんでした。よくある原因については、「Troubleshooting Guide」（トラブルシューティングガイド）をご覧ください。
EMPLOYER_ACCESS_TOKEN_NOT_ALLOWED	採用企業に紐づいたアクセストークンを使用して、このエンドポイントにアクセスできません。理由としては、次のことが考えられます。 このAPIエンドポイントは、マスターアカウントでのみ呼び出すことができます。つまり、この操作のためにアクセストークンをリクエストする際には、employerパラメータを省略する必要があります。現時点では、このエラーは GET /v1/subaccountsとPOST /v1/subaccounts からのみ返されます。 旧バージョンのスポンサー求人APIエンドポイントを新しいAPIエンドポイントの代わりに呼び出しています。必ず新しいエンドポイント（ https://apis.indeed.com/ads ）を使用してください。
LEGACY_ACCESS_TOKEN_NOT_ALLOWED	スポンサー求人APIは、旧バージョンのOAuthエンドポイントを使用して取得されたアクセストークンを現在はサポートしていません。更新されたエンドポイントについては、最新の「Authorization Guide」（認証ガイド）を確認してください。

application/json

Schema

Schema

meta

object

応答に関連するメタデータ。

status int32

常に応答のHTTPステータスコードと等しい値。

errors

object[]

リクエストを正常に処理できない原因となったエラー。エラーがなかった場合、値はnullです。

Array [

type string

エラーの名前。

description string

人間が読める形式での問題の説明。

]

rootLocation string

スポンサー求人APIのベースURL。

perPage int32

ページ付けされた結果を返すエンドポイントの場合、1つのページに返される実質的な最大エントリー数。この値は、perPageパラメータでリクエストした最大値より小さい場合があります。エンドポイントが返す結果が1つの場合や、ページ付けが行われない場合は、値はnullになります。

links

object[]

リクエストされたリソースに関連するリソース。

Array [

rel string

リクエストされたリソースと関連リソースの関係。次の値が一般的に使用されます。

• up：関連リソースはリクエストされたリソースを含むコレクション、またはリクエストされたリソースが付加されているエンティティ。
• next：ページ付けされた結果内で次のエントリーのページ。
• prev：ページ付けされた結果内で前のエントリーのページ。

ただし、この値は関係を説明する Campaign Infoのような任意の文字列の場合もあります。

href string

関連リソースのエンドポイントのURL。クエリの文字列パラメータを含む場合があります。完全なURLを取得するには、rootLocationにhrefを追加します。

]

data object

Example (from schema)

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": null
}

Example

{
  "meta": {
    "status": 403,
    "errors": [
      {
        "type": "INSUFFICIENT_SCOPE",
        "description": "Access token does not have permission to access this API."
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": null
  },
  "data": null
}

500

予期しないエラーを示しています。これは一時的な問題の場合があり、まったく同じリクエストをもう一度試すと成功する可能性があります。

リクエストをもう一度試しても解決しない場合は、リクエストの解析に問題があることが考えられます。必要なパラメータがすべて指定されており、すべてのパラメータの形式が正しいことを確認してください。

application/json

Schema

Schema

meta

object

応答に関連するメタデータ。

status int32

常に応答のHTTPステータスコードと等しい値。

errors

object[]

リクエストを正常に処理できない原因となったエラー。エラーがなかった場合、値はnullです。

Array [

type string

エラーの名前。

description string

人間が読める形式での問題の説明。

]

rootLocation string

スポンサー求人APIのベースURL。

perPage int32

ページ付けされた結果を返すエンドポイントの場合、1つのページに返される実質的な最大エントリー数。この値は、perPageパラメータでリクエストした最大値より小さい場合があります。エンドポイントが返す結果が1つの場合や、ページ付けが行われない場合は、値はnullになります。

links

object[]

リクエストされたリソースに関連するリソース。

Array [

rel string

リクエストされたリソースと関連リソースの関係。次の値が一般的に使用されます。

• up：関連リソースはリクエストされたリソースを含むコレクション、またはリクエストされたリソースが付加されているエンティティ。
• next：ページ付けされた結果内で次のエントリーのページ。
• prev：ページ付けされた結果内で前のエントリーのページ。

ただし、この値は関係を説明する Campaign Infoのような任意の文字列の場合もあります。

href string

関連リソースのエンドポイントのURL。クエリの文字列パラメータを含む場合があります。完全なURLを取得するには、rootLocationにhrefを追加します。

]

data object

Example (from schema)

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": null
}

Example

{
  "meta": {
    "status": 500,
    "errors": [
      {
        "type": "INTERNAL_SERVER_ERROR",
        "description": "Failed to process the request."
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": null
  },
  "data": null
}

Loading...

 

このページは役に立ちましたか？