GetAudienceGroupsByIds サービス操作 - キャンペーン管理

[アーティクル]
10/04/2023

指定した AudienceGroups を取得します。

Request 要素

GetAudienceGroupsByIdsRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。要素は、要求 SOAP に示されている順序と同じ順序である必要があります。

注:

以下に特に記載がない限り、すべての要求要素が必要です。

要求本文要素

要素	説明	データ型
AudienceGroupIds	取得する対象ユーザーグループ ID の配列。リストの最大サイズは、サービス要求ごとに 100 項目です。この要素を nil または空のままにすると、操作によってアカウント内のすべての対象ユーザーグループが返されます。	long 配列

要求ヘッダー要素

要素	説明	データ型
AuthenticationToken	Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセストークン。詳細については、「 OAuth による認証」を参照してください。	string
CustomerAccountId	要求のエンティティを所有または関連付けられている広告アカウントの識別子。両方が必要な場合、このヘッダー要素の値は AccountId 本文要素と同じである必要があります。この要素は、ほとんどのサービス操作に必要であり、ベストプラクティスとして常に設定する必要があります。詳細については、「アカウントと顧客 ID を取得する」を参照してください。	string
Customerid	ユーザーがアクセスまたは操作しているマネージャーアカウント (顧客) の識別子。ユーザーは複数のマネージャーアカウントにアクセスできます。この要素は、ほとんどのサービス操作に必要であり、ベストプラクティスとして常に設定する必要があります。詳細については、「アカウントと顧客 ID を取得する」を参照してください。	string
DeveloperToken	Bing Ads API へのアクセスに使用される開発者トークン。詳細については、「開発者トークンを取得する」を参照してください。	string
Password	この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。	string
UserName	この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。	string

Response 要素

GetAudienceGroupsByIdsResponse オブジェクトは、サービス操作応答の本文とヘッダー要素を定義します。要素は、応答 SOAP に示されている順序と同じ順序で返されます。

応答本文の要素

要素	説明	データ型
AudienceGroups	対象ユーザーグループの配列。リストの最大サイズは、サービス要求ごとに 100 項目です。	AudienceGroup 配列
PartialErrors	成功しなかった要求項目の詳細を含む BatchError オブジェクトの配列。	BatchError 配列

応答ヘッダー要素

要素	説明	データ型
TrackingId	API 呼び出しの詳細を含むログエントリの識別子。	string

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">GetAudienceGroupsByIds</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>
    <GetAudienceGroupsByIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <AudienceGroupIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </AudienceGroupIds>
    </GetAudienceGroupsByIdsRequest>
  </s:Body>
</s:Envelope>

応答 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>
    <GetAudienceGroupsByIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <AudienceGroups d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <AudienceGroup>
          <AssociationCount d4p1:nil="false">ValueHere</AssociationCount>
          <Description d4p1:nil="false">ValueHere</Description>
          <Dimensions d4p1:nil="false">
            <AudienceGroupDimension d4p1:type="-- derived type specified here with the appropriate prefix --">
              <Type>ValueHere</Type>
              <!--This field is applicable if the derived type attribute is set to AgeDimension-->
              <AgeRanges d4p1:nil="false">
                <AgeRange>ValueHere</AgeRange>
              </AgeRanges>
              <!--This field is applicable if the derived type attribute is set to GenderDimension-->
              <GenderTypes d4p1:nil="false">
                <GenderType>ValueHere</GenderType>
              </GenderTypes>
              <!--This field is applicable if the derived type attribute is set to AudienceDimension-->
              <Audiences d4p1:nil="false">
                <AudienceInfo>
                  <Id d4p1:nil="false">ValueHere</Id>
                  <Type>ValueHere</Type>
                </AudienceInfo>
              </Audiences>
            </AudienceGroupDimension>
          </Dimensions>
          <Id d4p1:nil="false">ValueHere</Id>
          <Name d4p1:nil="false">ValueHere</Name>
        </AudienceGroup>
      </AudienceGroups>
      <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:e125="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e125:KeyValuePairOfstringstring>
              <e125:key d4p1:nil="false">ValueHere</e125:key>
              <e125:value d4p1:nil="false">ValueHere</e125:value>
            </e125: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>
    </GetAudienceGroupsByIdsResponse>
  </s:Body>
</s:Envelope>

コード構文

構文の例は、 Bing広告 SDK で使用できます。その他の例については、「Bing広告 API コードの例」を参照してください。

public async Task<GetAudienceGroupsByIdsResponse> GetAudienceGroupsByIdsAsync(
	IList<long> audienceGroupIds)
{
	var request = new GetAudienceGroupsByIdsRequest
	{
		AudienceGroupIds = audienceGroupIds
	};

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

static GetAudienceGroupsByIdsResponse getAudienceGroupsByIds(
	ArrayOflong audienceGroupIds) throws RemoteException, Exception
{
	GetAudienceGroupsByIdsRequest request = new GetAudienceGroupsByIdsRequest();

	request.setAudienceGroupIds(audienceGroupIds);

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

static function GetAudienceGroupsByIds(
	$audienceGroupIds)
{

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

	$request = new GetAudienceGroupsByIdsRequest();

	$request->AudienceGroupIds = $audienceGroupIds;

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

response=campaignmanagement_service.GetAudienceGroupsByIds(
	AudienceGroupIds=AudienceGroupIds)

要件

サービス: CampaignManagementService.svc v13
名前空間： https://bingads.microsoft.com/CampaignManagement/v13

次の方法で共有