sdfdownloadtasks.create 要求會建立長時間執行的作業。這項作業會產生結構化資料檔案 (SDF)。
要求欄位會定義 SDF:
partnerId或advertiserId:將 SDF 的內容限制為指定合作夥伴或廣告主的環境。只能設定其中一個欄位。version:定義要使用的 SDF 版本。如果未設定,預設值為合作夥伴或廣告主設定。parentEntityFilter、idFilter或inventorySourceFilter:定義結構化資料檔案的內容。只能設定其中一個欄位。
以下說明如何建立下載工作,為指定廣告活動產生廣告訂單和委刊項 SDF:
Java
// Provide the ID of the parent advertiser of the resources to retrieve. long advertiserId = advertiser-id; // Provide the Structured Data Files version to download. String sdfVersion = sdf-version; // Provide the IDs of the parent campaigns of the resources to retrieve. List<Long> campaignIds = campaign-ids; // Create the filter structure. ParentEntityFilter parentEntityFilter = new ParentEntityFilter() .setFileType(Arrays.asList("FILE_TYPE_INSERTION_ORDER", "FILE_TYPE_LINE_ITEM")) .setFilterType("FILTER_TYPE_CAMPAIGN_ID") .setFilterIds(campaignIds); // Configure and create the SDF download task. Operation operation = service .sdfdownloadtasks() .create( new CreateSdfDownloadTaskRequest() .setVersion(sdfVersion) .setAdvertiserId(advertiserId) .setParentEntityFilter(parentEntityFilter)) .execute(); // Print the resulting operation name. System.out.printf("Operation %s was created.", operation.getName());
Python
# Provide the ID of the parent advertiser of the resources to retrieve. advertiser_id = advertiser-id # Provide the Structured Data Files version to download. sdf_version = sdf-version # Provide the IDs of the parent campaigns of the resources to retrieve. campaign_ids = campaign-ids # Create the request body. body = { "version": sdf_version, "advertiserId": advertiser_id, "parentEntityFilter": { "fileType": ["FILE_TYPE_INSERTION_ORDER", "FILE_TYPE_LINE_ITEM"], "filterType": "FILTER_TYPE_CAMPAIGN_ID", "filterIds": campaign_ids, }, } # Create the operation. operation = service.sdfdownloadtasks().create(body=body).execute() # Print resulting operation name. print(f'Operation {operation["name"]} was created.')
PHP
// Provide the ID of the parent advertiser of the resources to retrieve. $advertiserId = advertiser-id; // Provide the Structured Data Files version to download. $sdfVersion = sdf-version; // Provide the IDs of the parent campaigns of the resources to retrieve. $campaignIds = campaign-ids; // Create the filter structure. $filter = new Google_Service_DisplayVideo_ParentEntityFilter(); $filter->setFileType(array('FILE_TYPE_INSERTION_ORDER','FILE_TYPE_LINE_ITEM')); $filter->setFilterType('FILTER_TYPE_CAMPAIGN_ID'); $filter->setFilterIds($campaignIds); // Configure and create the SDF download task. $createDownloadRequest = new Google_Service_DisplayVideo_CreateSdfDownloadTaskRequest(); $createDownloadRequest->setVersion($sdfVersion); $createDownloadRequest->setAdvertiserId($advertiserId); $createDownloadRequest->setParentEntityFilter($filter); // Call the API, creating the SDF Download Task. $operation = $this->service->sdfdownloadtasks->create( $createDownloadRequest ); // Print the resulting operation name. printf('<p>Operation %s was created.</p>', $operation['name']);