許可リストにドメインを追加する

このページでは、許可リスト登録済みドメイン API を使用して許可リストにドメインを追加する方法について説明します。

始める前に

• 許可リスト登録済みドメイン API の概要を読む。
• 許可リスト登録済みドメイン API を設定する。

考慮すべきポイント

• 変更不可の設計: ドメイン名は変更できないため、既存のエントリを削除して新しいエントリを作成することで更新を行う必要があります。
• スループット: システムは、一意の顧客アカウントのすべてのドメインで共有される 1 秒あたりのクエリ数（QPS）の割り当てをサポートしています。
• 容量: 管理者は、1 つの顧客アカウントに最大 5,000 個のドメインを追加できます。

許可リストにドメインを追加する

create メソッドを使用して新しいエントリを追加します。このミューテーションは非同期で、長時間実行オペレーション（LRO）を返します。

Python

def create_allowlisted_domain(service, domain_name):
  """Creates an allowlisted domain."""
  try:
    payload = {'domain': domain_name}
    response = service.allowlistedDomains().create(body=payload).execute()
    return response
  except Exception as e:
    print(f'An error occurred during create: {e}')
    return None

エラー処理

エラー条件	RPC ステータス コード	エラー メッセージ	トラブルシューティング / 正当化
リソースに対する権限がない	PERMISSION_DENIED (403)	"Permission denied for allowlisted domain resource."	• ユーザーに適切なスコープが付与されていることを確認します。 •ユーザーに必要な権限があることを確認します。 •プロジェクト/ユーザーが許可リストに登録されているかどうかを確認するには、連絡先のメールアドレスにお問い合わせください。
ユーザーの顧客 ID が見つからない	NOT_FOUND (404)	"Customer ID not found for user."	ログインしているユーザーが有効なドメインにリンクされていません。
許可リストの更新がすでに進行中です。	FAILED_PRECONDITION (400)	"An allowlist update is already in progress. Please wait for it to complete before making another request."	前のミューテーションが完了するまで待ちます。
許可リストのドメイン数の上限に達しました。	FAILED_PRECONDITION (400)	"Allowlisted domain limit has been reached."	顧客アカウントのドメイン数の上限（5,000 個）に達したため、ドメインを追加できません。
ドメイン名が空	INVALID_ARGUMENT (400)	"Domain name cannot be empty."	作成リクエストに渡されたドメインを再確認します。空にすることはできません。
ドメイン名が無効	INVALID_ARGUMENT (400)	"Invalid domain name: <domain>."	リクエストで指定されたドメイン名が不正な形式であるか、無効です。通常、このエラーは次のいずれかのシナリオで発生します。 • 構文が無効: ドメイン名が必須の形式標準に準拠していません。 •制限付きドメイン: 次の特定のドメインは制限されており、許可リストに追加できません: • aol.com • gmail.com • hotmail.com • mail.ru • outlook.com • web.de • yahoo.com • yandex.com • yandex.ru

監査ログ

許可リスト登録済みドメイン API を使用して作成すると、管理者が確認できる監査ログイベントが生成されます。詳細については、監査ログの表示をご覧ください。