แชร์ผ่าน

การดําเนินการ GetAnnotationOptOut Service - การจัดการแคมเปญ

แสดงการกําหนดค่าการเลือกไม่เข้าร่วมคําอธิบายประกอบปัจจุบัน

ร้องขอองค์ประกอบ

วัตถุ GetAnnotationOptOutRequest จะกําหนดองค์ประกอบ เนื้อความ และ ส่วนหัว ของการร้องขอการดําเนินการบริการ องค์ประกอบต้องอยู่ในลําดับเดียวกับที่แสดงใน Request SOAP

หมายเหตุ

เว้นแต่ระบุไว้เป็นอย่างอื่นด้านล่าง จําเป็นต้องระบุองค์ประกอบคําขอทั้งหมด

ร้องขอองค์ประกอบเนื้อความ

ไม่มีองค์ประกอบใดๆ ในเนื้อความการร้องขอของการดําเนินการ

องค์ประกอบส่วนหัวของคําขอ

ธาตุ คำอธิบาย ชนิดข้อมูล
AuthenticationToken โทเค็นการเข้าถึง OAuth ที่แสดงข้อมูลประจําตัวของผู้ใช้ที่มีสิทธิ์เข้าถึงบัญชี Microsoft Advertising

สําหรับข้อมูลเพิ่มเติม ดูการรับรองความถูกต้องด้วย OAuth		 เชือก
CustomerAccountId ตัวระบุบัญชีโฆษณาที่เป็นเจ้าของหรือเชื่อมโยงกับเอนทิตีในคําขอ องค์ประกอบส่วนหัวนี้ต้องมีค่าเดียวกันกับองค์ประกอบเนื้อความ AccountId เมื่อต้องการทั้งสองอย่าง องค์ประกอบนี้จําเป็นสําหรับการดําเนินการบริการส่วนใหญ่ และเป็นแนวทางปฏิบัติที่ดีที่สุดที่คุณควรตั้งค่าไว้เสมอ

สําหรับข้อมูลเพิ่มเติม ดูรับบัญชีและรหัสลูกค้าของคุณ		 เชือก
CustomerId ตัวระบุบัญชีผู้จัดการ (ลูกค้า) ที่ผู้ใช้กําลังเข้าถึงหรือดําเนินการ ผู้ใช้สามารถเข้าถึงบัญชีผู้จัดการได้หลายบัญชี องค์ประกอบนี้จําเป็นสําหรับการดําเนินการบริการส่วนใหญ่ และเป็นแนวทางปฏิบัติที่ดีที่สุดที่คุณควรตั้งค่าไว้เสมอ

สําหรับข้อมูลเพิ่มเติม ดูรับบัญชีและรหัสลูกค้าของคุณ		 เชือก
DeveloperToken โทเค็นนักพัฒนาที่ใช้เพื่อเข้าถึง Bing Ads API

สําหรับข้อมูลเพิ่มเติม ดูรับโทเค็นนักพัฒนา		 เชือก
รหัสผ่าน องค์ประกอบนี้สงวนไว้สําหรับการใช้ภายในและจะถูกเอาออกจากเวอร์ชันในอนาคตของ API คุณต้องใช้องค์ประกอบ AuthenticationToken เพื่อตั้งค่าข้อมูลประจําตัวของผู้ใช้ เชือก
ชื่อผู้ใช้ องค์ประกอบนี้สงวนไว้สําหรับการใช้ภายในและจะถูกเอาออกจากเวอร์ชันในอนาคตของ API คุณต้องใช้องค์ประกอบ AuthenticationToken เพื่อตั้งค่าข้อมูลประจําตัวของผู้ใช้ เชือก

องค์ประกอบการตอบสนอง

วัตถุ GetAnnotationOptOutResponse จะกําหนดองค์ประกอบ เนื้อความ และ ส่วนหัว ของการตอบสนองการดําเนินการบริการ องค์ประกอบจะถูกส่งกลับตามลําดับเดียวกับที่แสดงใน Response SOAP

องค์ประกอบเนื้อความการตอบสนอง

ธาตุ คำอธิบาย ชนิดข้อมูล
คําอธิบายประกอบ OptOuts อาร์เรย์ของคําอธิบายประกอบเลือกไม่ใช้วัตถุข้อมูล อาร์เรย์ AnnotationOptOut
IsAccountOptOut บัญชีถูกปฏิเสธเข้าร่วมหรือไม่ บูลีน
IsCustomerOptOut ลูกค้าเลือกไม่เข้าร่วมหรือไม่ บูลีน
IsCustomerOptOutOfEverything ลูกค้าเลือกไม่รับทุกอย่างหรือไม่ บูลีน
ข้ออ้าง ข้อความของการจัดชิดขึ้น เชือก
ตัวแก้ไขบางส่วน อาร์เรย์ของออบเจ็กต์ BatchError ที่มีรายละเอียดสําหรับรายการคําขอใดๆ ที่ไม่ประสบความสําเร็จ

