เพิ่มการดําเนินการบริการ AddSharedEntity - การจัดการแคมเปญ

เพิ่มรายการคีย์เวิร์ดเชิงลบลงในไลบรารีบัญชีโฆษณา หรือเพิ่มรายการยกเว้นเว็บไซต์ลงในไลบรารีบัญชีผู้จัดการ (ลูกค้า)

เคล็ดลับ

สําหรับภาพรวม โปรดดูคําแนะนําทางเทคนิคเกี่ยวกับคําสําคัญเชิงลบและไซต์เชิงลบ

สิ่งสำคัญ

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

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

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

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

หมายเหตุ

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

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

องค์ ประกอบ	คำอธิบาย	ชนิดข้อมูล
ListItems	คําหลักเชิงลบ (สูงสุด 5,000 คํา) เพื่อรวมกับรายการคําหลักเชิงลบใหม่หรือไซต์เชิงลบ (สูงสุด 10,000 รายการ) เพื่อรวมเข้ากับรายการยกเว้นเว็บไซต์ใหม่ รายการสามารถมีรายการได้สูงสุด 5,000 รายการต่อการเรียกใช้บริการ เมื่อต้องการเพิ่มข้อมูลในรายการเพิ่มเติม ให้เรียกการดําเนินการ AddListItemsToSharedList	อาร์เรย์ SharedListItem
SharedEntity	รายการคีย์เวิร์ดเชิงลบหรือรายการการยกเว้นเว็บไซต์ ถ้า SharedEntityScope เป็นค่าว่างหรือตั้งค่าเป็น บัญชี และถ้า SharedEntity เป็น NegativeKeywordList ดังนั้น ListItems ต้องเป็นวัตถุคําสําคัญเชิงลบ (NegativeKeyword) ถ้า SharedEntityScope ถูกตั้งค่าเป็น ลูกค้า และถ้า SharedEntity เป็น PlacementExclusionList วัตถุ ListItems ต้องเป็นวัตถุไซต์เชิงลบ (NegativeSite)	SharedEntity
SharedEntityScope	ระบุว่าเอนทิตีที่แชร์จะพร้อมใช้งานที่ระดับบัญชีโฆษณา (บัญชี) หรือบัญชีผู้จัดการ (ลูกค้า) องค์ประกอบนี้เป็นตัวเลือกและค่าเริ่มต้นเป็นขอบเขตบัญชี ขอบเขตบัญชีโฆษณาใช้ได้กับรายการคีย์เวิร์ดเชิงลบเท่านั้น ตั้งค่าองค์ประกอบนี้เป็น ลูกค้า เพื่อเพิ่มรายการการยกเว้นเว็บไซต์ในบัญชีผู้จัดการของคุณ (ลูกค้า) ไลบรารีที่ใช้ร่วมกัน	ขอบเขตเอนทิตี

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

องค์ ประกอบ	คำอธิบาย	ชนิดข้อมูล
AuthenticationToken	โทเค็นการเข้าถึง OAuth ที่แสดงข้อมูลประจําตัวของผู้ใช้ที่มีสิทธิ์เข้าถึงบัญชี Microsoft Advertising สําหรับข้อมูลเพิ่มเติม ดูการรับรองความถูกต้องด้วย OAuth	สาย อักขระ
CustomerAccountId	ตัวระบุบัญชีโฆษณาที่เป็นเจ้าของหรือเชื่อมโยงกับเอนทิตีในคําขอ องค์ประกอบส่วนหัวนี้ต้องมีค่าเดียวกันกับองค์ประกอบเนื้อความ AccountId เมื่อต้องการทั้งสองอย่าง องค์ประกอบนี้จําเป็นสําหรับการดําเนินการบริการส่วนใหญ่ และเป็นแนวทางปฏิบัติที่ดีที่สุดที่คุณควรตั้งค่าไว้เสมอ สําหรับข้อมูลเพิ่มเติม ดูรับบัญชีและรหัสลูกค้าของคุณ	สาย อักขระ
CustomerId	ตัวระบุบัญชีผู้จัดการ (ลูกค้า) ที่ผู้ใช้กําลังเข้าถึงหรือดําเนินการ ผู้ใช้สามารถเข้าถึงบัญชีผู้จัดการได้หลายบัญชี องค์ประกอบนี้จําเป็นสําหรับการดําเนินการบริการส่วนใหญ่ และเป็นแนวทางปฏิบัติที่ดีที่สุดที่คุณควรตั้งค่าไว้เสมอ สําหรับข้อมูลเพิ่มเติม ดูรับบัญชีและรหัสลูกค้าของคุณ	สาย อักขระ
DeveloperToken	โทเค็นนักพัฒนาที่ใช้เพื่อเข้าถึง Bing Ads API สําหรับข้อมูลเพิ่มเติม ดูรับโทเค็นนักพัฒนา	สาย อักขระ
รหัส ผ่าน	องค์ประกอบนี้สงวนไว้สําหรับการใช้ภายในและจะถูกเอาออกจากเวอร์ชันในอนาคตของ API คุณต้องใช้องค์ประกอบ AuthenticationToken เพื่อตั้งค่าข้อมูลประจําตัวของผู้ใช้	สาย อักขระ
ชื่อ	องค์ประกอบนี้สงวนไว้สําหรับการใช้ภายในและจะถูกเอาออกจากเวอร์ชันในอนาคตของ API คุณต้องใช้องค์ประกอบ AuthenticationToken เพื่อตั้งค่าข้อมูลประจําตัวของผู้ใช้	สาย อักขระ

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

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

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

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

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

