API مستوى التحكم في بوابة واجهة API التحويلات للحسابات المتعددة: المرجع

تكوين توجيه بيانات الحساب

تحديث توجيه البيانات

يسمح بتحديد النطاق الأساسي للبيكسل للتواصل مع البوابة. المزيد من التفاصيل هنا.

المخطط

POST https://{capig_domain}/capig/graphql/ 
_________________________________________________________________________________________________________________
      
mutation IngressEditingModalMutation(
 $tenantId: ID!
 $input: IngressDomainInput
) {
 tenantMutations(tenantId: $tenantId) {
   upsertIngressDomain(input: $input) {
     id
     ingress
     cnameResolveSuccess
     tenantName
     enhancementTenantIngressVerifiedResult {
       id
       tenantIngressVerified
     }
   }
 }
}
_________________________________________________________________________________________________________
tenantId: ID!
_______________________________________________________________________________________________________
input IngressDomainInput {
  ingress: String!
  targetDomain: String!
}
     

الحقول

الحقلالوصف

tenantId
String (سلسلة)

مطلوب

المعرف الفريد للحساب


IngressDomainInput

الحقلالوصف

ingress
String (سلسلة)

مطلوب

النطاق الفرعي الجديد المطلوب تحديثه

targetDomain
String (سلسلة)

مطلوب

نطاق بوابة الشريك


القيم التي يتم إرجاعها

الحقلالوصف

IngressDomain
IngressDomain

كائن نطاق الدخول


رموز الأخطاء

الرمزالوصف

401

غير مصرح له بترقية نطاق الدخول

500

خطأ داخلي بالخادم


عينة من الطلب

التغير

 mutation IngressEditingModalMutation(
$tenantId: ID!
$input: IngressDomainInput
) {
tenantMutations(tenantId: $tenantId) {
  upsertIngressDomain(input: $input) {
    id
    ingress
    cnameResolveSuccess
    enhancementTenantIngressVerifiedResult {
      id
      tenantIngressVerified
    }
  }
}
}
     

المتغيرات

{
  "tenantId": "IaoreXfj",
  "input": {
      "ingress": "capig.advertiser.com",
      "targetDomain": "capig.targetDomain.com"
  }
}
     

عينة من الاستجابة

{
   "data": {
       "tenantMutations": {
           "upsertIngressDomain": {
               "id": "IaoreXfj:ingress",
               "ingress": "capig.advertiser.com",
               "cnameResolveSuccess": true,
               "enhancementTenantIngressVerifiedResult": {
                   "id": "IaoreXfj:tenantIngressVerified",
                   "tenantIngressVerified": true
               }
           }
       }