รายการของข้อผิดพลาดไม่สอดคล้องกับรายการของหน่วยข้อมูลในคําขอโดยตรง รายการอาจว่างเปล่าถ้าไม่มีข้อผิดพลาด หรืออาจรวมวัตถุข้อผิดพลาดอย่างน้อยหนึ่งวัตถุที่สอดคล้องกับข้อมูลในรายการที่ไม่สําเร็จแต่ละรายการในการร้องขอ		 อาร์เรย์ BatchError

องค์ประกอบส่วนหัวการตอบสนอง

ธาตุ คำอธิบาย ชนิดข้อมูล
TrackingId ตัวระบุของรายการบันทึกที่ประกอบด้วยรายละเอียดของการเรียกใช้ API เชือก

ร้องขอ SOAP

เทมเพลตนี้ถูกสร้างขึ้นโดยเครื่องมือเพื่อแสดง ลําดับ ขององค์ประกอบ เนื้อความ และ ส่วนหัว สําหรับคําขอ SOAP สําหรับชนิดที่สนับสนุนที่คุณสามารถใช้กับการดําเนินการบริการนี้ โปรดดูการอ้างอิง องค์ประกอบเนื้อความคําขอ ด้านบน

<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
    <Action mustUnderstand="1">GetAnnotationOptOut</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <CustomerAccountId i:nil="false">ValueHere</CustomerAccountId>
    <CustomerId i:nil="false">ValueHere</CustomerId>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <GetAnnotationOptOutRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13" />
  </s:Body>
</s:Envelope>

Response SOAP

เทมเพลตนี้ถูกสร้างขึ้นโดยเครื่องมือเพื่อแสดงลําดับขององค์ประกอบ เนื้อ ความและ ส่วนหัว สําหรับการตอบสนอง SOAP

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <GetAnnotationOptOutResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <Justification d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</Justification>
      <AnnotationOptOuts d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <AnnotationOptOut>
          <AccountId>ValueHere</AccountId>
          <AnnotationGroupId>ValueHere</AnnotationGroupId>
          <CustomerId>ValueHere</CustomerId>
          <IsOptOut>ValueHere</IsOptOut>
        </AnnotationOptOut>
      </AnnotationOptOuts>
      <IsAccountOptOut>ValueHere</IsAccountOptOut>
      <IsCustomerOptOut>ValueHere</IsCustomerOptOut>
      <IsCustomerOptOutOfEverything>ValueHere</IsCustomerOptOutOfEverything>
      <PartialErrors d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <BatchError d4p1:type="-- derived type specified here with the appropriate prefix --">
          <Code>ValueHere</Code>
          <Details d4p1:nil="false">ValueHere</Details>
          <ErrorCode d4p1:nil="false">ValueHere</ErrorCode>
          <FieldPath d4p1:nil="false">ValueHere</FieldPath>
          <ForwardCompatibilityMap xmlns:e257="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e257:KeyValuePairOfstringstring>
              <e257:key d4p1:nil="false">ValueHere</e257:key>
              <e257:value d4p1:nil="false">ValueHere</e257:value>
            </e257:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Index>ValueHere</Index>
          <Message d4p1:nil="false">ValueHere</Message>
          <Type d4p1:nil="false">ValueHere</Type>
          <!--These fields are applicable if the derived type attribute is set to EditorialError-->
          <Appealable d4p1:nil="false">ValueHere</Appealable>
          <DisapprovedText d4p1:nil="false">ValueHere</DisapprovedText>
          <Location d4p1:nil="false">ValueHere</Location>
          <PublisherCountry d4p1:nil="false">ValueHere</PublisherCountry>
          <ReasonCode>ValueHere</ReasonCode>
        </BatchError>
      </PartialErrors>
    </GetAnnotationOptOutResponse>
  </s:Body>
</s:Envelope>

ไวยากรณ์โค้ด

ไวยากรณ์ตัวอย่างสามารถใช้กับ Bing Ads SDKs ได้ ดู ตัวอย่างโค้ด API ของโฆษณา Bing สําหรับตัวอย่างเพิ่มเติม

public async Task<GetAnnotationOptOutResponse> GetAnnotationOptOutAsync()
{
	var request = new GetAnnotationOptOutRequest
	{
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.GetAnnotationOptOutAsync(r), request));
}