องค์ ประกอบ	คำอธิบาย	ชนิดข้อมูล
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">AddSharedEntity</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>
    <AddSharedEntityRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <SharedEntity i:nil="false" i:type="-- derived type specified here with the appropriate prefix --">
        <AssociationCount i:nil="false">ValueHere</AssociationCount>
        <ForwardCompatibilityMap xmlns:e57="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
          <e57:KeyValuePairOfstringstring>
            <e57:key i:nil="false">ValueHere</e57:key>
            <e57:value i:nil="false">ValueHere</e57:value>
          </e57:KeyValuePairOfstringstring>
        </ForwardCompatibilityMap>
        <Id i:nil="false">ValueHere</Id>
        <Name i:nil="false">ValueHere</Name>
        <Type i:nil="false">ValueHere</Type>
        <!--This field is applicable if the derived type attribute is set to SharedList-->
        <ItemCount i:nil="false">ValueHere</ItemCount>
      </SharedEntity>
      <ListItems i:nil="false">
        <SharedListItem i:type="-- derived type specified here with the appropriate prefix --">
          <ForwardCompatibilityMap xmlns:e58="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
            <e58:KeyValuePairOfstringstring>
              <e58:key i:nil="false">ValueHere</e58:key>
              <e58:value i:nil="false">ValueHere</e58:value>
            </e58:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Type i:nil="false">ValueHere</Type>
          <!--These fields are applicable if the derived type attribute is set to NegativeKeyword-->
          <Id i:nil="false">ValueHere</Id>
          <MatchType i:nil="false">ValueHere</MatchType>
          <Text i:nil="false">ValueHere</Text>
          <!--These fields are applicable if the derived type attribute is set to NegativeSite-->
          <Id i:nil="false">ValueHere</Id>
          <Url i:nil="false">ValueHere</Url>
          <!--This field is applicable if the derived type attribute is set to BrandItem-->
          <BrandId>ValueHere</BrandId>
        </SharedListItem>
      </ListItems>
      <SharedEntityScope i:nil="false">ValueHere</SharedEntityScope>
    </AddSharedEntityRequest>
  </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>
    <AddSharedEntityResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <ListItemIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <a1:long>ValueHere</a1:long>
      </ListItemIds>
      <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:e59="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e59:KeyValuePairOfstringstring>
              <e59:key d4p1:nil="false">ValueHere</e59:key>
              <e59:value d4p1:nil="false">ValueHere</e59:value>
            </e59: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>
      <SharedEntityId>ValueHere</SharedEntityId>
    </AddSharedEntityResponse>
  </s:Body>
</s:Envelope>

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

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

public async Task<AddSharedEntityResponse> AddSharedEntityAsync(
	SharedEntity sharedEntity,
	IList<SharedListItem> listItems,
	EntityScope? sharedEntityScope)
{
	var request = new AddSharedEntityRequest
	{
		SharedEntity = sharedEntity,
		ListItems = listItems,
		SharedEntityScope = sharedEntityScope
	};

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

static AddSharedEntityResponse addSharedEntity(
	SharedEntity sharedEntity,
	ArrayOfSharedListItem listItems,
	EntityScope sharedEntityScope) throws RemoteException, Exception
{
	AddSharedEntityRequest request = new AddSharedEntityRequest();

	request.setSharedEntity(sharedEntity);
	request.setListItems(listItems);
	request.setSharedEntityScope(sharedEntityScope);

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

static function AddSharedEntity(
	$sharedEntity,
	$listItems,
	$sharedEntityScope)
{

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

	$request = new AddSharedEntityRequest();

	$request->SharedEntity = $sharedEntity;
	$request->ListItems = $listItems;
	$request->SharedEntityScope = $sharedEntityScope;

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

response=campaignmanagement_service.AddSharedEntity(
	SharedEntity=SharedEntity,
	ListItems=ListItems,
	SharedEntityScope=SharedEntityScope)

ข้อกําหนด

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