static GetAnnotationOptOutResponse getAnnotationOptOut() throws RemoteException, Exception
{
	GetAnnotationOptOutRequest request = new GetAnnotationOptOutRequest();


	return CampaignManagementService.getService().getAnnotationOptOut(request);
}

static function GetAnnotationOptOut()
{

	$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];

	$request = new GetAnnotationOptOutRequest();


	return $GLOBALS['CampaignManagementProxy']->GetService()->GetAnnotationOptOut($request);
}

response=campaignmanagement_service.GetAnnotationOptOut()

ข้อกําหนด

บริการ: การส่งเสริมการขายการจัดการบริการ.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13

URL การร้องขอ

https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/AnnotationOptOut/Query

ร้องขอองค์ประกอบ

วัตถุ GetAnnotationOptOutRequest จะกําหนดองค์ประกอบ เนื้อความ และ ส่วนหัว ของการร้องขอการดําเนินการบริการ

หมายเหตุ

เว้นแต่ระบุไว้เป็นอย่างอื่นด้านล่าง จําเป็นต้องระบุองค์ประกอบคําขอทั้งหมด

ร้องขอองค์ประกอบเนื้อความ

ไม่มีองค์ประกอบใดๆ ในเนื้อความการร้องขอของการดําเนินการ

องค์ประกอบส่วนหัวของคําขอ

ธาตุ คำอธิบาย ชนิดข้อมูล
การอนุญาต โทเค็นการเข้าถึง OAuth ที่แสดงข้อมูลประจําตัวของผู้ใช้ที่มีสิทธิ์เข้าถึงบัญชี Microsoft Advertising โปรดตรวจสอบให้แน่ใจว่าโทเค็นขึ้นต้นด้วย "Bearer " ซึ่งจําเป็นสําหรับการรับรองความถูกต้องที่เหมาะสม

สําหรับข้อมูลเพิ่มเติม ดูการรับรองความถูกต้องด้วย OAuth		 เชือก
CustomerAccountId ตัวระบุบัญชีโฆษณาที่เป็นเจ้าของหรือเชื่อมโยงกับเอนทิตีในคําขอ องค์ประกอบส่วนหัวนี้ต้องมีค่าเดียวกันกับองค์ประกอบเนื้อความ AccountId เมื่อต้องการทั้งสองอย่าง องค์ประกอบนี้จําเป็นสําหรับการดําเนินการบริการส่วนใหญ่ และเป็นแนวทางปฏิบัติที่ดีที่สุดที่คุณควรตั้งค่าไว้เสมอ

สําหรับข้อมูลเพิ่มเติม ดูรับบัญชีและรหัสลูกค้าของคุณ		 เชือก
CustomerId ตัวระบุบัญชีผู้จัดการ (ลูกค้า) ที่ผู้ใช้กําลังเข้าถึงหรือดําเนินการ ผู้ใช้สามารถเข้าถึงบัญชีผู้จัดการได้หลายบัญชี องค์ประกอบนี้จําเป็นสําหรับการดําเนินการบริการส่วนใหญ่ และเป็นแนวทางปฏิบัติที่ดีที่สุดที่คุณควรตั้งค่าไว้เสมอ

สําหรับข้อมูลเพิ่มเติม ดูรับบัญชีและรหัสลูกค้าของคุณ		 เชือก
DeveloperToken โทเค็นนักพัฒนาที่ใช้เพื่อเข้าถึง Bing Ads API

สําหรับข้อมูลเพิ่มเติม ดูรับโทเค็นนักพัฒนา		 เชือก
รหัสผ่าน องค์ประกอบนี้สงวนไว้สําหรับการใช้ภายในและจะถูกเอาออกจากเวอร์ชันในอนาคตของ API คุณต้องใช้องค์ประกอบ AuthenticationToken เพื่อตั้งค่าข้อมูลประจําตัวของผู้ใช้ เชือก
ชื่อผู้ใช้ องค์ประกอบนี้สงวนไว้สําหรับการใช้ภายในและจะถูกเอาออกจากเวอร์ชันในอนาคตของ API คุณต้องใช้องค์ประกอบ AuthenticationToken เพื่อตั้งค่าข้อมูลประจําตัวของผู้ใช้ เชือก

องค์ประกอบการตอบสนอง

วัตถุ GetAnnotationOptOutResponse จะกําหนดองค์ประกอบ เนื้อความ และ ส่วนหัว ของการตอบสนองการดําเนินการบริการ องค์ประกอบจะถูกส่งกลับตามลําดับเดียวกับที่แสดงในการตอบสนอง JSON

องค์ประกอบเนื้อความการตอบสนอง

ธาตุ คำอธิบาย ชนิดข้อมูล
คําอธิบายประกอบ OptOuts อาร์เรย์ของคําอธิบายประกอบเลือกไม่ใช้วัตถุข้อมูล อาร์เรย์ AnnotationOptOut
IsAccountOptOut บัญชีถูกปฏิเสธเข้าร่วมหรือไม่ บูลีน
IsCustomerOptOut ลูกค้าเลือกไม่เข้าร่วมหรือไม่ บูลีน
IsCustomerOptOutOfEverything ลูกค้าเลือกไม่รับทุกอย่างหรือไม่ บูลีน
ข้ออ้าง ข้อความของการจัดชิดขึ้น เชือก
ตัวแก้ไขบางส่วน อาร์เรย์ของออบเจ็กต์ BatchError ที่มีรายละเอียดสําหรับรายการคําขอใดๆ ที่ไม่ประสบความสําเร็จ

รายการของข้อผิดพลาดไม่สอดคล้องกับรายการของหน่วยข้อมูลในคําขอโดยตรง รายการอาจว่างเปล่าถ้าไม่มีข้อผิดพลาด หรืออาจรวมวัตถุข้อผิดพลาดอย่างน้อยหนึ่งวัตถุที่สอดคล้องกับข้อมูลในรายการที่ไม่สําเร็จแต่ละรายการในการร้องขอ		 อาร์เรย์ BatchError

องค์ประกอบส่วนหัวการตอบสนอง

ธาตุ คำอธิบาย ชนิดข้อมูล
TrackingId ตัวระบุของรายการบันทึกที่ประกอบด้วยรายละเอียดของการเรียกใช้ API เชือก

ร้องขอ JSON

เทมเพลตนี้ถูกสร้างขึ้นโดยเครื่องมือเพื่อแสดงองค์ประกอบ เนื้อความ และ ส่วนหัว สําหรับคําขอ JSON สําหรับชนิดที่สนับสนุนที่คุณสามารถใช้กับการดําเนินการบริการนี้ โปรดดูการอ้างอิง องค์ประกอบเนื้อความคําขอ ด้านบน

{}

การตอบสนอง JSON

เทมเพลตนี้ถูกสร้างขึ้นโดยเครื่องมือเพื่อแสดงองค์ประกอบ เนื้อความ และ ส่วนหัว สําหรับการตอบสนอง JSON

ด้านล่างนี้คือตัวอย่างที่สามารถใช้ได้หากชนิดของ BatchError คือ EditorialError

{
  "Justification": "ValueHere",
  "AnnotationOptOuts": [
    {
      "AccountId": "LongValueHere",
      "AnnotationGroupId": "LongValueHere",
      "CustomerId": "LongValueHere",
      "IsOptOut": "ValueHere"
    }
  ],
  "IsAccountOptOut": "ValueHere",
  "IsCustomerOptOut": "ValueHere",
  "IsCustomerOptOutOfEverything": "ValueHere",
  "PartialErrors": [
    {
      "Code": IntValueHere,
      "Details": "ValueHere",
      "ErrorCode": "ValueHere",
      "FieldPath": "ValueHere",
      "ForwardCompatibilityMap": [
        {
          "key": "ValueHere",
          "value": "ValueHere"
        }
      ],
      "Index": IntValueHere,
      "Message": "ValueHere",
      "Type": "EditorialError",
      "Appealable": "ValueHere",
      "DisapprovedText": "ValueHere",
      "Location": "ValueHere",
      "PublisherCountry": "ValueHere",
      "ReasonCode": IntValueHere
    }
  ]
}

ไวยากรณ์โค้ด

หากต้องการเรียกใช้ REST API ผ่าน SDK คุณจําเป็นต้องอัปเกรด SDK เป็นเวอร์ชันเฉพาะและกําหนดค่าพารามิเตอร์ระบบ ไวยากรณ์ตัวอย่างสามารถใช้กับ Bing Ads SDKs ได้ ดู ตัวอย่างโค้ด API ของโฆษณา Bing สําหรับตัวอย่างเพิ่มเติม

public async Task<GetAnnotationOptOutResponse> GetAnnotationOptOutAsync()
{
	var request = new GetAnnotationOptOutRequest
	{
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.GetAnnotationOptOutAsync(r), request));
}

static GetAnnotationOptOutResponse getAnnotationOptOut() throws RemoteException, Exception
{
	GetAnnotationOptOutRequest request = new GetAnnotationOptOutRequest();


	return CampaignManagementService.getService().getAnnotationOptOut(request);
}

static function GetAnnotationOptOut()
{

	$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];

	$request = new GetAnnotationOptOutRequest();


	return $GLOBALS['CampaignManagementProxy']->GetService()->GetAnnotationOptOut($request);
}

response=campaignmanagement_service.GetAnnotationOptOut()