pinterest_sdk 1.1.0 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +107 -32
- data/README.md +1308 -80
- data/bin/byebug +1 -12
- data/bin/coderay +1 -12
- data/bin/htmldiff +1 -12
- data/bin/ldiff +1 -12
- data/bin/pry +1 -12
- data/bin/racc +16 -0
- data/bin/rake +1 -12
- data/bin/rspec +1 -12
- data/bin/rubocop +1 -12
- data/bin/ruby-parse +1 -12
- data/bin/ruby-rewrite +1 -12
- data/docs/Account.md +20 -4
- data/docs/AccountTemplate.md +76 -0
- data/docs/Ad.md +94 -0
- data/docs/AdAccount.md +13 -5
- data/docs/AdAccountAnalyticsItems.md +20 -0
- data/docs/AdAccountCountriesGet200Response.md +18 -0
- data/docs/AdAccountCreate.md +26 -0
- data/docs/AdAccountEntityType.md +15 -0
- data/docs/AdAccountOwner.md +2 -0
- data/docs/AdAccountToAdAccountSharedAudience.md +22 -0
- data/docs/AdAccountToAdAccountSharedAudienceUpdateWithRequiredBody.md +22 -0
- data/docs/AdAccountToBusinessSharedAudience.md +22 -0
- data/docs/AdAccountToBusinessSharedAudienceUpdateWithRequiredBody.md +22 -0
- data/docs/AdAccountsApi.md +442 -292
- data/docs/AdAccountsAudience.md +42 -0
- data/docs/AdAccountsAudienceCreate.md +26 -0
- data/docs/AdAccountsAudienceRule.md +56 -0
- data/docs/AdAccountsAudienceUpdate.md +28 -0
- data/docs/AdAccountsAudiencesSharedAccountsList200Response.md +20 -0
- data/docs/AdAccountsCountry.md +24 -0
- data/docs/AdAccountsList200Response.md +20 -0
- data/docs/AdAccountsSubscriptionsGetList200Response.md +20 -0
- data/docs/AdAdsAnalyticsAsyncTargetingTypes.md +15 -0
- data/docs/AdBatchItem.md +20 -0
- data/docs/AdBatchUpdate.md +72 -0
- data/docs/AdBatchWriteResponseModel.md +18 -0
- data/docs/AdCollectionsHeaderType.md +15 -0
- data/docs/AdCreate.md +70 -0
- data/docs/AdCreateRequest.md +62 -0
- data/docs/AdDisapprovalReasons.md +15 -0
- data/docs/AdGroup.md +92 -0
- data/docs/AdGroupAudienceSizing.md +20 -0
- data/docs/AdGroupAudienceSizingCreate.md +28 -0
- data/docs/AdGroupAudienceSizingCreativeTypes.md +15 -0
- data/docs/AdGroupAudienceSizingKeyword.md +20 -0
- data/docs/AdGroupBase.md +84 -0
- data/docs/AdGroupCreate.md +92 -0
- data/docs/AdGroupCreateCreate.md +76 -0
- data/docs/AdGroupCreateRequest.md +62 -0
- data/docs/AdGroupCreateRequestAllOf1.md +24 -0
- data/docs/AdGroupDeliveryEstimates.md +34 -0
- data/docs/AdGroupDeliveryEstimatesKeywordsItems.md +20 -0
- data/docs/AdGroupTrackingURLs.md +26 -0
- data/docs/AdGroupUpdate.md +92 -0
- data/docs/AdGroupUpdateBatchUpdate.md +80 -0
- data/docs/AdGroupUpdateRequest.md +66 -0
- data/docs/AdGroupUpdateRequestAllOf1.md +22 -0
- data/docs/AdGroupsAnalyticsMetrics.md +20 -0
- data/docs/AdGroupsApi.md +1035 -0
- data/docs/AdGroupsCreate200Response.md +18 -0
- data/docs/AdGroupsCreate200ResponseItemsInner.md +20 -0
- data/docs/AdGroupsList200Response.md +20 -0
- data/docs/AdPinAnalytics.md +20 -0
- data/docs/AdPinPreviewCreativeType.md +15 -0
- data/docs/AdPreviewRequest.md +51 -0
- data/docs/AdPreviewShopping.md +38 -0
- data/docs/AdPreviewSourceImage.md +22 -0
- data/docs/AdPreviewSourcePinId.md +20 -0
- data/docs/AdPreviewURLResponse.md +18 -0
- data/docs/AdReviewStatus.md +15 -0
- data/docs/AdShoppingPreviewCreativeType.md +15 -0
- data/docs/AdUpdateRequest.md +64 -0
- data/docs/AdUpdateRequestAllOf1.md +20 -0
- data/docs/AdeColumnType.md +15 -0
- data/docs/AdgroupPlacementGroupType.md +15 -0
- data/docs/AdgroupTrackingFeatureType.md +15 -0
- data/docs/AdgroupTrackingFeatures.md +18 -0
- data/docs/AdsAnalytics.md +20 -0
- data/docs/AdsAnalyticsAccountTargetingType.md +15 -0
- data/docs/AdsAnalyticsAdGroupTargetingType.md +15 -0
- data/docs/AdsAnalyticsAdTargetingType.md +15 -0
- data/docs/AdsAnalyticsCampaignTargetingType.md +15 -0
- data/docs/AdsAnalyticsCreateAsyncRequest.md +53 -37
- data/docs/AdsAnalyticsCreateAsyncResponse.md +4 -4
- data/docs/AdsAnalyticsGetAsyncResponse.md +4 -4
- data/docs/AdsAnalyticsMetricsFilter.md +3 -3
- data/docs/AdsApi.md +805 -0
- data/docs/AdsCreditDiscountType.md +15 -0
- data/docs/AdsCreditDiscountsResponse.md +30 -0
- data/docs/AdsCreditRedeem.md +22 -0
- data/docs/AdsCreditRedeemCreate.md +20 -0
- data/docs/AdsCreditsDiscountsGet200Response.md +20 -0
- data/docs/AdsList200Response.md +20 -0
- data/docs/AdvancedAuctionApi.md +155 -0
- data/docs/AdvancedAuctionBidOptions.md +22 -0
- data/docs/AdvancedAuctionItem.md +24 -0
- data/docs/AdvancedAuctionItems.md +20 -0
- data/docs/AdvancedAuctionItemsGetRequest.md +20 -0
- data/docs/AdvancedAuctionItemsSubmitDeleteRecord.md +26 -0
- data/docs/AdvancedAuctionItemsSubmitRecord.md +79 -0
- data/docs/AdvancedAuctionItemsSubmitRequest.md +20 -0
- data/docs/AdvancedAuctionItemsSubmitUpsertRecord.md +30 -0
- data/docs/AdvancedAuctionKey.md +22 -0
- data/docs/AdvancedAuctionOperationError.md +20 -0
- data/docs/AdvancedAuctionProcessedItems.md +20 -0
- data/docs/AdvertiserDefinedEvent.md +20 -0
- data/docs/AdvertiserDefinedEventInput.md +20 -0
- data/docs/AdvertiserDefinedEventMappingType.md +15 -0
- data/docs/AdvertiserDefinedEventProcessingRecord.md +22 -0
- data/docs/AdvertiserDefinedEventsCreate200Response.md +18 -0
- data/docs/AdvertiserDefinedEventsCreateRequest.md +18 -0
- data/docs/AdvertiserDefinedEventsGet200Response.md +18 -0
- data/docs/AgeBucketMultipliers.md +18 -0
- data/docs/AgeTrendsBucket.md +15 -0
- data/docs/AggregatedPinComment.md +54 -0
- data/docs/AiDisclosureItem.md +15 -0
- data/docs/AiDisclosures.md +18 -0
- data/docs/AiDisclosuresUpdate.md +18 -0
- data/docs/AmazonConnectRequest.md +30 -0
- data/docs/AmazonConnectResponse.md +18 -0
- data/docs/AnalyticsDailyMetrics.md +22 -0
- data/docs/AnalyticsMetricsResponse.md +2 -2
- data/docs/AppTypeMultipliers.md +18 -0
- data/docs/AppsflyerAudience.md +22 -0
- data/docs/AppsflyerAudienceCreate.md +20 -0
- data/docs/AppsflyerAudienceSyncCreate.md +22 -0
- data/docs/AppsflyerPlatform.md +15 -0
- data/docs/AssetAccessRequestError.md +20 -0
- data/docs/AssetGroupBinding.md +38 -0
- data/docs/AssetGroupDeleteError.md +22 -0
- data/docs/AssetGroupDeletion.md +20 -0
- data/docs/AssetGroupDeletionDelete.md +18 -0
- data/docs/AssetGroupInput.md +18 -0
- data/docs/AssetGroupInputCreate.md +24 -0
- data/docs/AssetGroupModification.md +20 -0
- data/docs/AssetGroupModificationReadOrUpdate.md +22 -0
- data/docs/AssetGroupType.md +15 -0
- data/docs/AssetGroupUpdateError.md +22 -0
- data/docs/AssetGroupUpdateItemReadOrUpdateItem.md +28 -0
- data/docs/AssetIdPermissions.md +24 -0
- data/docs/AssetIdWithPermissions.md +20 -0
- data/docs/AssetPermissionType.md +15 -0
- data/docs/AssetSearchBy.md +15 -0
- data/docs/AssetSortBy.md +15 -0
- data/docs/AssetTypeResponse.md +15 -0
- data/docs/AttributionActionType.md +15 -0
- data/docs/AttributionMatchType.md +15 -0
- data/docs/AttributionModel.md +15 -0
- data/docs/AttributionScope.md +15 -0
- data/docs/AttributionWindows.md +22 -0
- data/docs/Audience.md +42 -0
- data/docs/AudienceAccountType.md +15 -0
- data/docs/AudienceCategory.md +28 -0
- data/docs/AudienceDefinition.md +22 -0
- data/docs/AudienceDemographicValue.md +22 -0
- data/docs/AudienceDemographics.md +26 -0
- data/docs/AudienceInsightType.md +15 -0
- data/docs/AudienceInsights.md +28 -0
- data/docs/AudienceInsightsApi.md +155 -0
- data/docs/AudienceInsightsScopeAndTypeGet200Response.md +18 -0
- data/docs/AudienceObjectiveType.md +15 -0
- data/docs/AudienceOwnershipType.md +15 -0
- data/docs/AudienceRule.md +56 -0
- data/docs/AudienceSharingApi.md +536 -0
- data/docs/AudienceStatus.md +15 -0
- data/docs/AudienceSubcategory.md +26 -0
- data/docs/AudienceType.md +15 -0
- data/docs/AudienceUpdateOperationType.md +15 -0
- data/docs/AudiencesApi.md +313 -0
- data/docs/AudiencesList200Response.md +20 -0
- data/docs/AuthRespondInviteAction.md +20 -0
- data/docs/AuthRespondInvitesBody.md +18 -0
- data/docs/AuthRespondInvitesBodyItem.md +20 -0
- data/docs/AvailabilityFilter.md +1 -1
- data/docs/BaseBusinessAssets.md +24 -0
- data/docs/BaseInviteDataResponse.md +24 -0
- data/docs/BasePreferredMediaType.md +15 -0
- data/docs/BidFloor.md +20 -0
- data/docs/BidFloorCreate.md +20 -0
- data/docs/BidFloorObjectiveType.md +15 -0
- data/docs/BidFloorSpec.md +28 -0
- data/docs/BidOptionsAgeBucketMultipliers.md +30 -0
- data/docs/BidOptionsAppTypeMultipliers.md +28 -0
- data/docs/BidOptionsAudienceMultipliers.md +20 -0
- data/docs/BidOptionsGenderMultipliers.md +20 -0
- data/docs/BidOptionsPlacementMultipliers.md +22 -0
- data/docs/BidStrategyType.md +15 -0
- data/docs/BillingApi.md +833 -0
- data/docs/BillingInvoice.md +46 -0
- data/docs/BillingInvoiceDocumentType.md +15 -0
- data/docs/BillingInvoiceDownloadResponse.md +20 -0
- data/docs/BillingInvoiceSortField.md +15 -0
- data/docs/BillingInvoiceStatus.md +15 -0
- data/docs/BillingInvoicesGet200Response.md +20 -0
- data/docs/BillingProfileCardType.md +15 -0
- data/docs/BillingProfilePaymentMethodBrand.md +15 -0
- data/docs/BillingProfileStatus.md +15 -0
- data/docs/BillingProfilesGet200Response.md +20 -0
- data/docs/BillingProfilesResponse.md +28 -0
- data/docs/BillingType.md +15 -0
- data/docs/Board.md +19 -5
- data/docs/BoardBase.md +38 -0
- data/docs/BoardCreate.md +24 -0
- data/docs/BoardMedia.md +20 -0
- data/docs/BoardPrivacy.md +15 -0
- data/docs/BoardPrivacyFilter.md +15 -0
- data/docs/BoardSection.md +2 -2
- data/docs/BoardSectionCreate.md +20 -0
- data/docs/BoardSectionUpdateWithRequiredBody.md +20 -0
- data/docs/BoardSectionsList200Response.md +20 -0
- data/docs/BoardUpdatePrivacy.md +15 -0
- data/docs/BoardWithUpdatePrivacy.md +40 -0
- data/docs/BoardWithUpdatePrivacyUpdate.md +22 -0
- data/docs/BoardsApi.md +157 -94
- data/docs/BoardsList200Response.md +20 -0
- data/docs/BoardsListPins200Response.md +20 -0
- data/docs/BookClosed.md +20 -0
- data/docs/BrandAccount.md +18 -0
- data/docs/BrandAccountCreate.md +28 -0
- data/docs/BrandAccountProfileImage.md +20 -0
- data/docs/BrandAccountProfileImageUpdate.md +20 -0
- data/docs/BrandAccountUpdate.md +28 -0
- data/docs/BrandFilter.md +1 -1
- data/docs/BudgetDurationType.md +15 -0
- data/docs/BudgetType.md +15 -0
- data/docs/BulkApi.md +230 -0
- data/docs/BulkCampaignDeliveryEstimatesItem.md +32 -0
- data/docs/BulkCampaignDeliveryEstimatesResponse.md +18 -0
- data/docs/BulkDownload.md +18 -0
- data/docs/BulkDownloadCampaignFilter.md +26 -0
- data/docs/BulkDownloadCreate.md +26 -0
- data/docs/BulkEntityType.md +15 -0
- data/docs/BulkJobData.md +22 -0
- data/docs/BulkOutputFormat.md +15 -0
- data/docs/BulkReportingJobStatus.md +15 -0
- data/docs/BulkRequestStatus.md +15 -0
- data/docs/BulkUpsertRequest.md +20 -0
- data/docs/BulkUpsertRequestCreate.md +32 -0
- data/docs/BulkUpsertRequestCreateCatalogProductGroupsItems.md +49 -0
- data/docs/BulkUpsertRequestUpdate.md +32 -0
- data/docs/BulkUpsertRequestUpdateCatalogProductGroupsItems.md +49 -0
- data/docs/BulkUpsertResponse.md +18 -0
- data/docs/BusinessAccessAssetsApi.md +945 -0
- data/docs/BusinessAccessInviteApi.md +447 -0
- data/docs/BusinessAccessRelationshipsApi.md +690 -0
- data/docs/BusinessAccessRole.md +15 -0
- data/docs/BusinessAccessUserSummary.md +22 -0
- data/docs/BusinessAssetMembersGet200Response.md +20 -0
- data/docs/BusinessAssets.md +26 -0
- data/docs/BusinessAssetsGet200Response.md +20 -0
- data/docs/BusinessMemberAssetsGetResponse.md +24 -0
- data/docs/BusinessMemberAssetsSummary.md +20 -0
- data/docs/BusinessMemberSortBy.md +15 -0
- data/docs/BusinessMembersAssetAccessDeleteBody.md +18 -0
- data/docs/BusinessMembershipMember.md +20 -0
- data/docs/BusinessPartnerAssetAccessGet200Response.md +20 -0
- data/docs/BusinessRoleForInvite.md +15 -0
- data/docs/BusinessRoleForMembers.md +15 -0
- data/docs/BusinessSearchBy.md +15 -0
- data/docs/BusinessToAdAccountSharedAudience.md +22 -0
- data/docs/BusinessToAdAccountSharedAudienceUpdateWithRequiredBody.md +22 -0
- data/docs/BusinessToBusinessSharedAudience.md +22 -0
- data/docs/BusinessToBusinessSharedAudienceUpdateWithRequiredBody.md +22 -0
- data/docs/Campaign.md +68 -0
- data/docs/CampaignAdPreview.md +38 -0
- data/docs/CampaignAdPreviewCreate.md +18 -0
- data/docs/CampaignAdPreviewCreate200ResponseInner.md +18 -0
- data/docs/CampaignAdPreviewCreate200ResponseInnerData.md +49 -0
- data/docs/CampaignAdPreviewCreate200ResponseInnerDataOneOf.md +18 -0
- data/docs/CampaignAdPreviewDelete200ResponseInner.md +18 -0
- data/docs/CampaignAdPreviewDelete200ResponseInnerStatus.md +49 -0
- data/docs/CampaignAudienceMultipliers.md +18 -0
- data/docs/CampaignBatchItem.md +20 -0
- data/docs/CampaignBatchResponseData.md +68 -0
- data/docs/CampaignBatchUpdateItem.md +62 -0
- data/docs/CampaignBatchWriteResponseModel.md +18 -0
- data/docs/CampaignBidOptions.md +30 -0
- data/docs/CampaignBidOptionsCreate.md +30 -0
- data/docs/CampaignBidOptionsUpdate.md +32 -0
- data/docs/CampaignBidOptionsUpdateMaskItems.md +15 -0
- data/docs/CampaignCreateItem.md +58 -0
- data/docs/CampaignCreateRequest.md +54 -0
- data/docs/CampaignCreateRequestAllOf1.md +36 -0
- data/docs/CampaignDeliveryEstimatesCampaign.md +30 -0
- data/docs/CampaignDeliveryEstimatesDerivedMetrics.md +70 -0
- data/docs/CampaignDeliveryEstimatesResponse.md +22 -0
- data/docs/CampaignObjectiveType.md +15 -0
- data/docs/CampaignPlanningAdGroupAudienceSize.md +20 -0
- data/docs/CampaignPlanningBudgetRecommendation.md +24 -0
- data/docs/CampaignPlanningBudgetRecommendationPoint.md +20 -0
- data/docs/CampaignPlanningConfidenceLevelAlert.md +22 -0
- data/docs/CampaignPlanningConfidenceLevelAlertReason.md +15 -0
- data/docs/CampaignPlanningConfidenceLevelAlertSeverity.md +15 -0
- data/docs/CampaignPlanningConversionAttribution.md +22 -0
- data/docs/CampaignPlanningConversionAttributionWindowDays.md +15 -0
- data/docs/CampaignPlanningConversionEvent.md +15 -0
- data/docs/CampaignPlanningConversionRate.md +22 -0
- data/docs/CampaignPlanningCurveEstimate.md +20 -0
- data/docs/CampaignPlanningEstimationType.md +15 -0
- data/docs/CampaignPlanningExperimentBudgetRecommendation.md +24 -0
- data/docs/CampaignPlanningPointEstimate.md +26 -0
- data/docs/CampaignPlanningResponseError.md +20 -0
- data/docs/CampaignPlanningResponseErrorCode.md +15 -0
- data/docs/CampaignUpdateRequest.md +56 -0
- data/docs/CampaignUpdateRequestAllOf2.md +28 -0
- data/docs/CampaignsAnalyticsMetrics.md +20 -0
- data/docs/CampaignsApi.md +674 -0
- data/docs/CampaignsList200Response.md +20 -0
- data/docs/CancelInviteException.md +20 -0
- data/docs/CancelInviteResult.md +24 -0
- data/docs/CancelInviteResultItem.md +20 -0
- data/docs/CancelInviteResultUser.md +22 -0
- data/docs/CancelInvitesRequest.md +18 -0
- data/docs/CancelInvitesResponse.md +18 -0
- data/docs/CarouselSlot.md +22 -0
- data/docs/CartingProduct.md +26 -0
- data/docs/CartingRetailer.md +20 -0
- data/docs/Catalog.md +26 -0
- data/docs/CatalogBinding.md +22 -0
- data/docs/CatalogCreate.md +20 -0
- data/docs/CatalogFeedsApi.md +632 -0
- data/docs/CatalogItemsApi.md +235 -0
- data/docs/CatalogProductGroupsApi.md +771 -0
- data/docs/CatalogReportsApi.md +233 -0
- data/docs/CatalogSupplementalApi.md +543 -0
- data/docs/CatalogUpdate.md +20 -0
- data/docs/CatalogsAiContentDisclosure.md +20 -0
- data/docs/CatalogsAiContentDisclosureLabel.md +15 -0
- data/docs/CatalogsApi.md +65 -767
- data/docs/CatalogsAvailableFilterValues.md +82 -0
- data/docs/CatalogsBaseFilterKeys.md +84 -0
- data/docs/CatalogsBaseFiltersAllOf.md +18 -0
- data/docs/CatalogsBaseFiltersAnyOf.md +18 -0
- data/docs/CatalogsCreateCreativeAssetsItem.md +22 -0
- data/docs/CatalogsCreateHotelItem.md +22 -0
- data/docs/CatalogsCreateReportResponse.md +18 -0
- data/docs/CatalogsCreateRetailItem.md +22 -0
- data/docs/CatalogsCreativeAssetsAttributes.md +46 -0
- data/docs/CatalogsCreativeAssetsAvailableFilterValues.md +20 -0
- data/docs/CatalogsCreativeAssetsBatchItem.md +85 -0
- data/docs/CatalogsCreativeAssetsBatchRequest.md +26 -0
- data/docs/CatalogsCreativeAssetsFeed.md +44 -0
- data/docs/CatalogsCreativeAssetsFeedsCreateRequest.md +38 -0
- data/docs/CatalogsCreativeAssetsFeedsCreateRequestDefaultLocale.md +15 -0
- data/docs/CatalogsCreativeAssetsFeedsUpdateRequest.md +32 -0
- data/docs/CatalogsCreativeAssetsFilterValuesMap.md +42 -0
- data/docs/CatalogsCreativeAssetsItemErrorResponse.md +24 -0
- data/docs/CatalogsCreativeAssetsItemResponse.md +26 -0
- data/docs/CatalogsCreativeAssetsItemsBatch.md +28 -0
- data/docs/CatalogsCreativeAssetsItemsPostFilter.md +22 -0
- data/docs/CatalogsCreativeAssetsListProductsByCatalogBasedFilterRequest.md +22 -0
- data/docs/CatalogsCreativeAssetsProduct.md +22 -0
- data/docs/CatalogsCreativeAssetsProductGroup.md +32 -0
- data/docs/CatalogsCreativeAssetsProductGroupCreateRequest.md +26 -0
- data/docs/CatalogsCreativeAssetsProductGroupFilterKeys.md +48 -0
- data/docs/CatalogsCreativeAssetsProductGroupFilters.md +20 -0
- data/docs/CatalogsCreativeAssetsProductGroupFiltersAllOf.md +18 -0
- data/docs/CatalogsCreativeAssetsProductGroupFiltersAnyOf.md +18 -0
- data/docs/CatalogsCreativeAssetsProductGroupProductCounts.md +26 -0
- data/docs/CatalogsCreativeAssetsProductGroupUpdateRequest.md +24 -0
- data/docs/CatalogsCreativeAssetsProductMetadata.md +20 -0
- data/docs/CatalogsDeleteCreativeAssetsItem.md +20 -0
- data/docs/CatalogsDeleteHotelItem.md +20 -0
- data/docs/CatalogsDeleteRetailItem.md +22 -0
- data/docs/CatalogsFeed.md +74 -34
- data/docs/CatalogsFeedCreateRequestSchema.md +49 -0
- data/docs/CatalogsFeedIngestion.md +24 -0
- data/docs/CatalogsFeedIngestionDetails.md +3 -1
- data/docs/CatalogsFeedIngestionErrors.md +18 -10
- data/docs/CatalogsFeedIngestionInfo.md +3 -3
- data/docs/CatalogsFeedIngestionWarnings.md +188 -0
- data/docs/CatalogsFeedProcessingResult.md +10 -8
- data/docs/CatalogsFeedProcessingSchedule.md +2 -2
- data/docs/CatalogsFeedProcessingScheduleTimezone.md +15 -0
- data/docs/CatalogsFeedProductCounts.md +3 -1
- data/docs/CatalogsFeedUpdateRequestSchema.md +49 -0
- data/docs/CatalogsFeedValidationErrors.md +56 -58
- data/docs/CatalogsFeedValidationWarnings.md +414 -82
- data/docs/CatalogsFeedVideoCounts.md +22 -0
- data/docs/CatalogsFeedsCreateRequest.md +11 -9
- data/docs/CatalogsFeedsUpdateRequest.md +4 -4
- data/docs/CatalogsHotelAddress.md +26 -0
- data/docs/CatalogsHotelAttributes.md +56 -0
- data/docs/CatalogsHotelAvailableFilterValues.md +20 -0
- data/docs/CatalogsHotelBatchItem.md +85 -0
- data/docs/CatalogsHotelBatchRequest.md +26 -0
- data/docs/CatalogsHotelFeed.md +42 -0
- data/docs/CatalogsHotelFeedsCreateRequest.md +36 -0
- data/docs/CatalogsHotelFeedsUpdateRequest.md +32 -0
- data/docs/CatalogsHotelFilterValuesMap.md +28 -0
- data/docs/CatalogsHotelGuestRatings.md +24 -0
- data/docs/CatalogsHotelItemErrorResponse.md +24 -0
- data/docs/CatalogsHotelItemResponse.md +26 -0
- data/docs/CatalogsHotelItemsBatch.md +28 -0
- data/docs/CatalogsHotelItemsPostFilter.md +22 -0
- data/docs/CatalogsHotelListProductsByCatalogBasedFilterRequest.md +22 -0
- data/docs/CatalogsHotelMainImage.md +20 -0
- data/docs/CatalogsHotelProduct.md +22 -0
- data/docs/CatalogsHotelProductGroup.md +34 -0
- data/docs/CatalogsHotelProductGroupCreateRequest.md +26 -0
- data/docs/CatalogsHotelProductGroupFilterKeys.md +36 -0
- data/docs/CatalogsHotelProductGroupFilters.md +20 -0
- data/docs/CatalogsHotelProductGroupFiltersAllOf.md +18 -0
- data/docs/CatalogsHotelProductGroupFiltersAnyOf.md +18 -0
- data/docs/CatalogsHotelProductGroupProductCounts.md +20 -0
- data/docs/CatalogsHotelProductGroupType.md +15 -0
- data/docs/CatalogsHotelProductGroupUpdateRequest.md +24 -0
- data/docs/CatalogsHotelProductMetadata.md +18 -0
- data/docs/CatalogsHotelReportParameters.md +20 -0
- data/docs/CatalogsHotelReportParametersReport.md +79 -0
- data/docs/CatalogsHotelReportStatsParameters.md +20 -0
- data/docs/CatalogsHotelReportStatsParametersReport.md +79 -0
- data/docs/CatalogsItemValidationDetails.md +20 -0
- data/docs/CatalogsItemValidationErrors.md +62 -0
- data/docs/CatalogsItemValidationIssue.md +15 -0
- data/docs/CatalogsItemValidationIssues.md +24 -0
- data/docs/CatalogsItemValidationWarnings.md +428 -0
- data/docs/CatalogsItemsBatch.md +72 -16
- data/docs/CatalogsItemsBatchPostRequest.md +49 -0
- data/docs/CatalogsItemsBatchRequest.md +78 -14
- data/docs/CatalogsItemsCreateBatchRequest.md +24 -0
- data/docs/CatalogsItemsDeleteBatchRequest.md +24 -0
- data/docs/CatalogsItemsDeleteDiscontinuedBatchRequest.md +24 -0
- data/docs/CatalogsItemsPostFilters.md +82 -0
- data/docs/CatalogsItemsRequest.md +22 -0
- data/docs/CatalogsItemsUpdateBatchRequest.md +24 -0
- data/docs/CatalogsItemsUpsertBatchRequest.md +24 -0
- data/docs/CatalogsList200Response.md +20 -0
- data/docs/CatalogsListProductsByFeedBasedFilter.md +20 -0
- data/docs/CatalogsListProductsByFilterRequest.md +49 -0
- data/docs/CatalogsLocalStoresCreate200ResponseInner.md +18 -0
- data/docs/CatalogsLocalStoresCreate200ResponseInnerData.md +49 -0
- data/docs/CatalogsLocalStoresCreate200ResponseInnerDataOneOf.md +20 -0
- data/docs/CatalogsLocalStoresDelete200ResponseInner.md +20 -0
- data/docs/CatalogsLocalStoresList200Response.md +20 -0
- data/docs/CatalogsLocale.md +15 -0
- data/docs/CatalogsProduct.md +82 -0
- data/docs/CatalogsProductGroupCreateRequest.md +7 -5
- data/docs/CatalogsProductGroupCurrencyCriteria.md +3 -3
- data/docs/CatalogsProductGroupFilterKeys.md +45 -27
- data/docs/CatalogsProductGroupFilterOperatorTypeCriteria.md +22 -0
- data/docs/CatalogsProductGroupFilters.md +2 -2
- data/docs/CatalogsProductGroupFiltersAllOf.md +1 -1
- data/docs/CatalogsProductGroupFiltersAnyOf.md +1 -1
- data/docs/CatalogsProductGroupFiltersRequest.md +20 -0
- data/docs/CatalogsProductGroupFiltersRequestAnyOfItems0.md +18 -0
- data/docs/CatalogsProductGroupFiltersRequestAnyOfItems1.md +18 -0
- data/docs/CatalogsProductGroupMultipleCountriesCriteria.md +20 -0
- data/docs/CatalogsProductGroupMultipleGenderCriteria.md +20 -0
- data/docs/CatalogsProductGroupMultipleMediaTypesCriteria.md +20 -0
- data/docs/CatalogsProductGroupMultiplePinterestProductCategoryCriteria.md +20 -0
- data/docs/CatalogsProductGroupMultipleStringCriteria.md +3 -3
- data/docs/CatalogsProductGroupMultipleStringListCriteria.md +4 -4
- data/docs/CatalogsProductGroupPinsList200Response.md +20 -0
- data/docs/CatalogsProductGroupPricingCriteria.md +4 -4
- data/docs/CatalogsProductGroupProductCountsVertical.md +82 -0
- data/docs/CatalogsProductGroupUint32Criteria.md +22 -0
- data/docs/CatalogsProductGroupUpdateManyRequestItemsOneOfItems0.md +26 -0
- data/docs/CatalogsProductGroupUpdateRequest.md +6 -6
- data/docs/CatalogsProductGroupsCreateManyRequestItems.md +49 -0
- data/docs/CatalogsProductGroupsCreateRequestSchema.md +49 -0
- data/docs/CatalogsProductGroupsList200Response.md +20 -0
- data/docs/CatalogsProductGroupsUpdateRequestSchema.md +49 -0
- data/docs/CatalogsReport.md +22 -0
- data/docs/CatalogsReportDistributionIssueFilter.md +20 -0
- data/docs/CatalogsReportDistributionStats.md +32 -0
- data/docs/CatalogsReportFeedIngestionFilter.md +22 -0
- data/docs/CatalogsReportFeedIngestionStats.md +30 -0
- data/docs/CatalogsReportParameters.md +79 -0
- data/docs/CatalogsReportStats.md +79 -0
- data/docs/CatalogsReportStatsParameters.md +79 -0
- data/docs/CatalogsRetailAvailableFilterValues.md +20 -0
- data/docs/CatalogsRetailBatchRequest.md +26 -0
- data/docs/CatalogsRetailBatchRequestItemsItems.md +85 -0
- data/docs/CatalogsRetailFeed.md +44 -0
- data/docs/CatalogsRetailFeedsCreateRequest.md +40 -0
- data/docs/CatalogsRetailFeedsUpdateRequest.md +34 -0
- data/docs/CatalogsRetailFilterValuesMap.md +64 -0
- data/docs/CatalogsRetailItemErrorResponse.md +24 -0
- data/docs/CatalogsRetailItemResponse.md +26 -0
- data/docs/CatalogsRetailItemsBatch.md +28 -0
- data/docs/CatalogsRetailItemsPostFilter.md +22 -0
- data/docs/CatalogsRetailListProductsByCatalogBasedFilterRequest.md +26 -0
- data/docs/CatalogsRetailProduct.md +22 -0
- data/docs/CatalogsRetailProductGroup.md +44 -0
- data/docs/CatalogsRetailProductGroupCreateRequest.md +30 -0
- data/docs/CatalogsRetailProductGroupProductCounts.md +28 -0
- data/docs/CatalogsRetailProductGroupUpdateRequest.md +28 -0
- data/docs/CatalogsRetailProductMetadata.md +28 -0
- data/docs/CatalogsRetailReportAllItemsFilter.md +22 -0
- data/docs/CatalogsRetailReportParameters.md +20 -0
- data/docs/CatalogsRetailReportParametersReport.md +82 -0
- data/docs/CatalogsRetailReportStatsParameters.md +20 -0
- data/docs/CatalogsRetailReportStatsParametersReport.md +79 -0
- data/docs/CatalogsType.md +15 -0
- data/docs/CatalogsUpdatableCreativeAssetsAttributes.md +40 -0
- data/docs/CatalogsUpdatableHotelAttributes.md +50 -0
- data/docs/CatalogsUpdateCreativeAssetsItem.md +22 -0
- data/docs/CatalogsUpdateHotelItem.md +22 -0
- data/docs/CatalogsUpdateRetailItem.md +24 -0
- data/docs/CatalogsUpsertCreativeAssetsItem.md +22 -0
- data/docs/CatalogsUpsertHotelItem.md +22 -0
- data/docs/CatalogsUpsertRetailItem.md +22 -0
- data/docs/CatalogsVerticalBatchRequest.md +82 -0
- data/docs/CatalogsVerticalFeedsCreateRequest.md +82 -0
- data/docs/CatalogsVerticalFeedsUpdateRequest.md +82 -0
- data/docs/CatalogsVerticalProductGroup.md +82 -0
- data/docs/CatalogsVerticalProductGroupCreateRequest.md +82 -0
- data/docs/CatalogsVerticalProductGroupUpdateRequest.md +82 -0
- data/docs/CatalogsVerticalsListProductsByCatalogBasedFilterRequest.md +82 -0
- data/docs/ChangeHistoryDataType.md +15 -0
- data/docs/ChangeHistoryOperationType.md +15 -0
- data/docs/CollectionsHeaderType.md +15 -0
- data/docs/ConditionFilter.md +1 -1
- data/docs/ContentType.md +15 -0
- data/docs/ConversionAccessToken.md +20 -0
- data/docs/ConversionApiResponseEventsItems.md +22 -0
- data/docs/ConversionDeletionRequest.md +24 -0
- data/docs/ConversionDeletionRequestCreate.md +18 -0
- data/docs/ConversionDeletionRequestEPIKTargets.md +18 -0
- data/docs/ConversionDeletionRequestList200Response.md +20 -0
- data/docs/ConversionDeletionRequestStatus.md +15 -0
- data/docs/ConversionDeletionRequestTargets.md +20 -0
- data/docs/ConversionDeletionRequestUserEmailTargets.md +18 -0
- data/docs/ConversionDeletionRequestsApi.md +313 -0
- data/docs/ConversionEqsApi.md +88 -0
- data/docs/ConversionEvent.md +15 -0
- data/docs/ConversionEventAppInfo.md +34 -0
- data/docs/ConversionEventDeviceInfo.md +64 -0
- data/docs/ConversionEventIngestionSource.md +15 -0
- data/docs/ConversionEventResponse.md +26 -0
- data/docs/ConversionEvents.md +22 -0
- data/docs/ConversionEventsApi.md +86 -0
- data/docs/ConversionEventsCreate.md +18 -0
- data/docs/ConversionEventsDataItems.md +58 -0
- data/docs/ConversionEventsDataItemsCustomData.md +46 -0
- data/docs/ConversionEventsDataItemsCustomDataContentsItems.md +30 -0
- data/docs/ConversionEventsUserDataProperties.md +48 -0
- data/docs/ConversionHealthSelectionItem.md +24 -0
- data/docs/ConversionLearningModeType.md +15 -0
- data/docs/ConversionMSOTEventsCreate.md +48 -0
- data/docs/ConversionObjectiveType.md +15 -0
- data/docs/ConversionProductAttributionType.md +15 -0
- data/docs/ConversionProductReport.md +26 -0
- data/docs/ConversionProductReportBreakdownType.md +15 -0
- data/docs/ConversionProductReportCreate.md +46 -0
- data/docs/ConversionProductReportGranularity.md +15 -0
- data/docs/ConversionProductReportLevel.md +15 -0
- data/docs/ConversionProductReportingColumn.md +15 -0
- data/docs/ConversionTag.md +34 -0
- data/docs/ConversionTagCommon.md +30 -0
- data/docs/ConversionTagConfigs.md +34 -0
- data/docs/ConversionTagCreate.md +34 -0
- data/docs/ConversionTagResponse.md +34 -0
- data/docs/ConversionTagType.md +15 -0
- data/docs/ConversionTagTypeOptimal.md +15 -0
- data/docs/ConversionTagV3GoalMetadata.md +28 -0
- data/docs/ConversionTagsApi.md +385 -0
- data/docs/ConversionTagsList200Response.md +18 -0
- data/docs/ConversionsApi.md +305 -0
- data/docs/CountryFilter.md +18 -0
- data/docs/CreateAssetAccessRequestBody.md +18 -0
- data/docs/CreateAssetAccessRequestItem.md +20 -0
- data/docs/CreateAssetAccessRequestResponse.md +20 -0
- data/docs/CreateAssetInvitesRequest.md +18 -0
- data/docs/CreateAssetInvitesRequestItem.md +22 -0
- data/docs/CreateInvitesResultsResponseArray.md +18 -0
- data/docs/CreateMembershipOrPartnershipInvitesBody.md +24 -0
- data/docs/CreationSource.md +15 -0
- data/docs/CreativeAssetsIdFilter.md +18 -0
- data/docs/CreativeAssetsProcessingRecord.md +24 -0
- data/docs/CreativeAssetsVisibilityType.md +15 -0
- data/docs/CreativeType.md +15 -0
- data/docs/CurrencyFilter.md +1 -1
- data/docs/CustomConversionEventMetrics.md +20 -0
- data/docs/CustomLabel0Filter.md +1 -1
- data/docs/CustomLabel1Filter.md +1 -1
- data/docs/CustomLabel2Filter.md +1 -1
- data/docs/CustomLabel3Filter.md +1 -1
- data/docs/CustomLabel4Filter.md +1 -1
- data/docs/CustomNumber0Filter.md +18 -0
- data/docs/CustomNumber1Filter.md +18 -0
- data/docs/CustomNumber2Filter.md +18 -0
- data/docs/CustomNumber3Filter.md +18 -0
- data/docs/CustomNumber4Filter.md +18 -0
- data/docs/CustomerList.md +40 -0
- data/docs/CustomerListCreate.md +26 -0
- data/docs/CustomerListRecordRow.md +32 -0
- data/docs/CustomerListStatus.md +15 -0
- data/docs/CustomerListUpdateWithRequiredBody.md +22 -0
- data/docs/CustomerListUpload.md +34 -0
- data/docs/CustomerListUploadCreateRequest.md +20 -0
- data/docs/CustomerListUploadCreateResponse.md +20 -0
- data/docs/CustomerListUploadsApi.md +229 -0
- data/docs/CustomerListsApi.md +308 -0
- data/docs/CustomerListsList200Response.md +20 -0
- data/docs/CustomerSegment.md +30 -0
- data/docs/CustomerSegmentApi.md +232 -0
- data/docs/CustomerSegmentCreate.md +20 -0
- data/docs/CustomerSegmentList200Response.md +20 -0
- data/docs/CustomerSegmentUpdateRequestUpdateWithRequiredBody.md +22 -0
- data/docs/CustomizableCTAType.md +15 -0
- data/docs/DataStatus.md +15 -0
- data/docs/DeleteBusinessMembership200Response.md +18 -0
- data/docs/DeleteBusinessMembershipBody.md +18 -0
- data/docs/DeleteBusinessMembershipMember.md +20 -0
- data/docs/DeleteBusinessPartners.md +18 -0
- data/docs/DeleteBusinessPartnersDelete.md +20 -0
- data/docs/DeleteMemberAccessResult.md +20 -0
- data/docs/DeleteMemberAccessResultsResponseArray.md +18 -0
- data/docs/DeleteMemberAssetAccessItem.md +20 -0
- data/docs/DeletePartnerAssetAccessBody.md +18 -0
- data/docs/DeletePartnerAssetAccessItem.md +22 -0
- data/docs/DeletePartnerAssetAccessResult.md +26 -0
- data/docs/DeletePartnerAssetAccessResultsResponseArray.md +18 -0
- data/docs/DeliveryEstimateObjectiveType.md +15 -0
- data/docs/DeliveryMetricsGet200Response.md +18 -0
- data/docs/DeliveryMetricsResponseItemsItems.md +24 -0
- data/docs/DetailedError.md +22 -0
- data/docs/DisclosureType.md +15 -0
- data/docs/DiscountStatus.md +15 -0
- data/docs/DynamicTitlesDownloadCSV.md +18 -0
- data/docs/DynamicTitlesGetStatus.md +22 -0
- data/docs/DynamicTitlesProcessCSV.md +20 -0
- data/docs/DynamicTitlesProcessCSVCreate.md +18 -0
- data/docs/DynamicTitlesProcessCSVError.md +20 -0
- data/docs/DynamicTitlesUploadURL.md +22 -0
- data/docs/EnhancedMatchStatusType.md +15 -0
- data/docs/EntityDataChangeHistory.md +26 -0
- data/docs/EntityHistory.md +30 -0
- data/docs/EntityLabel.md +24 -0
- data/docs/EntityLabelError.md +20 -0
- data/docs/EntityLabelStatus.md +15 -0
- data/docs/ErrorDetail.md +22 -0
- data/docs/EventData.md +38 -0
- data/docs/EventProcessingStatus.md +15 -0
- data/docs/EventQualityScore.md +26 -0
- data/docs/Exception.md +20 -0
- data/docs/FeaturedTrend.md +22 -0
- data/docs/FeedProcessingResultsList200Response.md +20 -0
- data/docs/FeedsList200Response.md +20 -0
- data/docs/FilterOperatorType.md +15 -0
- data/docs/FollowUser.md +20 -0
- data/docs/FollowUserCreate.md +18 -0
- data/docs/FollowersList200Response.md +20 -0
- data/docs/FormFactor.md +15 -0
- data/docs/FreqBidMultiplierTimeWindow.md +15 -0
- data/docs/FrequencyGoalMetadata.md +20 -0
- data/docs/FrequencyGoalMetadataTimerange.md +15 -0
- data/docs/FrequencyMultipliers.md +18 -0
- data/docs/Gender.md +15 -0
- data/docs/GenderBucket.md +15 -0
- data/docs/GenderDemographics.md +22 -0
- data/docs/GenderFilter.md +1 -1
- data/docs/GenderMultipliers.md +18 -0
- data/docs/GetBusinessEmployers200Response.md +20 -0
- data/docs/GetInvites200Response.md +20 -0
- data/docs/GoogleProductCategory0Filter.md +1 -1
- data/docs/GoogleProductCategory1Filter.md +1 -1
- data/docs/GoogleProductCategory2Filter.md +1 -1
- data/docs/GoogleProductCategory3Filter.md +1 -1
- data/docs/GoogleProductCategory4Filter.md +1 -1
- data/docs/GoogleProductCategory5Filter.md +1 -1
- data/docs/GoogleProductCategory6Filter.md +1 -1
- data/docs/GridClickType.md +15 -0
- data/docs/HotelIdFilter.md +18 -0
- data/docs/HotelProcessingRecord.md +24 -0
- data/docs/HttpMethod.md +15 -0
- data/docs/ImageDetails.md +3 -3
- data/docs/ImageMetadata.md +26 -0
- data/docs/ImageSize.md +24 -0
- data/docs/IneligibleProductTagErrorItem.md +20 -0
- data/docs/IneligibleProductTagReason.md +15 -0
- data/docs/IneligibleProductTagsErrorDetails.md +18 -0
- data/docs/IngestionSource.md +15 -0
- data/docs/IngestionSourceOptions.md +15 -0
- data/docs/InnerProductCategoriesMetricsHighlights.md +18 -0
- data/docs/IntegrationLog.md +42 -0
- data/docs/IntegrationLogClientError.md +34 -0
- data/docs/IntegrationLogClientRequest.md +28 -0
- data/docs/IntegrationLogEventType.md +15 -0
- data/docs/IntegrationLogLevel.md +15 -0
- data/docs/IntegrationLogsInvalidLogResponse.md +18 -0
- data/docs/IntegrationLogsInvalidLogResponseRejectedLogsItems.md +24 -0
- data/docs/IntegrationLogsRequestCreate.md +18 -0
- data/docs/IntegrationLogsSuccessResponse.md +18 -0
- data/docs/IntegrationMetadata.md +44 -0
- data/docs/IntegrationMetadataCreate.md +42 -0
- data/docs/IntegrationMetadataUpdate.md +40 -0
- data/docs/IntegrationRecord.md +50 -0
- data/docs/IntegrationsApi.md +503 -0
- data/docs/IntegrationsGetList200Response.md +20 -0
- data/docs/IntendedPromotionType.md +15 -0
- data/docs/Interest.md +24 -0
- data/docs/InterestsEnum.md +15 -0
- data/docs/InviteActionResultItem.md +20 -0
- data/docs/InviteAssetsSummary.md +20 -0
- data/docs/InviteAssetsSummaryItem.md +20 -0
- data/docs/InviteBusinessRoleBinding.md +28 -0
- data/docs/InviteDataResponse.md +26 -0
- data/docs/InviteExceptionResponse.md +24 -0
- data/docs/InviteFilterStatus.md +15 -0
- data/docs/InviteResponse.md +34 -0
- data/docs/InviteStatus.md +15 -0
- data/docs/InviteType.md +15 -0
- data/docs/ItemAttributes.md +157 -31
- data/docs/ItemAttributesRequest.md +232 -0
- data/docs/ItemAttributesRequestImageLink.md +49 -0
- data/docs/ItemAvailability.md +15 -0
- data/docs/ItemCreateBatchRecord.md +20 -0
- data/docs/ItemDeleteBatchRecord.md +18 -0
- data/docs/ItemDeleteDiscontinuedBatchRecord.md +18 -0
- data/docs/ItemGroupIdFilter.md +1 -1
- data/docs/ItemIdFilter.md +1 -1
- data/docs/ItemIdStoreCodePair.md +20 -0
- data/docs/ItemProcessingRecord.md +5 -5
- data/docs/ItemResponse.md +91 -0
- data/docs/ItemUpdateBatchRecord.md +22 -0
- data/docs/ItemUpsertBatchRecord.md +20 -0
- data/docs/ItemsIssuesList200Response.md +20 -0
- data/docs/ItemsPost200Response.md +18 -0
- data/docs/Keyword.md +32 -0
- data/docs/KeywordCreateItem.md +22 -0
- data/docs/KeywordError.md +20 -0
- data/docs/KeywordInfo.md +20 -0
- data/docs/KeywordMetrics.md +18 -0
- data/docs/KeywordMetricsResponse.md +20 -0
- data/docs/KeywordUpdateGenerated.md +22 -0
- data/docs/KeywordUpdateItem.md +22 -0
- data/docs/Keywords.md +20 -0
- data/docs/KeywordsApi.md +403 -0
- data/docs/KeywordsCommon.md +22 -0
- data/docs/KeywordsCreate.md +20 -0
- data/docs/KeywordsGet200Response.md +20 -0
- data/docs/KeywordsMetricsArrayResponse.md +18 -0
- data/docs/KeywordsRequest.md +20 -0
- data/docs/KeywordsUpdate.md +18 -0
- data/docs/Label.md +24 -0
- data/docs/LabelBulkCreateRequest.md +20 -0
- data/docs/LabelBulkUpdateRequest.md +22 -0
- data/docs/LabelCreateItem.md +20 -0
- data/docs/LabelCreateRequest.md +18 -0
- data/docs/LabelError.md +20 -0
- data/docs/LabelErrorData.md +24 -0
- data/docs/LabelParentType.md +15 -0
- data/docs/LabelStatus.md +15 -0
- data/docs/LabelStatusBulkUpdate.md +15 -0
- data/docs/LabelType.md +15 -0
- data/docs/LabelUpdateItem.md +22 -0
- data/docs/LabelUpdateRequest.md +18 -0
- data/docs/LabeledEntities.md +20 -0
- data/docs/LabeledEntitiesCreate.md +18 -0
- data/docs/LabelsApi.md +383 -0
- data/docs/LabelsList200Response.md +20 -0
- data/docs/LabelsResponse.md +20 -0
- data/docs/LeadAdsApi.md +302 -0
- data/docs/LeadForm.md +40 -0
- data/docs/LeadFormBatchUpdate.md +34 -0
- data/docs/LeadFormCreate.md +32 -0
- data/docs/LeadFormPolicyLink.md +20 -0
- data/docs/LeadFormQuestion.md +24 -0
- data/docs/LeadFormQuestionFieldType.md +15 -0
- data/docs/LeadFormQuestionType.md +15 -0
- data/docs/LeadFormStatus.md +15 -0
- data/docs/LeadFormTest.md +18 -0
- data/docs/LeadFormTestCreate.md +18 -0
- data/docs/LeadFormsApi.md +375 -0
- data/docs/LeadFormsCreate200Response.md +18 -0
- data/docs/LeadFormsCreate200ResponseItemsInner.md +20 -0
- data/docs/LeadFormsList200Response.md +20 -0
- data/docs/LeadSubscription.md +34 -0
- data/docs/LeadSubscriptionCreate.md +20 -0
- data/docs/LeadSubscriptionPostParams.md +40 -0
- data/docs/LeadSubscriptionPostParamsCreate.md +26 -0
- data/docs/LeadsExportApi.md +151 -0
- data/docs/LeadsExportResponseData.md +20 -0
- data/docs/LeadsExportStatus.md +15 -0
- data/docs/LeadsExports.md +18 -0
- data/docs/LeadsExportsCreate.md +22 -0
- data/docs/LineItem.md +32 -0
- data/docs/LinkFilter.md +18 -0
- data/docs/LinkedBusiness.md +26 -0
- data/docs/LocalInventoryCreateOperation.md +24 -0
- data/docs/LocalInventoryDeleteOperation.md +22 -0
- data/docs/LocalInventoryItemResponse.md +32 -0
- data/docs/LocalInventoryItemsBatch.md +26 -0
- data/docs/LocalInventoryItemsBatchCreate.md +18 -0
- data/docs/LocalInventoryItemsGet.md +18 -0
- data/docs/LocalInventoryItemsGetCreate.md +18 -0
- data/docs/LocalInventoryOperation.md +85 -0
- data/docs/LocalInventoryOperationResult.md +28 -0
- data/docs/LocalInventoryUpdateOperation.md +24 -0
- data/docs/LocalInventoryUpsertOperation.md +24 -0
- data/docs/LocalStore.md +42 -0
- data/docs/LocalStoreBatchUpdate.md +38 -0
- data/docs/LocalStoreCreate.md +36 -0
- data/docs/LookbackPeriodOptions.md +15 -0
- data/docs/MMMReport.md +28 -0
- data/docs/MMMReportCreate.md +36 -0
- data/docs/MMMReportGranularity.md +15 -0
- data/docs/MMMReportLevel.md +15 -0
- data/docs/MMMReportingColumn.md +15 -0
- data/docs/MMMReportingTargetingType.md +15 -0
- data/docs/MatchType.md +15 -0
- data/docs/MatchTypeResponse.md +15 -0
- data/docs/MaxPriceFilter.md +1 -1
- data/docs/Media.md +22 -0
- data/docs/MediaApi.md +21 -21
- data/docs/MediaList200Response.md +20 -0
- data/docs/MediaType.md +15 -0
- data/docs/MediaTypeFilter.md +18 -0
- data/docs/MediaUpload.md +7 -7
- data/docs/MediaUploadCreate.md +18 -0
- data/docs/MediaUploadParameters.md +32 -0
- data/docs/MemberBusinessRole.md +15 -0
- data/docs/MetricsReportingTemplateType.md +15 -0
- data/docs/MetricsResponse.md +18 -0
- data/docs/MetricsResponseDataItems.md +22 -0
- data/docs/MinPriceFilter.md +1 -1
- data/docs/MobileAppPlatform.md +15 -0
- data/docs/MsotEventName.md +15 -0
- data/docs/MsotEventsApi.md +78 -0
- data/docs/MultiPinsAnalyticsMetricTypesItem.md +15 -0
- data/docs/NetworkType.md +15 -0
- data/docs/NonDraftEntityStatus.md +15 -0
- data/docs/NotificationApi.md +80 -0
- data/docs/NotificationPostRequest.md +49 -0
- data/docs/NotificationResponse.md +22 -0
- data/docs/NullableCatalogsItemFieldType.md +15 -0
- data/docs/NullableEntityStatus.md +15 -0
- data/docs/NullableLabelStatus.md +15 -0
- data/docs/NullableLabelType.md +15 -0
- data/docs/NullableOptimizationGoalMetadata.md +22 -0
- data/docs/NullablePartnerType.md +15 -0
- data/docs/NullalbleMatchType.md +15 -0
- data/docs/NumericFilterOperatorType.md +15 -0
- data/docs/OauthAccessToken.md +32 -0
- data/docs/OauthApi.md +169 -10
- data/docs/OperationType.md +15 -0
- data/docs/OptimizationGoalMetadata.md +22 -0
- data/docs/OptimizationType.md +15 -0
- data/docs/Order.md +15 -0
- data/docs/OrderLine.md +40 -0
- data/docs/OrderLineMutationError.md +20 -0
- data/docs/OrderLineMutationResponse.md +18 -0
- data/docs/OrderLineMutationResult.md +20 -0
- data/docs/OrderLinePaidType.md +15 -0
- data/docs/OrderLineStatus.md +15 -0
- data/docs/OrderLinesApi.md +157 -0
- data/docs/OrderLinesList200Response.md +20 -0
- data/docs/OsFamily.md +15 -0
- data/docs/OverallStatusOptions.md +15 -0
- data/docs/PageVisitConversionTagsGet200Response.md +20 -0
- data/docs/PartnerMetadata.md +18 -0
- data/docs/PartnerType.md +15 -0
- data/docs/PerformancePlusCampaignSettings.md +20 -0
- data/docs/Permissions.md +15 -0
- data/docs/PermissionsWithOwner.md +15 -0
- data/docs/Pin.md +32 -16
- data/docs/PinAnalyticsDailyMetrics.md +22 -0
- data/docs/PinAnalyticsMetricsResponse.md +22 -0
- data/docs/PinBase.md +46 -0
- data/docs/PinCreate.md +38 -0
- data/docs/PinFilter.md +15 -0
- data/docs/PinMedia.md +78 -8
- data/docs/PinMediaMetadata.md +79 -0
- data/docs/PinMediaSource.md +10 -0
- data/docs/PinMediaSourceImageBase64.md +6 -4
- data/docs/PinMediaSourceImageURL.md +3 -1
- data/docs/PinMediaSourceImagesBase64.md +22 -0
- data/docs/PinMediaSourceImagesBase64Item.md +26 -0
- data/docs/PinMediaSourceImagesURL.md +22 -0
- data/docs/PinMediaSourceImagesURLItem.md +24 -0
- data/docs/PinMediaSourcePinURL.md +20 -0
- data/docs/PinMediaSourceVideoID.md +12 -4
- data/docs/PinMediaWithImage.md +4 -2
- data/docs/PinMediaWithImageAndVideo.md +20 -0
- data/docs/PinMediaWithImages.md +20 -0
- data/docs/PinMediaWithVideo.md +32 -0
- data/docs/PinMediaWithVideos.md +20 -0
- data/docs/PinRead.md +54 -0
- data/docs/PinType.md +15 -0
- data/docs/PinUpdate.md +32 -0
- data/docs/PinnerListType.md +15 -0
- data/docs/PinsApi.md +393 -35
- data/docs/PinsList200Response.md +20 -0
- data/docs/PinsSaveRequestCreate.md +20 -0
- data/docs/PinterestLibBatchItemException.md +20 -0
- data/docs/PinterestLibError.md +20 -0
- data/docs/PinterestLibPaginationOrder.md +15 -0
- data/docs/PinterestLibStatus204.md +18 -0
- data/docs/PinterestProductCategoriesFilter.md +18 -0
- data/docs/PlacementMultipliers.md +18 -0
- data/docs/PlacementTrafficType.md +15 -0
- data/docs/PlacementType.md +15 -0
- data/docs/PredictedTimeSeries.md +18 -0
- data/docs/PreferredMediaType.md +15 -0
- data/docs/PriceFilter.md +18 -0
- data/docs/PriceFilterPrice.md +24 -0
- data/docs/PrimarySort.md +15 -0
- data/docs/ProductAvailability.md +15 -0
- data/docs/ProductCategoriesDemographic.md +20 -0
- data/docs/ProductCategoriesEngagementType.md +15 -0
- data/docs/ProductCategoriesMetricsHighlights.md +22 -0
- data/docs/ProductCategoryDetailLookbackWindow.md +15 -0
- data/docs/ProductCategoryDetails.md +30 -0
- data/docs/ProductCategoryEnum.md +15 -0
- data/docs/ProductCategoryRegion.md +15 -0
- data/docs/ProductCondition.md +15 -0
- data/docs/ProductGroupAnalyticsItems.md +20 -0
- data/docs/ProductGroupPromotion.md +66 -0
- data/docs/ProductGroupPromotionCreateRequest.md +20 -0
- data/docs/ProductGroupPromotionCustomizableCTAType.md +15 -0
- data/docs/ProductGroupPromotionResponseItem.md +20 -0
- data/docs/ProductGroupPromotionUpdateRequest.md +20 -0
- data/docs/ProductGroupPromotions.md +18 -0
- data/docs/ProductGroupPromotionsApi.md +402 -0
- data/docs/ProductGroupPromotionsCreate.md +20 -0
- data/docs/ProductGroupPromotionsList200Response.md +20 -0
- data/docs/ProductGroupPromotionsUpdateWithRequiredBody.md +20 -0
- data/docs/ProductGroupReferenceFilter.md +18 -0
- data/docs/ProductTagItem.md +18 -0
- data/docs/ProductTagsApi.md +220 -0
- data/docs/ProductTagsBulkAddRequest.md +18 -0
- data/docs/ProductTagsBulkDeleteRequest.md +18 -0
- data/docs/ProductTagsError.md +22 -0
- data/docs/ProductTagsResponse.md +18 -0
- data/docs/ProductType0Filter.md +1 -1
- data/docs/ProductType1Filter.md +1 -1
- data/docs/ProductType2Filter.md +1 -1
- data/docs/ProductType3Filter.md +1 -1
- data/docs/ProductType4Filter.md +1 -1
- data/docs/Promotion.md +42 -0
- data/docs/PromotionApplicationLevel.md +15 -0
- data/docs/PromotionArrayElement.md +20 -0
- data/docs/PromotionBatchUpdate.md +38 -0
- data/docs/PromotionCreate.md +36 -0
- data/docs/PromotionTemplateValue.md +24 -0
- data/docs/PromotionType.md +15 -0
- data/docs/PromotionsApi.md +373 -0
- data/docs/PromotionsList200Response.md +20 -0
- data/docs/PromotionsResponse.md +18 -0
- data/docs/PublicTargetingType.md +15 -0
- data/docs/QualityComponentDetails.md +22 -0
- data/docs/QualityComponentIssue.md +22 -0
- data/docs/QualityComponents.md +38 -0
- data/docs/QueryLabelEntityStatusesItems.md +15 -0
- data/docs/QueryLabelTypesItems.md +15 -0
- data/docs/QuerymetrictypesItems.md +15 -0
- data/docs/QuerypinanalyticsmetrictypesItems.md +15 -0
- data/docs/QueryvideopinmetrictypesItems.md +15 -0
- data/docs/QuizPinData.md +24 -0
- data/docs/QuizPinOption.md +20 -0
- data/docs/QuizPinQuestion.md +22 -0
- data/docs/QuizPinResult.md +26 -0
- data/docs/RecordCounts.md +22 -0
- data/docs/RelatedTerms.md +22 -0
- data/docs/RelatedTermsRelatedTermsListItems.md +20 -0
- data/docs/ReportType.md +15 -0
- data/docs/ReportingColumn.md +15 -0
- data/docs/ReportingColumnSync.md +15 -0
- data/docs/ReportingTimeZone.md +15 -0
- data/docs/ReportsStats200Response.md +20 -0
- data/docs/ResourcesApi.md +444 -0
- data/docs/RespondToInviteResultItem.md +20 -0
- data/docs/RespondToInvitesResponseArray.md +18 -0
- data/docs/RetailLocalInventoryItemAttributes.md +24 -0
- data/docs/RetailLocalInventoryItemAttributesOptional.md +24 -0
- data/docs/Role.md +15 -0
- data/docs/S3FilePart.md +20 -0
- data/docs/S3MultipartUploadData.md +18 -0
- data/docs/SSIOAccount.md +28 -0
- data/docs/SSIOAccountAddress.md +24 -0
- data/docs/SSIOAccountItem.md +36 -0
- data/docs/SSIOAccountPMPName.md +20 -0
- data/docs/SSIOInsertionOrder.md +18 -0
- data/docs/SSIOInsertionOrderCreate.md +60 -0
- data/docs/SSIOInsertionOrderStatus.md +22 -0
- data/docs/SSIOInsertionOrderStatusResponse.md +22 -0
- data/docs/SSIOInsertionOrderUpdate.md +48 -0
- data/docs/SSIOOrderLine.md +60 -0
- data/docs/SSIOOrderLineType.md +15 -0
- data/docs/Schedule.md +36 -0
- data/docs/ScheduleAction.md +15 -0
- data/docs/ScheduleAgeBucketMultipliers.md +18 -0
- data/docs/ScheduleAppTypeMultipliers.md +18 -0
- data/docs/ScheduleAudienceMultipliers.md +18 -0
- data/docs/ScheduleBatchUpdate.md +38 -0
- data/docs/ScheduleBidMultipliers.md +26 -0
- data/docs/ScheduleBidOptions.md +26 -0
- data/docs/ScheduleBidOptionsGenderMultipliers.md +18 -0
- data/docs/ScheduleBidOptionsPlacementMultipliers.md +22 -0
- data/docs/ScheduleCommonDeltaValue.md +49 -0
- data/docs/ScheduleCreate.md +34 -0
- data/docs/ScheduleCreateRequest.md +34 -0
- data/docs/ScheduleCreateRequestAllOf1.md +20 -0
- data/docs/ScheduleDeltaValue.md +26 -0
- data/docs/ScheduleGenderMultipliers.md +18 -0
- data/docs/SchedulePlacementMultipliers.md +22 -0
- data/docs/ScheduleStatus.md +15 -0
- data/docs/ScheduleType.md +15 -0
- data/docs/ScheduleUpdateRequest.md +36 -0
- data/docs/ScheduleUpdateRequestAllOf1.md +22 -0
- data/docs/SchedulesApi.md +235 -0
- data/docs/SchedulesCreate200ResponseInner.md +18 -0
- data/docs/SchedulesCreate200ResponseInnerData.md +49 -0
- data/docs/SchedulesCreate200ResponseInnerDataOneOf.md +22 -0
- data/docs/SchedulesList200Response.md +20 -0
- data/docs/ScrollupGoalMetadata.md +18 -0
- data/docs/SearchApi.md +244 -0
- data/docs/SearchPartnerPins200Response.md +20 -0
- data/docs/SharedAudienceAccount.md +24 -0
- data/docs/SharedAudiencesForBusinessList200Response.md +20 -0
- data/docs/SingleInterestTargetingOption.md +24 -0
- data/docs/SourcePlatformOptions.md +15 -0
- data/docs/SsioInsertionOrdersStatusGetByAdAccount200Response.md +20 -0
- data/docs/SsioOrderLinesGetByAdAccount200Response.md +20 -0
- data/docs/StandardPinMetricTypes.md +15 -0
- data/docs/StoreMetadata.md +28 -0
- data/docs/SummaryPin.md +28 -0
- data/docs/SummaryStatus.md +15 -0
- data/docs/SupplementalItemBatchOperationStatus.md +15 -0
- data/docs/SupplementalItemProcessingStatus.md +15 -0
- data/docs/SupplementalItemValidationEvent.md +22 -0
- data/docs/SupplementalItemsBatchResponse.md +26 -0
- data/docs/SupplementalOperationResult.md +28 -0
- data/docs/SystemUserUpdateWithRequiredBody.md +18 -0
- data/docs/TargetingAdvertiserCountry.md +15 -0
- data/docs/TargetingSpec.md +46 -0
- data/docs/TargetingSpecAgeBucket.md +15 -0
- data/docs/TargetingSpecAppType.md +15 -0
- data/docs/TargetingSpecGender.md +15 -0
- data/docs/TargetingSpecListOperation.md +15 -0
- data/docs/TargetingSpecOperationAgeBucket.md +22 -0
- data/docs/TargetingSpecOperationAppType.md +22 -0
- data/docs/TargetingSpecOperationAudienceExclude.md +22 -0
- data/docs/TargetingSpecOperationAudienceInclude.md +22 -0
- data/docs/TargetingSpecOperationGender.md +22 -0
- data/docs/TargetingSpecOperationGeo.md +22 -0
- data/docs/TargetingSpecOperationGeoExclude.md +22 -0
- data/docs/TargetingSpecOperationInterest.md +22 -0
- data/docs/TargetingSpecOperationLocale.md +22 -0
- data/docs/TargetingSpecOperationLocation.md +22 -0
- data/docs/TargetingSpecOperationLocationExclude.md +22 -0
- data/docs/TargetingSpecOperationMaximumAge.md +22 -0
- data/docs/TargetingSpecOperationMinimumAge.md +22 -0
- data/docs/TargetingSpecOperationShoppingRetargeting.md +22 -0
- data/docs/TargetingSpecOperations.md +115 -0
- data/docs/TargetingSpecOptimal.md +46 -0
- data/docs/TargetingSpecShoppingRetargeting.md +22 -0
- data/docs/TargetingSpecTargetingStrategyItems.md +15 -0
- data/docs/TargetingStrategy.md +15 -0
- data/docs/TargetingTemplate.md +42 -0
- data/docs/TargetingTemplateApi.md +235 -0
- data/docs/TargetingTemplateAudienceSizing.md +18 -0
- data/docs/TargetingTemplateAudienceSizingReachEstimate.md +22 -0
- data/docs/TargetingTemplateCreate.md +28 -0
- data/docs/TargetingTemplateKeyword.md +20 -0
- data/docs/TargetingTemplateList200Response.md +20 -0
- data/docs/TargetingTemplateStatus.md +15 -0
- data/docs/TargetingTemplateUpdateRequestReadOrUpdate.md +22 -0
- data/docs/TemplateBasedReport.md +24 -0
- data/docs/TemplateBasedReportCreate.md +22 -0
- data/docs/TemplatesList200Response.md +20 -0
- data/docs/TermsApi.md +151 -0
- data/docs/TermsOfService.md +24 -0
- data/docs/TermsOfServiceApi.md +83 -0
- data/docs/TieBreakerType.md +15 -0
- data/docs/TimeSeries.md +18 -0
- data/docs/TitleKeywordsFilter.md +18 -0
- data/docs/TokenGrantType.md +15 -0
- data/docs/TokenTypeHint.md +15 -0
- data/docs/TopPinsAnalyticsResponse.md +22 -0
- data/docs/TopPinsAnalyticsResponseDateAvailability.md +20 -0
- data/docs/TopPinsAnalyticsResponsePinsItems.md +22 -0
- data/docs/TopPinsSortBy.md +15 -0
- data/docs/TopVideoPinsAnalyticsResponse.md +22 -0
- data/docs/TopVideoPinsAnalyticsResponseDateAvailability.md +20 -0
- data/docs/TopVideoPinsAnalyticsResponsePinsItems.md +22 -0
- data/docs/TopVideoPinsSortBy.md +15 -0
- data/docs/TotalCountByEntityStatus.md +22 -0
- data/docs/TrackingUrls.md +6 -6
- data/docs/TrendType.md +15 -0
- data/docs/TrendingKeyword.md +32 -0
- data/docs/TrendingKeywordDemographics.md +20 -0
- data/docs/TrendingKeywordsResponse.md +18 -0
- data/docs/TrendingPin.md +28 -0
- data/docs/TrendingProductCategory.md +28 -0
- data/docs/TrendingTopic.md +32 -0
- data/docs/TrendsAgeBucket.md +15 -0
- data/docs/TrendsAgeDistribution.md +18 -0
- data/docs/TrendsApi.md +318 -0
- data/docs/TrendsEditorial.md +28 -0
- data/docs/TrendsGender.md +15 -0
- data/docs/TrendsGenderDistribution.md +18 -0
- data/docs/TrendsGenderFilter.md +15 -0
- data/docs/TrendsL1Interest.md +15 -0
- data/docs/TrendsSupportedRegion.md +15 -0
- data/docs/UpdatableItemAttributes.md +222 -0
- data/docs/UpdatableItemAttributesGtin.md +49 -0
- data/docs/UpdateBusinessMembershipsResponse.md +18 -0
- data/docs/UpdateInvitesResultsResponseArray.md +18 -0
- data/docs/UpdateMaskBidOptionField.md +15 -0
- data/docs/UpdateMaskFieldType.md +15 -0
- data/docs/UpdateMemberAssetAccessBody.md +18 -0
- data/docs/UpdateMemberAssetAccessItem.md +22 -0
- data/docs/UpdateMemberAssetResultItem.md +18 -0
- data/docs/UpdateMemberAssetsResultsResponseArray.md +18 -0
- data/docs/UpdatePartnerAssetAccessBody.md +18 -0
- data/docs/UpdatePartnerAssetAccessItem.md +22 -0
- data/docs/UpdatePartnerAssetsResult.md +24 -0
- data/docs/UpdatePartnerAssetsResultsResponseArray.md +18 -0
- data/docs/UserAccountApi.md +987 -31
- data/docs/UserAccountFollowedInterests200Response.md +20 -0
- data/docs/UserAccountType.md +15 -0
- data/docs/UserBusinessRoleBinding.md +32 -0
- data/docs/UserFollowingFeedType.md +15 -0
- data/docs/UserListOperationType.md +15 -0
- data/docs/UserListType.md +15 -0
- data/docs/UserSingleAssetBinding.md +20 -0
- data/docs/UserWebsite.md +22 -0
- data/docs/UserWebsiteCreate.md +20 -0
- data/docs/UserWebsiteVerification.md +26 -0
- data/docs/UserWebsitesGet200Response.md +20 -0
- data/docs/UsersForIndividualAssetResponse.md +22 -0
- data/docs/VerticalProductCategory.md +15 -0
- data/docs/VideoMetadataWithItemType.md +30 -0
- data/docs/VideoPinMetricTypes.md +15 -0
- data/docs/WebsiteVerificationMethod.md +15 -0
- data/docs/WorkloadState.md +15 -0
- data/git_push.sh +2 -2
- data/lib/pinterest_sdk/api/ad_accounts_api.rb +603 -632
- data/lib/pinterest_sdk/api/ad_groups_api.rb +1368 -0
- data/lib/pinterest_sdk/api/ads_api.rb +1086 -0
- data/lib/pinterest_sdk/api/advanced_auction_api.rb +182 -0
- data/lib/pinterest_sdk/api/audience_insights_api.rb +173 -0
- data/lib/pinterest_sdk/api/audience_sharing_api.rb +677 -0
- data/lib/pinterest_sdk/api/audiences_api.rb +377 -0
- data/lib/pinterest_sdk/api/billing_api.rb +966 -0
- data/lib/pinterest_sdk/api/boards_api.rb +276 -142
- data/lib/pinterest_sdk/api/bulk_api.rb +269 -0
- data/lib/pinterest_sdk/api/business_access_assets_api.rb +1288 -0
- data/lib/pinterest_sdk/api/business_access_invite_api.rb +529 -0
- data/lib/pinterest_sdk/api/business_access_relationships_api.rb +873 -0
- data/lib/pinterest_sdk/api/campaigns_api.rb +961 -0
- data/lib/pinterest_sdk/api/catalog_feeds_api.rb +718 -0
- data/lib/pinterest_sdk/api/catalog_items_api.rb +262 -0
- data/lib/pinterest_sdk/api/catalog_product_groups_api.rb +909 -0
- data/lib/pinterest_sdk/api/catalog_reports_api.rb +268 -0
- data/lib/pinterest_sdk/api/catalog_supplemental_api.rb +689 -0
- data/lib/pinterest_sdk/api/catalogs_api.rb +103 -788
- data/lib/pinterest_sdk/api/conversion_deletion_requests_api.rb +368 -0
- data/lib/pinterest_sdk/api/conversion_eqs_api.rb +107 -0
- data/lib/pinterest_sdk/api/conversion_events_api.rb +108 -0
- data/lib/pinterest_sdk/api/conversion_tags_api.rb +428 -0
- data/lib/pinterest_sdk/api/conversions_api.rb +339 -0
- data/lib/pinterest_sdk/api/customer_list_uploads_api.rb +316 -0
- data/lib/pinterest_sdk/api/customer_lists_api.rb +382 -0
- data/lib/pinterest_sdk/api/customer_segment_api.rb +283 -0
- data/lib/pinterest_sdk/api/integrations_api.rb +497 -0
- data/lib/pinterest_sdk/api/keywords_api.rb +520 -0
- data/lib/pinterest_sdk/api/labels_api.rb +480 -0
- data/lib/pinterest_sdk/api/lead_ads_api.rb +357 -0
- data/lib/pinterest_sdk/api/lead_forms_api.rb +470 -0
- data/lib/pinterest_sdk/api/leads_export_api.rb +188 -0
- data/lib/pinterest_sdk/api/media_api.rb +34 -34
- data/lib/pinterest_sdk/api/msot_events_api.rb +105 -0
- data/lib/pinterest_sdk/api/notification_api.rb +86 -0
- data/lib/pinterest_sdk/api/oauth_api.rb +156 -17
- data/lib/pinterest_sdk/api/order_lines_api.rb +194 -0
- data/lib/pinterest_sdk/api/pins_api.rb +500 -51
- data/lib/pinterest_sdk/api/product_group_promotions_api.rb +536 -0
- data/lib/pinterest_sdk/api/product_tags_api.rb +248 -0
- data/lib/pinterest_sdk/api/promotions_api.rb +467 -0
- data/lib/pinterest_sdk/api/resources_api.rb +435 -0
- data/lib/pinterest_sdk/api/schedules_api.rb +294 -0
- data/lib/pinterest_sdk/api/search_api.rb +275 -0
- data/lib/pinterest_sdk/api/targeting_template_api.rb +283 -0
- data/lib/pinterest_sdk/api/terms_api.rb +161 -0
- data/lib/pinterest_sdk/api/terms_of_service_api.rb +100 -0
- data/lib/pinterest_sdk/api/trends_api.rb +314 -0
- data/lib/pinterest_sdk/api/user_account_api.rb +1095 -37
- data/lib/pinterest_sdk/api_client.rb +34 -27
- data/lib/pinterest_sdk/api_error.rb +4 -3
- data/lib/pinterest_sdk/api_model_base.rb +88 -0
- data/lib/pinterest_sdk/configuration.rb +60 -16
- data/lib/pinterest_sdk/models/account.rb +143 -119
- data/lib/pinterest_sdk/models/account_template.rb +491 -0
- data/lib/pinterest_sdk/models/action_type.rb +9 -7
- data/lib/pinterest_sdk/models/ad.rb +869 -0
- data/lib/pinterest_sdk/models/ad_account.rb +160 -109
- data/lib/pinterest_sdk/models/ad_account_analytics_items.rb +184 -0
- data/lib/pinterest_sdk/models/ad_account_countries_get200_response.rb +166 -0
- data/lib/pinterest_sdk/models/ad_account_create.rb +249 -0
- data/lib/pinterest_sdk/models/ad_account_entity_type.rb +42 -0
- data/lib/pinterest_sdk/models/ad_account_owner.rb +36 -97
- data/lib/pinterest_sdk/models/ad_account_to_ad_account_shared_audience.rb +217 -0
- data/lib/pinterest_sdk/models/ad_account_to_ad_account_shared_audience_update_with_required_body.rb +254 -0
- data/lib/pinterest_sdk/models/ad_account_to_business_shared_audience.rb +217 -0
- data/lib/pinterest_sdk/models/ad_account_to_business_shared_audience_update_with_required_body.rb +254 -0
- data/lib/pinterest_sdk/models/ad_accounts_audience.rb +343 -0
- data/lib/pinterest_sdk/models/ad_accounts_audience_create.rb +232 -0
- data/lib/pinterest_sdk/models/ad_accounts_audience_rule.rb +394 -0
- data/lib/pinterest_sdk/models/ad_accounts_audience_update.rb +242 -0
- data/lib/pinterest_sdk/models/ad_accounts_audiences_shared_accounts_list200_response.rb +176 -0
- data/lib/pinterest_sdk/models/ad_accounts_country.rb +267 -0
- data/lib/pinterest_sdk/models/ad_accounts_list200_response.rb +176 -0
- data/lib/pinterest_sdk/models/ad_accounts_subscriptions_get_list200_response.rb +176 -0
- data/lib/pinterest_sdk/models/ad_ads_analytics_async_targeting_types.rb +55 -0
- data/lib/pinterest_sdk/models/ad_batch_item.rb +156 -0
- data/lib/pinterest_sdk/models/ad_batch_update.rb +553 -0
- data/lib/pinterest_sdk/models/ad_batch_write_response_model.rb +166 -0
- data/lib/pinterest_sdk/models/ad_collections_header_type.rb +41 -0
- data/lib/pinterest_sdk/models/ad_create.rb +538 -0
- data/lib/pinterest_sdk/models/ad_create_request.rb +496 -0
- data/lib/pinterest_sdk/models/ad_disapproval_reasons.rb +86 -0
- data/lib/pinterest_sdk/models/ad_group.rb +830 -0
- data/lib/pinterest_sdk/models/ad_group_audience_sizing.rb +158 -0
- data/lib/pinterest_sdk/models/ad_group_audience_sizing_create.rb +231 -0
- data/lib/pinterest_sdk/models/ad_group_audience_sizing_creative_types.rb +46 -0
- data/lib/pinterest_sdk/models/ad_group_audience_sizing_keyword.rb +213 -0
- data/lib/pinterest_sdk/models/ad_group_base.rb +759 -0
- data/lib/pinterest_sdk/models/ad_group_create.rb +832 -0
- data/lib/pinterest_sdk/models/ad_group_create_create.rb +617 -0
- data/lib/pinterest_sdk/models/ad_group_create_request.rb +536 -0
- data/lib/pinterest_sdk/models/ad_group_create_request_all_of1.rb +226 -0
- data/lib/pinterest_sdk/models/ad_group_delivery_estimates.rb +275 -0
- data/lib/pinterest_sdk/models/ad_group_delivery_estimates_keywords_items.rb +199 -0
- data/lib/pinterest_sdk/models/ad_group_summary_status.rb +11 -6
- data/lib/pinterest_sdk/models/ad_group_tracking_urls.rb +194 -0
- data/lib/pinterest_sdk/models/ad_group_update.rb +833 -0
- data/lib/pinterest_sdk/models/ad_group_update_batch_update.rb +634 -0
- data/lib/pinterest_sdk/models/ad_group_update_request.rb +546 -0
- data/lib/pinterest_sdk/models/ad_group_update_request_all_of1.rb +226 -0
- data/lib/pinterest_sdk/models/ad_groups_analytics_metrics.rb +179 -0
- data/lib/pinterest_sdk/models/ad_groups_create200_response.rb +166 -0
- data/lib/pinterest_sdk/models/ad_groups_create200_response_items_inner.rb +158 -0
- data/lib/pinterest_sdk/models/ad_groups_list200_response.rb +176 -0
- data/lib/pinterest_sdk/models/ad_pin_analytics.rb +186 -0
- data/lib/pinterest_sdk/models/ad_pin_preview_creative_type.rb +43 -0
- data/lib/pinterest_sdk/models/ad_preview_request.rb +105 -0
- data/lib/pinterest_sdk/models/ad_preview_shopping.rb +338 -0
- data/lib/pinterest_sdk/models/ad_preview_source_image.rb +224 -0
- data/lib/pinterest_sdk/models/ad_preview_source_pin_id.rb +198 -0
- data/lib/pinterest_sdk/models/ad_preview_url_response.rb +148 -0
- data/lib/pinterest_sdk/models/ad_review_status.rb +42 -0
- data/lib/pinterest_sdk/models/ad_shopping_preview_creative_type.rb +42 -0
- data/lib/pinterest_sdk/models/ad_update_request.rb +500 -0
- data/lib/pinterest_sdk/models/ad_update_request_all_of1.rb +204 -0
- data/lib/pinterest_sdk/models/ade_column_type.rb +92 -0
- data/lib/pinterest_sdk/models/adgroup_placement_group_type.rb +42 -0
- data/lib/pinterest_sdk/models/adgroup_tracking_feature_type.rb +42 -0
- data/lib/pinterest_sdk/models/adgroup_tracking_features.rb +150 -0
- data/lib/pinterest_sdk/models/ads_analytics.rb +184 -0
- data/lib/pinterest_sdk/models/ads_analytics_account_targeting_type.rb +51 -0
- data/lib/pinterest_sdk/models/ads_analytics_ad_group_targeting_type.rb +52 -0
- data/lib/pinterest_sdk/models/ads_analytics_ad_targeting_type.rb +52 -0
- data/lib/pinterest_sdk/models/ads_analytics_campaign_targeting_type.rb +53 -0
- data/lib/pinterest_sdk/models/ads_analytics_create_async_request.rb +514 -389
- data/lib/pinterest_sdk/models/ads_analytics_create_async_response.rb +61 -110
- data/lib/pinterest_sdk/models/ads_analytics_filter_column.rb +9 -6
- data/lib/pinterest_sdk/models/ads_analytics_filter_operator.rb +9 -6
- data/lib/pinterest_sdk/models/ads_analytics_get_async_response.rb +62 -111
- data/lib/pinterest_sdk/models/ads_analytics_metrics_filter.rb +95 -99
- data/lib/pinterest_sdk/models/ads_credit_discount_type.rb +58 -0
- data/lib/pinterest_sdk/models/ads_credit_discounts_response.rb +256 -0
- data/lib/pinterest_sdk/models/ads_credit_redeem.rb +171 -0
- data/lib/pinterest_sdk/models/ads_credit_redeem_create.rb +204 -0
- data/lib/pinterest_sdk/models/ads_credits_discounts_get200_response.rb +176 -0
- data/lib/pinterest_sdk/models/ads_list200_response.rb +176 -0
- data/lib/pinterest_sdk/models/advanced_auction_bid_options.rb +170 -0
- data/lib/pinterest_sdk/models/advanced_auction_item.rb +265 -0
- data/lib/pinterest_sdk/models/advanced_auction_items.rb +182 -0
- data/lib/pinterest_sdk/models/advanced_auction_items_get_request.rb +224 -0
- data/lib/pinterest_sdk/models/advanced_auction_items_submit_delete_record.rb +280 -0
- data/lib/pinterest_sdk/models/advanced_auction_items_submit_record.rb +56 -0
- data/lib/pinterest_sdk/models/advanced_auction_items_submit_request.rb +224 -0
- data/lib/pinterest_sdk/models/advanced_auction_items_submit_upsert_record.rb +321 -0
- data/lib/pinterest_sdk/models/advanced_auction_key.rb +240 -0
- data/lib/pinterest_sdk/models/advanced_auction_operation_error.rb +159 -0
- data/lib/pinterest_sdk/models/advanced_auction_processed_items.rb +182 -0
- data/lib/pinterest_sdk/models/advertiser_defined_event.rb +181 -0
- data/lib/pinterest_sdk/models/advertiser_defined_event_input.rb +215 -0
- data/lib/pinterest_sdk/models/advertiser_defined_event_mapping_type.rb +57 -0
- data/lib/pinterest_sdk/models/advertiser_defined_event_processing_record.rb +205 -0
- data/lib/pinterest_sdk/models/advertiser_defined_events_create200_response.rb +166 -0
- data/lib/pinterest_sdk/models/advertiser_defined_events_create_request.rb +177 -0
- data/lib/pinterest_sdk/models/advertiser_defined_events_get200_response.rb +166 -0
- data/lib/pinterest_sdk/models/age_bucket_multipliers.rb +171 -0
- data/lib/pinterest_sdk/models/age_trends_bucket.rb +45 -0
- data/lib/pinterest_sdk/models/aggregated_pin_comment.rb +493 -0
- data/lib/pinterest_sdk/models/ai_disclosure_item.rb +40 -0
- data/lib/pinterest_sdk/models/ai_disclosures.rb +168 -0
- data/lib/pinterest_sdk/models/ai_disclosures_update.rb +151 -0
- data/lib/pinterest_sdk/models/amazon_connect_request.rb +281 -0
- data/lib/pinterest_sdk/models/amazon_connect_response.rb +148 -0
- data/lib/pinterest_sdk/models/analytics_daily_metrics.rb +190 -0
- data/lib/pinterest_sdk/models/analytics_metrics_response.rb +26 -97
- data/lib/pinterest_sdk/models/app_type_multipliers.rb +171 -0
- data/lib/pinterest_sdk/models/appsflyer_audience.rb +242 -0
- data/lib/pinterest_sdk/models/appsflyer_audience_create.rb +215 -0
- data/lib/pinterest_sdk/models/appsflyer_audience_sync_create.rb +186 -0
- data/lib/pinterest_sdk/models/appsflyer_platform.rb +40 -0
- data/lib/pinterest_sdk/models/asset_access_request_error.rb +159 -0
- data/lib/pinterest_sdk/models/asset_group_binding.rb +398 -0
- data/lib/pinterest_sdk/models/asset_group_delete_error.rb +168 -0
- data/lib/pinterest_sdk/models/asset_group_deletion.rb +161 -0
- data/lib/pinterest_sdk/models/asset_group_deletion_delete.rb +184 -0
- data/lib/pinterest_sdk/models/asset_group_input.rb +147 -0
- data/lib/pinterest_sdk/models/asset_group_input_create.rb +230 -0
- data/lib/pinterest_sdk/models/asset_group_modification.rb +162 -0
- data/lib/pinterest_sdk/models/asset_group_modification_read_or_update.rb +174 -0
- data/lib/pinterest_sdk/models/asset_group_type.rb +42 -0
- data/lib/pinterest_sdk/models/asset_group_update_error.rb +165 -0
- data/lib/pinterest_sdk/models/asset_group_update_item_read_or_update_item.rb +221 -0
- data/lib/pinterest_sdk/models/asset_id_permissions.rb +282 -0
- data/lib/pinterest_sdk/models/asset_id_with_permissions.rb +200 -0
- data/lib/pinterest_sdk/models/asset_permission_type.rb +40 -0
- data/lib/pinterest_sdk/models/asset_search_by.rb +43 -0
- data/lib/pinterest_sdk/models/asset_sort_by.rb +41 -0
- data/lib/pinterest_sdk/models/asset_type_response.rb +46 -0
- data/lib/pinterest_sdk/models/attribution_action_type.rb +40 -0
- data/lib/pinterest_sdk/models/attribution_match_type.rb +41 -0
- data/lib/pinterest_sdk/models/attribution_model.rb +42 -0
- data/lib/pinterest_sdk/models/attribution_scope.rb +41 -0
- data/lib/pinterest_sdk/models/attribution_windows.rb +165 -0
- data/lib/pinterest_sdk/models/audience.rb +336 -0
- data/lib/pinterest_sdk/models/audience_account_type.rb +40 -0
- data/lib/pinterest_sdk/models/audience_category.rb +200 -0
- data/lib/pinterest_sdk/models/audience_definition.rb +168 -0
- data/lib/pinterest_sdk/models/audience_demographic_value.rb +169 -0
- data/lib/pinterest_sdk/models/audience_demographics.rb +199 -0
- data/lib/pinterest_sdk/models/audience_insight_type.rb +41 -0
- data/lib/pinterest_sdk/models/audience_insights.rb +239 -0
- data/lib/pinterest_sdk/models/audience_insights_scope_and_type_get200_response.rb +166 -0
- data/lib/pinterest_sdk/models/audience_objective_type.rb +44 -0
- data/lib/pinterest_sdk/models/audience_ownership_type.rb +40 -0
- data/lib/pinterest_sdk/models/audience_rule.rb +415 -0
- data/lib/pinterest_sdk/models/audience_status.rb +44 -0
- data/lib/pinterest_sdk/models/audience_subcategory.rb +183 -0
- data/lib/pinterest_sdk/models/audience_type.rb +43 -0
- data/lib/pinterest_sdk/models/audience_update_operation_type.rb +40 -0
- data/lib/pinterest_sdk/models/audiences_list200_response.rb +176 -0
- data/lib/pinterest_sdk/models/auth_respond_invite_action.rb +177 -0
- data/lib/pinterest_sdk/models/auth_respond_invites_body.rb +185 -0
- data/lib/pinterest_sdk/models/auth_respond_invites_body_item.rb +220 -0
- data/lib/pinterest_sdk/models/availability_filter.rb +37 -96
- data/lib/pinterest_sdk/models/base_business_assets.rb +241 -0
- data/lib/pinterest_sdk/models/base_invite_data_response.rb +199 -0
- data/lib/pinterest_sdk/models/base_preferred_media_type.rb +40 -0
- data/lib/pinterest_sdk/models/batch_operation_status.rb +10 -6
- data/lib/pinterest_sdk/models/bid_floor.rb +163 -0
- data/lib/pinterest_sdk/models/bid_floor_create.rb +178 -0
- data/lib/pinterest_sdk/models/bid_floor_objective_type.rb +44 -0
- data/lib/pinterest_sdk/models/bid_floor_spec.rb +257 -0
- data/lib/pinterest_sdk/models/bid_options_age_bucket_multipliers.rb +202 -0
- data/lib/pinterest_sdk/models/bid_options_app_type_multipliers.rb +193 -0
- data/lib/pinterest_sdk/models/bid_options_audience_multipliers.rb +202 -0
- data/lib/pinterest_sdk/models/bid_options_gender_multipliers.rb +157 -0
- data/lib/pinterest_sdk/models/bid_options_placement_multipliers.rb +166 -0
- data/lib/pinterest_sdk/models/bid_strategy_type.rb +41 -0
- data/lib/pinterest_sdk/models/billing_invoice.rb +355 -0
- data/lib/pinterest_sdk/models/billing_invoice_document_type.rb +40 -0
- data/lib/pinterest_sdk/models/billing_invoice_download_response.rb +158 -0
- data/lib/pinterest_sdk/models/billing_invoice_sort_field.rb +43 -0
- data/lib/pinterest_sdk/models/billing_invoice_status.rb +40 -0
- data/lib/pinterest_sdk/models/billing_invoices_get200_response.rb +176 -0
- data/lib/pinterest_sdk/models/billing_profile_card_type.rb +44 -0
- data/lib/pinterest_sdk/models/billing_profile_payment_method_brand.rb +47 -0
- data/lib/pinterest_sdk/models/billing_profile_status.rb +45 -0
- data/lib/pinterest_sdk/models/billing_profiles_get200_response.rb +176 -0
- data/lib/pinterest_sdk/models/billing_profiles_response.rb +262 -0
- data/lib/pinterest_sdk/models/billing_type.rb +43 -0
- data/lib/pinterest_sdk/models/board.rb +211 -123
- data/lib/pinterest_sdk/models/board_base.rb +350 -0
- data/lib/pinterest_sdk/models/board_create.rb +220 -0
- data/lib/pinterest_sdk/models/board_media.rb +161 -0
- data/lib/pinterest_sdk/models/board_owner.rb +25 -96
- data/lib/pinterest_sdk/models/board_privacy.rb +41 -0
- data/lib/pinterest_sdk/models/board_privacy_filter.rb +43 -0
- data/lib/pinterest_sdk/models/board_section.rb +44 -104
- data/lib/pinterest_sdk/models/board_section_create.rb +192 -0
- data/lib/pinterest_sdk/models/board_section_update_with_required_body.rb +192 -0
- data/lib/pinterest_sdk/models/board_sections_list200_response.rb +176 -0
- data/lib/pinterest_sdk/models/board_update_privacy.rb +40 -0
- data/lib/pinterest_sdk/models/board_with_update_privacy.rb +388 -0
- data/lib/pinterest_sdk/models/board_with_update_privacy_update.rb +190 -0
- data/lib/pinterest_sdk/models/boards_list200_response.rb +176 -0
- data/lib/pinterest_sdk/models/boards_list_pins200_response.rb +176 -0
- data/lib/pinterest_sdk/models/book_closed.rb +192 -0
- data/lib/pinterest_sdk/models/brand_account.rb +164 -0
- data/lib/pinterest_sdk/models/brand_account_create.rb +270 -0
- data/lib/pinterest_sdk/models/brand_account_profile_image.rb +226 -0
- data/lib/pinterest_sdk/models/brand_account_profile_image_update.rb +212 -0
- data/lib/pinterest_sdk/models/brand_account_update.rb +219 -0
- data/lib/pinterest_sdk/models/brand_filter.rb +37 -96
- data/lib/pinterest_sdk/models/budget_duration_type.rb +41 -0
- data/lib/pinterest_sdk/models/budget_type.rb +41 -0
- data/lib/pinterest_sdk/models/bulk_campaign_delivery_estimates_item.rb +245 -0
- data/lib/pinterest_sdk/models/bulk_campaign_delivery_estimates_response.rb +168 -0
- data/lib/pinterest_sdk/models/bulk_download.rb +149 -0
- data/lib/pinterest_sdk/models/bulk_download_campaign_filter.rb +232 -0
- data/lib/pinterest_sdk/models/bulk_download_create.rb +262 -0
- data/lib/pinterest_sdk/models/bulk_entity_type.rb +46 -0
- data/lib/pinterest_sdk/models/bulk_job_data.rb +207 -0
- data/lib/pinterest_sdk/models/bulk_output_format.rb +40 -0
- data/lib/pinterest_sdk/models/bulk_reporting_job_status.rb +44 -0
- data/lib/pinterest_sdk/models/bulk_request_status.rb +41 -0
- data/lib/pinterest_sdk/models/bulk_upsert_request.rb +157 -0
- data/lib/pinterest_sdk/models/bulk_upsert_request_create.rb +227 -0
- data/lib/pinterest_sdk/models/bulk_upsert_request_create_catalog_product_groups_items.rb +104 -0
- data/lib/pinterest_sdk/models/bulk_upsert_request_update.rb +227 -0
- data/lib/pinterest_sdk/models/bulk_upsert_request_update_catalog_product_groups_items.rb +104 -0
- data/lib/pinterest_sdk/models/bulk_upsert_response.rb +148 -0
- data/lib/pinterest_sdk/models/business_access_role.rb +55 -0
- data/lib/pinterest_sdk/models/business_access_user_summary.rb +196 -0
- data/lib/pinterest_sdk/models/business_asset_members_get200_response.rb +176 -0
- data/lib/pinterest_sdk/models/business_assets.rb +257 -0
- data/lib/pinterest_sdk/models/business_assets_get200_response.rb +176 -0
- data/lib/pinterest_sdk/models/business_member_assets_get_response.rb +214 -0
- data/lib/pinterest_sdk/models/business_member_assets_summary.rb +163 -0
- data/lib/pinterest_sdk/models/business_member_sort_by.rb +41 -0
- data/lib/pinterest_sdk/models/business_members_asset_access_delete_body.rb +186 -0
- data/lib/pinterest_sdk/models/business_membership_member.rb +234 -0
- data/lib/pinterest_sdk/models/business_partner_asset_access_get200_response.rb +176 -0
- data/lib/pinterest_sdk/models/business_role_for_invite.rb +41 -0
- data/lib/pinterest_sdk/models/business_role_for_members.rb +40 -0
- data/lib/pinterest_sdk/models/business_search_by.rb +42 -0
- data/lib/pinterest_sdk/models/business_to_ad_account_shared_audience.rb +217 -0
- data/lib/pinterest_sdk/models/business_to_ad_account_shared_audience_update_with_required_body.rb +254 -0
- data/lib/pinterest_sdk/models/business_to_business_shared_audience.rb +217 -0
- data/lib/pinterest_sdk/models/business_to_business_shared_audience_update_with_required_body.rb +254 -0
- data/lib/pinterest_sdk/models/campaign.rb +519 -0
- data/lib/pinterest_sdk/models/campaign_ad_preview.rb +399 -0
- data/lib/pinterest_sdk/models/campaign_ad_preview_create.rb +186 -0
- data/lib/pinterest_sdk/models/campaign_ad_preview_create200_response_inner.rb +164 -0
- data/lib/pinterest_sdk/models/campaign_ad_preview_create200_response_inner_data.rb +105 -0
- data/lib/pinterest_sdk/models/campaign_ad_preview_create200_response_inner_data_one_of.rb +164 -0
- data/lib/pinterest_sdk/models/campaign_ad_preview_delete200_response_inner.rb +164 -0
- data/lib/pinterest_sdk/models/campaign_ad_preview_delete200_response_inner_status.rb +104 -0
- data/lib/pinterest_sdk/models/campaign_audience_multipliers.rb +170 -0
- data/lib/pinterest_sdk/models/campaign_batch_item.rb +161 -0
- data/lib/pinterest_sdk/models/campaign_batch_response_data.rb +467 -0
- data/lib/pinterest_sdk/models/campaign_batch_update_item.rb +474 -0
- data/lib/pinterest_sdk/models/campaign_batch_write_response_model.rb +167 -0
- data/lib/pinterest_sdk/models/campaign_bid_options.rb +237 -0
- data/lib/pinterest_sdk/models/campaign_bid_options_create.rb +237 -0
- data/lib/pinterest_sdk/models/campaign_bid_options_update.rb +266 -0
- data/lib/pinterest_sdk/models/campaign_bid_options_update_mask_items.rb +44 -0
- data/lib/pinterest_sdk/models/campaign_create_item.rb +460 -0
- data/lib/pinterest_sdk/models/campaign_create_request.rb +439 -0
- data/lib/pinterest_sdk/models/campaign_create_request_all_of1.rb +281 -0
- data/lib/pinterest_sdk/models/campaign_delivery_estimates_campaign.rb +349 -0
- data/lib/pinterest_sdk/models/campaign_delivery_estimates_derived_metrics.rb +409 -0
- data/lib/pinterest_sdk/models/campaign_delivery_estimates_response.rb +189 -0
- data/lib/pinterest_sdk/models/campaign_objective_type.rb +49 -0
- data/lib/pinterest_sdk/models/campaign_planning_ad_group_audience_size.rb +197 -0
- data/lib/pinterest_sdk/models/campaign_planning_budget_recommendation.rb +183 -0
- data/lib/pinterest_sdk/models/campaign_planning_budget_recommendation_point.rb +181 -0
- data/lib/pinterest_sdk/models/campaign_planning_confidence_level_alert.rb +191 -0
- data/lib/pinterest_sdk/models/campaign_planning_confidence_level_alert_reason.rb +42 -0
- data/lib/pinterest_sdk/models/campaign_planning_confidence_level_alert_severity.rb +42 -0
- data/lib/pinterest_sdk/models/campaign_planning_conversion_attribution.rb +191 -0
- data/lib/pinterest_sdk/models/campaign_planning_conversion_attribution_window_days.rb +43 -0
- data/lib/pinterest_sdk/models/campaign_planning_conversion_event.rb +42 -0
- data/lib/pinterest_sdk/models/campaign_planning_conversion_rate.rb +240 -0
- data/lib/pinterest_sdk/models/campaign_planning_curve_estimate.rb +201 -0
- data/lib/pinterest_sdk/models/campaign_planning_estimation_type.rb +48 -0
- data/lib/pinterest_sdk/models/campaign_planning_experiment_budget_recommendation.rb +181 -0
- data/lib/pinterest_sdk/models/campaign_planning_point_estimate.rb +218 -0
- data/lib/pinterest_sdk/models/campaign_planning_response_error.rb +180 -0
- data/lib/pinterest_sdk/models/campaign_planning_response_error_code.rb +42 -0
- data/lib/pinterest_sdk/models/campaign_summary_status.rb +11 -6
- data/lib/pinterest_sdk/models/campaign_update_request.rb +440 -0
- data/lib/pinterest_sdk/models/campaign_update_request_all_of2.rb +219 -0
- data/lib/pinterest_sdk/models/campaigns_analytics_metrics.rb +179 -0
- data/lib/pinterest_sdk/models/campaigns_list200_response.rb +176 -0
- data/lib/pinterest_sdk/models/cancel_invite_exception.rb +178 -0
- data/lib/pinterest_sdk/models/cancel_invite_result.rb +195 -0
- data/lib/pinterest_sdk/models/cancel_invite_result_item.rb +158 -0
- data/lib/pinterest_sdk/models/cancel_invite_result_user.rb +197 -0
- data/lib/pinterest_sdk/models/cancel_invites_request.rb +186 -0
- data/lib/pinterest_sdk/models/cancel_invites_response.rb +149 -0
- data/lib/pinterest_sdk/models/carousel_slot.rb +168 -0
- data/lib/pinterest_sdk/models/carting_product.rb +218 -0
- data/lib/pinterest_sdk/models/carting_retailer.rb +192 -0
- data/lib/pinterest_sdk/models/catalog.rb +304 -0
- data/lib/pinterest_sdk/models/catalog_binding.rb +190 -0
- data/lib/pinterest_sdk/models/catalog_create.rb +214 -0
- data/lib/pinterest_sdk/models/catalog_update.rb +180 -0
- data/lib/pinterest_sdk/models/catalogs_ai_content_disclosure.rb +213 -0
- data/lib/pinterest_sdk/models/catalogs_ai_content_disclosure_label.rb +40 -0
- data/lib/pinterest_sdk/models/catalogs_available_filter_values.rb +58 -0
- data/lib/pinterest_sdk/models/catalogs_base_filter_keys.rb +136 -0
- data/lib/pinterest_sdk/models/catalogs_base_filters_all_of.rb +175 -0
- data/lib/pinterest_sdk/models/catalogs_base_filters_any_of.rb +175 -0
- data/lib/pinterest_sdk/models/catalogs_create_creative_assets_item.rb +242 -0
- data/lib/pinterest_sdk/models/catalogs_create_hotel_item.rb +242 -0
- data/lib/pinterest_sdk/models/catalogs_create_report_response.rb +148 -0
- data/lib/pinterest_sdk/models/catalogs_create_retail_item.rb +242 -0
- data/lib/pinterest_sdk/models/catalogs_creative_assets_attributes.rb +306 -0
- data/lib/pinterest_sdk/models/catalogs_creative_assets_available_filter_values.rb +214 -0
- data/lib/pinterest_sdk/models/catalogs_creative_assets_batch_item.rb +60 -0
- data/lib/pinterest_sdk/models/catalogs_creative_assets_batch_request.rb +322 -0
- data/lib/pinterest_sdk/models/catalogs_creative_assets_feed.rb +503 -0
- data/lib/pinterest_sdk/models/catalogs_creative_assets_feeds_create_request.rb +402 -0
- data/lib/pinterest_sdk/models/catalogs_creative_assets_feeds_create_request_default_locale.rb +104 -0
- data/lib/pinterest_sdk/models/catalogs_creative_assets_feeds_update_request.rb +278 -0
- data/lib/pinterest_sdk/models/catalogs_creative_assets_filter_values_map.rb +282 -0
- data/lib/pinterest_sdk/models/catalogs_creative_assets_item_error_response.rb +257 -0
- data/lib/pinterest_sdk/models/catalogs_creative_assets_item_response.rb +265 -0
- data/lib/pinterest_sdk/models/catalogs_creative_assets_items_batch.rb +262 -0
- data/lib/pinterest_sdk/models/catalogs_creative_assets_items_post_filter.rb +265 -0
- data/lib/pinterest_sdk/models/catalogs_creative_assets_list_products_by_catalog_based_filter_request.rb +253 -0
- data/lib/pinterest_sdk/models/catalogs_creative_assets_product.rb +240 -0
- data/lib/pinterest_sdk/models/catalogs_creative_assets_product_group.rb +330 -0
- data/lib/pinterest_sdk/models/catalogs_creative_assets_product_group_create_request.rb +289 -0
- data/lib/pinterest_sdk/models/catalogs_creative_assets_product_group_filter_keys.rb +117 -0
- data/lib/pinterest_sdk/models/catalogs_creative_assets_product_group_filters.rb +104 -0
- data/lib/pinterest_sdk/models/catalogs_creative_assets_product_group_filters_all_of.rb +166 -0
- data/lib/pinterest_sdk/models/catalogs_creative_assets_product_group_filters_any_of.rb +166 -0
- data/lib/pinterest_sdk/models/catalogs_creative_assets_product_group_product_counts.rb +329 -0
- data/lib/pinterest_sdk/models/catalogs_creative_assets_product_group_update_request.rb +211 -0
- data/lib/pinterest_sdk/models/catalogs_creative_assets_product_metadata.rb +214 -0
- data/lib/pinterest_sdk/models/catalogs_delete_creative_assets_item.rb +216 -0
- data/lib/pinterest_sdk/models/catalogs_delete_hotel_item.rb +216 -0
- data/lib/pinterest_sdk/models/catalogs_delete_retail_item.rb +226 -0
- data/lib/pinterest_sdk/models/catalogs_feed.rb +32 -342
- data/lib/pinterest_sdk/models/catalogs_feed_create_request_schema.rb +104 -0
- data/lib/pinterest_sdk/models/catalogs_feed_credentials.rb +50 -97
- data/lib/pinterest_sdk/models/catalogs_feed_ingestion.rb +290 -0
- data/lib/pinterest_sdk/models/catalogs_feed_ingestion_details.rb +79 -100
- data/lib/pinterest_sdk/models/catalogs_feed_ingestion_errors.rb +97 -157
- data/lib/pinterest_sdk/models/catalogs_feed_ingestion_info.rb +31 -99
- data/lib/pinterest_sdk/models/catalogs_feed_ingestion_warnings.rb +998 -0
- data/lib/pinterest_sdk/models/catalogs_feed_processing_result.rb +176 -123
- data/lib/pinterest_sdk/models/catalogs_feed_processing_schedule.rb +31 -110
- data/lib/pinterest_sdk/models/catalogs_feed_processing_schedule_timezone.rb +425 -0
- data/lib/pinterest_sdk/models/catalogs_feed_processing_status.rb +9 -11
- data/lib/pinterest_sdk/models/catalogs_feed_product_counts.rb +37 -98
- data/lib/pinterest_sdk/models/catalogs_feed_update_request_schema.rb +104 -0
- data/lib/pinterest_sdk/models/catalogs_feed_validation_details.rb +49 -96
- data/lib/pinterest_sdk/models/catalogs_feed_validation_errors.rb +231 -278
- data/lib/pinterest_sdk/models/catalogs_feed_validation_warnings.rb +1982 -348
- data/lib/pinterest_sdk/models/catalogs_feed_video_counts.rb +169 -0
- data/lib/pinterest_sdk/models/catalogs_feeds_create_request.rb +145 -139
- data/lib/pinterest_sdk/models/catalogs_feeds_update_request.rb +89 -117
- data/lib/pinterest_sdk/models/catalogs_format.rb +10 -6
- data/lib/pinterest_sdk/models/catalogs_hotel_address.rb +188 -0
- data/lib/pinterest_sdk/models/catalogs_hotel_attributes.rb +366 -0
- data/lib/pinterest_sdk/models/catalogs_hotel_available_filter_values.rb +214 -0
- data/lib/pinterest_sdk/models/catalogs_hotel_batch_item.rb +60 -0
- data/lib/pinterest_sdk/models/catalogs_hotel_batch_request.rb +322 -0
- data/lib/pinterest_sdk/models/catalogs_hotel_feed.rb +469 -0
- data/lib/pinterest_sdk/models/catalogs_hotel_feeds_create_request.rb +376 -0
- data/lib/pinterest_sdk/models/catalogs_hotel_feeds_update_request.rb +278 -0
- data/lib/pinterest_sdk/models/catalogs_hotel_filter_values_map.rb +205 -0
- data/lib/pinterest_sdk/models/catalogs_hotel_guest_ratings.rb +182 -0
- data/lib/pinterest_sdk/models/catalogs_hotel_item_error_response.rb +257 -0
- data/lib/pinterest_sdk/models/catalogs_hotel_item_response.rb +265 -0
- data/lib/pinterest_sdk/models/catalogs_hotel_items_batch.rb +262 -0
- data/lib/pinterest_sdk/models/catalogs_hotel_items_post_filter.rb +265 -0
- data/lib/pinterest_sdk/models/catalogs_hotel_list_products_by_catalog_based_filter_request.rb +253 -0
- data/lib/pinterest_sdk/models/catalogs_hotel_main_image.rb +162 -0
- data/lib/pinterest_sdk/models/catalogs_hotel_product.rb +240 -0
- data/lib/pinterest_sdk/models/catalogs_hotel_product_group.rb +356 -0
- data/lib/pinterest_sdk/models/catalogs_hotel_product_group_create_request.rb +289 -0
- data/lib/pinterest_sdk/models/catalogs_hotel_product_group_filter_keys.rb +111 -0
- data/lib/pinterest_sdk/models/catalogs_hotel_product_group_filters.rb +104 -0
- data/lib/pinterest_sdk/models/catalogs_hotel_product_group_filters_all_of.rb +166 -0
- data/lib/pinterest_sdk/models/catalogs_hotel_product_group_filters_any_of.rb +166 -0
- data/lib/pinterest_sdk/models/catalogs_hotel_product_group_product_counts.rb +224 -0
- data/lib/pinterest_sdk/models/catalogs_hotel_product_group_type.rb +40 -0
- data/lib/pinterest_sdk/models/catalogs_hotel_product_group_update_request.rb +211 -0
- data/lib/pinterest_sdk/models/catalogs_hotel_product_metadata.rb +166 -0
- data/lib/pinterest_sdk/models/catalogs_hotel_report_parameters.rb +215 -0
- data/lib/pinterest_sdk/models/catalogs_hotel_report_parameters_report.rb +55 -0
- data/lib/pinterest_sdk/models/catalogs_hotel_report_stats_parameters.rb +215 -0
- data/lib/pinterest_sdk/models/catalogs_hotel_report_stats_parameters_report.rb +55 -0
- data/lib/pinterest_sdk/models/catalogs_item_validation_details.rb +186 -0
- data/lib/pinterest_sdk/models/catalogs_item_validation_errors.rb +368 -0
- data/lib/pinterest_sdk/models/catalogs_item_validation_issue.rb +267 -0
- data/lib/pinterest_sdk/models/catalogs_item_validation_issues.rb +230 -0
- data/lib/pinterest_sdk/models/catalogs_item_validation_warnings.rb +2198 -0
- data/lib/pinterest_sdk/models/catalogs_items_batch.rb +31 -235
- data/lib/pinterest_sdk/models/catalogs_items_batch_post_request.rb +104 -0
- data/lib/pinterest_sdk/models/catalogs_items_batch_request.rb +35 -222
- data/lib/pinterest_sdk/models/catalogs_items_create_batch_request.rb +291 -0
- data/lib/pinterest_sdk/models/catalogs_items_delete_batch_request.rb +273 -0
- data/lib/pinterest_sdk/models/catalogs_items_delete_discontinued_batch_request.rb +273 -0
- data/lib/pinterest_sdk/models/catalogs_items_post_filters.rb +57 -0
- data/lib/pinterest_sdk/models/catalogs_items_request.rb +242 -0
- data/lib/pinterest_sdk/models/catalogs_items_update_batch_request.rb +291 -0
- data/lib/pinterest_sdk/models/catalogs_items_upsert_batch_request.rb +291 -0
- data/lib/pinterest_sdk/models/catalogs_list200_response.rb +176 -0
- data/lib/pinterest_sdk/models/catalogs_list_products_by_feed_based_filter.rb +203 -0
- data/lib/pinterest_sdk/models/catalogs_list_products_by_filter_request.rb +105 -0
- data/lib/pinterest_sdk/models/catalogs_local_stores_create200_response_inner.rb +164 -0
- data/lib/pinterest_sdk/models/catalogs_local_stores_create200_response_inner_data.rb +105 -0
- data/lib/pinterest_sdk/models/catalogs_local_stores_create200_response_inner_data_one_of.rb +202 -0
- data/lib/pinterest_sdk/models/catalogs_local_stores_delete200_response_inner.rb +202 -0
- data/lib/pinterest_sdk/models/catalogs_local_stores_list200_response.rb +176 -0
- data/lib/pinterest_sdk/models/catalogs_locale.rb +84 -0
- data/lib/pinterest_sdk/models/catalogs_product.rb +57 -0
- data/lib/pinterest_sdk/models/catalogs_product_group_create_request.rb +85 -120
- data/lib/pinterest_sdk/models/catalogs_product_group_currency_criteria.rb +72 -113
- data/lib/pinterest_sdk/models/catalogs_product_group_filter_keys.rb +79 -593
- data/lib/pinterest_sdk/models/catalogs_product_group_filter_operator_type_criteria.rb +206 -0
- data/lib/pinterest_sdk/models/catalogs_product_group_filters.rb +75 -223
- data/lib/pinterest_sdk/models/catalogs_product_group_filters_all_of.rb +42 -96
- data/lib/pinterest_sdk/models/catalogs_product_group_filters_any_of.rb +42 -96
- data/lib/pinterest_sdk/models/catalogs_product_group_filters_request.rb +104 -0
- data/lib/pinterest_sdk/models/catalogs_product_group_filters_request_any_of_items0.rb +175 -0
- data/lib/pinterest_sdk/models/catalogs_product_group_filters_request_any_of_items1.rb +175 -0
- data/lib/pinterest_sdk/models/catalogs_product_group_multiple_countries_criteria.rb +175 -0
- data/lib/pinterest_sdk/models/catalogs_product_group_multiple_gender_criteria.rb +175 -0
- data/lib/pinterest_sdk/models/catalogs_product_group_multiple_media_types_criteria.rb +175 -0
- data/lib/pinterest_sdk/models/catalogs_product_group_multiple_pinterest_product_category_criteria.rb +175 -0
- data/lib/pinterest_sdk/models/catalogs_product_group_multiple_string_criteria.rb +50 -114
- data/lib/pinterest_sdk/models/catalogs_product_group_multiple_string_list_criteria.rb +50 -114
- data/lib/pinterest_sdk/models/catalogs_product_group_pins_list200_response.rb +176 -0
- data/lib/pinterest_sdk/models/catalogs_product_group_pricing_criteria.rb +59 -117
- data/lib/pinterest_sdk/models/catalogs_product_group_product_counts_vertical.rb +58 -0
- data/lib/pinterest_sdk/models/catalogs_product_group_status.rb +9 -6
- data/lib/pinterest_sdk/models/catalogs_product_group_type.rb +12 -6
- data/lib/pinterest_sdk/models/catalogs_product_group_uint32_criteria.rb +239 -0
- data/lib/pinterest_sdk/models/catalogs_product_group_update_many_request_items_one_of_items0.rb +221 -0
- data/lib/pinterest_sdk/models/catalogs_product_group_update_request.rb +48 -155
- data/lib/pinterest_sdk/models/catalogs_product_groups_create_many_request_items.rb +104 -0
- data/lib/pinterest_sdk/models/catalogs_product_groups_create_request_schema.rb +104 -0
- data/lib/pinterest_sdk/models/catalogs_product_groups_list200_response.rb +176 -0
- data/lib/pinterest_sdk/models/catalogs_product_groups_update_request_schema.rb +104 -0
- data/lib/pinterest_sdk/models/catalogs_report.rb +203 -0
- data/lib/pinterest_sdk/models/catalogs_report_distribution_issue_filter.rb +219 -0
- data/lib/pinterest_sdk/models/catalogs_report_distribution_stats.rb +272 -0
- data/lib/pinterest_sdk/models/catalogs_report_feed_ingestion_filter.rb +257 -0
- data/lib/pinterest_sdk/models/catalogs_report_feed_ingestion_stats.rb +274 -0
- data/lib/pinterest_sdk/models/catalogs_report_parameters.rb +56 -0
- data/lib/pinterest_sdk/models/catalogs_report_stats.rb +56 -0
- data/lib/pinterest_sdk/models/catalogs_report_stats_parameters.rb +56 -0
- data/lib/pinterest_sdk/models/catalogs_retail_available_filter_values.rb +214 -0
- data/lib/pinterest_sdk/models/catalogs_retail_batch_request.rb +322 -0
- data/lib/pinterest_sdk/models/catalogs_retail_batch_request_items_items.rb +59 -0
- data/lib/pinterest_sdk/models/catalogs_retail_feed.rb +475 -0
- data/lib/pinterest_sdk/models/catalogs_retail_feeds_create_request.rb +412 -0
- data/lib/pinterest_sdk/models/catalogs_retail_feeds_update_request.rb +288 -0
- data/lib/pinterest_sdk/models/catalogs_retail_filter_values_map.rb +403 -0
- data/lib/pinterest_sdk/models/catalogs_retail_item_error_response.rb +257 -0
- data/lib/pinterest_sdk/models/catalogs_retail_item_response.rb +265 -0
- data/lib/pinterest_sdk/models/catalogs_retail_items_batch.rb +265 -0
- data/lib/pinterest_sdk/models/catalogs_retail_items_post_filter.rb +265 -0
- data/lib/pinterest_sdk/models/catalogs_retail_list_products_by_catalog_based_filter_request.rb +306 -0
- data/lib/pinterest_sdk/models/catalogs_retail_product.rb +240 -0
- data/lib/pinterest_sdk/models/catalogs_retail_product_group.rb +425 -0
- data/lib/pinterest_sdk/models/catalogs_retail_product_group_create_request.rb +308 -0
- data/lib/pinterest_sdk/models/catalogs_retail_product_group_product_counts.rb +357 -0
- data/lib/pinterest_sdk/models/catalogs_retail_product_group_update_request.rb +230 -0
- data/lib/pinterest_sdk/models/catalogs_retail_product_metadata.rb +293 -0
- data/lib/pinterest_sdk/models/catalogs_retail_report_all_items_filter.rb +251 -0
- data/lib/pinterest_sdk/models/catalogs_retail_report_parameters.rb +215 -0
- data/lib/pinterest_sdk/models/catalogs_retail_report_parameters_report.rb +57 -0
- data/lib/pinterest_sdk/models/catalogs_retail_report_stats_parameters.rb +215 -0
- data/lib/pinterest_sdk/models/catalogs_retail_report_stats_parameters_report.rb +55 -0
- data/lib/pinterest_sdk/models/catalogs_status.rb +9 -6
- data/lib/pinterest_sdk/models/catalogs_type.rb +41 -0
- data/lib/pinterest_sdk/models/catalogs_updatable_creative_assets_attributes.rb +267 -0
- data/lib/pinterest_sdk/models/catalogs_updatable_hotel_attributes.rb +324 -0
- data/lib/pinterest_sdk/models/catalogs_update_creative_assets_item.rb +242 -0
- data/lib/pinterest_sdk/models/catalogs_update_hotel_item.rb +242 -0
- data/lib/pinterest_sdk/models/catalogs_update_retail_item.rb +255 -0
- data/lib/pinterest_sdk/models/catalogs_upsert_creative_assets_item.rb +242 -0
- data/lib/pinterest_sdk/models/catalogs_upsert_hotel_item.rb +242 -0
- data/lib/pinterest_sdk/models/catalogs_upsert_retail_item.rb +242 -0
- data/lib/pinterest_sdk/models/catalogs_vertical_batch_request.rb +58 -0
- data/lib/pinterest_sdk/models/catalogs_vertical_feeds_create_request.rb +58 -0
- data/lib/pinterest_sdk/models/catalogs_vertical_feeds_update_request.rb +58 -0
- data/lib/pinterest_sdk/models/catalogs_vertical_product_group.rb +57 -0
- data/lib/pinterest_sdk/models/catalogs_vertical_product_group_create_request.rb +58 -0
- data/lib/pinterest_sdk/models/catalogs_vertical_product_group_update_request.rb +58 -0
- data/lib/pinterest_sdk/models/catalogs_verticals_list_products_by_catalog_based_filter_request.rb +58 -0
- data/lib/pinterest_sdk/models/change_history_data_type.rb +48 -0
- data/lib/pinterest_sdk/models/change_history_operation_type.rb +41 -0
- data/lib/pinterest_sdk/models/collections_header_type.rb +43 -0
- data/lib/pinterest_sdk/models/condition_filter.rb +37 -96
- data/lib/pinterest_sdk/models/content_type.rb +40 -0
- data/lib/pinterest_sdk/models/conversion_access_token.rb +176 -0
- data/lib/pinterest_sdk/models/conversion_api_response_events_items.rb +209 -0
- data/lib/pinterest_sdk/models/conversion_attribution_window_days.rb +11 -6
- data/lib/pinterest_sdk/models/conversion_deletion_request.rb +273 -0
- data/lib/pinterest_sdk/models/conversion_deletion_request_create.rb +166 -0
- data/lib/pinterest_sdk/models/conversion_deletion_request_epik_targets.rb +176 -0
- data/lib/pinterest_sdk/models/conversion_deletion_request_list200_response.rb +176 -0
- data/lib/pinterest_sdk/models/conversion_deletion_request_status.rb +41 -0
- data/lib/pinterest_sdk/models/conversion_deletion_request_targets.rb +103 -0
- data/lib/pinterest_sdk/models/conversion_deletion_request_user_email_targets.rb +176 -0
- data/lib/pinterest_sdk/models/conversion_event.rb +48 -0
- data/lib/pinterest_sdk/models/conversion_event_app_info.rb +418 -0
- data/lib/pinterest_sdk/models/conversion_event_device_info.rb +892 -0
- data/lib/pinterest_sdk/models/conversion_event_ingestion_source.rb +43 -0
- data/lib/pinterest_sdk/models/conversion_event_response.rb +251 -0
- data/lib/pinterest_sdk/models/conversion_events.rb +222 -0
- data/lib/pinterest_sdk/models/conversion_events_create.rb +186 -0
- data/lib/pinterest_sdk/models/conversion_events_data_items.rb +441 -0
- data/lib/pinterest_sdk/models/conversion_events_data_items_custom_data.rb +305 -0
- data/lib/pinterest_sdk/models/conversion_events_data_items_custom_data_contents_items.rb +227 -0
- data/lib/pinterest_sdk/models/conversion_events_user_data_properties.rb +324 -0
- data/lib/pinterest_sdk/models/conversion_health_selection_item.rb +182 -0
- data/lib/pinterest_sdk/models/conversion_learning_mode_type.rb +40 -0
- data/lib/pinterest_sdk/models/conversion_msot_events_create.rb +517 -0
- data/lib/pinterest_sdk/models/conversion_objective_type.rb +47 -0
- data/lib/pinterest_sdk/models/conversion_product_attribution_type.rb +40 -0
- data/lib/pinterest_sdk/models/conversion_product_report.rb +210 -0
- data/lib/pinterest_sdk/models/conversion_product_report_breakdown_type.rb +43 -0
- data/lib/pinterest_sdk/models/conversion_product_report_create.rb +557 -0
- data/lib/pinterest_sdk/models/conversion_product_report_granularity.rb +41 -0
- data/lib/pinterest_sdk/models/conversion_product_report_level.rb +41 -0
- data/lib/pinterest_sdk/models/conversion_product_reporting_column.rb +210 -0
- data/lib/pinterest_sdk/models/conversion_report_attribution_type.rb +9 -6
- data/lib/pinterest_sdk/models/conversion_report_time_type.rb +11 -8
- data/lib/pinterest_sdk/models/conversion_tag.rb +291 -0
- data/lib/pinterest_sdk/models/conversion_tag_common.rb +248 -0
- data/lib/pinterest_sdk/models/conversion_tag_configs.rb +254 -0
- data/lib/pinterest_sdk/models/conversion_tag_create.rb +270 -0
- data/lib/pinterest_sdk/models/conversion_tag_response.rb +291 -0
- data/lib/pinterest_sdk/models/conversion_tag_type.rb +66 -0
- data/lib/pinterest_sdk/models/conversion_tag_type_optimal.rb +66 -0
- data/lib/pinterest_sdk/models/conversion_tag_v3_goal_metadata.rb +259 -0
- data/lib/pinterest_sdk/models/conversion_tags_list200_response.rb +166 -0
- data/lib/pinterest_sdk/models/country.rb +11 -7
- data/lib/pinterest_sdk/models/country_filter.rb +164 -0
- data/lib/pinterest_sdk/models/create_asset_access_request_body.rb +185 -0
- data/lib/pinterest_sdk/models/create_asset_access_request_item.rb +205 -0
- data/lib/pinterest_sdk/models/create_asset_access_request_response.rb +162 -0
- data/lib/pinterest_sdk/models/create_asset_invites_request.rb +185 -0
- data/lib/pinterest_sdk/models/create_asset_invites_request_item.rb +254 -0
- data/lib/pinterest_sdk/models/create_invites_results_response_array.rb +150 -0
- data/lib/pinterest_sdk/models/create_membership_or_partnership_invites_body.rb +293 -0
- data/lib/pinterest_sdk/models/creation_source.rb +41 -0
- data/lib/pinterest_sdk/models/creative_assets_id_filter.rb +164 -0
- data/lib/pinterest_sdk/models/creative_assets_processing_record.rb +204 -0
- data/lib/pinterest_sdk/models/creative_assets_visibility_type.rb +40 -0
- data/lib/pinterest_sdk/models/creative_type.rb +52 -0
- data/lib/pinterest_sdk/models/currency.rb +11 -6
- data/lib/pinterest_sdk/models/currency_filter.rb +37 -96
- data/lib/pinterest_sdk/models/custom_conversion_event_metrics.rb +213 -0
- data/lib/pinterest_sdk/models/custom_label0_filter.rb +38 -97
- data/lib/pinterest_sdk/models/custom_label1_filter.rb +38 -97
- data/lib/pinterest_sdk/models/custom_label2_filter.rb +38 -97
- data/lib/pinterest_sdk/models/custom_label3_filter.rb +38 -97
- data/lib/pinterest_sdk/models/custom_label4_filter.rb +38 -97
- data/lib/pinterest_sdk/models/custom_number0_filter.rb +164 -0
- data/lib/pinterest_sdk/models/custom_number1_filter.rb +164 -0
- data/lib/pinterest_sdk/models/custom_number2_filter.rb +164 -0
- data/lib/pinterest_sdk/models/custom_number3_filter.rb +164 -0
- data/lib/pinterest_sdk/models/custom_number4_filter.rb +164 -0
- data/lib/pinterest_sdk/models/customer_list.rb +334 -0
- data/lib/pinterest_sdk/models/customer_list_create.rb +230 -0
- data/lib/pinterest_sdk/models/customer_list_record_row.rb +219 -0
- data/lib/pinterest_sdk/models/customer_list_status.rb +42 -0
- data/lib/pinterest_sdk/models/customer_list_update_with_required_body.rb +210 -0
- data/lib/pinterest_sdk/models/customer_list_upload.rb +412 -0
- data/lib/pinterest_sdk/models/customer_list_upload_create_request.rb +231 -0
- data/lib/pinterest_sdk/models/customer_list_upload_create_response.rb +192 -0
- data/lib/pinterest_sdk/models/customer_lists_list200_response.rb +176 -0
- data/lib/pinterest_sdk/models/customer_segment.rb +308 -0
- data/lib/pinterest_sdk/models/customer_segment_create.rb +195 -0
- data/lib/pinterest_sdk/models/customer_segment_list200_response.rb +176 -0
- data/lib/pinterest_sdk/models/customer_segment_update_request_update_with_required_body.rb +237 -0
- data/lib/pinterest_sdk/models/customizable_cta_type.rb +69 -0
- data/lib/pinterest_sdk/models/data_output_format.rb +9 -6
- data/lib/pinterest_sdk/models/data_status.rb +61 -0
- data/lib/pinterest_sdk/models/delete_business_membership200_response.rb +149 -0
- data/lib/pinterest_sdk/models/delete_business_membership_body.rb +185 -0
- data/lib/pinterest_sdk/models/delete_business_membership_member.rb +234 -0
- data/lib/pinterest_sdk/models/delete_business_partners.rb +149 -0
- data/lib/pinterest_sdk/models/delete_business_partners_delete.rb +217 -0
- data/lib/pinterest_sdk/models/delete_member_access_result.rb +201 -0
- data/lib/pinterest_sdk/models/delete_member_access_results_response_array.rb +150 -0
- data/lib/pinterest_sdk/models/delete_member_asset_access_item.rb +232 -0
- data/lib/pinterest_sdk/models/delete_partner_asset_access_body.rb +186 -0
- data/lib/pinterest_sdk/models/delete_partner_asset_access_item.rb +278 -0
- data/lib/pinterest_sdk/models/delete_partner_asset_access_result.rb +233 -0
- data/lib/pinterest_sdk/models/delete_partner_asset_access_results_response_array.rb +150 -0
- data/lib/pinterest_sdk/models/delivery_estimate_objective_type.rb +42 -0
- data/lib/pinterest_sdk/models/delivery_metrics_get200_response.rb +166 -0
- data/lib/pinterest_sdk/models/delivery_metrics_response_items_items.rb +212 -0
- data/lib/pinterest_sdk/models/detailed_error.rb +217 -0
- data/lib/pinterest_sdk/models/disclosure_type.rb +44 -0
- data/lib/pinterest_sdk/models/discount_status.rb +43 -0
- data/lib/pinterest_sdk/models/dynamic_titles_download_csv.rb +148 -0
- data/lib/pinterest_sdk/models/dynamic_titles_get_status.rb +168 -0
- data/lib/pinterest_sdk/models/dynamic_titles_process_csv.rb +160 -0
- data/lib/pinterest_sdk/models/dynamic_titles_process_csv_create.rb +166 -0
- data/lib/pinterest_sdk/models/dynamic_titles_process_csv_error.rb +158 -0
- data/lib/pinterest_sdk/models/dynamic_titles_upload_url.rb +202 -0
- data/lib/pinterest_sdk/models/enhanced_match_status_type.rb +42 -0
- data/lib/pinterest_sdk/models/entity_data_change_history.rb +210 -0
- data/lib/pinterest_sdk/models/entity_history.rb +274 -0
- data/lib/pinterest_sdk/models/entity_label.rb +234 -0
- data/lib/pinterest_sdk/models/entity_label_error.rb +158 -0
- data/lib/pinterest_sdk/models/entity_label_status.rb +41 -0
- data/lib/pinterest_sdk/models/entity_status.rb +11 -6
- data/lib/pinterest_sdk/models/error_detail.rb +219 -0
- data/lib/pinterest_sdk/models/event_data.rb +270 -0
- data/lib/pinterest_sdk/models/event_processing_status.rb +40 -0
- data/lib/pinterest_sdk/models/event_quality_score.rb +291 -0
- data/lib/pinterest_sdk/models/exception.rb +173 -0
- data/lib/pinterest_sdk/models/featured_trend.rb +210 -0
- data/lib/pinterest_sdk/models/feed_processing_results_list200_response.rb +176 -0
- data/lib/pinterest_sdk/models/feeds_list200_response.rb +176 -0
- data/lib/pinterest_sdk/models/filter_operator_type.rb +40 -0
- data/lib/pinterest_sdk/models/follow_user.rb +158 -0
- data/lib/pinterest_sdk/models/follow_user_create.rb +149 -0
- data/lib/pinterest_sdk/models/followers_list200_response.rb +176 -0
- data/lib/pinterest_sdk/models/form_factor.rb +47 -0
- data/lib/pinterest_sdk/models/freq_bid_multiplier_time_window.rb +40 -0
- data/lib/pinterest_sdk/models/frequency_goal_metadata.rb +207 -0
- data/lib/pinterest_sdk/models/frequency_goal_metadata_timerange.rb +44 -0
- data/lib/pinterest_sdk/models/frequency_multipliers.rb +149 -0
- data/lib/pinterest_sdk/models/gender.rb +41 -0
- data/lib/pinterest_sdk/models/gender_bucket.rb +41 -0
- data/lib/pinterest_sdk/models/gender_demographics.rb +220 -0
- data/lib/pinterest_sdk/models/gender_filter.rb +38 -97
- data/lib/pinterest_sdk/models/gender_multipliers.rb +171 -0
- data/lib/pinterest_sdk/models/get_business_employers200_response.rb +176 -0
- data/lib/pinterest_sdk/models/get_invites200_response.rb +176 -0
- data/lib/pinterest_sdk/models/google_product_category0_filter.rb +37 -96
- data/lib/pinterest_sdk/models/google_product_category1_filter.rb +37 -96
- data/lib/pinterest_sdk/models/google_product_category2_filter.rb +37 -96
- data/lib/pinterest_sdk/models/google_product_category3_filter.rb +37 -96
- data/lib/pinterest_sdk/models/google_product_category4_filter.rb +37 -96
- data/lib/pinterest_sdk/models/google_product_category5_filter.rb +37 -96
- data/lib/pinterest_sdk/models/google_product_category6_filter.rb +37 -96
- data/lib/pinterest_sdk/models/granularity.rb +9 -6
- data/lib/pinterest_sdk/models/grid_click_type.rb +40 -0
- data/lib/pinterest_sdk/models/hotel_id_filter.rb +164 -0
- data/lib/pinterest_sdk/models/hotel_processing_record.rb +204 -0
- data/lib/pinterest_sdk/models/http_method.rb +47 -0
- data/lib/pinterest_sdk/models/image_details.rb +50 -143
- data/lib/pinterest_sdk/models/image_metadata.rb +228 -0
- data/lib/pinterest_sdk/models/image_size.rb +174 -0
- data/lib/pinterest_sdk/models/ineligible_product_tag_error_item.rb +226 -0
- data/lib/pinterest_sdk/models/ineligible_product_tag_reason.rb +43 -0
- data/lib/pinterest_sdk/models/ineligible_product_tags_error_details.rb +168 -0
- data/lib/pinterest_sdk/models/ingestion_source.rb +43 -0
- data/lib/pinterest_sdk/models/ingestion_source_options.rb +43 -0
- data/lib/pinterest_sdk/models/inner_product_categories_metrics_highlights.rb +165 -0
- data/lib/pinterest_sdk/models/integration_log.rb +472 -0
- data/lib/pinterest_sdk/models/integration_log_client_error.rb +324 -0
- data/lib/pinterest_sdk/models/integration_log_client_request.rb +274 -0
- data/lib/pinterest_sdk/models/integration_log_event_type.rb +40 -0
- data/lib/pinterest_sdk/models/integration_log_level.rb +41 -0
- data/lib/pinterest_sdk/models/integration_logs_invalid_log_response.rb +150 -0
- data/lib/pinterest_sdk/models/integration_logs_invalid_log_response_rejected_logs_items.rb +229 -0
- data/lib/pinterest_sdk/models/integration_logs_request_create.rb +185 -0
- data/lib/pinterest_sdk/models/integration_logs_success_response.rb +148 -0
- data/lib/pinterest_sdk/models/integration_metadata.rb +287 -0
- data/lib/pinterest_sdk/models/integration_metadata_create.rb +257 -0
- data/lib/pinterest_sdk/models/integration_metadata_update.rb +247 -0
- data/lib/pinterest_sdk/models/integration_record.rb +334 -0
- data/lib/pinterest_sdk/models/integrations_get_list200_response.rb +176 -0
- data/lib/pinterest_sdk/models/intended_promotion_type.rb +41 -0
- data/lib/pinterest_sdk/models/interest.rb +195 -0
- data/lib/pinterest_sdk/models/interests_enum.rb +54 -0
- data/lib/pinterest_sdk/models/invite_action_result_item.rb +159 -0
- data/lib/pinterest_sdk/models/invite_assets_summary.rb +163 -0
- data/lib/pinterest_sdk/models/invite_assets_summary_item.rb +181 -0
- data/lib/pinterest_sdk/models/invite_business_role_binding.rb +219 -0
- data/lib/pinterest_sdk/models/invite_data_response.rb +189 -0
- data/lib/pinterest_sdk/models/invite_exception_response.rb +199 -0
- data/lib/pinterest_sdk/models/invite_filter_status.rb +40 -0
- data/lib/pinterest_sdk/models/invite_response.rb +251 -0
- data/lib/pinterest_sdk/models/invite_status.rb +43 -0
- data/lib/pinterest_sdk/models/invite_type.rb +41 -0
- data/lib/pinterest_sdk/models/item_attributes.rb +1524 -252
- data/lib/pinterest_sdk/models/item_attributes_request.rb +2088 -0
- data/lib/pinterest_sdk/models/item_attributes_request_image_link.rb +105 -0
- data/lib/pinterest_sdk/models/item_availability.rb +41 -0
- data/lib/pinterest_sdk/models/item_create_batch_record.rb +158 -0
- data/lib/pinterest_sdk/models/item_delete_batch_record.rb +149 -0
- data/lib/pinterest_sdk/models/item_delete_discontinued_batch_record.rb +149 -0
- data/lib/pinterest_sdk/models/item_group_id_filter.rb +37 -96
- data/lib/pinterest_sdk/models/item_id_filter.rb +38 -97
- data/lib/pinterest_sdk/models/item_id_store_code_pair.rb +193 -0
- data/lib/pinterest_sdk/models/item_processing_record.rb +68 -117
- data/lib/pinterest_sdk/models/item_processing_status.rb +9 -6
- data/lib/pinterest_sdk/models/item_response.rb +64 -0
- data/lib/pinterest_sdk/models/item_update_batch_record.rb +171 -0
- data/lib/pinterest_sdk/models/item_upsert_batch_record.rb +158 -0
- data/lib/pinterest_sdk/models/item_validation_event.rb +25 -96
- data/lib/pinterest_sdk/models/items_issues_list200_response.rb +176 -0
- data/lib/pinterest_sdk/models/items_post200_response.rb +166 -0
- data/lib/pinterest_sdk/models/keyword.rb +316 -0
- data/lib/pinterest_sdk/models/keyword_create_item.rb +211 -0
- data/lib/pinterest_sdk/models/keyword_error.rb +158 -0
- data/lib/pinterest_sdk/models/keyword_info.rb +176 -0
- data/lib/pinterest_sdk/models/keyword_metrics.rb +149 -0
- data/lib/pinterest_sdk/models/keyword_metrics_response.rb +157 -0
- data/lib/pinterest_sdk/models/keyword_update_generated.rb +197 -0
- data/lib/pinterest_sdk/models/keyword_update_item.rb +196 -0
- data/lib/pinterest_sdk/models/keywords.rb +196 -0
- data/lib/pinterest_sdk/models/keywords_common.rb +210 -0
- data/lib/pinterest_sdk/models/keywords_create.rb +195 -0
- data/lib/pinterest_sdk/models/keywords_get200_response.rb +176 -0
- data/lib/pinterest_sdk/models/keywords_metrics_array_response.rb +149 -0
- data/lib/pinterest_sdk/models/keywords_request.rb +205 -0
- data/lib/pinterest_sdk/models/keywords_update.rb +151 -0
- data/lib/pinterest_sdk/models/label.rb +256 -0
- data/lib/pinterest_sdk/models/label_bulk_create_request.rb +205 -0
- data/lib/pinterest_sdk/models/label_bulk_update_request.rb +240 -0
- data/lib/pinterest_sdk/models/label_create_item.rb +222 -0
- data/lib/pinterest_sdk/models/label_create_request.rb +167 -0
- data/lib/pinterest_sdk/models/label_error.rb +158 -0
- data/lib/pinterest_sdk/models/label_error_data.rb +240 -0
- data/lib/pinterest_sdk/models/label_parent_type.rb +39 -0
- data/lib/pinterest_sdk/models/label_status.rb +40 -0
- data/lib/pinterest_sdk/models/label_status_bulk_update.rb +39 -0
- data/lib/pinterest_sdk/models/label_type.rb +40 -0
- data/lib/pinterest_sdk/models/label_update_item.rb +236 -0
- data/lib/pinterest_sdk/models/label_update_request.rb +167 -0
- data/lib/pinterest_sdk/models/labeled_entities.rb +161 -0
- data/lib/pinterest_sdk/models/labeled_entities_create.rb +168 -0
- data/lib/pinterest_sdk/models/labels_list200_response.rb +176 -0
- data/lib/pinterest_sdk/models/labels_response.rb +161 -0
- data/lib/pinterest_sdk/models/language.rb +10 -7
- data/lib/pinterest_sdk/models/lead_form.rb +422 -0
- data/lib/pinterest_sdk/models/lead_form_batch_update.rb +341 -0
- data/lib/pinterest_sdk/models/lead_form_create.rb +334 -0
- data/lib/pinterest_sdk/models/lead_form_policy_link.rb +158 -0
- data/lib/pinterest_sdk/models/lead_form_question.rb +227 -0
- data/lib/pinterest_sdk/models/lead_form_question_field_type.rb +42 -0
- data/lib/pinterest_sdk/models/lead_form_question_type.rb +52 -0
- data/lib/pinterest_sdk/models/lead_form_status.rb +40 -0
- data/lib/pinterest_sdk/models/lead_form_test.rb +170 -0
- data/lib/pinterest_sdk/models/lead_form_test_create.rb +168 -0
- data/lib/pinterest_sdk/models/lead_forms_create200_response.rb +166 -0
- data/lib/pinterest_sdk/models/lead_forms_create200_response_items_inner.rb +158 -0
- data/lib/pinterest_sdk/models/lead_forms_list200_response.rb +176 -0
- data/lib/pinterest_sdk/models/lead_subscription.rb +311 -0
- data/lib/pinterest_sdk/models/lead_subscription_create.rb +196 -0
- data/lib/pinterest_sdk/models/lead_subscription_post_params.rb +348 -0
- data/lib/pinterest_sdk/models/lead_subscription_post_params_create.rb +233 -0
- data/lib/pinterest_sdk/models/leads_export_response_data.rb +179 -0
- data/lib/pinterest_sdk/models/leads_export_status.rb +41 -0
- data/lib/pinterest_sdk/models/leads_exports.rb +169 -0
- data/lib/pinterest_sdk/models/leads_exports_create.rb +253 -0
- data/lib/pinterest_sdk/models/line_item.rb +218 -0
- data/lib/pinterest_sdk/models/link_filter.rb +164 -0
- data/lib/pinterest_sdk/models/linked_business.rb +188 -0
- data/lib/pinterest_sdk/models/local_inventory_create_operation.rb +269 -0
- data/lib/pinterest_sdk/models/local_inventory_delete_operation.rb +243 -0
- data/lib/pinterest_sdk/models/local_inventory_item_response.rb +309 -0
- data/lib/pinterest_sdk/models/local_inventory_items_batch.rb +281 -0
- data/lib/pinterest_sdk/models/local_inventory_items_batch_create.rb +186 -0
- data/lib/pinterest_sdk/models/local_inventory_items_get.rb +168 -0
- data/lib/pinterest_sdk/models/local_inventory_items_get_create.rb +186 -0
- data/lib/pinterest_sdk/models/local_inventory_operation.rb +59 -0
- data/lib/pinterest_sdk/models/local_inventory_operation_result.rb +294 -0
- data/lib/pinterest_sdk/models/local_inventory_update_operation.rb +269 -0
- data/lib/pinterest_sdk/models/local_inventory_upsert_operation.rb +269 -0
- data/lib/pinterest_sdk/models/local_store.rb +404 -0
- data/lib/pinterest_sdk/models/local_store_batch_update.rb +298 -0
- data/lib/pinterest_sdk/models/local_store_create.rb +312 -0
- data/lib/pinterest_sdk/models/lookback_period_options.rb +40 -0
- data/lib/pinterest_sdk/models/match_type.rb +43 -0
- data/lib/pinterest_sdk/models/match_type_response.rb +43 -0
- data/lib/pinterest_sdk/models/max_price_filter.rb +37 -96
- data/lib/pinterest_sdk/models/media.rb +233 -0
- data/lib/pinterest_sdk/models/media_list200_response.rb +176 -0
- data/lib/pinterest_sdk/models/media_type.rb +40 -0
- data/lib/pinterest_sdk/models/media_type_filter.rb +164 -0
- data/lib/pinterest_sdk/models/media_upload.rb +105 -115
- data/lib/pinterest_sdk/models/media_upload_create.rb +187 -0
- data/lib/pinterest_sdk/models/media_upload_parameters.rb +210 -0
- data/lib/pinterest_sdk/models/media_upload_status.rb +9 -6
- data/lib/pinterest_sdk/models/media_upload_type.rb +9 -6
- data/lib/pinterest_sdk/models/member_business_role.rb +40 -0
- data/lib/pinterest_sdk/models/metrics_reporting_level.rb +10 -6
- data/lib/pinterest_sdk/models/metrics_reporting_template_type.rb +44 -0
- data/lib/pinterest_sdk/models/metrics_response.rb +149 -0
- data/lib/pinterest_sdk/models/metrics_response_data_items.rb +219 -0
- data/lib/pinterest_sdk/models/min_price_filter.rb +37 -96
- data/lib/pinterest_sdk/models/mmm_report.rb +214 -0
- data/lib/pinterest_sdk/models/mmm_report_create.rb +449 -0
- data/lib/pinterest_sdk/models/mmm_report_granularity.rb +40 -0
- data/lib/pinterest_sdk/models/mmm_report_level.rb +40 -0
- data/lib/pinterest_sdk/models/mmm_reporting_column.rb +64 -0
- data/lib/pinterest_sdk/models/mmm_reporting_targeting_type.rb +45 -0
- data/lib/pinterest_sdk/models/mobile_app_platform.rb +40 -0
- data/lib/pinterest_sdk/models/msot_event_name.rb +42 -0
- data/lib/pinterest_sdk/models/multi_pins_analytics_metric_types_item.rb +53 -0
- data/lib/pinterest_sdk/models/network_type.rb +46 -0
- data/lib/pinterest_sdk/models/non_draft_entity_status.rb +41 -0
- data/lib/pinterest_sdk/models/non_nullable_catalogs_currency.rb +9 -6
- data/lib/pinterest_sdk/models/notification_post_request.rb +105 -0
- data/lib/pinterest_sdk/models/notification_response.rb +168 -0
- data/lib/pinterest_sdk/models/nullable_catalogs_item_field_type.rb +143 -0
- data/lib/pinterest_sdk/models/nullable_currency.rb +9 -7
- data/lib/pinterest_sdk/models/nullable_entity_status.rb +43 -0
- data/lib/pinterest_sdk/models/nullable_label_status.rb +40 -0
- data/lib/pinterest_sdk/models/nullable_label_type.rb +40 -0
- data/lib/pinterest_sdk/models/nullable_optimization_goal_metadata.rb +165 -0
- data/lib/pinterest_sdk/models/nullable_partner_type.rb +40 -0
- data/lib/pinterest_sdk/models/nullalble_match_type.rb +43 -0
- data/lib/pinterest_sdk/models/numeric_filter_operator_type.rb +42 -0
- data/lib/pinterest_sdk/models/oauth_access_token.rb +284 -0
- data/lib/pinterest_sdk/models/objective_type.rb +13 -10
- data/lib/pinterest_sdk/models/operation_type.rb +40 -0
- data/lib/pinterest_sdk/models/optimization_goal_metadata.rb +165 -0
- data/lib/pinterest_sdk/models/optimization_type.rb +43 -0
- data/lib/pinterest_sdk/models/order.rb +40 -0
- data/lib/pinterest_sdk/models/order_line.rb +384 -0
- data/lib/pinterest_sdk/models/order_line_mutation_error.rb +159 -0
- data/lib/pinterest_sdk/models/order_line_mutation_response.rb +147 -0
- data/lib/pinterest_sdk/models/order_line_mutation_result.rb +162 -0
- data/lib/pinterest_sdk/models/order_line_paid_type.rb +42 -0
- data/lib/pinterest_sdk/models/order_line_status.rb +41 -0
- data/lib/pinterest_sdk/models/order_lines_list200_response.rb +176 -0
- data/lib/pinterest_sdk/models/os_family.rb +45 -0
- data/lib/pinterest_sdk/models/overall_status_options.rb +41 -0
- data/lib/pinterest_sdk/models/pacing_delivery_type.rb +9 -6
- data/lib/pinterest_sdk/models/page_visit_conversion_tags_get200_response.rb +176 -0
- data/lib/pinterest_sdk/models/partner_metadata.rb +148 -0
- data/lib/pinterest_sdk/models/partner_type.rb +40 -0
- data/lib/pinterest_sdk/models/performance_plus_campaign_settings.rb +161 -0
- data/lib/pinterest_sdk/models/permissions.rb +50 -0
- data/lib/pinterest_sdk/models/permissions_with_owner.rb +49 -0
- data/lib/pinterest_sdk/models/pin.rb +306 -165
- data/lib/pinterest_sdk/models/pin_analytics_daily_metrics.rb +190 -0
- data/lib/pinterest_sdk/models/pin_analytics_metrics_response.rb +174 -0
- data/lib/pinterest_sdk/models/pin_base.rb +393 -0
- data/lib/pinterest_sdk/models/pin_create.rb +384 -0
- data/lib/pinterest_sdk/models/pin_filter.rb +41 -0
- data/lib/pinterest_sdk/models/pin_media.rb +36 -198
- data/lib/pinterest_sdk/models/pin_media_metadata.rb +56 -0
- data/lib/pinterest_sdk/models/pin_media_source.rb +12 -6
- data/lib/pinterest_sdk/models/pin_media_source_image_base64.rb +83 -137
- data/lib/pinterest_sdk/models/pin_media_source_image_url.rb +54 -98
- data/lib/pinterest_sdk/models/pin_media_source_images_base64.rb +265 -0
- data/lib/pinterest_sdk/models/pin_media_source_images_base64_item.rb +250 -0
- data/lib/pinterest_sdk/models/pin_media_source_images_url.rb +265 -0
- data/lib/pinterest_sdk/models/pin_media_source_images_url_item.rb +191 -0
- data/lib/pinterest_sdk/models/pin_media_source_pin_url.rb +201 -0
- data/lib/pinterest_sdk/models/pin_media_source_video_id.rb +113 -123
- data/lib/pinterest_sdk/models/pin_media_with_image.rb +84 -119
- data/lib/pinterest_sdk/models/pin_media_with_image_and_video.rb +200 -0
- data/lib/pinterest_sdk/models/pin_media_with_images.rb +200 -0
- data/lib/pinterest_sdk/models/pin_media_with_video.rb +262 -0
- data/lib/pinterest_sdk/models/pin_media_with_videos.rb +200 -0
- data/lib/pinterest_sdk/models/pin_promotion_summary_status.rb +11 -6
- data/lib/pinterest_sdk/models/pin_read.rb +440 -0
- data/lib/pinterest_sdk/models/pin_type.rb +39 -0
- data/lib/pinterest_sdk/models/pin_update.rb +320 -0
- data/lib/pinterest_sdk/models/pinner_list_type.rb +44 -0
- data/lib/pinterest_sdk/models/pins_list200_response.rb +176 -0
- data/lib/pinterest_sdk/models/pins_save_request_create.rb +195 -0
- data/lib/pinterest_sdk/models/pinterest_lib_batch_item_exception.rb +174 -0
- data/lib/pinterest_sdk/models/pinterest_lib_error.rb +191 -0
- data/lib/pinterest_sdk/models/pinterest_lib_pagination_order.rb +40 -0
- data/lib/pinterest_sdk/models/pinterest_lib_status204.rb +189 -0
- data/lib/pinterest_sdk/models/pinterest_product_categories_filter.rb +164 -0
- data/lib/pinterest_sdk/models/placement_group_type.rb +9 -6
- data/lib/pinterest_sdk/models/placement_multipliers.rb +171 -0
- data/lib/pinterest_sdk/models/placement_traffic_type.rb +41 -0
- data/lib/pinterest_sdk/models/placement_type.rb +41 -0
- data/lib/pinterest_sdk/models/predicted_time_series.rb +147 -0
- data/lib/pinterest_sdk/models/preferred_media_type.rb +40 -0
- data/lib/pinterest_sdk/models/price_filter.rb +164 -0
- data/lib/pinterest_sdk/models/price_filter_price.rb +256 -0
- data/lib/pinterest_sdk/models/primary_sort.rb +40 -0
- data/lib/pinterest_sdk/models/product_availability.rb +41 -0
- data/lib/pinterest_sdk/models/product_availability_type.rb +9 -7
- data/lib/pinterest_sdk/models/product_categories_demographic.rb +194 -0
- data/lib/pinterest_sdk/models/product_categories_engagement_type.rb +41 -0
- data/lib/pinterest_sdk/models/product_categories_metrics_highlights.rb +169 -0
- data/lib/pinterest_sdk/models/product_category_detail_lookback_window.rb +42 -0
- data/lib/pinterest_sdk/models/product_category_details.rb +268 -0
- data/lib/pinterest_sdk/models/product_category_enum.rb +421 -0
- data/lib/pinterest_sdk/models/product_category_region.rb +41 -0
- data/lib/pinterest_sdk/models/product_condition.rb +41 -0
- data/lib/pinterest_sdk/models/product_group_analytics_items.rb +186 -0
- data/lib/pinterest_sdk/models/product_group_promotion.rb +516 -0
- data/lib/pinterest_sdk/models/product_group_promotion_create_request.rb +204 -0
- data/lib/pinterest_sdk/models/product_group_promotion_customizable_cta_type.rb +71 -0
- data/lib/pinterest_sdk/models/product_group_promotion_response_item.rb +158 -0
- data/lib/pinterest_sdk/models/product_group_promotion_update_request.rb +204 -0
- data/lib/pinterest_sdk/models/product_group_promotions.rb +151 -0
- data/lib/pinterest_sdk/models/product_group_promotions_create.rb +206 -0
- data/lib/pinterest_sdk/models/product_group_promotions_list200_response.rb +176 -0
- data/lib/pinterest_sdk/models/product_group_promotions_update_with_required_body.rb +206 -0
- data/lib/pinterest_sdk/models/product_group_reference_filter.rb +164 -0
- data/lib/pinterest_sdk/models/product_group_summary_status.rb +9 -6
- data/lib/pinterest_sdk/models/product_tag_item.rb +177 -0
- data/lib/pinterest_sdk/models/product_tags_bulk_add_request.rb +186 -0
- data/lib/pinterest_sdk/models/product_tags_bulk_delete_request.rb +186 -0
- data/lib/pinterest_sdk/models/product_tags_error.rb +201 -0
- data/lib/pinterest_sdk/models/product_tags_response.rb +168 -0
- data/lib/pinterest_sdk/models/product_type0_filter.rb +37 -96
- data/lib/pinterest_sdk/models/product_type1_filter.rb +37 -96
- data/lib/pinterest_sdk/models/product_type2_filter.rb +37 -96
- data/lib/pinterest_sdk/models/product_type3_filter.rb +37 -96
- data/lib/pinterest_sdk/models/product_type4_filter.rb +37 -96
- data/lib/pinterest_sdk/models/promotion.rb +454 -0
- data/lib/pinterest_sdk/models/promotion_application_level.rb +41 -0
- data/lib/pinterest_sdk/models/promotion_array_element.rb +156 -0
- data/lib/pinterest_sdk/models/promotion_batch_update.rb +373 -0
- data/lib/pinterest_sdk/models/promotion_create.rb +361 -0
- data/lib/pinterest_sdk/models/promotion_template_value.rb +199 -0
- data/lib/pinterest_sdk/models/promotion_type.rb +61 -0
- data/lib/pinterest_sdk/models/promotions_list200_response.rb +176 -0
- data/lib/pinterest_sdk/models/promotions_response.rb +149 -0
- data/lib/pinterest_sdk/models/public_targeting_type.rb +48 -0
- data/lib/pinterest_sdk/models/quality_component_details.rb +188 -0
- data/lib/pinterest_sdk/models/quality_component_issue.rb +220 -0
- data/lib/pinterest_sdk/models/quality_components.rb +263 -0
- data/lib/pinterest_sdk/models/query_label_entity_statuses_items.rb +40 -0
- data/lib/pinterest_sdk/models/query_label_types_items.rb +40 -0
- data/lib/pinterest_sdk/models/querymetrictypes_items.rb +47 -0
- data/lib/pinterest_sdk/models/querypinanalyticsmetrictypes_items.rb +53 -0
- data/lib/pinterest_sdk/models/queryvideopinmetrictypes_items.rb +47 -0
- data/lib/pinterest_sdk/models/quiz_pin_data.rb +202 -0
- data/lib/pinterest_sdk/models/quiz_pin_option.rb +157 -0
- data/lib/pinterest_sdk/models/quiz_pin_question.rb +168 -0
- data/lib/pinterest_sdk/models/quiz_pin_result.rb +184 -0
- data/lib/pinterest_sdk/models/record_counts.rb +219 -0
- data/lib/pinterest_sdk/models/related_terms.rb +170 -0
- data/lib/pinterest_sdk/models/related_terms_related_terms_list_items.rb +158 -0
- data/lib/pinterest_sdk/models/report_type.rb +40 -0
- data/lib/pinterest_sdk/models/reporting_column.rb +2974 -0
- data/lib/pinterest_sdk/models/reporting_column_async.rb +149 -34
- data/lib/pinterest_sdk/models/reporting_column_sync.rb +223 -0
- data/lib/pinterest_sdk/models/reporting_time_zone.rb +40 -0
- data/lib/pinterest_sdk/models/reports_stats200_response.rb +176 -0
- data/lib/pinterest_sdk/models/respond_to_invite_result_item.rb +159 -0
- data/lib/pinterest_sdk/models/respond_to_invites_response_array.rb +150 -0
- data/lib/pinterest_sdk/models/retail_local_inventory_item_attributes.rb +235 -0
- data/lib/pinterest_sdk/models/retail_local_inventory_item_attributes_optional.rb +201 -0
- data/lib/pinterest_sdk/models/role.rb +57 -0
- data/lib/pinterest_sdk/models/s3_file_part.rb +192 -0
- data/lib/pinterest_sdk/models/s3_multipart_upload_data.rb +150 -0
- data/lib/pinterest_sdk/models/schedule.rb +315 -0
- data/lib/pinterest_sdk/models/schedule_action.rb +40 -0
- data/lib/pinterest_sdk/models/schedule_age_bucket_multipliers.rb +182 -0
- data/lib/pinterest_sdk/models/schedule_app_type_multipliers.rb +170 -0
- data/lib/pinterest_sdk/models/schedule_audience_multipliers.rb +169 -0
- data/lib/pinterest_sdk/models/schedule_batch_update.rb +354 -0
- data/lib/pinterest_sdk/models/schedule_bid_multipliers.rb +186 -0
- data/lib/pinterest_sdk/models/schedule_bid_options.rb +188 -0
- data/lib/pinterest_sdk/models/schedule_bid_options_gender_multipliers.rb +170 -0
- data/lib/pinterest_sdk/models/schedule_bid_options_placement_multipliers.rb +169 -0
- data/lib/pinterest_sdk/models/schedule_common_delta_value.rb +104 -0
- data/lib/pinterest_sdk/models/schedule_create.rb +278 -0
- data/lib/pinterest_sdk/models/schedule_create_request.rb +408 -0
- data/lib/pinterest_sdk/models/schedule_create_request_all_of1.rb +202 -0
- data/lib/pinterest_sdk/models/schedule_delta_value.rb +104 -0
- data/lib/pinterest_sdk/models/schedule_gender_multipliers.rb +170 -0
- data/lib/pinterest_sdk/models/schedule_placement_multipliers.rb +169 -0
- data/lib/pinterest_sdk/models/schedule_status.rb +45 -0
- data/lib/pinterest_sdk/models/schedule_type.rb +40 -0
- data/lib/pinterest_sdk/models/schedule_update_request.rb +292 -0
- data/lib/pinterest_sdk/models/schedule_update_request_all_of1.rb +205 -0
- data/lib/pinterest_sdk/models/schedules_create200_response_inner.rb +164 -0
- data/lib/pinterest_sdk/models/schedules_create200_response_inner_data.rb +105 -0
- data/lib/pinterest_sdk/models/schedules_create200_response_inner_data_one_of.rb +248 -0
- data/lib/pinterest_sdk/models/schedules_list200_response.rb +176 -0
- data/lib/pinterest_sdk/models/scrollup_goal_metadata.rb +165 -0
- data/lib/pinterest_sdk/models/search_partner_pins200_response.rb +176 -0
- data/lib/pinterest_sdk/models/shared_audience_account.rb +279 -0
- data/lib/pinterest_sdk/models/shared_audiences_for_business_list200_response.rb +176 -0
- data/lib/pinterest_sdk/models/single_interest_targeting_option.rb +255 -0
- data/lib/pinterest_sdk/models/source_platform_options.rb +47 -0
- data/lib/pinterest_sdk/models/ssio_account.rb +201 -0
- data/lib/pinterest_sdk/models/ssio_account_address.rb +179 -0
- data/lib/pinterest_sdk/models/ssio_account_item.rb +231 -0
- data/lib/pinterest_sdk/models/ssio_account_pmp_name.rb +159 -0
- data/lib/pinterest_sdk/models/ssio_insertion_order.rb +149 -0
- data/lib/pinterest_sdk/models/ssio_insertion_order_create.rb +684 -0
- data/lib/pinterest_sdk/models/ssio_insertion_order_status.rb +170 -0
- data/lib/pinterest_sdk/models/ssio_insertion_order_status_response.rb +177 -0
- data/lib/pinterest_sdk/models/ssio_insertion_order_update.rb +341 -0
- data/lib/pinterest_sdk/models/ssio_insertion_orders_status_get_by_ad_account200_response.rb +176 -0
- data/lib/pinterest_sdk/models/ssio_order_line.rb +435 -0
- data/lib/pinterest_sdk/models/ssio_order_line_type.rb +40 -0
- data/lib/pinterest_sdk/models/ssio_order_lines_get_by_ad_account200_response.rb +176 -0
- data/lib/pinterest_sdk/models/standard_pin_metric_types.rb +47 -0
- data/lib/pinterest_sdk/models/store_metadata.rb +233 -0
- data/lib/pinterest_sdk/models/summary_pin.rb +285 -0
- data/lib/pinterest_sdk/models/summary_status.rb +46 -0
- data/lib/pinterest_sdk/models/supplemental_item_batch_operation_status.rb +41 -0
- data/lib/pinterest_sdk/models/supplemental_item_processing_status.rb +41 -0
- data/lib/pinterest_sdk/models/supplemental_item_validation_event.rb +220 -0
- data/lib/pinterest_sdk/models/supplemental_items_batch_response.rb +281 -0
- data/lib/pinterest_sdk/models/supplemental_operation_result.rb +301 -0
- data/lib/pinterest_sdk/models/system_user_update_with_required_body.rb +166 -0
- data/lib/pinterest_sdk/models/targeting_advertiser_country.rb +76 -0
- data/lib/pinterest_sdk/models/targeting_spec.rb +388 -0
- data/lib/pinterest_sdk/models/targeting_spec_age_bucket.rb +48 -0
- data/lib/pinterest_sdk/models/targeting_spec_app_type.rb +44 -0
- data/lib/pinterest_sdk/models/targeting_spec_gender.rb +41 -0
- data/lib/pinterest_sdk/models/targeting_spec_list_operation.rb +41 -0
- data/lib/pinterest_sdk/models/targeting_spec_operation_age_bucket.rb +244 -0
- data/lib/pinterest_sdk/models/targeting_spec_operation_app_type.rb +242 -0
- data/lib/pinterest_sdk/models/targeting_spec_operation_audience_exclude.rb +242 -0
- data/lib/pinterest_sdk/models/targeting_spec_operation_audience_include.rb +242 -0
- data/lib/pinterest_sdk/models/targeting_spec_operation_gender.rb +242 -0
- data/lib/pinterest_sdk/models/targeting_spec_operation_geo.rb +242 -0
- data/lib/pinterest_sdk/models/targeting_spec_operation_geo_exclude.rb +242 -0
- data/lib/pinterest_sdk/models/targeting_spec_operation_interest.rb +242 -0
- data/lib/pinterest_sdk/models/targeting_spec_operation_locale.rb +242 -0
- data/lib/pinterest_sdk/models/targeting_spec_operation_location.rb +242 -0
- data/lib/pinterest_sdk/models/targeting_spec_operation_location_exclude.rb +242 -0
- data/lib/pinterest_sdk/models/targeting_spec_operation_maximum_age.rb +245 -0
- data/lib/pinterest_sdk/models/targeting_spec_operation_minimum_age.rb +245 -0
- data/lib/pinterest_sdk/models/targeting_spec_operation_shopping_retargeting.rb +244 -0
- data/lib/pinterest_sdk/models/targeting_spec_operations.rb +79 -0
- data/lib/pinterest_sdk/models/targeting_spec_optimal.rb +365 -0
- data/lib/pinterest_sdk/models/targeting_spec_shopping_retargeting.rb +170 -0
- data/lib/pinterest_sdk/models/targeting_spec_targeting_strategy_items.rb +41 -0
- data/lib/pinterest_sdk/models/targeting_strategy.rb +41 -0
- data/lib/pinterest_sdk/models/targeting_template.rb +371 -0
- data/lib/pinterest_sdk/models/targeting_template_audience_sizing.rb +148 -0
- data/lib/pinterest_sdk/models/targeting_template_audience_sizing_reach_estimate.rb +165 -0
- data/lib/pinterest_sdk/models/targeting_template_create.rb +259 -0
- data/lib/pinterest_sdk/models/targeting_template_keyword.rb +179 -0
- data/lib/pinterest_sdk/models/targeting_template_list200_response.rb +176 -0
- data/lib/pinterest_sdk/models/targeting_template_status.rb +40 -0
- data/lib/pinterest_sdk/models/targeting_template_update_request_read_or_update.rb +234 -0
- data/lib/pinterest_sdk/models/template_based_report.rb +240 -0
- data/lib/pinterest_sdk/models/template_based_report_create.rb +205 -0
- data/lib/pinterest_sdk/models/templates_list200_response.rb +176 -0
- data/lib/pinterest_sdk/models/terms_of_service.rb +180 -0
- data/lib/pinterest_sdk/models/tie_breaker_type.rb +40 -0
- data/lib/pinterest_sdk/models/time_series.rb +147 -0
- data/lib/pinterest_sdk/models/title_keywords_filter.rb +164 -0
- data/lib/pinterest_sdk/models/token_grant_type.rb +41 -0
- data/lib/pinterest_sdk/models/token_type_hint.rb +40 -0
- data/lib/pinterest_sdk/models/top_pins_analytics_response.rb +189 -0
- data/lib/pinterest_sdk/models/top_pins_analytics_response_date_availability.rb +156 -0
- data/lib/pinterest_sdk/models/top_pins_analytics_response_pins_items.rb +171 -0
- data/lib/pinterest_sdk/models/top_pins_sort_by.rb +43 -0
- data/lib/pinterest_sdk/models/top_video_pins_analytics_response.rb +189 -0
- data/lib/pinterest_sdk/models/top_video_pins_analytics_response_date_availability.rb +156 -0
- data/lib/pinterest_sdk/models/top_video_pins_analytics_response_pins_items.rb +171 -0
- data/lib/pinterest_sdk/models/top_video_pins_sort_by.rb +47 -0
- data/lib/pinterest_sdk/models/total_count_by_entity_status.rb +169 -0
- data/lib/pinterest_sdk/models/tracking_urls.rb +52 -198
- data/lib/pinterest_sdk/models/trend_type.rb +42 -0
- data/lib/pinterest_sdk/models/trending_keyword.rb +237 -0
- data/lib/pinterest_sdk/models/trending_keyword_demographics.rb +159 -0
- data/lib/pinterest_sdk/models/trending_keywords_response.rb +150 -0
- data/lib/pinterest_sdk/models/trending_pin.rb +284 -0
- data/lib/pinterest_sdk/models/trending_product_category.rb +308 -0
- data/lib/pinterest_sdk/models/trending_topic.rb +355 -0
- data/lib/pinterest_sdk/models/trends_age_bucket.rb +45 -0
- data/lib/pinterest_sdk/models/trends_age_distribution.rb +170 -0
- data/lib/pinterest_sdk/models/trends_editorial.rb +307 -0
- data/lib/pinterest_sdk/models/trends_gender.rb +41 -0
- data/lib/pinterest_sdk/models/trends_gender_distribution.rb +170 -0
- data/lib/pinterest_sdk/models/trends_gender_filter.rb +41 -0
- data/lib/pinterest_sdk/models/trends_l1_interest.rb +62 -0
- data/lib/pinterest_sdk/models/trends_supported_region.rb +56 -0
- data/lib/pinterest_sdk/models/updatable_item_attributes.rb +2031 -0
- data/lib/pinterest_sdk/models/updatable_item_attributes_gtin.rb +105 -0
- data/lib/pinterest_sdk/models/update_business_memberships_response.rb +150 -0
- data/lib/pinterest_sdk/models/update_invites_results_response_array.rb +150 -0
- data/lib/pinterest_sdk/models/update_mask_bid_option_field.rb +41 -0
- data/lib/pinterest_sdk/models/update_mask_field_type.rb +87 -0
- data/lib/pinterest_sdk/models/update_member_asset_access_body.rb +186 -0
- data/lib/pinterest_sdk/models/update_member_asset_access_item.rb +279 -0
- data/lib/pinterest_sdk/models/update_member_asset_result_item.rb +147 -0
- data/lib/pinterest_sdk/models/update_member_assets_results_response_array.rb +150 -0
- data/lib/pinterest_sdk/models/update_partner_asset_access_body.rb +186 -0
- data/lib/pinterest_sdk/models/update_partner_asset_access_item.rb +279 -0
- data/lib/pinterest_sdk/models/update_partner_assets_result.rb +244 -0
- data/lib/pinterest_sdk/models/update_partner_assets_results_response_array.rb +150 -0
- data/lib/pinterest_sdk/models/user_account_followed_interests200_response.rb +176 -0
- data/lib/pinterest_sdk/models/user_account_type.rb +40 -0
- data/lib/pinterest_sdk/models/user_business_role_binding.rb +246 -0
- data/lib/pinterest_sdk/models/user_following_feed_type.rb +42 -0
- data/lib/pinterest_sdk/models/user_list_operation_type.rb +40 -0
- data/lib/pinterest_sdk/models/user_list_type.rb +44 -0
- data/lib/pinterest_sdk/models/user_single_asset_binding.rb +160 -0
- data/lib/pinterest_sdk/models/user_website.rb +168 -0
- data/lib/pinterest_sdk/models/user_website_create.rb +181 -0
- data/lib/pinterest_sdk/models/user_website_verification.rb +188 -0
- data/lib/pinterest_sdk/models/user_websites_get200_response.rb +176 -0
- data/lib/pinterest_sdk/models/users_for_individual_asset_response.rb +213 -0
- data/lib/pinterest_sdk/models/vertical_product_category.rb +41 -0
- data/lib/pinterest_sdk/models/video_metadata_with_item_type.rb +253 -0
- data/lib/pinterest_sdk/models/video_pin_metric_types.rb +51 -0
- data/lib/pinterest_sdk/models/website_verification_method.rb +41 -0
- data/lib/pinterest_sdk/models/workload_state.rb +43 -0
- data/lib/pinterest_sdk/version.rb +4 -4
- data/lib/pinterest_sdk.rb +1047 -42
- data/pinterest_sdk.gemspec +5 -4
- data/spec/api/ad_accounts_api_spec.rb +133 -129
- data/spec/api/ad_groups_api_spec.rb +237 -0
- data/spec/api/ads_api_spec.rb +195 -0
- data/spec/api/advanced_auction_api_spec.rb +61 -0
- data/spec/api/audience_insights_api_spec.rb +60 -0
- data/spec/api/audience_sharing_api_spec.rb +134 -0
- data/spec/api/audiences_api_spec.rb +92 -0
- data/spec/api/billing_api_spec.rb +190 -0
- data/spec/api/boards_api_spec.rb +57 -44
- data/spec/api/bulk_api_spec.rb +75 -0
- data/spec/api/business_access_assets_api_spec.rb +223 -0
- data/spec/api/business_access_invite_api_spec.rb +116 -0
- data/spec/api/business_access_relationships_api_spec.rb +167 -0
- data/spec/api/campaigns_api_spec.rb +173 -0
- data/spec/api/catalog_feeds_api_spec.rb +148 -0
- data/spec/api/catalog_items_api_spec.rb +74 -0
- data/spec/api/catalog_product_groups_api_spec.rb +176 -0
- data/spec/api/catalog_reports_api_spec.rb +76 -0
- data/spec/api/catalog_supplemental_api_spec.rb +135 -0
- data/spec/api/catalogs_api_spec.rb +30 -152
- data/spec/api/conversion_deletion_requests_api_spec.rb +89 -0
- data/spec/api/conversion_eqs_api_spec.rb +50 -0
- data/spec/api/conversion_events_api_spec.rb +49 -0
- data/spec/api/conversion_tags_api_spec.rb +101 -0
- data/spec/api/conversions_api_spec.rb +86 -0
- data/spec/api/customer_list_uploads_api_spec.rb +77 -0
- data/spec/api/customer_lists_api_spec.rb +91 -0
- data/spec/api/customer_segment_api_spec.rb +78 -0
- data/spec/api/integrations_api_spec.rb +121 -0
- data/spec/api/keywords_api_spec.rb +113 -0
- data/spec/api/labels_api_spec.rb +107 -0
- data/spec/api/lead_ads_api_spec.rb +88 -0
- data/spec/api/lead_forms_api_spec.rb +103 -0
- data/spec/api/leads_export_api_spec.rb +61 -0
- data/spec/api/media_api_spec.rb +14 -14
- data/spec/api/msot_events_api_spec.rb +48 -0
- data/spec/api/notification_api_spec.rb +47 -0
- data/spec/api/oauth_api_spec.rb +35 -6
- data/spec/api/order_lines_api_spec.rb +63 -0
- data/spec/api/pins_api_spec.rb +89 -19
- data/spec/api/product_group_promotions_api_spec.rb +114 -0
- data/spec/api/product_tags_api_spec.rb +73 -0
- data/spec/api/promotions_api_spec.rb +102 -0
- data/spec/api/resources_api_spec.rb +109 -0
- data/spec/api/schedules_api_spec.rb +79 -0
- data/spec/api/search_api_spec.rb +80 -0
- data/spec/api/targeting_template_api_spec.rb +78 -0
- data/spec/api/terms_api_spec.rb +60 -0
- data/spec/api/terms_of_service_api_spec.rb +49 -0
- data/spec/api/trends_api_spec.rb +91 -0
- data/spec/api/user_account_api_spec.rb +189 -9
- data/spec/spec_helper.rb +3 -3
- metadata +2181 -386
- data/bin/bundle +0 -114
- data/docs/AdGroupResponse.md +0 -62
- data/docs/AdGroupResponseAllOf.md +0 -48
- data/docs/AdGroupResponseAllOf1.md +0 -30
- data/docs/AdResponse.md +0 -70
- data/docs/AdResponseAllOf.md +0 -48
- data/docs/AdResponseAllOf1.md +0 -38
- data/docs/AdsAnalyticsCreateAsyncRequestAllOf.md +0 -32
- data/docs/AdsAnalyticsCreateAsyncRequestAllOf1.md +0 -22
- data/docs/AdsAnalyticsTargetingType.md +0 -15
- data/docs/AnalyticsMetricsResponseDailyMetrics.md +0 -22
- data/docs/BatchOperation.md +0 -15
- data/docs/BoardUpdate.md +0 -22
- data/docs/CampaignCommon.md +0 -34
- data/docs/CampaignResponse.md +0 -44
- data/docs/CampaignResponseAllOf.md +0 -18
- data/docs/CampaignResponseAllOf1.md +0 -24
- data/docs/CatalogsDbItem.md +0 -22
- data/docs/CatalogsFeedProcessingResultFields.md +0 -24
- data/docs/CatalogsItems.md +0 -18
- data/docs/CatalogsProductGroup.md +0 -34
- data/docs/Error.md +0 -20
- data/docs/FeedFields.md +0 -36
- data/docs/ItemBatchRecord.md +0 -20
- data/docs/MediaUploadAllOf.md +0 -24
- data/docs/MediaUploadAllOfUploadParameters.md +0 -32
- data/docs/MediaUploadDetails.md +0 -22
- data/docs/MediaUploadRequest.md +0 -18
- data/docs/OauthAccessTokenRequest.md +0 -18
- data/docs/OauthAccessTokenRequestCode.md +0 -20
- data/docs/OauthAccessTokenRequestCodeAllOf.md +0 -20
- data/docs/OauthAccessTokenRequestRefresh.md +0 -20
- data/docs/OauthAccessTokenRequestRefreshAllOf.md +0 -20
- data/docs/OauthAccessTokenResponse.md +0 -26
- data/docs/OauthAccessTokenResponseCode.md +0 -20
- data/docs/OauthAccessTokenResponseCodeAllOf.md +0 -20
- data/docs/OauthAccessTokenResponseRefresh.md +0 -15
- data/docs/Paginated.md +0 -20
- data/docs/PinMediaWithImageAllOf.md +0 -18
- data/docs/TargetingTypeFilter.md +0 -18
- data/lib/pinterest_sdk/models/ad_group_response.rb +0 -555
- data/lib/pinterest_sdk/models/ad_group_response_all_of.rb +0 -427
- data/lib/pinterest_sdk/models/ad_group_response_all_of1.rb +0 -329
- data/lib/pinterest_sdk/models/ad_response.rb +0 -640
- data/lib/pinterest_sdk/models/ad_response_all_of.rb +0 -455
- data/lib/pinterest_sdk/models/ad_response_all_of1.rb +0 -409
- data/lib/pinterest_sdk/models/ads_analytics_create_async_request_all_of.rb +0 -356
- data/lib/pinterest_sdk/models/ads_analytics_create_async_request_all_of1.rb +0 -253
- data/lib/pinterest_sdk/models/ads_analytics_targeting_type.rb +0 -48
- data/lib/pinterest_sdk/models/analytics_metrics_response_daily_metrics.rb +0 -275
- data/lib/pinterest_sdk/models/batch_operation.rb +0 -38
- data/lib/pinterest_sdk/models/board_update.rb +0 -272
- data/lib/pinterest_sdk/models/campaign_common.rb +0 -352
- data/lib/pinterest_sdk/models/campaign_response.rb +0 -435
- data/lib/pinterest_sdk/models/campaign_response_all_of.rb +0 -245
- data/lib/pinterest_sdk/models/campaign_response_all_of1.rb +0 -248
- data/lib/pinterest_sdk/models/catalogs_db_item.rb +0 -236
- data/lib/pinterest_sdk/models/catalogs_feed_processing_result_fields.rb +0 -261
- data/lib/pinterest_sdk/models/catalogs_items.rb +0 -222
- data/lib/pinterest_sdk/models/catalogs_product_group.rb +0 -345
- data/lib/pinterest_sdk/models/error.rb +0 -237
- data/lib/pinterest_sdk/models/feed_fields.rb +0 -332
- data/lib/pinterest_sdk/models/item_batch_record.rb +0 -229
- data/lib/pinterest_sdk/models/media_upload_all_of.rb +0 -247
- data/lib/pinterest_sdk/models/media_upload_all_of_upload_parameters.rb +0 -282
- data/lib/pinterest_sdk/models/media_upload_details.rb +0 -254
- data/lib/pinterest_sdk/models/media_upload_request.rb +0 -224
- data/lib/pinterest_sdk/models/oauth_access_token_request_code.rb +0 -272
- data/lib/pinterest_sdk/models/oauth_access_token_request_code_all_of.rb +0 -237
- data/lib/pinterest_sdk/models/oauth_access_token_request_refresh.rb +0 -267
- data/lib/pinterest_sdk/models/oauth_access_token_request_refresh_all_of.rb +0 -232
- data/lib/pinterest_sdk/models/oauth_access_token_response.rb +0 -316
- data/lib/pinterest_sdk/models/oauth_access_token_response_code.rb +0 -272
- data/lib/pinterest_sdk/models/oauth_access_token_response_code_all_of.rb +0 -237
- data/lib/pinterest_sdk/models/oauth_access_token_response_refresh.rb +0 -243
- data/lib/pinterest_sdk/models/paginated.rb +0 -235
- data/lib/pinterest_sdk/models/pin_media_with_image_all_of.rb +0 -220
- data/lib/pinterest_sdk/models/targeting_type_filter.rb +0 -245
- data/spec/api_client_spec.rb +0 -226
- data/spec/configuration_spec.rb +0 -42
- data/spec/models/account_spec.rb +0 -56
- data/spec/models/action_type_spec.rb +0 -28
- data/spec/models/ad_account_owner_spec.rb +0 -34
- data/spec/models/ad_account_spec.rb +0 -58
- data/spec/models/ad_group_response_all_of1_spec.rb +0 -70
- data/spec/models/ad_group_response_all_of_spec.rb +0 -132
- data/spec/models/ad_group_response_spec.rb +0 -174
- data/spec/models/ad_group_summary_status_spec.rb +0 -28
- data/spec/models/ad_response_all_of1_spec.rb +0 -102
- data/spec/models/ad_response_all_of_spec.rb +0 -128
- data/spec/models/ad_response_spec.rb +0 -202
- data/spec/models/ads_analytics_create_async_request_all_of1_spec.rb +0 -46
- data/spec/models/ads_analytics_create_async_request_all_of_spec.rb +0 -76
- data/spec/models/ads_analytics_create_async_request_spec.rb +0 -166
- data/spec/models/ads_analytics_create_async_response_spec.rb +0 -46
- data/spec/models/ads_analytics_filter_column_spec.rb +0 -28
- data/spec/models/ads_analytics_filter_operator_spec.rb +0 -28
- data/spec/models/ads_analytics_get_async_response_spec.rb +0 -46
- data/spec/models/ads_analytics_metrics_filter_spec.rb +0 -46
- data/spec/models/ads_analytics_targeting_type_spec.rb +0 -28
- data/spec/models/analytics_metrics_response_daily_metrics_spec.rb +0 -50
- data/spec/models/analytics_metrics_response_spec.rb +0 -40
- data/spec/models/availability_filter_spec.rb +0 -34
- data/spec/models/batch_operation_spec.rb +0 -28
- data/spec/models/batch_operation_status_spec.rb +0 -28
- data/spec/models/board_owner_spec.rb +0 -34
- data/spec/models/board_section_spec.rb +0 -40
- data/spec/models/board_spec.rb +0 -62
- data/spec/models/board_update_spec.rb +0 -50
- data/spec/models/brand_filter_spec.rb +0 -34
- data/spec/models/campaign_common_spec.rb +0 -82
- data/spec/models/campaign_response_all_of1_spec.rb +0 -52
- data/spec/models/campaign_response_all_of_spec.rb +0 -34
- data/spec/models/campaign_response_spec.rb +0 -112
- data/spec/models/campaign_summary_status_spec.rb +0 -28
- data/spec/models/catalogs_db_item_spec.rb +0 -46
- data/spec/models/catalogs_feed_credentials_spec.rb +0 -40
- data/spec/models/catalogs_feed_ingestion_details_spec.rb +0 -40
- data/spec/models/catalogs_feed_ingestion_errors_spec.rb +0 -62
- data/spec/models/catalogs_feed_ingestion_info_spec.rb +0 -46
- data/spec/models/catalogs_feed_processing_result_fields_spec.rb +0 -52
- data/spec/models/catalogs_feed_processing_result_spec.rb +0 -70
- data/spec/models/catalogs_feed_processing_schedule_spec.rb +0 -44
- data/spec/models/catalogs_feed_processing_status_spec.rb +0 -28
- data/spec/models/catalogs_feed_product_counts_spec.rb +0 -34
- data/spec/models/catalogs_feed_spec.rb +0 -106
- data/spec/models/catalogs_feed_validation_details_spec.rb +0 -40
- data/spec/models/catalogs_feed_validation_errors_spec.rb +0 -232
- data/spec/models/catalogs_feed_validation_warnings_spec.rb +0 -298
- data/spec/models/catalogs_feeds_create_request_spec.rb +0 -82
- data/spec/models/catalogs_feeds_update_request_spec.rb +0 -76
- data/spec/models/catalogs_format_spec.rb +0 -28
- data/spec/models/catalogs_items_batch_request_spec.rb +0 -52
- data/spec/models/catalogs_items_batch_spec.rb +0 -58
- data/spec/models/catalogs_items_spec.rb +0 -34
- data/spec/models/catalogs_product_group_create_request_spec.rb +0 -52
- data/spec/models/catalogs_product_group_currency_criteria_spec.rb +0 -40
- data/spec/models/catalogs_product_group_filter_keys_spec.rb +0 -184
- data/spec/models/catalogs_product_group_filters_all_of_spec.rb +0 -34
- data/spec/models/catalogs_product_group_filters_any_of_spec.rb +0 -34
- data/spec/models/catalogs_product_group_filters_spec.rb +0 -40
- data/spec/models/catalogs_product_group_multiple_string_criteria_spec.rb +0 -40
- data/spec/models/catalogs_product_group_multiple_string_list_criteria_spec.rb +0 -40
- data/spec/models/catalogs_product_group_pricing_criteria_spec.rb +0 -46
- data/spec/models/catalogs_product_group_spec.rb +0 -82
- data/spec/models/catalogs_product_group_status_spec.rb +0 -28
- data/spec/models/catalogs_product_group_type_spec.rb +0 -28
- data/spec/models/catalogs_product_group_update_request_spec.rb +0 -52
- data/spec/models/catalogs_status_spec.rb +0 -28
- data/spec/models/condition_filter_spec.rb +0 -34
- data/spec/models/conversion_attribution_window_days_spec.rb +0 -28
- data/spec/models/conversion_report_attribution_type_spec.rb +0 -28
- data/spec/models/conversion_report_time_type_spec.rb +0 -28
- data/spec/models/country_spec.rb +0 -28
- data/spec/models/currency_filter_spec.rb +0 -34
- data/spec/models/currency_spec.rb +0 -28
- data/spec/models/custom_label0_filter_spec.rb +0 -34
- data/spec/models/custom_label1_filter_spec.rb +0 -34
- data/spec/models/custom_label2_filter_spec.rb +0 -34
- data/spec/models/custom_label3_filter_spec.rb +0 -34
- data/spec/models/custom_label4_filter_spec.rb +0 -34
- data/spec/models/data_output_format_spec.rb +0 -28
- data/spec/models/entity_status_spec.rb +0 -28
- data/spec/models/error_spec.rb +0 -40
- data/spec/models/feed_fields_spec.rb +0 -88
- data/spec/models/gender_filter_spec.rb +0 -34
- data/spec/models/google_product_category0_filter_spec.rb +0 -34
- data/spec/models/google_product_category1_filter_spec.rb +0 -34
- data/spec/models/google_product_category2_filter_spec.rb +0 -34
- data/spec/models/google_product_category3_filter_spec.rb +0 -34
- data/spec/models/google_product_category4_filter_spec.rb +0 -34
- data/spec/models/google_product_category5_filter_spec.rb +0 -34
- data/spec/models/google_product_category6_filter_spec.rb +0 -34
- data/spec/models/granularity_spec.rb +0 -28
- data/spec/models/image_details_spec.rb +0 -46
- data/spec/models/item_attributes_spec.rb +0 -292
- data/spec/models/item_batch_record_spec.rb +0 -40
- data/spec/models/item_group_id_filter_spec.rb +0 -34
- data/spec/models/item_id_filter_spec.rb +0 -34
- data/spec/models/item_processing_record_spec.rb +0 -52
- data/spec/models/item_processing_status_spec.rb +0 -28
- data/spec/models/item_validation_event_spec.rb +0 -46
- data/spec/models/language_spec.rb +0 -28
- data/spec/models/max_price_filter_spec.rb +0 -34
- data/spec/models/media_upload_all_of_spec.rb +0 -52
- data/spec/models/media_upload_all_of_upload_parameters_spec.rb +0 -76
- data/spec/models/media_upload_details_spec.rb +0 -46
- data/spec/models/media_upload_request_spec.rb +0 -34
- data/spec/models/media_upload_spec.rb +0 -52
- data/spec/models/media_upload_status_spec.rb +0 -28
- data/spec/models/media_upload_type_spec.rb +0 -28
- data/spec/models/metrics_reporting_level_spec.rb +0 -28
- data/spec/models/min_price_filter_spec.rb +0 -34
- data/spec/models/non_nullable_catalogs_currency_spec.rb +0 -28
- data/spec/models/nullable_currency_spec.rb +0 -28
- data/spec/models/oauth_access_token_request_code_all_of_spec.rb +0 -40
- data/spec/models/oauth_access_token_request_code_spec.rb +0 -40
- data/spec/models/oauth_access_token_request_refresh_all_of_spec.rb +0 -40
- data/spec/models/oauth_access_token_request_refresh_spec.rb +0 -40
- data/spec/models/oauth_access_token_request_spec.rb +0 -38
- data/spec/models/oauth_access_token_response_code_all_of_spec.rb +0 -40
- data/spec/models/oauth_access_token_response_code_spec.rb +0 -40
- data/spec/models/oauth_access_token_response_refresh_spec.rb +0 -28
- data/spec/models/oauth_access_token_response_spec.rb +0 -62
- data/spec/models/objective_type_spec.rb +0 -28
- data/spec/models/pacing_delivery_type_spec.rb +0 -28
- data/spec/models/paginated_spec.rb +0 -40
- data/spec/models/pin_media_source_image_base64_spec.rb +0 -54
- data/spec/models/pin_media_source_image_url_spec.rb +0 -44
- data/spec/models/pin_media_source_spec.rb +0 -43
- data/spec/models/pin_media_source_video_id_spec.rb +0 -50
- data/spec/models/pin_media_spec.rb +0 -34
- data/spec/models/pin_media_with_image_all_of_spec.rb +0 -34
- data/spec/models/pin_media_with_image_spec.rb +0 -34
- data/spec/models/pin_promotion_summary_status_spec.rb +0 -28
- data/spec/models/pin_spec.rb +0 -94
- data/spec/models/placement_group_type_spec.rb +0 -28
- data/spec/models/product_availability_type_spec.rb +0 -28
- data/spec/models/product_group_summary_status_spec.rb +0 -28
- data/spec/models/product_type0_filter_spec.rb +0 -34
- data/spec/models/product_type1_filter_spec.rb +0 -34
- data/spec/models/product_type2_filter_spec.rb +0 -34
- data/spec/models/product_type3_filter_spec.rb +0 -34
- data/spec/models/product_type4_filter_spec.rb +0 -34
- data/spec/models/reporting_column_async_spec.rb +0 -28
- data/spec/models/targeting_type_filter_spec.rb +0 -34
- data/spec/models/tracking_urls_spec.rb +0 -58
|
@@ -3,10 +3,10 @@
|
|
|
3
3
|
|
|
4
4
|
#Pinterest's REST API
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 5.
|
|
7
|
-
Contact: blah@cliffano.com
|
|
6
|
+
The version of the OpenAPI document: 5.28.0
|
|
7
|
+
Contact: blah+oapicf@cliffano.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
|
|
9
|
+
Generator version: 7.24.0
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -20,49 +20,42 @@ module PinterestSdkClient
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Get ad account analytics
|
|
23
|
-
#
|
|
23
|
+
# Get analytics for the specified `ad_account_id`, filtered by the specified options. - The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via [Business Access](https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts): Admin, Analyst, Campaign Manager. - If granularity is not HOUR, you can pull data from up to 90 days before the current date in UTC time, with a maximum time range of 90 days. - If granularity is HOUR, you can pull data from up to 8 days before the current date in UTC time.
|
|
24
|
+
# @param start_date [Date] Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today.
|
|
25
|
+
# @param end_date [Date] Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date.
|
|
26
|
+
# @param columns [Array<ReportingColumnSync>] Columns to retrieve, encoded as a comma-separated string. **NOTE**: Any metrics defined as MICRO_DOLLARS returns a value based on the advertiser profile's currency field. For USD, ($1/1,000,000, or $0.000001 - one one-ten-thousandth of a cent). it's microdollars. Otherwise, it's in microunits of the advertiser's currency. For example, if the advertiser's currency is GBP (British pound sterling), all MICRO_DOLLARS fields will be in GBP microunits (1/1,000,000 British pound). If a column has no value, it may not be returned.
|
|
27
|
+
# @param granularity [Granularity] TOTAL - metrics are aggregated over the specified date range. DAY - metrics are broken down daily. HOUR - metrics are broken down hourly. WEEK - metrics are broken down weekly. MONTH - metrics are broken down monthly
|
|
24
28
|
# @param ad_account_id [String] Unique identifier of an ad account.
|
|
25
|
-
# @param start_date [Date] Metric report start date (UTC). Format: YYYY-MM-DD
|
|
26
|
-
# @param end_date [Date] Metric report end date (UTC). Format: YYYY-MM-DD
|
|
27
|
-
# @param columns [Array<String>] Columns to retrieve. **NOTE**: Any metrics defined as MICRO_DOLLARS returns a value based on the advertiser profile's currency field. For USD,($1/1,000,000, or $0.000001 - one one-ten-thousandth of a cent). it's microdollars. Otherwise, it's in microunits of the advertiser's currency.<br/>For example, if the advertiser's currency is GBP (British pound sterling), all MICRO_DOLLARS fields will be in GBP microunits (1/1,000,000 British pound).<br/>If a column has no value, it may not be returned
|
|
28
|
-
# @param granularity [Granularity] Granularity
|
|
29
29
|
# @param [Hash] opts the optional parameters
|
|
30
|
-
# @option opts [
|
|
31
|
-
# @option opts [
|
|
32
|
-
# @option opts [
|
|
30
|
+
# @option opts [Float] :click_window_days Number of days to use as the conversion attribution window for a pin click action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` days. (default to 30)
|
|
31
|
+
# @option opts [Float] :engagement_window_days Number of days to use as the conversion attribution window for an engagement action. Engagements include saves, closeups, link clicks, and carousel card swipes. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` days. **Note:** This parameter no longer returns new data. However, you can still access historic data through **Sept 30, 2027**. (default to 30)
|
|
32
|
+
# @option opts [Float] :view_window_days Number of days to use as the conversion attribution window for a view action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `1` day. (default to 1)
|
|
33
33
|
# @option opts [String] :conversion_report_time The date by which the conversion metrics returned from this endpoint will be reported. There are two dates associated with a conversion event: the date that the user interacted with the ad, and the date that the user completed a conversion event. (default to 'TIME_OF_AD_ACTION')
|
|
34
|
-
# @
|
|
35
|
-
|
|
36
|
-
|
|
34
|
+
# @option opts [ReportingTimeZone] :reporting_timezone Specify the timezone to be applied for the reporting. This feature is currently in BETA and is not available to all users.
|
|
35
|
+
# @return [Array<AdAccountAnalyticsItems>]
|
|
36
|
+
def ad_account_analytics(start_date, end_date, columns, granularity, ad_account_id, opts = {})
|
|
37
|
+
data, _status_code, _headers = ad_account_analytics_with_http_info(start_date, end_date, columns, granularity, ad_account_id, opts)
|
|
37
38
|
data
|
|
38
39
|
end
|
|
39
40
|
|
|
40
41
|
# Get ad account analytics
|
|
41
|
-
#
|
|
42
|
+
# Get analytics for the specified `ad_account_id`, filtered by the specified options. - The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via [Business Access](https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts): Admin, Analyst, Campaign Manager. - If granularity is not HOUR, you can pull data from up to 90 days before the current date in UTC time, with a maximum time range of 90 days. - If granularity is HOUR, you can pull data from up to 8 days before the current date in UTC time.
|
|
43
|
+
# @param start_date [Date] Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today.
|
|
44
|
+
# @param end_date [Date] Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date.
|
|
45
|
+
# @param columns [Array<ReportingColumnSync>] Columns to retrieve, encoded as a comma-separated string. **NOTE**: Any metrics defined as MICRO_DOLLARS returns a value based on the advertiser profile's currency field. For USD, ($1/1,000,000, or $0.000001 - one one-ten-thousandth of a cent). it's microdollars. Otherwise, it's in microunits of the advertiser's currency. For example, if the advertiser's currency is GBP (British pound sterling), all MICRO_DOLLARS fields will be in GBP microunits (1/1,000,000 British pound). If a column has no value, it may not be returned.
|
|
46
|
+
# @param granularity [Granularity] TOTAL - metrics are aggregated over the specified date range. DAY - metrics are broken down daily. HOUR - metrics are broken down hourly. WEEK - metrics are broken down weekly. MONTH - metrics are broken down monthly
|
|
42
47
|
# @param ad_account_id [String] Unique identifier of an ad account.
|
|
43
|
-
# @param start_date [Date] Metric report start date (UTC). Format: YYYY-MM-DD
|
|
44
|
-
# @param end_date [Date] Metric report end date (UTC). Format: YYYY-MM-DD
|
|
45
|
-
# @param columns [Array<String>] Columns to retrieve. **NOTE**: Any metrics defined as MICRO_DOLLARS returns a value based on the advertiser profile's currency field. For USD,($1/1,000,000, or $0.000001 - one one-ten-thousandth of a cent). it's microdollars. Otherwise, it's in microunits of the advertiser's currency.<br/>For example, if the advertiser's currency is GBP (British pound sterling), all MICRO_DOLLARS fields will be in GBP microunits (1/1,000,000 British pound).<br/>If a column has no value, it may not be returned
|
|
46
|
-
# @param granularity [Granularity] Granularity
|
|
47
48
|
# @param [Hash] opts the optional parameters
|
|
48
|
-
# @option opts [
|
|
49
|
-
# @option opts [
|
|
50
|
-
# @option opts [
|
|
51
|
-
# @option opts [String] :conversion_report_time The date by which the conversion metrics returned from this endpoint will be reported. There are two dates associated with a conversion event: the date that the user interacted with the ad, and the date that the user completed a conversion event.
|
|
52
|
-
# @
|
|
53
|
-
|
|
49
|
+
# @option opts [Float] :click_window_days Number of days to use as the conversion attribution window for a pin click action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` days. (default to 30)
|
|
50
|
+
# @option opts [Float] :engagement_window_days Number of days to use as the conversion attribution window for an engagement action. Engagements include saves, closeups, link clicks, and carousel card swipes. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` days. **Note:** This parameter no longer returns new data. However, you can still access historic data through **Sept 30, 2027**. (default to 30)
|
|
51
|
+
# @option opts [Float] :view_window_days Number of days to use as the conversion attribution window for a view action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `1` day. (default to 1)
|
|
52
|
+
# @option opts [String] :conversion_report_time The date by which the conversion metrics returned from this endpoint will be reported. There are two dates associated with a conversion event: the date that the user interacted with the ad, and the date that the user completed a conversion event. (default to 'TIME_OF_AD_ACTION')
|
|
53
|
+
# @option opts [ReportingTimeZone] :reporting_timezone Specify the timezone to be applied for the reporting. This feature is currently in BETA and is not available to all users.
|
|
54
|
+
# @return [Array<(Array<AdAccountAnalyticsItems>, Integer, Hash)>] Array<AdAccountAnalyticsItems> data, response status code and response headers
|
|
55
|
+
def ad_account_analytics_with_http_info(start_date, end_date, columns, granularity, ad_account_id, opts = {})
|
|
54
56
|
if @api_client.config.debugging
|
|
55
57
|
@api_client.config.logger.debug 'Calling API: AdAccountsApi.ad_account_analytics ...'
|
|
56
58
|
end
|
|
57
|
-
# verify the required parameter 'ad_account_id' is set
|
|
58
|
-
if @api_client.config.client_side_validation && ad_account_id.nil?
|
|
59
|
-
fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling AdAccountsApi.ad_account_analytics"
|
|
60
|
-
end
|
|
61
|
-
pattern = Regexp.new(/^\d+$/)
|
|
62
|
-
if @api_client.config.client_side_validation && ad_account_id !~ pattern
|
|
63
|
-
fail ArgumentError, "invalid value for 'ad_account_id' when calling AdAccountsApi.ad_account_analytics, must conform to the pattern #{pattern}."
|
|
64
|
-
end
|
|
65
|
-
|
|
66
59
|
# verify the required parameter 'start_date' is set
|
|
67
60
|
if @api_client.config.client_side_validation && start_date.nil?
|
|
68
61
|
fail ArgumentError, "Missing the required parameter 'start_date' when calling AdAccountsApi.ad_account_analytics"
|
|
@@ -79,15 +72,28 @@ module PinterestSdkClient
|
|
|
79
72
|
if @api_client.config.client_side_validation && granularity.nil?
|
|
80
73
|
fail ArgumentError, "Missing the required parameter 'granularity' when calling AdAccountsApi.ad_account_analytics"
|
|
81
74
|
end
|
|
82
|
-
|
|
75
|
+
# verify the required parameter 'ad_account_id' is set
|
|
76
|
+
if @api_client.config.client_side_validation && ad_account_id.nil?
|
|
77
|
+
fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling AdAccountsApi.ad_account_analytics"
|
|
78
|
+
end
|
|
79
|
+
if @api_client.config.client_side_validation && ad_account_id.to_s.length > 18
|
|
80
|
+
fail ArgumentError, 'invalid value for "ad_account_id" when calling AdAccountsApi.ad_account_analytics, the character length must be smaller than or equal to 18.'
|
|
81
|
+
end
|
|
82
|
+
|
|
83
|
+
pattern = Regexp.new(/^\d+$/)
|
|
84
|
+
if @api_client.config.client_side_validation && ad_account_id !~ pattern
|
|
85
|
+
fail ArgumentError, "invalid value for 'ad_account_id' when calling AdAccountsApi.ad_account_analytics, must conform to the pattern #{pattern}."
|
|
86
|
+
end
|
|
87
|
+
|
|
88
|
+
allowable_values = [0, 1, 7, 14, 30, 60]
|
|
83
89
|
if @api_client.config.client_side_validation && opts[:'click_window_days'] && !allowable_values.include?(opts[:'click_window_days'])
|
|
84
90
|
fail ArgumentError, "invalid value for \"click_window_days\", must be one of #{allowable_values}"
|
|
85
91
|
end
|
|
86
|
-
allowable_values = [1, 7, 30, 60]
|
|
92
|
+
allowable_values = [0, 1, 7, 14, 30, 60]
|
|
87
93
|
if @api_client.config.client_side_validation && opts[:'engagement_window_days'] && !allowable_values.include?(opts[:'engagement_window_days'])
|
|
88
94
|
fail ArgumentError, "invalid value for \"engagement_window_days\", must be one of #{allowable_values}"
|
|
89
95
|
end
|
|
90
|
-
allowable_values = [1, 7, 30, 60]
|
|
96
|
+
allowable_values = [0, 1, 7, 14, 30, 60]
|
|
91
97
|
if @api_client.config.client_side_validation && opts[:'view_window_days'] && !allowable_values.include?(opts[:'view_window_days'])
|
|
92
98
|
fail ArgumentError, "invalid value for \"view_window_days\", must be one of #{allowable_values}"
|
|
93
99
|
end
|
|
@@ -96,7 +102,7 @@ module PinterestSdkClient
|
|
|
96
102
|
fail ArgumentError, "invalid value for \"conversion_report_time\", must be one of #{allowable_values}"
|
|
97
103
|
end
|
|
98
104
|
# resource path
|
|
99
|
-
local_var_path = '/ad_accounts/{ad_account_id}/analytics'.sub('{
|
|
105
|
+
local_var_path = '/ad_accounts/{ad_account_id}/analytics'.sub('{ad_account_id}', CGI.escape(ad_account_id.to_s))
|
|
100
106
|
|
|
101
107
|
# query parameters
|
|
102
108
|
query_params = opts[:query_params] || {}
|
|
@@ -108,11 +114,12 @@ module PinterestSdkClient
|
|
|
108
114
|
query_params[:'engagement_window_days'] = opts[:'engagement_window_days'] if !opts[:'engagement_window_days'].nil?
|
|
109
115
|
query_params[:'view_window_days'] = opts[:'view_window_days'] if !opts[:'view_window_days'].nil?
|
|
110
116
|
query_params[:'conversion_report_time'] = opts[:'conversion_report_time'] if !opts[:'conversion_report_time'].nil?
|
|
117
|
+
query_params[:'reporting_timezone'] = opts[:'reporting_timezone'] if !opts[:'reporting_timezone'].nil?
|
|
111
118
|
|
|
112
119
|
# header parameters
|
|
113
120
|
header_params = opts[:header_params] || {}
|
|
114
121
|
# HTTP header 'Accept' (if needed)
|
|
115
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
122
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
116
123
|
|
|
117
124
|
# form parameters
|
|
118
125
|
form_params = opts[:form_params] || {}
|
|
@@ -121,10 +128,10 @@ module PinterestSdkClient
|
|
|
121
128
|
post_body = opts[:debug_body]
|
|
122
129
|
|
|
123
130
|
# return_type
|
|
124
|
-
return_type = opts[:debug_return_type] || 'Array<
|
|
131
|
+
return_type = opts[:debug_return_type] || 'Array<AdAccountAnalyticsItems>'
|
|
125
132
|
|
|
126
133
|
# auth_names
|
|
127
|
-
auth_names = opts[:debug_auth_names] || ['pinterest_oauth2']
|
|
134
|
+
auth_names = opts[:debug_auth_names] || ['pinterest_oauth2', 'client_credentials']
|
|
128
135
|
|
|
129
136
|
new_options = opts.merge(
|
|
130
137
|
:operation => :"AdAccountsApi.ad_account_analytics",
|
|
@@ -143,163 +150,97 @@ module PinterestSdkClient
|
|
|
143
150
|
return data, status_code, headers
|
|
144
151
|
end
|
|
145
152
|
|
|
146
|
-
#
|
|
147
|
-
# Get
|
|
148
|
-
# @param [Hash] opts the optional parameters
|
|
149
|
-
# @option opts [String] :bookmark Cursor used to fetch the next page of items
|
|
150
|
-
# @option opts [Integer] :page_size Maximum number of items to include in a single page of the response. See documentation on <a href='/docs/api/v5/#tag/Pagination'>Pagination</a> for more information. (default to 25)
|
|
151
|
-
# @option opts [Boolean] :include_shared_accounts Include shared ad accounts (default to true)
|
|
152
|
-
# @return [Paginated]
|
|
153
|
-
def ad_accounts_list(opts = {})
|
|
154
|
-
data, _status_code, _headers = ad_accounts_list_with_http_info(opts)
|
|
155
|
-
data
|
|
156
|
-
end
|
|
157
|
-
|
|
158
|
-
# List ad accounts
|
|
159
|
-
# Get a list of the ad_accounts that the \"operation user_account\" has access to. - This includes ad_accounts they own and ad_accounts that are owned by others who have granted them <a href=\"https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts\">Business Access</a>.
|
|
160
|
-
# @param [Hash] opts the optional parameters
|
|
161
|
-
# @option opts [String] :bookmark Cursor used to fetch the next page of items
|
|
162
|
-
# @option opts [Integer] :page_size Maximum number of items to include in a single page of the response. See documentation on <a href='/docs/api/v5/#tag/Pagination'>Pagination</a> for more information.
|
|
163
|
-
# @option opts [Boolean] :include_shared_accounts Include shared ad accounts
|
|
164
|
-
# @return [Array<(Paginated, Integer, Hash)>] Paginated data, response status code and response headers
|
|
165
|
-
def ad_accounts_list_with_http_info(opts = {})
|
|
166
|
-
if @api_client.config.debugging
|
|
167
|
-
@api_client.config.logger.debug 'Calling API: AdAccountsApi.ad_accounts_list ...'
|
|
168
|
-
end
|
|
169
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
|
170
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AdAccountsApi.ad_accounts_list, must be smaller than or equal to 100.'
|
|
171
|
-
end
|
|
172
|
-
|
|
173
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
|
174
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AdAccountsApi.ad_accounts_list, must be greater than or equal to 1.'
|
|
175
|
-
end
|
|
176
|
-
|
|
177
|
-
# resource path
|
|
178
|
-
local_var_path = '/ad_accounts'
|
|
179
|
-
|
|
180
|
-
# query parameters
|
|
181
|
-
query_params = opts[:query_params] || {}
|
|
182
|
-
query_params[:'bookmark'] = opts[:'bookmark'] if !opts[:'bookmark'].nil?
|
|
183
|
-
query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
184
|
-
query_params[:'include_shared_accounts'] = opts[:'include_shared_accounts'] if !opts[:'include_shared_accounts'].nil?
|
|
185
|
-
|
|
186
|
-
# header parameters
|
|
187
|
-
header_params = opts[:header_params] || {}
|
|
188
|
-
# HTTP header 'Accept' (if needed)
|
|
189
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
190
|
-
|
|
191
|
-
# form parameters
|
|
192
|
-
form_params = opts[:form_params] || {}
|
|
193
|
-
|
|
194
|
-
# http body (model)
|
|
195
|
-
post_body = opts[:debug_body]
|
|
196
|
-
|
|
197
|
-
# return_type
|
|
198
|
-
return_type = opts[:debug_return_type] || 'Paginated'
|
|
199
|
-
|
|
200
|
-
# auth_names
|
|
201
|
-
auth_names = opts[:debug_auth_names] || ['pinterest_oauth2']
|
|
202
|
-
|
|
203
|
-
new_options = opts.merge(
|
|
204
|
-
:operation => :"AdAccountsApi.ad_accounts_list",
|
|
205
|
-
:header_params => header_params,
|
|
206
|
-
:query_params => query_params,
|
|
207
|
-
:form_params => form_params,
|
|
208
|
-
:body => post_body,
|
|
209
|
-
:auth_names => auth_names,
|
|
210
|
-
:return_type => return_type
|
|
211
|
-
)
|
|
212
|
-
|
|
213
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
214
|
-
if @api_client.config.debugging
|
|
215
|
-
@api_client.config.logger.debug "API called: AdAccountsApi#ad_accounts_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
216
|
-
end
|
|
217
|
-
return data, status_code, headers
|
|
218
|
-
end
|
|
219
|
-
|
|
220
|
-
# Get ad group analytics
|
|
221
|
-
# Get analytics for the specified ad groups in the specified <code>ad_account_id</code>, filtered by the specified options. - The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via <a href=\"https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts\">Business Access</a>: Admin, Analyst, Campaign Manager.
|
|
153
|
+
# Get targeting analytics for an ad account
|
|
154
|
+
# Get targeting analytics for an ad account. For the requested account and metrics, the response will include the requested metric information (e.g. SPEND_IN_DOLLAR) for the requested target type (e.g. \"age_bucket\") for applicable values (e.g. \"45-49\"). <p/> * The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via [Business Access](https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts): Admin, Analyst, Campaign Manager. * If granularity is not HOUR, you can pull data from up to 90 days before the current date in UTC time, with a maximum time range of 90 days. * If granularity is HOUR, you can pull data from up to 8 days before the current date in UTC time, with a maximum time range of 3 days.
|
|
222
155
|
# @param ad_account_id [String] Unique identifier of an ad account.
|
|
223
|
-
# @param start_date [Date] Metric report start date (UTC). Format: YYYY-MM-DD
|
|
224
|
-
# @param end_date [Date] Metric report end date (UTC). Format: YYYY-MM-DD
|
|
225
|
-
# @param
|
|
226
|
-
# @param columns [Array<
|
|
227
|
-
# @param granularity [Granularity]
|
|
156
|
+
# @param start_date [Date] Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today.
|
|
157
|
+
# @param end_date [Date] Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date.
|
|
158
|
+
# @param targeting_types [Array<AdsAnalyticsAccountTargetingType>] Targeting type breakdowns for the report. The reporting per targeting type is independent from each other. [\"AGE_BUCKET_AND_GENDER\"] is in BETA and not yet available to all users.
|
|
159
|
+
# @param columns [Array<ReportingColumnSync>] Columns to retrieve, encoded as a comma-separated string. **NOTE**: Any metrics defined as MICRO_DOLLARS returns a value based on the advertiser profile's currency field. For USD, ($1/1,000,000, or $0.000001 - one one-ten-thousandth of a cent). it's microdollars. Otherwise, it's in microunits of the advertiser's currency. For example, if the advertiser's currency is GBP (British pound sterling), all MICRO_DOLLARS fields will be in GBP microunits (1/1,000,000 British pound). If a column has no value, it may not be returned.
|
|
160
|
+
# @param granularity [Granularity] TOTAL - metrics are aggregated over the specified date range. DAY - metrics are broken down daily. HOUR - metrics are broken down hourly. WEEK - metrics are broken down weekly. MONTH - metrics are broken down monthly
|
|
228
161
|
# @param [Hash] opts the optional parameters
|
|
229
|
-
# @option opts [
|
|
230
|
-
# @option opts [
|
|
231
|
-
# @option opts [
|
|
162
|
+
# @option opts [Float] :click_window_days Number of days to use as the conversion attribution window for a pin click action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` days. (default to 30)
|
|
163
|
+
# @option opts [Float] :engagement_window_days Number of days to use as the conversion attribution window for an engagement action. Engagements include saves, closeups, link clicks, and carousel card swipes. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` days. **Note:** This parameter no longer returns new data. However, you can still access historic data through **Sept 30, 2027**. (default to 30)
|
|
164
|
+
# @option opts [Float] :view_window_days Number of days to use as the conversion attribution window for a view action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `1` day. (default to 1)
|
|
232
165
|
# @option opts [String] :conversion_report_time The date by which the conversion metrics returned from this endpoint will be reported. There are two dates associated with a conversion event: the date that the user interacted with the ad, and the date that the user completed a conversion event. (default to 'TIME_OF_AD_ACTION')
|
|
233
|
-
# @
|
|
234
|
-
|
|
235
|
-
|
|
166
|
+
# @option opts [Array<ConversionReportAttributionType>] :attribution_types List of types of attribution for the conversion report
|
|
167
|
+
# @option opts [ReportingTimeZone] :reporting_timezone Specify the timezone to be applied for the reporting. This feature is currently in BETA and is not available to all users.
|
|
168
|
+
# @return [MetricsResponse]
|
|
169
|
+
def ad_account_targeting_analytics_get(ad_account_id, start_date, end_date, targeting_types, columns, granularity, opts = {})
|
|
170
|
+
data, _status_code, _headers = ad_account_targeting_analytics_get_with_http_info(ad_account_id, start_date, end_date, targeting_types, columns, granularity, opts)
|
|
236
171
|
data
|
|
237
172
|
end
|
|
238
173
|
|
|
239
|
-
# Get ad
|
|
240
|
-
# Get analytics for the
|
|
174
|
+
# Get targeting analytics for an ad account
|
|
175
|
+
# Get targeting analytics for an ad account. For the requested account and metrics, the response will include the requested metric information (e.g. SPEND_IN_DOLLAR) for the requested target type (e.g. \"age_bucket\") for applicable values (e.g. \"45-49\"). <p/> * The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via [Business Access](https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts): Admin, Analyst, Campaign Manager. * If granularity is not HOUR, you can pull data from up to 90 days before the current date in UTC time, with a maximum time range of 90 days. * If granularity is HOUR, you can pull data from up to 8 days before the current date in UTC time, with a maximum time range of 3 days.
|
|
241
176
|
# @param ad_account_id [String] Unique identifier of an ad account.
|
|
242
|
-
# @param start_date [Date] Metric report start date (UTC). Format: YYYY-MM-DD
|
|
243
|
-
# @param end_date [Date] Metric report end date (UTC). Format: YYYY-MM-DD
|
|
244
|
-
# @param
|
|
245
|
-
# @param columns [Array<
|
|
246
|
-
# @param granularity [Granularity]
|
|
177
|
+
# @param start_date [Date] Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today.
|
|
178
|
+
# @param end_date [Date] Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date.
|
|
179
|
+
# @param targeting_types [Array<AdsAnalyticsAccountTargetingType>] Targeting type breakdowns for the report. The reporting per targeting type is independent from each other. [\"AGE_BUCKET_AND_GENDER\"] is in BETA and not yet available to all users.
|
|
180
|
+
# @param columns [Array<ReportingColumnSync>] Columns to retrieve, encoded as a comma-separated string. **NOTE**: Any metrics defined as MICRO_DOLLARS returns a value based on the advertiser profile's currency field. For USD, ($1/1,000,000, or $0.000001 - one one-ten-thousandth of a cent). it's microdollars. Otherwise, it's in microunits of the advertiser's currency. For example, if the advertiser's currency is GBP (British pound sterling), all MICRO_DOLLARS fields will be in GBP microunits (1/1,000,000 British pound). If a column has no value, it may not be returned.
|
|
181
|
+
# @param granularity [Granularity] TOTAL - metrics are aggregated over the specified date range. DAY - metrics are broken down daily. HOUR - metrics are broken down hourly. WEEK - metrics are broken down weekly. MONTH - metrics are broken down monthly
|
|
247
182
|
# @param [Hash] opts the optional parameters
|
|
248
|
-
# @option opts [
|
|
249
|
-
# @option opts [
|
|
250
|
-
# @option opts [
|
|
251
|
-
# @option opts [String] :conversion_report_time The date by which the conversion metrics returned from this endpoint will be reported. There are two dates associated with a conversion event: the date that the user interacted with the ad, and the date that the user completed a conversion event.
|
|
252
|
-
# @
|
|
253
|
-
|
|
183
|
+
# @option opts [Float] :click_window_days Number of days to use as the conversion attribution window for a pin click action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` days. (default to 30)
|
|
184
|
+
# @option opts [Float] :engagement_window_days Number of days to use as the conversion attribution window for an engagement action. Engagements include saves, closeups, link clicks, and carousel card swipes. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` days. **Note:** This parameter no longer returns new data. However, you can still access historic data through **Sept 30, 2027**. (default to 30)
|
|
185
|
+
# @option opts [Float] :view_window_days Number of days to use as the conversion attribution window for a view action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `1` day. (default to 1)
|
|
186
|
+
# @option opts [String] :conversion_report_time The date by which the conversion metrics returned from this endpoint will be reported. There are two dates associated with a conversion event: the date that the user interacted with the ad, and the date that the user completed a conversion event. (default to 'TIME_OF_AD_ACTION')
|
|
187
|
+
# @option opts [Array<ConversionReportAttributionType>] :attribution_types List of types of attribution for the conversion report
|
|
188
|
+
# @option opts [ReportingTimeZone] :reporting_timezone Specify the timezone to be applied for the reporting. This feature is currently in BETA and is not available to all users.
|
|
189
|
+
# @return [Array<(MetricsResponse, Integer, Hash)>] MetricsResponse data, response status code and response headers
|
|
190
|
+
def ad_account_targeting_analytics_get_with_http_info(ad_account_id, start_date, end_date, targeting_types, columns, granularity, opts = {})
|
|
254
191
|
if @api_client.config.debugging
|
|
255
|
-
@api_client.config.logger.debug 'Calling API: AdAccountsApi.
|
|
192
|
+
@api_client.config.logger.debug 'Calling API: AdAccountsApi.ad_account_targeting_analytics_get ...'
|
|
256
193
|
end
|
|
257
194
|
# verify the required parameter 'ad_account_id' is set
|
|
258
195
|
if @api_client.config.client_side_validation && ad_account_id.nil?
|
|
259
|
-
fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling AdAccountsApi.
|
|
196
|
+
fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling AdAccountsApi.ad_account_targeting_analytics_get"
|
|
260
197
|
end
|
|
198
|
+
if @api_client.config.client_side_validation && ad_account_id.to_s.length > 18
|
|
199
|
+
fail ArgumentError, 'invalid value for "ad_account_id" when calling AdAccountsApi.ad_account_targeting_analytics_get, the character length must be smaller than or equal to 18.'
|
|
200
|
+
end
|
|
201
|
+
|
|
261
202
|
pattern = Regexp.new(/^\d+$/)
|
|
262
203
|
if @api_client.config.client_side_validation && ad_account_id !~ pattern
|
|
263
|
-
fail ArgumentError, "invalid value for 'ad_account_id' when calling AdAccountsApi.
|
|
204
|
+
fail ArgumentError, "invalid value for 'ad_account_id' when calling AdAccountsApi.ad_account_targeting_analytics_get, must conform to the pattern #{pattern}."
|
|
264
205
|
end
|
|
265
206
|
|
|
266
207
|
# verify the required parameter 'start_date' is set
|
|
267
208
|
if @api_client.config.client_side_validation && start_date.nil?
|
|
268
|
-
fail ArgumentError, "Missing the required parameter 'start_date' when calling AdAccountsApi.
|
|
209
|
+
fail ArgumentError, "Missing the required parameter 'start_date' when calling AdAccountsApi.ad_account_targeting_analytics_get"
|
|
269
210
|
end
|
|
270
211
|
# verify the required parameter 'end_date' is set
|
|
271
212
|
if @api_client.config.client_side_validation && end_date.nil?
|
|
272
|
-
fail ArgumentError, "Missing the required parameter 'end_date' when calling AdAccountsApi.
|
|
213
|
+
fail ArgumentError, "Missing the required parameter 'end_date' when calling AdAccountsApi.ad_account_targeting_analytics_get"
|
|
273
214
|
end
|
|
274
|
-
# verify the required parameter '
|
|
275
|
-
if @api_client.config.client_side_validation &&
|
|
276
|
-
fail ArgumentError, "Missing the required parameter '
|
|
215
|
+
# verify the required parameter 'targeting_types' is set
|
|
216
|
+
if @api_client.config.client_side_validation && targeting_types.nil?
|
|
217
|
+
fail ArgumentError, "Missing the required parameter 'targeting_types' when calling AdAccountsApi.ad_account_targeting_analytics_get"
|
|
277
218
|
end
|
|
278
|
-
if @api_client.config.client_side_validation &&
|
|
279
|
-
fail ArgumentError, 'invalid value for "
|
|
219
|
+
if @api_client.config.client_side_validation && targeting_types.length > 15
|
|
220
|
+
fail ArgumentError, 'invalid value for "targeting_types" when calling AdAccountsApi.ad_account_targeting_analytics_get, number of items must be less than or equal to 15.'
|
|
280
221
|
end
|
|
281
222
|
|
|
282
|
-
if @api_client.config.client_side_validation &&
|
|
283
|
-
fail ArgumentError, 'invalid value for "
|
|
223
|
+
if @api_client.config.client_side_validation && targeting_types.length < 1
|
|
224
|
+
fail ArgumentError, 'invalid value for "targeting_types" when calling AdAccountsApi.ad_account_targeting_analytics_get, number of items must be greater than or equal to 1.'
|
|
284
225
|
end
|
|
285
226
|
|
|
286
227
|
# verify the required parameter 'columns' is set
|
|
287
228
|
if @api_client.config.client_side_validation && columns.nil?
|
|
288
|
-
fail ArgumentError, "Missing the required parameter 'columns' when calling AdAccountsApi.
|
|
229
|
+
fail ArgumentError, "Missing the required parameter 'columns' when calling AdAccountsApi.ad_account_targeting_analytics_get"
|
|
289
230
|
end
|
|
290
231
|
# verify the required parameter 'granularity' is set
|
|
291
232
|
if @api_client.config.client_side_validation && granularity.nil?
|
|
292
|
-
fail ArgumentError, "Missing the required parameter 'granularity' when calling AdAccountsApi.
|
|
233
|
+
fail ArgumentError, "Missing the required parameter 'granularity' when calling AdAccountsApi.ad_account_targeting_analytics_get"
|
|
293
234
|
end
|
|
294
|
-
allowable_values = [1, 7, 30, 60]
|
|
235
|
+
allowable_values = [0, 1, 7, 14, 30, 60]
|
|
295
236
|
if @api_client.config.client_side_validation && opts[:'click_window_days'] && !allowable_values.include?(opts[:'click_window_days'])
|
|
296
237
|
fail ArgumentError, "invalid value for \"click_window_days\", must be one of #{allowable_values}"
|
|
297
238
|
end
|
|
298
|
-
allowable_values = [1, 7, 30, 60]
|
|
239
|
+
allowable_values = [0, 1, 7, 14, 30, 60]
|
|
299
240
|
if @api_client.config.client_side_validation && opts[:'engagement_window_days'] && !allowable_values.include?(opts[:'engagement_window_days'])
|
|
300
241
|
fail ArgumentError, "invalid value for \"engagement_window_days\", must be one of #{allowable_values}"
|
|
301
242
|
end
|
|
302
|
-
allowable_values = [1, 7, 30, 60]
|
|
243
|
+
allowable_values = [0, 1, 7, 14, 30, 60]
|
|
303
244
|
if @api_client.config.client_side_validation && opts[:'view_window_days'] && !allowable_values.include?(opts[:'view_window_days'])
|
|
304
245
|
fail ArgumentError, "invalid value for \"view_window_days\", must be one of #{allowable_values}"
|
|
305
246
|
end
|
|
@@ -307,25 +248,31 @@ module PinterestSdkClient
|
|
|
307
248
|
if @api_client.config.client_side_validation && opts[:'conversion_report_time'] && !allowable_values.include?(opts[:'conversion_report_time'])
|
|
308
249
|
fail ArgumentError, "invalid value for \"conversion_report_time\", must be one of #{allowable_values}"
|
|
309
250
|
end
|
|
251
|
+
if @api_client.config.client_side_validation && !opts[:'attribution_types'].nil? && opts[:'attribution_types'].length > 2
|
|
252
|
+
fail ArgumentError, 'invalid value for "opts[:"attribution_types"]" when calling AdAccountsApi.ad_account_targeting_analytics_get, number of items must be less than or equal to 2.'
|
|
253
|
+
end
|
|
254
|
+
|
|
310
255
|
# resource path
|
|
311
|
-
local_var_path = '/ad_accounts/{ad_account_id}/
|
|
256
|
+
local_var_path = '/ad_accounts/{ad_account_id}/targeting_analytics'.sub('{ad_account_id}', CGI.escape(ad_account_id.to_s))
|
|
312
257
|
|
|
313
258
|
# query parameters
|
|
314
259
|
query_params = opts[:query_params] || {}
|
|
315
260
|
query_params[:'start_date'] = start_date
|
|
316
261
|
query_params[:'end_date'] = end_date
|
|
317
|
-
query_params[:'
|
|
262
|
+
query_params[:'targeting_types'] = @api_client.build_collection_param(targeting_types, :csv)
|
|
318
263
|
query_params[:'columns'] = @api_client.build_collection_param(columns, :csv)
|
|
319
264
|
query_params[:'granularity'] = granularity
|
|
320
265
|
query_params[:'click_window_days'] = opts[:'click_window_days'] if !opts[:'click_window_days'].nil?
|
|
321
266
|
query_params[:'engagement_window_days'] = opts[:'engagement_window_days'] if !opts[:'engagement_window_days'].nil?
|
|
322
267
|
query_params[:'view_window_days'] = opts[:'view_window_days'] if !opts[:'view_window_days'].nil?
|
|
323
268
|
query_params[:'conversion_report_time'] = opts[:'conversion_report_time'] if !opts[:'conversion_report_time'].nil?
|
|
269
|
+
query_params[:'attribution_types'] = @api_client.build_collection_param(opts[:'attribution_types'], :csv) if !opts[:'attribution_types'].nil?
|
|
270
|
+
query_params[:'reporting_timezone'] = opts[:'reporting_timezone'] if !opts[:'reporting_timezone'].nil?
|
|
324
271
|
|
|
325
272
|
# header parameters
|
|
326
273
|
header_params = opts[:header_params] || {}
|
|
327
274
|
# HTTP header 'Accept' (if needed)
|
|
328
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
275
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
329
276
|
|
|
330
277
|
# form parameters
|
|
331
278
|
form_params = opts[:form_params] || {}
|
|
@@ -334,13 +281,13 @@ module PinterestSdkClient
|
|
|
334
281
|
post_body = opts[:debug_body]
|
|
335
282
|
|
|
336
283
|
# return_type
|
|
337
|
-
return_type = opts[:debug_return_type] || '
|
|
284
|
+
return_type = opts[:debug_return_type] || 'MetricsResponse'
|
|
338
285
|
|
|
339
286
|
# auth_names
|
|
340
|
-
auth_names = opts[:debug_auth_names] || ['pinterest_oauth2']
|
|
287
|
+
auth_names = opts[:debug_auth_names] || ['pinterest_oauth2', 'client_credentials']
|
|
341
288
|
|
|
342
289
|
new_options = opts.merge(
|
|
343
|
-
:operation => :"AdAccountsApi.
|
|
290
|
+
:operation => :"AdAccountsApi.ad_account_targeting_analytics_get",
|
|
344
291
|
:header_params => header_params,
|
|
345
292
|
:query_params => query_params,
|
|
346
293
|
:form_params => form_params,
|
|
@@ -351,102 +298,121 @@ module PinterestSdkClient
|
|
|
351
298
|
|
|
352
299
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
353
300
|
if @api_client.config.debugging
|
|
354
|
-
@api_client.config.logger.debug "API called: AdAccountsApi#
|
|
301
|
+
@api_client.config.logger.debug "API called: AdAccountsApi#ad_account_targeting_analytics_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
355
302
|
end
|
|
356
303
|
return data, status_code, headers
|
|
357
304
|
end
|
|
358
305
|
|
|
359
|
-
#
|
|
360
|
-
#
|
|
361
|
-
# @param
|
|
306
|
+
# Create ad account
|
|
307
|
+
# Create a new ad account. Different ad accounts can support different currencies, payment methods, etc. An ad account is needed to create campaigns, ad groups, and ads; other accounts (your employees or partners) can be assigned business access and appropriate roles to access an ad account. You can set up up to 50 ad accounts per user. (The user must have a business account to create an ad account.) For more, see [Create an advertiser account](https://help.pinterest.com/en/business/article/create-an-advertiser-account).
|
|
308
|
+
# @param ad_account_create [AdAccountCreate]
|
|
362
309
|
# @param [Hash] opts the optional parameters
|
|
363
|
-
# @
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
# @option opts [Integer] :page_size Maximum number of items to include in a single page of the response. See documentation on <a href='/docs/api/v5/#tag/Pagination'>Pagination</a> for more information. (default to 25)
|
|
367
|
-
# @option opts [String] :order The order in which to sort the items returned: “ASCENDING” or “DESCENDING” by ID. Note that higher-value IDs are associated with more-recently added items.
|
|
368
|
-
# @option opts [String] :bookmark Cursor used to fetch the next page of items
|
|
369
|
-
# @option opts [Boolean] :translate_interests_to_names Return interests as text names (if value is true) rather than topic IDs. (default to false)
|
|
370
|
-
# @return [Paginated]
|
|
371
|
-
def ad_groups_list(ad_account_id, opts = {})
|
|
372
|
-
data, _status_code, _headers = ad_groups_list_with_http_info(ad_account_id, opts)
|
|
310
|
+
# @return [AdAccount]
|
|
311
|
+
def ad_accounts_create(ad_account_create, opts = {})
|
|
312
|
+
data, _status_code, _headers = ad_accounts_create_with_http_info(ad_account_create, opts)
|
|
373
313
|
data
|
|
374
314
|
end
|
|
375
315
|
|
|
376
|
-
#
|
|
377
|
-
#
|
|
378
|
-
# @param
|
|
316
|
+
# Create ad account
|
|
317
|
+
# Create a new ad account. Different ad accounts can support different currencies, payment methods, etc. An ad account is needed to create campaigns, ad groups, and ads; other accounts (your employees or partners) can be assigned business access and appropriate roles to access an ad account. You can set up up to 50 ad accounts per user. (The user must have a business account to create an ad account.) For more, see [Create an advertiser account](https://help.pinterest.com/en/business/article/create-an-advertiser-account).
|
|
318
|
+
# @param ad_account_create [AdAccountCreate]
|
|
379
319
|
# @param [Hash] opts the optional parameters
|
|
380
|
-
# @
|
|
381
|
-
|
|
382
|
-
# @option opts [Array<String>] :entity_statuses Entity status
|
|
383
|
-
# @option opts [Integer] :page_size Maximum number of items to include in a single page of the response. See documentation on <a href='/docs/api/v5/#tag/Pagination'>Pagination</a> for more information.
|
|
384
|
-
# @option opts [String] :order The order in which to sort the items returned: “ASCENDING” or “DESCENDING” by ID. Note that higher-value IDs are associated with more-recently added items.
|
|
385
|
-
# @option opts [String] :bookmark Cursor used to fetch the next page of items
|
|
386
|
-
# @option opts [Boolean] :translate_interests_to_names Return interests as text names (if value is true) rather than topic IDs.
|
|
387
|
-
# @return [Array<(Paginated, Integer, Hash)>] Paginated data, response status code and response headers
|
|
388
|
-
def ad_groups_list_with_http_info(ad_account_id, opts = {})
|
|
320
|
+
# @return [Array<(AdAccount, Integer, Hash)>] AdAccount data, response status code and response headers
|
|
321
|
+
def ad_accounts_create_with_http_info(ad_account_create, opts = {})
|
|
389
322
|
if @api_client.config.debugging
|
|
390
|
-
@api_client.config.logger.debug 'Calling API: AdAccountsApi.
|
|
323
|
+
@api_client.config.logger.debug 'Calling API: AdAccountsApi.ad_accounts_create ...'
|
|
391
324
|
end
|
|
392
|
-
# verify the required parameter '
|
|
393
|
-
if @api_client.config.client_side_validation &&
|
|
394
|
-
fail ArgumentError, "Missing the required parameter '
|
|
395
|
-
end
|
|
396
|
-
pattern = Regexp.new(/^\d+$/)
|
|
397
|
-
if @api_client.config.client_side_validation && ad_account_id !~ pattern
|
|
398
|
-
fail ArgumentError, "invalid value for 'ad_account_id' when calling AdAccountsApi.ad_groups_list, must conform to the pattern #{pattern}."
|
|
325
|
+
# verify the required parameter 'ad_account_create' is set
|
|
326
|
+
if @api_client.config.client_side_validation && ad_account_create.nil?
|
|
327
|
+
fail ArgumentError, "Missing the required parameter 'ad_account_create' when calling AdAccountsApi.ad_accounts_create"
|
|
399
328
|
end
|
|
329
|
+
# resource path
|
|
330
|
+
local_var_path = '/ad_accounts'
|
|
400
331
|
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
end
|
|
332
|
+
# query parameters
|
|
333
|
+
query_params = opts[:query_params] || {}
|
|
404
334
|
|
|
405
|
-
|
|
406
|
-
|
|
335
|
+
# header parameters
|
|
336
|
+
header_params = opts[:header_params] || {}
|
|
337
|
+
# HTTP header 'Accept' (if needed)
|
|
338
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
339
|
+
# HTTP header 'Content-Type'
|
|
340
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
341
|
+
if !content_type.nil?
|
|
342
|
+
header_params['Content-Type'] = content_type
|
|
407
343
|
end
|
|
408
344
|
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
345
|
+
# form parameters
|
|
346
|
+
form_params = opts[:form_params] || {}
|
|
347
|
+
|
|
348
|
+
# http body (model)
|
|
349
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(ad_account_create)
|
|
350
|
+
|
|
351
|
+
# return_type
|
|
352
|
+
return_type = opts[:debug_return_type] || 'AdAccount'
|
|
353
|
+
|
|
354
|
+
# auth_names
|
|
355
|
+
auth_names = opts[:debug_auth_names] || ['pinterest_oauth2']
|
|
356
|
+
|
|
357
|
+
new_options = opts.merge(
|
|
358
|
+
:operation => :"AdAccountsApi.ad_accounts_create",
|
|
359
|
+
:header_params => header_params,
|
|
360
|
+
:query_params => query_params,
|
|
361
|
+
:form_params => form_params,
|
|
362
|
+
:body => post_body,
|
|
363
|
+
:auth_names => auth_names,
|
|
364
|
+
:return_type => return_type
|
|
365
|
+
)
|
|
412
366
|
|
|
413
|
-
|
|
414
|
-
|
|
367
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
368
|
+
if @api_client.config.debugging
|
|
369
|
+
@api_client.config.logger.debug "API called: AdAccountsApi#ad_accounts_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
415
370
|
end
|
|
371
|
+
return data, status_code, headers
|
|
372
|
+
end
|
|
416
373
|
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
374
|
+
# Get ad account
|
|
375
|
+
# Get an ad account
|
|
376
|
+
# @param ad_account_id [String]
|
|
377
|
+
# @param [Hash] opts the optional parameters
|
|
378
|
+
# @return [AdAccount]
|
|
379
|
+
def ad_accounts_get(ad_account_id, opts = {})
|
|
380
|
+
data, _status_code, _headers = ad_accounts_get_with_http_info(ad_account_id, opts)
|
|
381
|
+
data
|
|
382
|
+
end
|
|
383
|
+
|
|
384
|
+
# Get ad account
|
|
385
|
+
# Get an ad account
|
|
386
|
+
# @param ad_account_id [String]
|
|
387
|
+
# @param [Hash] opts the optional parameters
|
|
388
|
+
# @return [Array<(AdAccount, Integer, Hash)>] AdAccount data, response status code and response headers
|
|
389
|
+
def ad_accounts_get_with_http_info(ad_account_id, opts = {})
|
|
390
|
+
if @api_client.config.debugging
|
|
391
|
+
@api_client.config.logger.debug 'Calling API: AdAccountsApi.ad_accounts_get ...'
|
|
392
|
+
end
|
|
393
|
+
# verify the required parameter 'ad_account_id' is set
|
|
394
|
+
if @api_client.config.client_side_validation && ad_account_id.nil?
|
|
395
|
+
fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling AdAccountsApi.ad_accounts_get"
|
|
420
396
|
end
|
|
421
|
-
if @api_client.config.client_side_validation &&
|
|
422
|
-
fail ArgumentError, 'invalid value for "
|
|
397
|
+
if @api_client.config.client_side_validation && ad_account_id.to_s.length > 18
|
|
398
|
+
fail ArgumentError, 'invalid value for "ad_account_id" when calling AdAccountsApi.ad_accounts_get, the character length must be smaller than or equal to 18.'
|
|
423
399
|
end
|
|
424
400
|
|
|
425
|
-
|
|
426
|
-
|
|
401
|
+
pattern = Regexp.new(/^\d+$/)
|
|
402
|
+
if @api_client.config.client_side_validation && ad_account_id !~ pattern
|
|
403
|
+
fail ArgumentError, "invalid value for 'ad_account_id' when calling AdAccountsApi.ad_accounts_get, must conform to the pattern #{pattern}."
|
|
427
404
|
end
|
|
428
405
|
|
|
429
|
-
allowable_values = ["ASCENDING", "DESCENDING"]
|
|
430
|
-
if @api_client.config.client_side_validation && opts[:'order'] && !allowable_values.include?(opts[:'order'])
|
|
431
|
-
fail ArgumentError, "invalid value for \"order\", must be one of #{allowable_values}"
|
|
432
|
-
end
|
|
433
406
|
# resource path
|
|
434
|
-
local_var_path = '/ad_accounts/{ad_account_id}
|
|
407
|
+
local_var_path = '/ad_accounts/{ad_account_id}'.sub('{ad_account_id}', CGI.escape(ad_account_id.to_s))
|
|
435
408
|
|
|
436
409
|
# query parameters
|
|
437
410
|
query_params = opts[:query_params] || {}
|
|
438
|
-
query_params[:'campaign_ids'] = @api_client.build_collection_param(opts[:'campaign_ids'], :multi) if !opts[:'campaign_ids'].nil?
|
|
439
|
-
query_params[:'ad_group_ids'] = @api_client.build_collection_param(opts[:'ad_group_ids'], :multi) if !opts[:'ad_group_ids'].nil?
|
|
440
|
-
query_params[:'entity_statuses'] = @api_client.build_collection_param(opts[:'entity_statuses'], :multi) if !opts[:'entity_statuses'].nil?
|
|
441
|
-
query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
442
|
-
query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
|
|
443
|
-
query_params[:'bookmark'] = opts[:'bookmark'] if !opts[:'bookmark'].nil?
|
|
444
|
-
query_params[:'translate_interests_to_names'] = opts[:'translate_interests_to_names'] if !opts[:'translate_interests_to_names'].nil?
|
|
445
411
|
|
|
446
412
|
# header parameters
|
|
447
413
|
header_params = opts[:header_params] || {}
|
|
448
414
|
# HTTP header 'Accept' (if needed)
|
|
449
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
415
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
450
416
|
|
|
451
417
|
# form parameters
|
|
452
418
|
form_params = opts[:form_params] || {}
|
|
@@ -455,13 +421,13 @@ module PinterestSdkClient
|
|
|
455
421
|
post_body = opts[:debug_body]
|
|
456
422
|
|
|
457
423
|
# return_type
|
|
458
|
-
return_type = opts[:debug_return_type] || '
|
|
424
|
+
return_type = opts[:debug_return_type] || 'AdAccount'
|
|
459
425
|
|
|
460
426
|
# auth_names
|
|
461
|
-
auth_names = opts[:debug_auth_names] || ['pinterest_oauth2']
|
|
427
|
+
auth_names = opts[:debug_auth_names] || ['pinterest_oauth2', 'client_credentials']
|
|
462
428
|
|
|
463
429
|
new_options = opts.merge(
|
|
464
|
-
:operation => :"AdAccountsApi.
|
|
430
|
+
:operation => :"AdAccountsApi.ad_accounts_get",
|
|
465
431
|
:header_params => header_params,
|
|
466
432
|
:query_params => query_params,
|
|
467
433
|
:form_params => form_params,
|
|
@@ -472,120 +438,55 @@ module PinterestSdkClient
|
|
|
472
438
|
|
|
473
439
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
474
440
|
if @api_client.config.debugging
|
|
475
|
-
@api_client.config.logger.debug "API called: AdAccountsApi#
|
|
441
|
+
@api_client.config.logger.debug "API called: AdAccountsApi#ad_accounts_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
476
442
|
end
|
|
477
443
|
return data, status_code, headers
|
|
478
444
|
end
|
|
479
445
|
|
|
480
|
-
#
|
|
481
|
-
# Get
|
|
482
|
-
# @param ad_account_id [String] Unique identifier of an ad account.
|
|
483
|
-
# @param start_date [Date] Metric report start date (UTC). Format: YYYY-MM-DD
|
|
484
|
-
# @param end_date [Date] Metric report end date (UTC). Format: YYYY-MM-DD
|
|
485
|
-
# @param ad_ids [Array<String>] List of Ad Ids to use to filter the results.
|
|
486
|
-
# @param columns [Array<String>] Columns to retrieve. **NOTE**: Any metrics defined as MICRO_DOLLARS returns a value based on the advertiser profile's currency field. For USD,($1/1,000,000, or $0.000001 - one one-ten-thousandth of a cent). it's microdollars. Otherwise, it's in microunits of the advertiser's currency.<br/>For example, if the advertiser's currency is GBP (British pound sterling), all MICRO_DOLLARS fields will be in GBP microunits (1/1,000,000 British pound).<br/>If a column has no value, it may not be returned
|
|
487
|
-
# @param granularity [Granularity] Granularity
|
|
446
|
+
# List ad accounts
|
|
447
|
+
# Get a list of the ad_accounts that the \"operation user_account\" has access to. - This includes ad_accounts they own and ad_accounts that are owned by others who have granted them [Business Access](https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts).
|
|
488
448
|
# @param [Hash] opts the optional parameters
|
|
489
|
-
# @option opts [
|
|
490
|
-
# @option opts [
|
|
491
|
-
# @option opts [Integer] :
|
|
492
|
-
# @
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
data, _status_code, _headers = ads_analytics_with_http_info(ad_account_id, start_date, end_date, ad_ids, columns, granularity, opts)
|
|
449
|
+
# @option opts [Boolean] :include_shared_accounts Include shared ad accounts (default to true)
|
|
450
|
+
# @option opts [String] :bookmark Cursor used to fetch the next page of items
|
|
451
|
+
# @option opts [Integer] :page_size Maximum number of items to include in a single page. See documentation on [Pagination](/docs/reference/pagination/) for more information. (default to 25)
|
|
452
|
+
# @return [AdAccountsList200Response]
|
|
453
|
+
def ad_accounts_list(opts = {})
|
|
454
|
+
data, _status_code, _headers = ad_accounts_list_with_http_info(opts)
|
|
496
455
|
data
|
|
497
456
|
end
|
|
498
457
|
|
|
499
|
-
#
|
|
500
|
-
# Get
|
|
501
|
-
# @param ad_account_id [String] Unique identifier of an ad account.
|
|
502
|
-
# @param start_date [Date] Metric report start date (UTC). Format: YYYY-MM-DD
|
|
503
|
-
# @param end_date [Date] Metric report end date (UTC). Format: YYYY-MM-DD
|
|
504
|
-
# @param ad_ids [Array<String>] List of Ad Ids to use to filter the results.
|
|
505
|
-
# @param columns [Array<String>] Columns to retrieve. **NOTE**: Any metrics defined as MICRO_DOLLARS returns a value based on the advertiser profile's currency field. For USD,($1/1,000,000, or $0.000001 - one one-ten-thousandth of a cent). it's microdollars. Otherwise, it's in microunits of the advertiser's currency.<br/>For example, if the advertiser's currency is GBP (British pound sterling), all MICRO_DOLLARS fields will be in GBP microunits (1/1,000,000 British pound).<br/>If a column has no value, it may not be returned
|
|
506
|
-
# @param granularity [Granularity] Granularity
|
|
458
|
+
# List ad accounts
|
|
459
|
+
# Get a list of the ad_accounts that the \"operation user_account\" has access to. - This includes ad_accounts they own and ad_accounts that are owned by others who have granted them [Business Access](https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts).
|
|
507
460
|
# @param [Hash] opts the optional parameters
|
|
508
|
-
# @option opts [
|
|
509
|
-
# @option opts [
|
|
510
|
-
# @option opts [Integer] :
|
|
511
|
-
# @
|
|
512
|
-
|
|
513
|
-
def ads_analytics_with_http_info(ad_account_id, start_date, end_date, ad_ids, columns, granularity, opts = {})
|
|
461
|
+
# @option opts [Boolean] :include_shared_accounts Include shared ad accounts (default to true)
|
|
462
|
+
# @option opts [String] :bookmark Cursor used to fetch the next page of items
|
|
463
|
+
# @option opts [Integer] :page_size Maximum number of items to include in a single page. See documentation on [Pagination](/docs/reference/pagination/) for more information. (default to 25)
|
|
464
|
+
# @return [Array<(AdAccountsList200Response, Integer, Hash)>] AdAccountsList200Response data, response status code and response headers
|
|
465
|
+
def ad_accounts_list_with_http_info(opts = {})
|
|
514
466
|
if @api_client.config.debugging
|
|
515
|
-
@api_client.config.logger.debug 'Calling API: AdAccountsApi.
|
|
516
|
-
end
|
|
517
|
-
# verify the required parameter 'ad_account_id' is set
|
|
518
|
-
if @api_client.config.client_side_validation && ad_account_id.nil?
|
|
519
|
-
fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling AdAccountsApi.ads_analytics"
|
|
520
|
-
end
|
|
521
|
-
pattern = Regexp.new(/^\d+$/)
|
|
522
|
-
if @api_client.config.client_side_validation && ad_account_id !~ pattern
|
|
523
|
-
fail ArgumentError, "invalid value for 'ad_account_id' when calling AdAccountsApi.ads_analytics, must conform to the pattern #{pattern}."
|
|
524
|
-
end
|
|
525
|
-
|
|
526
|
-
# verify the required parameter 'start_date' is set
|
|
527
|
-
if @api_client.config.client_side_validation && start_date.nil?
|
|
528
|
-
fail ArgumentError, "Missing the required parameter 'start_date' when calling AdAccountsApi.ads_analytics"
|
|
529
|
-
end
|
|
530
|
-
# verify the required parameter 'end_date' is set
|
|
531
|
-
if @api_client.config.client_side_validation && end_date.nil?
|
|
532
|
-
fail ArgumentError, "Missing the required parameter 'end_date' when calling AdAccountsApi.ads_analytics"
|
|
533
|
-
end
|
|
534
|
-
# verify the required parameter 'ad_ids' is set
|
|
535
|
-
if @api_client.config.client_side_validation && ad_ids.nil?
|
|
536
|
-
fail ArgumentError, "Missing the required parameter 'ad_ids' when calling AdAccountsApi.ads_analytics"
|
|
467
|
+
@api_client.config.logger.debug 'Calling API: AdAccountsApi.ad_accounts_list ...'
|
|
537
468
|
end
|
|
538
|
-
if @api_client.config.client_side_validation &&
|
|
539
|
-
fail ArgumentError, 'invalid value for "
|
|
469
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 250
|
|
470
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AdAccountsApi.ad_accounts_list, must be smaller than or equal to 250.'
|
|
540
471
|
end
|
|
541
472
|
|
|
542
|
-
if @api_client.config.client_side_validation &&
|
|
543
|
-
fail ArgumentError, 'invalid value for "
|
|
473
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
|
474
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AdAccountsApi.ad_accounts_list, must be greater than or equal to 1.'
|
|
544
475
|
end
|
|
545
476
|
|
|
546
|
-
# verify the required parameter 'columns' is set
|
|
547
|
-
if @api_client.config.client_side_validation && columns.nil?
|
|
548
|
-
fail ArgumentError, "Missing the required parameter 'columns' when calling AdAccountsApi.ads_analytics"
|
|
549
|
-
end
|
|
550
|
-
# verify the required parameter 'granularity' is set
|
|
551
|
-
if @api_client.config.client_side_validation && granularity.nil?
|
|
552
|
-
fail ArgumentError, "Missing the required parameter 'granularity' when calling AdAccountsApi.ads_analytics"
|
|
553
|
-
end
|
|
554
|
-
allowable_values = [1, 7, 30, 60]
|
|
555
|
-
if @api_client.config.client_side_validation && opts[:'click_window_days'] && !allowable_values.include?(opts[:'click_window_days'])
|
|
556
|
-
fail ArgumentError, "invalid value for \"click_window_days\", must be one of #{allowable_values}"
|
|
557
|
-
end
|
|
558
|
-
allowable_values = [1, 7, 30, 60]
|
|
559
|
-
if @api_client.config.client_side_validation && opts[:'engagement_window_days'] && !allowable_values.include?(opts[:'engagement_window_days'])
|
|
560
|
-
fail ArgumentError, "invalid value for \"engagement_window_days\", must be one of #{allowable_values}"
|
|
561
|
-
end
|
|
562
|
-
allowable_values = [1, 7, 30, 60]
|
|
563
|
-
if @api_client.config.client_side_validation && opts[:'view_window_days'] && !allowable_values.include?(opts[:'view_window_days'])
|
|
564
|
-
fail ArgumentError, "invalid value for \"view_window_days\", must be one of #{allowable_values}"
|
|
565
|
-
end
|
|
566
|
-
allowable_values = ["TIME_OF_AD_ACTION", "TIME_OF_CONVERSION"]
|
|
567
|
-
if @api_client.config.client_side_validation && opts[:'conversion_report_time'] && !allowable_values.include?(opts[:'conversion_report_time'])
|
|
568
|
-
fail ArgumentError, "invalid value for \"conversion_report_time\", must be one of #{allowable_values}"
|
|
569
|
-
end
|
|
570
477
|
# resource path
|
|
571
|
-
local_var_path = '/ad_accounts
|
|
478
|
+
local_var_path = '/ad_accounts'
|
|
572
479
|
|
|
573
480
|
# query parameters
|
|
574
481
|
query_params = opts[:query_params] || {}
|
|
575
|
-
query_params[:'
|
|
576
|
-
query_params[:'
|
|
577
|
-
query_params[:'
|
|
578
|
-
query_params[:'columns'] = @api_client.build_collection_param(columns, :csv)
|
|
579
|
-
query_params[:'granularity'] = granularity
|
|
580
|
-
query_params[:'click_window_days'] = opts[:'click_window_days'] if !opts[:'click_window_days'].nil?
|
|
581
|
-
query_params[:'engagement_window_days'] = opts[:'engagement_window_days'] if !opts[:'engagement_window_days'].nil?
|
|
582
|
-
query_params[:'view_window_days'] = opts[:'view_window_days'] if !opts[:'view_window_days'].nil?
|
|
583
|
-
query_params[:'conversion_report_time'] = opts[:'conversion_report_time'] if !opts[:'conversion_report_time'].nil?
|
|
482
|
+
query_params[:'include_shared_accounts'] = opts[:'include_shared_accounts'] if !opts[:'include_shared_accounts'].nil?
|
|
483
|
+
query_params[:'bookmark'] = opts[:'bookmark'] if !opts[:'bookmark'].nil?
|
|
484
|
+
query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
584
485
|
|
|
585
486
|
# header parameters
|
|
586
487
|
header_params = opts[:header_params] || {}
|
|
587
488
|
# HTTP header 'Accept' (if needed)
|
|
588
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
489
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
589
490
|
|
|
590
491
|
# form parameters
|
|
591
492
|
form_params = opts[:form_params] || {}
|
|
@@ -594,13 +495,13 @@ module PinterestSdkClient
|
|
|
594
495
|
post_body = opts[:debug_body]
|
|
595
496
|
|
|
596
497
|
# return_type
|
|
597
|
-
return_type = opts[:debug_return_type] || '
|
|
498
|
+
return_type = opts[:debug_return_type] || 'AdAccountsList200Response'
|
|
598
499
|
|
|
599
500
|
# auth_names
|
|
600
|
-
auth_names = opts[:debug_auth_names] || ['pinterest_oauth2']
|
|
501
|
+
auth_names = opts[:debug_auth_names] || ['pinterest_oauth2', 'client_credentials']
|
|
601
502
|
|
|
602
503
|
new_options = opts.merge(
|
|
603
|
-
:operation => :"AdAccountsApi.
|
|
504
|
+
:operation => :"AdAccountsApi.ad_accounts_list",
|
|
604
505
|
:header_params => header_params,
|
|
605
506
|
:query_params => query_params,
|
|
606
507
|
:form_params => form_params,
|
|
@@ -611,125 +512,162 @@ module PinterestSdkClient
|
|
|
611
512
|
|
|
612
513
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
613
514
|
if @api_client.config.debugging
|
|
614
|
-
@api_client.config.logger.debug "API called: AdAccountsApi#
|
|
515
|
+
@api_client.config.logger.debug "API called: AdAccountsApi#ad_accounts_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
615
516
|
end
|
|
616
517
|
return data, status_code, headers
|
|
617
518
|
end
|
|
618
519
|
|
|
619
|
-
#
|
|
620
|
-
#
|
|
520
|
+
# Create a request for a brand, category, SKU report
|
|
521
|
+
# [Restricted](/docs/getting-started/using-beta-and-restricted-features/) This creates an asynchronous brand, category, SKU report based on the given request. This request returns a token that you can use to download the report when it is ready.
|
|
621
522
|
# @param ad_account_id [String] Unique identifier of an ad account.
|
|
523
|
+
# @param conversion_product_report_create [ConversionProductReportCreate]
|
|
622
524
|
# @param [Hash] opts the optional parameters
|
|
623
|
-
# @
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
# @option opts [Array<String>] :entity_statuses Entity status
|
|
627
|
-
# @option opts [Integer] :page_size Maximum number of items to include in a single page of the response. See documentation on <a href='/docs/api/v5/#tag/Pagination'>Pagination</a> for more information. (default to 25)
|
|
628
|
-
# @option opts [String] :order The order in which to sort the items returned: “ASCENDING” or “DESCENDING” by ID. Note that higher-value IDs are associated with more-recently added items.
|
|
629
|
-
# @option opts [String] :bookmark Cursor used to fetch the next page of items
|
|
630
|
-
# @return [Paginated]
|
|
631
|
-
def ads_list(ad_account_id, opts = {})
|
|
632
|
-
data, _status_code, _headers = ads_list_with_http_info(ad_account_id, opts)
|
|
525
|
+
# @return [ConversionProductReport]
|
|
526
|
+
def analytics_create_conversion_product_report(ad_account_id, conversion_product_report_create, opts = {})
|
|
527
|
+
data, _status_code, _headers = analytics_create_conversion_product_report_with_http_info(ad_account_id, conversion_product_report_create, opts)
|
|
633
528
|
data
|
|
634
529
|
end
|
|
635
530
|
|
|
636
|
-
#
|
|
637
|
-
#
|
|
531
|
+
# Create a request for a brand, category, SKU report
|
|
532
|
+
# [Restricted](/docs/getting-started/using-beta-and-restricted-features/) This creates an asynchronous brand, category, SKU report based on the given request. This request returns a token that you can use to download the report when it is ready.
|
|
638
533
|
# @param ad_account_id [String] Unique identifier of an ad account.
|
|
534
|
+
# @param conversion_product_report_create [ConversionProductReportCreate]
|
|
639
535
|
# @param [Hash] opts the optional parameters
|
|
640
|
-
# @
|
|
641
|
-
|
|
642
|
-
# @option opts [Array<String>] :ad_ids List of Ad Ids to use to filter the results.
|
|
643
|
-
# @option opts [Array<String>] :entity_statuses Entity status
|
|
644
|
-
# @option opts [Integer] :page_size Maximum number of items to include in a single page of the response. See documentation on <a href='/docs/api/v5/#tag/Pagination'>Pagination</a> for more information.
|
|
645
|
-
# @option opts [String] :order The order in which to sort the items returned: “ASCENDING” or “DESCENDING” by ID. Note that higher-value IDs are associated with more-recently added items.
|
|
646
|
-
# @option opts [String] :bookmark Cursor used to fetch the next page of items
|
|
647
|
-
# @return [Array<(Paginated, Integer, Hash)>] Paginated data, response status code and response headers
|
|
648
|
-
def ads_list_with_http_info(ad_account_id, opts = {})
|
|
536
|
+
# @return [Array<(ConversionProductReport, Integer, Hash)>] ConversionProductReport data, response status code and response headers
|
|
537
|
+
def analytics_create_conversion_product_report_with_http_info(ad_account_id, conversion_product_report_create, opts = {})
|
|
649
538
|
if @api_client.config.debugging
|
|
650
|
-
@api_client.config.logger.debug 'Calling API: AdAccountsApi.
|
|
539
|
+
@api_client.config.logger.debug 'Calling API: AdAccountsApi.analytics_create_conversion_product_report ...'
|
|
651
540
|
end
|
|
652
541
|
# verify the required parameter 'ad_account_id' is set
|
|
653
542
|
if @api_client.config.client_side_validation && ad_account_id.nil?
|
|
654
|
-
fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling AdAccountsApi.
|
|
543
|
+
fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling AdAccountsApi.analytics_create_conversion_product_report"
|
|
655
544
|
end
|
|
545
|
+
if @api_client.config.client_side_validation && ad_account_id.to_s.length > 18
|
|
546
|
+
fail ArgumentError, 'invalid value for "ad_account_id" when calling AdAccountsApi.analytics_create_conversion_product_report, the character length must be smaller than or equal to 18.'
|
|
547
|
+
end
|
|
548
|
+
|
|
656
549
|
pattern = Regexp.new(/^\d+$/)
|
|
657
550
|
if @api_client.config.client_side_validation && ad_account_id !~ pattern
|
|
658
|
-
fail ArgumentError, "invalid value for 'ad_account_id' when calling AdAccountsApi.
|
|
551
|
+
fail ArgumentError, "invalid value for 'ad_account_id' when calling AdAccountsApi.analytics_create_conversion_product_report, must conform to the pattern #{pattern}."
|
|
659
552
|
end
|
|
660
553
|
|
|
661
|
-
|
|
662
|
-
|
|
554
|
+
# verify the required parameter 'conversion_product_report_create' is set
|
|
555
|
+
if @api_client.config.client_side_validation && conversion_product_report_create.nil?
|
|
556
|
+
fail ArgumentError, "Missing the required parameter 'conversion_product_report_create' when calling AdAccountsApi.analytics_create_conversion_product_report"
|
|
663
557
|
end
|
|
558
|
+
# resource path
|
|
559
|
+
local_var_path = '/ad_accounts/{ad_account_id}/reports/brand_category_sku'.sub('{ad_account_id}', CGI.escape(ad_account_id.to_s))
|
|
664
560
|
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
end
|
|
561
|
+
# query parameters
|
|
562
|
+
query_params = opts[:query_params] || {}
|
|
668
563
|
|
|
669
|
-
|
|
670
|
-
|
|
564
|
+
# header parameters
|
|
565
|
+
header_params = opts[:header_params] || {}
|
|
566
|
+
# HTTP header 'Accept' (if needed)
|
|
567
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
568
|
+
# HTTP header 'Content-Type'
|
|
569
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
570
|
+
if !content_type.nil?
|
|
571
|
+
header_params['Content-Type'] = content_type
|
|
671
572
|
end
|
|
672
573
|
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
end
|
|
574
|
+
# form parameters
|
|
575
|
+
form_params = opts[:form_params] || {}
|
|
676
576
|
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
end
|
|
577
|
+
# http body (model)
|
|
578
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(conversion_product_report_create)
|
|
680
579
|
|
|
681
|
-
|
|
682
|
-
|
|
580
|
+
# return_type
|
|
581
|
+
return_type = opts[:debug_return_type] || 'ConversionProductReport'
|
|
582
|
+
|
|
583
|
+
# auth_names
|
|
584
|
+
auth_names = opts[:debug_auth_names] || ['pinterest_oauth2']
|
|
585
|
+
|
|
586
|
+
new_options = opts.merge(
|
|
587
|
+
:operation => :"AdAccountsApi.analytics_create_conversion_product_report",
|
|
588
|
+
:header_params => header_params,
|
|
589
|
+
:query_params => query_params,
|
|
590
|
+
:form_params => form_params,
|
|
591
|
+
:body => post_body,
|
|
592
|
+
:auth_names => auth_names,
|
|
593
|
+
:return_type => return_type
|
|
594
|
+
)
|
|
595
|
+
|
|
596
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
597
|
+
if @api_client.config.debugging
|
|
598
|
+
@api_client.config.logger.debug "API called: AdAccountsApi#analytics_create_conversion_product_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
683
599
|
end
|
|
600
|
+
return data, status_code, headers
|
|
601
|
+
end
|
|
602
|
+
|
|
603
|
+
# Create a request for a Marketing Mix Modeling (MMM) report
|
|
604
|
+
# This creates an asynchronous mmm report based on the given request. It returns a token that you can use to download the report when it is ready. NOTE: An additional limit of 5 queries per minute per advertiser applies to this endpoint while it's in beta release. For the ADVERTISER_PAID_SPEND_IN_DOLLAR, ADVERTISER_PAID_ECPC_IN_DOLLAR, and ADVERTISER_PAID_ECPM_IN_DOLLAR columns: if you receive bonus media, this value still includes that spend, and it will need to be removed manually with support from your Pinterest account team for a fully netted value. Over time, we'll also subtract bonus media and other incentives as data becomes available. Production and other non-media fees are excluded.
|
|
605
|
+
# @param ad_account_id [String]
|
|
606
|
+
# @param mmm_report_create [MMMReportCreate]
|
|
607
|
+
# @param [Hash] opts the optional parameters
|
|
608
|
+
# @return [MMMReport]
|
|
609
|
+
def analytics_create_mmm_report(ad_account_id, mmm_report_create, opts = {})
|
|
610
|
+
data, _status_code, _headers = analytics_create_mmm_report_with_http_info(ad_account_id, mmm_report_create, opts)
|
|
611
|
+
data
|
|
612
|
+
end
|
|
684
613
|
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
614
|
+
# Create a request for a Marketing Mix Modeling (MMM) report
|
|
615
|
+
# This creates an asynchronous mmm report based on the given request. It returns a token that you can use to download the report when it is ready. NOTE: An additional limit of 5 queries per minute per advertiser applies to this endpoint while it's in beta release. For the ADVERTISER_PAID_SPEND_IN_DOLLAR, ADVERTISER_PAID_ECPC_IN_DOLLAR, and ADVERTISER_PAID_ECPM_IN_DOLLAR columns: if you receive bonus media, this value still includes that spend, and it will need to be removed manually with support from your Pinterest account team for a fully netted value. Over time, we'll also subtract bonus media and other incentives as data becomes available. Production and other non-media fees are excluded.
|
|
616
|
+
# @param ad_account_id [String]
|
|
617
|
+
# @param mmm_report_create [MMMReportCreate]
|
|
618
|
+
# @param [Hash] opts the optional parameters
|
|
619
|
+
# @return [Array<(MMMReport, Integer, Hash)>] MMMReport data, response status code and response headers
|
|
620
|
+
def analytics_create_mmm_report_with_http_info(ad_account_id, mmm_report_create, opts = {})
|
|
621
|
+
if @api_client.config.debugging
|
|
622
|
+
@api_client.config.logger.debug 'Calling API: AdAccountsApi.analytics_create_mmm_report ...'
|
|
623
|
+
end
|
|
624
|
+
# verify the required parameter 'ad_account_id' is set
|
|
625
|
+
if @api_client.config.client_side_validation && ad_account_id.nil?
|
|
626
|
+
fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling AdAccountsApi.analytics_create_mmm_report"
|
|
688
627
|
end
|
|
689
|
-
if @api_client.config.client_side_validation &&
|
|
690
|
-
fail ArgumentError, 'invalid value for "
|
|
628
|
+
if @api_client.config.client_side_validation && ad_account_id.to_s.length > 18
|
|
629
|
+
fail ArgumentError, 'invalid value for "ad_account_id" when calling AdAccountsApi.analytics_create_mmm_report, the character length must be smaller than or equal to 18.'
|
|
691
630
|
end
|
|
692
631
|
|
|
693
|
-
|
|
694
|
-
|
|
632
|
+
pattern = Regexp.new(/^\d+$/)
|
|
633
|
+
if @api_client.config.client_side_validation && ad_account_id !~ pattern
|
|
634
|
+
fail ArgumentError, "invalid value for 'ad_account_id' when calling AdAccountsApi.analytics_create_mmm_report, must conform to the pattern #{pattern}."
|
|
695
635
|
end
|
|
696
636
|
|
|
697
|
-
|
|
698
|
-
if @api_client.config.client_side_validation &&
|
|
699
|
-
fail ArgumentError, "
|
|
637
|
+
# verify the required parameter 'mmm_report_create' is set
|
|
638
|
+
if @api_client.config.client_side_validation && mmm_report_create.nil?
|
|
639
|
+
fail ArgumentError, "Missing the required parameter 'mmm_report_create' when calling AdAccountsApi.analytics_create_mmm_report"
|
|
700
640
|
end
|
|
701
641
|
# resource path
|
|
702
|
-
local_var_path = '/ad_accounts/{ad_account_id}/
|
|
642
|
+
local_var_path = '/ad_accounts/{ad_account_id}/mmm_reports'.sub('{ad_account_id}', CGI.escape(ad_account_id.to_s))
|
|
703
643
|
|
|
704
644
|
# query parameters
|
|
705
645
|
query_params = opts[:query_params] || {}
|
|
706
|
-
query_params[:'campaign_ids'] = @api_client.build_collection_param(opts[:'campaign_ids'], :multi) if !opts[:'campaign_ids'].nil?
|
|
707
|
-
query_params[:'ad_group_ids'] = @api_client.build_collection_param(opts[:'ad_group_ids'], :multi) if !opts[:'ad_group_ids'].nil?
|
|
708
|
-
query_params[:'ad_ids'] = @api_client.build_collection_param(opts[:'ad_ids'], :multi) if !opts[:'ad_ids'].nil?
|
|
709
|
-
query_params[:'entity_statuses'] = @api_client.build_collection_param(opts[:'entity_statuses'], :multi) if !opts[:'entity_statuses'].nil?
|
|
710
|
-
query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
711
|
-
query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
|
|
712
|
-
query_params[:'bookmark'] = opts[:'bookmark'] if !opts[:'bookmark'].nil?
|
|
713
646
|
|
|
714
647
|
# header parameters
|
|
715
648
|
header_params = opts[:header_params] || {}
|
|
716
649
|
# HTTP header 'Accept' (if needed)
|
|
717
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
650
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
651
|
+
# HTTP header 'Content-Type'
|
|
652
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
653
|
+
if !content_type.nil?
|
|
654
|
+
header_params['Content-Type'] = content_type
|
|
655
|
+
end
|
|
718
656
|
|
|
719
657
|
# form parameters
|
|
720
658
|
form_params = opts[:form_params] || {}
|
|
721
659
|
|
|
722
660
|
# http body (model)
|
|
723
|
-
post_body = opts[:debug_body]
|
|
661
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(mmm_report_create)
|
|
724
662
|
|
|
725
663
|
# return_type
|
|
726
|
-
return_type = opts[:debug_return_type] || '
|
|
664
|
+
return_type = opts[:debug_return_type] || 'MMMReport'
|
|
727
665
|
|
|
728
666
|
# auth_names
|
|
729
667
|
auth_names = opts[:debug_auth_names] || ['pinterest_oauth2']
|
|
730
668
|
|
|
731
669
|
new_options = opts.merge(
|
|
732
|
-
:operation => :"AdAccountsApi.
|
|
670
|
+
:operation => :"AdAccountsApi.analytics_create_mmm_report",
|
|
733
671
|
:header_params => header_params,
|
|
734
672
|
:query_params => query_params,
|
|
735
673
|
:form_params => form_params,
|
|
@@ -738,15 +676,15 @@ module PinterestSdkClient
|
|
|
738
676
|
:return_type => return_type
|
|
739
677
|
)
|
|
740
678
|
|
|
741
|
-
data, status_code, headers = @api_client.call_api(:
|
|
679
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
742
680
|
if @api_client.config.debugging
|
|
743
|
-
@api_client.config.logger.debug "API called: AdAccountsApi#
|
|
681
|
+
@api_client.config.logger.debug "API called: AdAccountsApi#analytics_create_mmm_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
744
682
|
end
|
|
745
683
|
return data, status_code, headers
|
|
746
684
|
end
|
|
747
685
|
|
|
748
686
|
# Create async request for an account analytics report
|
|
749
|
-
#
|
|
687
|
+
# This returns a token that you can use to download the report when it is ready. Note that this endpoint requires the parameters to be passed as JSON-formatted in the request body. This endpoint does not support URL query parameters. - The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via [Business Access](https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts): Admin, Analyst, Campaign Manager. - If granularity is not HOUR, you can pull data from up to 914 days before the current date in UTC time, with a maximum time range of 186 days. - If granularity is HOUR, you can pull data from up to 8 days before the current date in UTC time, with a maximum time range of 3 days. - If level is PRODUCT_ITEM, you can pull data from up to 92 days before the current date in UTC time, with a maximum time range of 31 days. - If level is PRODUCT_ITEM, ad_ids and ad_statuses parameters are not allowed. Any columns related to pin promotion and ad is not allowed either.
|
|
750
688
|
# @param ad_account_id [String] Unique identifier of an ad account.
|
|
751
689
|
# @param ads_analytics_create_async_request [AdsAnalyticsCreateAsyncRequest]
|
|
752
690
|
# @param [Hash] opts the optional parameters
|
|
@@ -757,7 +695,7 @@ module PinterestSdkClient
|
|
|
757
695
|
end
|
|
758
696
|
|
|
759
697
|
# Create async request for an account analytics report
|
|
760
|
-
#
|
|
698
|
+
# This returns a token that you can use to download the report when it is ready. Note that this endpoint requires the parameters to be passed as JSON-formatted in the request body. This endpoint does not support URL query parameters. - The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via [Business Access](https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts): Admin, Analyst, Campaign Manager. - If granularity is not HOUR, you can pull data from up to 914 days before the current date in UTC time, with a maximum time range of 186 days. - If granularity is HOUR, you can pull data from up to 8 days before the current date in UTC time, with a maximum time range of 3 days. - If level is PRODUCT_ITEM, you can pull data from up to 92 days before the current date in UTC time, with a maximum time range of 31 days. - If level is PRODUCT_ITEM, ad_ids and ad_statuses parameters are not allowed. Any columns related to pin promotion and ad is not allowed either.
|
|
761
699
|
# @param ad_account_id [String] Unique identifier of an ad account.
|
|
762
700
|
# @param ads_analytics_create_async_request [AdsAnalyticsCreateAsyncRequest]
|
|
763
701
|
# @param [Hash] opts the optional parameters
|
|
@@ -770,6 +708,10 @@ module PinterestSdkClient
|
|
|
770
708
|
if @api_client.config.client_side_validation && ad_account_id.nil?
|
|
771
709
|
fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling AdAccountsApi.analytics_create_report"
|
|
772
710
|
end
|
|
711
|
+
if @api_client.config.client_side_validation && ad_account_id.to_s.length > 18
|
|
712
|
+
fail ArgumentError, 'invalid value for "ad_account_id" when calling AdAccountsApi.analytics_create_report, the character length must be smaller than or equal to 18.'
|
|
713
|
+
end
|
|
714
|
+
|
|
773
715
|
pattern = Regexp.new(/^\d+$/)
|
|
774
716
|
if @api_client.config.client_side_validation && ad_account_id !~ pattern
|
|
775
717
|
fail ArgumentError, "invalid value for 'ad_account_id' when calling AdAccountsApi.analytics_create_report, must conform to the pattern #{pattern}."
|
|
@@ -780,7 +722,7 @@ module PinterestSdkClient
|
|
|
780
722
|
fail ArgumentError, "Missing the required parameter 'ads_analytics_create_async_request' when calling AdAccountsApi.analytics_create_report"
|
|
781
723
|
end
|
|
782
724
|
# resource path
|
|
783
|
-
local_var_path = '/ad_accounts/{ad_account_id}/reports'.sub('{
|
|
725
|
+
local_var_path = '/ad_accounts/{ad_account_id}/reports'.sub('{ad_account_id}', CGI.escape(ad_account_id.to_s))
|
|
784
726
|
|
|
785
727
|
# query parameters
|
|
786
728
|
query_params = opts[:query_params] || {}
|
|
@@ -788,7 +730,7 @@ module PinterestSdkClient
|
|
|
788
730
|
# header parameters
|
|
789
731
|
header_params = opts[:header_params] || {}
|
|
790
732
|
# HTTP header 'Accept' (if needed)
|
|
791
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
733
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
792
734
|
# HTTP header 'Content-Type'
|
|
793
735
|
content_type = @api_client.select_header_content_type(['application/json'])
|
|
794
736
|
if !content_type.nil?
|
|
@@ -824,51 +766,67 @@ module PinterestSdkClient
|
|
|
824
766
|
return data, status_code, headers
|
|
825
767
|
end
|
|
826
768
|
|
|
827
|
-
#
|
|
828
|
-
#
|
|
829
|
-
# @param ad_account_id [String]
|
|
830
|
-
# @param
|
|
769
|
+
# Create async request for an analytics report using a template
|
|
770
|
+
# This takes a template ID and an optional custom timeframe and constructs an asynchronous report based on the template. It returns a token that you can use to download the report when it is ready.
|
|
771
|
+
# @param ad_account_id [String]
|
|
772
|
+
# @param template_id [String] Unique identifier of a template.
|
|
831
773
|
# @param [Hash] opts the optional parameters
|
|
832
|
-
# @
|
|
833
|
-
|
|
834
|
-
|
|
774
|
+
# @option opts [Date] :start_date Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 2.5 years back from today.
|
|
775
|
+
# @option opts [Date] :end_date Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 2.5 years past start date.
|
|
776
|
+
# @option opts [Granularity] :granularity TOTAL - metrics are aggregated over the specified date range. DAY - metrics are broken down daily. HOUR - metrics are broken down hourly. WEEK - metrics are broken down weekly. MONTH - metrics are broken down monthly
|
|
777
|
+
# @return [TemplateBasedReport]
|
|
778
|
+
def analytics_create_template_report(ad_account_id, template_id, opts = {})
|
|
779
|
+
data, _status_code, _headers = analytics_create_template_report_with_http_info(ad_account_id, template_id, opts)
|
|
835
780
|
data
|
|
836
781
|
end
|
|
837
782
|
|
|
838
|
-
#
|
|
839
|
-
#
|
|
840
|
-
# @param ad_account_id [String]
|
|
841
|
-
# @param
|
|
783
|
+
# Create async request for an analytics report using a template
|
|
784
|
+
# This takes a template ID and an optional custom timeframe and constructs an asynchronous report based on the template. It returns a token that you can use to download the report when it is ready.
|
|
785
|
+
# @param ad_account_id [String]
|
|
786
|
+
# @param template_id [String] Unique identifier of a template.
|
|
842
787
|
# @param [Hash] opts the optional parameters
|
|
843
|
-
# @
|
|
844
|
-
|
|
788
|
+
# @option opts [Date] :start_date Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 2.5 years back from today.
|
|
789
|
+
# @option opts [Date] :end_date Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 2.5 years past start date.
|
|
790
|
+
# @option opts [Granularity] :granularity TOTAL - metrics are aggregated over the specified date range. DAY - metrics are broken down daily. HOUR - metrics are broken down hourly. WEEK - metrics are broken down weekly. MONTH - metrics are broken down monthly
|
|
791
|
+
# @return [Array<(TemplateBasedReport, Integer, Hash)>] TemplateBasedReport data, response status code and response headers
|
|
792
|
+
def analytics_create_template_report_with_http_info(ad_account_id, template_id, opts = {})
|
|
845
793
|
if @api_client.config.debugging
|
|
846
|
-
@api_client.config.logger.debug 'Calling API: AdAccountsApi.
|
|
794
|
+
@api_client.config.logger.debug 'Calling API: AdAccountsApi.analytics_create_template_report ...'
|
|
847
795
|
end
|
|
848
796
|
# verify the required parameter 'ad_account_id' is set
|
|
849
797
|
if @api_client.config.client_side_validation && ad_account_id.nil?
|
|
850
|
-
fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling AdAccountsApi.
|
|
798
|
+
fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling AdAccountsApi.analytics_create_template_report"
|
|
799
|
+
end
|
|
800
|
+
if @api_client.config.client_side_validation && ad_account_id.to_s.length > 18
|
|
801
|
+
fail ArgumentError, 'invalid value for "ad_account_id" when calling AdAccountsApi.analytics_create_template_report, the character length must be smaller than or equal to 18.'
|
|
851
802
|
end
|
|
803
|
+
|
|
852
804
|
pattern = Regexp.new(/^\d+$/)
|
|
853
805
|
if @api_client.config.client_side_validation && ad_account_id !~ pattern
|
|
854
|
-
fail ArgumentError, "invalid value for 'ad_account_id' when calling AdAccountsApi.
|
|
806
|
+
fail ArgumentError, "invalid value for 'ad_account_id' when calling AdAccountsApi.analytics_create_template_report, must conform to the pattern #{pattern}."
|
|
855
807
|
end
|
|
856
808
|
|
|
857
|
-
# verify the required parameter '
|
|
858
|
-
if @api_client.config.client_side_validation &&
|
|
859
|
-
fail ArgumentError, "Missing the required parameter '
|
|
809
|
+
# verify the required parameter 'template_id' is set
|
|
810
|
+
if @api_client.config.client_side_validation && template_id.nil?
|
|
811
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling AdAccountsApi.analytics_create_template_report"
|
|
812
|
+
end
|
|
813
|
+
if @api_client.config.client_side_validation && template_id.to_s.length > 18
|
|
814
|
+
fail ArgumentError, 'invalid value for "template_id" when calling AdAccountsApi.analytics_create_template_report, the character length must be smaller than or equal to 18.'
|
|
860
815
|
end
|
|
816
|
+
|
|
861
817
|
# resource path
|
|
862
|
-
local_var_path = '/ad_accounts/{ad_account_id}/reports'.sub('{'
|
|
818
|
+
local_var_path = '/ad_accounts/{ad_account_id}/templates/{template_id}/reports'.sub('{ad_account_id}', CGI.escape(ad_account_id.to_s)).sub('{template_id}', CGI.escape(template_id.to_s))
|
|
863
819
|
|
|
864
820
|
# query parameters
|
|
865
821
|
query_params = opts[:query_params] || {}
|
|
866
|
-
query_params[:'
|
|
822
|
+
query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
|
|
823
|
+
query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
|
|
824
|
+
query_params[:'granularity'] = opts[:'granularity'] if !opts[:'granularity'].nil?
|
|
867
825
|
|
|
868
826
|
# header parameters
|
|
869
827
|
header_params = opts[:header_params] || {}
|
|
870
828
|
# HTTP header 'Accept' (if needed)
|
|
871
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
829
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
872
830
|
|
|
873
831
|
# form parameters
|
|
874
832
|
form_params = opts[:form_params] || {}
|
|
@@ -877,13 +835,13 @@ module PinterestSdkClient
|
|
|
877
835
|
post_body = opts[:debug_body]
|
|
878
836
|
|
|
879
837
|
# return_type
|
|
880
|
-
return_type = opts[:debug_return_type] || '
|
|
838
|
+
return_type = opts[:debug_return_type] || 'TemplateBasedReport'
|
|
881
839
|
|
|
882
840
|
# auth_names
|
|
883
841
|
auth_names = opts[:debug_auth_names] || ['pinterest_oauth2']
|
|
884
842
|
|
|
885
843
|
new_options = opts.merge(
|
|
886
|
-
:operation => :"AdAccountsApi.
|
|
844
|
+
:operation => :"AdAccountsApi.analytics_create_template_report",
|
|
887
845
|
:header_params => header_params,
|
|
888
846
|
:query_params => query_params,
|
|
889
847
|
:form_params => form_params,
|
|
@@ -892,122 +850,141 @@ module PinterestSdkClient
|
|
|
892
850
|
:return_type => return_type
|
|
893
851
|
)
|
|
894
852
|
|
|
895
|
-
data, status_code, headers = @api_client.call_api(:
|
|
853
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
896
854
|
if @api_client.config.debugging
|
|
897
|
-
@api_client.config.logger.debug "API called: AdAccountsApi#
|
|
855
|
+
@api_client.config.logger.debug "API called: AdAccountsApi#analytics_create_template_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
898
856
|
end
|
|
899
857
|
return data, status_code, headers
|
|
900
858
|
end
|
|
901
859
|
|
|
902
|
-
# Get
|
|
903
|
-
#
|
|
860
|
+
# Get advertiser brand, category, SKU report
|
|
861
|
+
# [Restricted](/docs/getting-started/using-beta-and-restricted-features/) Get a brand, category, SKU report for an ad account. This call returns the URL for the report that matches the token returned in the request to the Create brand, category, SKU report endpoint.
|
|
904
862
|
# @param ad_account_id [String] Unique identifier of an ad account.
|
|
905
|
-
# @param
|
|
906
|
-
# @param end_date [Date] Metric report end date (UTC). Format: YYYY-MM-DD
|
|
907
|
-
# @param campaign_ids [Array<String>] List of Campaign Ids to use to filter the results.
|
|
908
|
-
# @param columns [Array<String>] Columns to retrieve. **NOTE**: Any metrics defined as MICRO_DOLLARS returns a value based on the advertiser profile's currency field. For USD,($1/1,000,000, or $0.000001 - one one-ten-thousandth of a cent). it's microdollars. Otherwise, it's in microunits of the advertiser's currency.<br/>For example, if the advertiser's currency is GBP (British pound sterling), all MICRO_DOLLARS fields will be in GBP microunits (1/1,000,000 British pound).<br/>If a column has no value, it may not be returned
|
|
909
|
-
# @param granularity [Granularity] Granularity
|
|
863
|
+
# @param token [String] Token returned from the post request creation call
|
|
910
864
|
# @param [Hash] opts the optional parameters
|
|
911
|
-
# @
|
|
912
|
-
|
|
913
|
-
|
|
914
|
-
# @option opts [String] :conversion_report_time The date by which the conversion metrics returned from this endpoint will be reported. There are two dates associated with a conversion event: the date that the user interacted with the ad, and the date that the user completed a conversion event. (default to 'TIME_OF_AD_ACTION')
|
|
915
|
-
# @return [Array<Hash<String, Object>>]
|
|
916
|
-
def campaigns_analytics(ad_account_id, start_date, end_date, campaign_ids, columns, granularity, opts = {})
|
|
917
|
-
data, _status_code, _headers = campaigns_analytics_with_http_info(ad_account_id, start_date, end_date, campaign_ids, columns, granularity, opts)
|
|
865
|
+
# @return [ConversionProductReport]
|
|
866
|
+
def analytics_get_conversion_product_report(ad_account_id, token, opts = {})
|
|
867
|
+
data, _status_code, _headers = analytics_get_conversion_product_report_with_http_info(ad_account_id, token, opts)
|
|
918
868
|
data
|
|
919
869
|
end
|
|
920
870
|
|
|
921
|
-
# Get
|
|
922
|
-
#
|
|
871
|
+
# Get advertiser brand, category, SKU report
|
|
872
|
+
# [Restricted](/docs/getting-started/using-beta-and-restricted-features/) Get a brand, category, SKU report for an ad account. This call returns the URL for the report that matches the token returned in the request to the Create brand, category, SKU report endpoint.
|
|
923
873
|
# @param ad_account_id [String] Unique identifier of an ad account.
|
|
924
|
-
# @param
|
|
925
|
-
# @param end_date [Date] Metric report end date (UTC). Format: YYYY-MM-DD
|
|
926
|
-
# @param campaign_ids [Array<String>] List of Campaign Ids to use to filter the results.
|
|
927
|
-
# @param columns [Array<String>] Columns to retrieve. **NOTE**: Any metrics defined as MICRO_DOLLARS returns a value based on the advertiser profile's currency field. For USD,($1/1,000,000, or $0.000001 - one one-ten-thousandth of a cent). it's microdollars. Otherwise, it's in microunits of the advertiser's currency.<br/>For example, if the advertiser's currency is GBP (British pound sterling), all MICRO_DOLLARS fields will be in GBP microunits (1/1,000,000 British pound).<br/>If a column has no value, it may not be returned
|
|
928
|
-
# @param granularity [Granularity] Granularity
|
|
874
|
+
# @param token [String] Token returned from the post request creation call
|
|
929
875
|
# @param [Hash] opts the optional parameters
|
|
930
|
-
# @
|
|
931
|
-
|
|
932
|
-
# @option opts [Integer] :view_window_days Number of days to use as the conversion attribution window for a view action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `1` day.
|
|
933
|
-
# @option opts [String] :conversion_report_time The date by which the conversion metrics returned from this endpoint will be reported. There are two dates associated with a conversion event: the date that the user interacted with the ad, and the date that the user completed a conversion event.
|
|
934
|
-
# @return [Array<(Array<Hash<String, Object>>, Integer, Hash)>] Array<Hash<String, Object>> data, response status code and response headers
|
|
935
|
-
def campaigns_analytics_with_http_info(ad_account_id, start_date, end_date, campaign_ids, columns, granularity, opts = {})
|
|
876
|
+
# @return [Array<(ConversionProductReport, Integer, Hash)>] ConversionProductReport data, response status code and response headers
|
|
877
|
+
def analytics_get_conversion_product_report_with_http_info(ad_account_id, token, opts = {})
|
|
936
878
|
if @api_client.config.debugging
|
|
937
|
-
@api_client.config.logger.debug 'Calling API: AdAccountsApi.
|
|
879
|
+
@api_client.config.logger.debug 'Calling API: AdAccountsApi.analytics_get_conversion_product_report ...'
|
|
938
880
|
end
|
|
939
881
|
# verify the required parameter 'ad_account_id' is set
|
|
940
882
|
if @api_client.config.client_side_validation && ad_account_id.nil?
|
|
941
|
-
fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling AdAccountsApi.
|
|
883
|
+
fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling AdAccountsApi.analytics_get_conversion_product_report"
|
|
942
884
|
end
|
|
885
|
+
if @api_client.config.client_side_validation && ad_account_id.to_s.length > 18
|
|
886
|
+
fail ArgumentError, 'invalid value for "ad_account_id" when calling AdAccountsApi.analytics_get_conversion_product_report, the character length must be smaller than or equal to 18.'
|
|
887
|
+
end
|
|
888
|
+
|
|
943
889
|
pattern = Regexp.new(/^\d+$/)
|
|
944
890
|
if @api_client.config.client_side_validation && ad_account_id !~ pattern
|
|
945
|
-
fail ArgumentError, "invalid value for 'ad_account_id' when calling AdAccountsApi.
|
|
891
|
+
fail ArgumentError, "invalid value for 'ad_account_id' when calling AdAccountsApi.analytics_get_conversion_product_report, must conform to the pattern #{pattern}."
|
|
946
892
|
end
|
|
947
893
|
|
|
948
|
-
# verify the required parameter '
|
|
949
|
-
if @api_client.config.client_side_validation &&
|
|
950
|
-
fail ArgumentError, "Missing the required parameter '
|
|
951
|
-
end
|
|
952
|
-
# verify the required parameter 'end_date' is set
|
|
953
|
-
if @api_client.config.client_side_validation && end_date.nil?
|
|
954
|
-
fail ArgumentError, "Missing the required parameter 'end_date' when calling AdAccountsApi.campaigns_analytics"
|
|
955
|
-
end
|
|
956
|
-
# verify the required parameter 'campaign_ids' is set
|
|
957
|
-
if @api_client.config.client_side_validation && campaign_ids.nil?
|
|
958
|
-
fail ArgumentError, "Missing the required parameter 'campaign_ids' when calling AdAccountsApi.campaigns_analytics"
|
|
959
|
-
end
|
|
960
|
-
if @api_client.config.client_side_validation && campaign_ids.length > 100
|
|
961
|
-
fail ArgumentError, 'invalid value for "campaign_ids" when calling AdAccountsApi.campaigns_analytics, number of items must be less than or equal to 100.'
|
|
894
|
+
# verify the required parameter 'token' is set
|
|
895
|
+
if @api_client.config.client_side_validation && token.nil?
|
|
896
|
+
fail ArgumentError, "Missing the required parameter 'token' when calling AdAccountsApi.analytics_get_conversion_product_report"
|
|
962
897
|
end
|
|
898
|
+
# resource path
|
|
899
|
+
local_var_path = '/ad_accounts/{ad_account_id}/reports/brand_category_sku'.sub('{ad_account_id}', CGI.escape(ad_account_id.to_s))
|
|
963
900
|
|
|
964
|
-
|
|
965
|
-
|
|
966
|
-
|
|
901
|
+
# query parameters
|
|
902
|
+
query_params = opts[:query_params] || {}
|
|
903
|
+
query_params[:'token'] = token
|
|
967
904
|
|
|
968
|
-
#
|
|
969
|
-
|
|
970
|
-
|
|
905
|
+
# header parameters
|
|
906
|
+
header_params = opts[:header_params] || {}
|
|
907
|
+
# HTTP header 'Accept' (if needed)
|
|
908
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
909
|
+
|
|
910
|
+
# form parameters
|
|
911
|
+
form_params = opts[:form_params] || {}
|
|
912
|
+
|
|
913
|
+
# http body (model)
|
|
914
|
+
post_body = opts[:debug_body]
|
|
915
|
+
|
|
916
|
+
# return_type
|
|
917
|
+
return_type = opts[:debug_return_type] || 'ConversionProductReport'
|
|
918
|
+
|
|
919
|
+
# auth_names
|
|
920
|
+
auth_names = opts[:debug_auth_names] || ['pinterest_oauth2']
|
|
921
|
+
|
|
922
|
+
new_options = opts.merge(
|
|
923
|
+
:operation => :"AdAccountsApi.analytics_get_conversion_product_report",
|
|
924
|
+
:header_params => header_params,
|
|
925
|
+
:query_params => query_params,
|
|
926
|
+
:form_params => form_params,
|
|
927
|
+
:body => post_body,
|
|
928
|
+
:auth_names => auth_names,
|
|
929
|
+
:return_type => return_type
|
|
930
|
+
)
|
|
931
|
+
|
|
932
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
933
|
+
if @api_client.config.debugging
|
|
934
|
+
@api_client.config.logger.debug "API called: AdAccountsApi#analytics_get_conversion_product_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
971
935
|
end
|
|
972
|
-
|
|
973
|
-
|
|
974
|
-
|
|
936
|
+
return data, status_code, headers
|
|
937
|
+
end
|
|
938
|
+
|
|
939
|
+
# Get advertiser Marketing Mix Modeling (MMM) report.
|
|
940
|
+
# Get an mmm report for an ad account. This returns a URL to an mmm metrics report given a token returned from the create mmm report endpoint.
|
|
941
|
+
# @param ad_account_id [String]
|
|
942
|
+
# @param token [String] Token returned from the post request creation call
|
|
943
|
+
# @param [Hash] opts the optional parameters
|
|
944
|
+
# @return [MMMReport]
|
|
945
|
+
def analytics_get_mmm_report(ad_account_id, token, opts = {})
|
|
946
|
+
data, _status_code, _headers = analytics_get_mmm_report_with_http_info(ad_account_id, token, opts)
|
|
947
|
+
data
|
|
948
|
+
end
|
|
949
|
+
|
|
950
|
+
# Get advertiser Marketing Mix Modeling (MMM) report.
|
|
951
|
+
# Get an mmm report for an ad account. This returns a URL to an mmm metrics report given a token returned from the create mmm report endpoint.
|
|
952
|
+
# @param ad_account_id [String]
|
|
953
|
+
# @param token [String] Token returned from the post request creation call
|
|
954
|
+
# @param [Hash] opts the optional parameters
|
|
955
|
+
# @return [Array<(MMMReport, Integer, Hash)>] MMMReport data, response status code and response headers
|
|
956
|
+
def analytics_get_mmm_report_with_http_info(ad_account_id, token, opts = {})
|
|
957
|
+
if @api_client.config.debugging
|
|
958
|
+
@api_client.config.logger.debug 'Calling API: AdAccountsApi.analytics_get_mmm_report ...'
|
|
975
959
|
end
|
|
976
|
-
|
|
977
|
-
if @api_client.config.client_side_validation &&
|
|
978
|
-
fail ArgumentError, "
|
|
960
|
+
# verify the required parameter 'ad_account_id' is set
|
|
961
|
+
if @api_client.config.client_side_validation && ad_account_id.nil?
|
|
962
|
+
fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling AdAccountsApi.analytics_get_mmm_report"
|
|
979
963
|
end
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
fail ArgumentError, "invalid value for \"engagement_window_days\", must be one of #{allowable_values}"
|
|
964
|
+
if @api_client.config.client_side_validation && ad_account_id.to_s.length > 18
|
|
965
|
+
fail ArgumentError, 'invalid value for "ad_account_id" when calling AdAccountsApi.analytics_get_mmm_report, the character length must be smaller than or equal to 18.'
|
|
983
966
|
end
|
|
984
|
-
|
|
985
|
-
|
|
986
|
-
|
|
967
|
+
|
|
968
|
+
pattern = Regexp.new(/^\d+$/)
|
|
969
|
+
if @api_client.config.client_side_validation && ad_account_id !~ pattern
|
|
970
|
+
fail ArgumentError, "invalid value for 'ad_account_id' when calling AdAccountsApi.analytics_get_mmm_report, must conform to the pattern #{pattern}."
|
|
987
971
|
end
|
|
988
|
-
|
|
989
|
-
|
|
990
|
-
|
|
972
|
+
|
|
973
|
+
# verify the required parameter 'token' is set
|
|
974
|
+
if @api_client.config.client_side_validation && token.nil?
|
|
975
|
+
fail ArgumentError, "Missing the required parameter 'token' when calling AdAccountsApi.analytics_get_mmm_report"
|
|
991
976
|
end
|
|
992
977
|
# resource path
|
|
993
|
-
local_var_path = '/ad_accounts/{ad_account_id}/
|
|
978
|
+
local_var_path = '/ad_accounts/{ad_account_id}/mmm_reports'.sub('{ad_account_id}', CGI.escape(ad_account_id.to_s))
|
|
994
979
|
|
|
995
980
|
# query parameters
|
|
996
981
|
query_params = opts[:query_params] || {}
|
|
997
|
-
query_params[:'
|
|
998
|
-
query_params[:'end_date'] = end_date
|
|
999
|
-
query_params[:'campaign_ids'] = @api_client.build_collection_param(campaign_ids, :multi)
|
|
1000
|
-
query_params[:'columns'] = @api_client.build_collection_param(columns, :csv)
|
|
1001
|
-
query_params[:'granularity'] = granularity
|
|
1002
|
-
query_params[:'click_window_days'] = opts[:'click_window_days'] if !opts[:'click_window_days'].nil?
|
|
1003
|
-
query_params[:'engagement_window_days'] = opts[:'engagement_window_days'] if !opts[:'engagement_window_days'].nil?
|
|
1004
|
-
query_params[:'view_window_days'] = opts[:'view_window_days'] if !opts[:'view_window_days'].nil?
|
|
1005
|
-
query_params[:'conversion_report_time'] = opts[:'conversion_report_time'] if !opts[:'conversion_report_time'].nil?
|
|
982
|
+
query_params[:'token'] = token
|
|
1006
983
|
|
|
1007
984
|
# header parameters
|
|
1008
985
|
header_params = opts[:header_params] || {}
|
|
1009
986
|
# HTTP header 'Accept' (if needed)
|
|
1010
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
987
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1011
988
|
|
|
1012
989
|
# form parameters
|
|
1013
990
|
form_params = opts[:form_params] || {}
|
|
@@ -1016,13 +993,13 @@ module PinterestSdkClient
|
|
|
1016
993
|
post_body = opts[:debug_body]
|
|
1017
994
|
|
|
1018
995
|
# return_type
|
|
1019
|
-
return_type = opts[:debug_return_type] || '
|
|
996
|
+
return_type = opts[:debug_return_type] || 'MMMReport'
|
|
1020
997
|
|
|
1021
998
|
# auth_names
|
|
1022
999
|
auth_names = opts[:debug_auth_names] || ['pinterest_oauth2']
|
|
1023
1000
|
|
|
1024
1001
|
new_options = opts.merge(
|
|
1025
|
-
:operation => :"AdAccountsApi.
|
|
1002
|
+
:operation => :"AdAccountsApi.analytics_get_mmm_report",
|
|
1026
1003
|
:header_params => header_params,
|
|
1027
1004
|
:query_params => query_params,
|
|
1028
1005
|
:form_params => form_params,
|
|
@@ -1033,88 +1010,132 @@ module PinterestSdkClient
|
|
|
1033
1010
|
|
|
1034
1011
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1035
1012
|
if @api_client.config.debugging
|
|
1036
|
-
@api_client.config.logger.debug "API called: AdAccountsApi#
|
|
1013
|
+
@api_client.config.logger.debug "API called: AdAccountsApi#analytics_get_mmm_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1037
1014
|
end
|
|
1038
1015
|
return data, status_code, headers
|
|
1039
1016
|
end
|
|
1040
1017
|
|
|
1041
|
-
#
|
|
1042
|
-
#
|
|
1018
|
+
# Get the account analytics report created by the async call
|
|
1019
|
+
# This returns a URL to an analytics report given a token returned from the post request report creation call. You can use the URL to download the report. The link is valid for five minutes and the report is valid for one hour. - The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via [Business Access](https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts): Admin, Analyst, Campaign Manager.
|
|
1043
1020
|
# @param ad_account_id [String] Unique identifier of an ad account.
|
|
1021
|
+
# @param token [String] Token returned from the post request creation call
|
|
1044
1022
|
# @param [Hash] opts the optional parameters
|
|
1045
|
-
# @
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
# @option opts [String] :order The order in which to sort the items returned: “ASCENDING” or “DESCENDING” by ID. Note that higher-value IDs are associated with more-recently added items.
|
|
1049
|
-
# @option opts [String] :bookmark Cursor used to fetch the next page of items
|
|
1050
|
-
# @return [Paginated]
|
|
1051
|
-
def campaigns_list(ad_account_id, opts = {})
|
|
1052
|
-
data, _status_code, _headers = campaigns_list_with_http_info(ad_account_id, opts)
|
|
1023
|
+
# @return [AdsAnalyticsGetAsyncResponse]
|
|
1024
|
+
def analytics_get_report(ad_account_id, token, opts = {})
|
|
1025
|
+
data, _status_code, _headers = analytics_get_report_with_http_info(ad_account_id, token, opts)
|
|
1053
1026
|
data
|
|
1054
1027
|
end
|
|
1055
1028
|
|
|
1056
|
-
#
|
|
1057
|
-
#
|
|
1029
|
+
# Get the account analytics report created by the async call
|
|
1030
|
+
# This returns a URL to an analytics report given a token returned from the post request report creation call. You can use the URL to download the report. The link is valid for five minutes and the report is valid for one hour. - The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via [Business Access](https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts): Admin, Analyst, Campaign Manager.
|
|
1058
1031
|
# @param ad_account_id [String] Unique identifier of an ad account.
|
|
1032
|
+
# @param token [String] Token returned from the post request creation call
|
|
1059
1033
|
# @param [Hash] opts the optional parameters
|
|
1060
|
-
# @
|
|
1061
|
-
|
|
1062
|
-
# @option opts [Integer] :page_size Maximum number of items to include in a single page of the response. See documentation on <a href='/docs/api/v5/#tag/Pagination'>Pagination</a> for more information.
|
|
1063
|
-
# @option opts [String] :order The order in which to sort the items returned: “ASCENDING” or “DESCENDING” by ID. Note that higher-value IDs are associated with more-recently added items.
|
|
1064
|
-
# @option opts [String] :bookmark Cursor used to fetch the next page of items
|
|
1065
|
-
# @return [Array<(Paginated, Integer, Hash)>] Paginated data, response status code and response headers
|
|
1066
|
-
def campaigns_list_with_http_info(ad_account_id, opts = {})
|
|
1034
|
+
# @return [Array<(AdsAnalyticsGetAsyncResponse, Integer, Hash)>] AdsAnalyticsGetAsyncResponse data, response status code and response headers
|
|
1035
|
+
def analytics_get_report_with_http_info(ad_account_id, token, opts = {})
|
|
1067
1036
|
if @api_client.config.debugging
|
|
1068
|
-
@api_client.config.logger.debug 'Calling API: AdAccountsApi.
|
|
1037
|
+
@api_client.config.logger.debug 'Calling API: AdAccountsApi.analytics_get_report ...'
|
|
1069
1038
|
end
|
|
1070
1039
|
# verify the required parameter 'ad_account_id' is set
|
|
1071
1040
|
if @api_client.config.client_side_validation && ad_account_id.nil?
|
|
1072
|
-
fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling AdAccountsApi.
|
|
1041
|
+
fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling AdAccountsApi.analytics_get_report"
|
|
1042
|
+
end
|
|
1043
|
+
if @api_client.config.client_side_validation && ad_account_id.to_s.length > 18
|
|
1044
|
+
fail ArgumentError, 'invalid value for "ad_account_id" when calling AdAccountsApi.analytics_get_report, the character length must be smaller than or equal to 18.'
|
|
1073
1045
|
end
|
|
1046
|
+
|
|
1074
1047
|
pattern = Regexp.new(/^\d+$/)
|
|
1075
1048
|
if @api_client.config.client_side_validation && ad_account_id !~ pattern
|
|
1076
|
-
fail ArgumentError, "invalid value for 'ad_account_id' when calling AdAccountsApi.
|
|
1049
|
+
fail ArgumentError, "invalid value for 'ad_account_id' when calling AdAccountsApi.analytics_get_report, must conform to the pattern #{pattern}."
|
|
1077
1050
|
end
|
|
1078
1051
|
|
|
1079
|
-
|
|
1080
|
-
|
|
1052
|
+
# verify the required parameter 'token' is set
|
|
1053
|
+
if @api_client.config.client_side_validation && token.nil?
|
|
1054
|
+
fail ArgumentError, "Missing the required parameter 'token' when calling AdAccountsApi.analytics_get_report"
|
|
1081
1055
|
end
|
|
1056
|
+
# resource path
|
|
1057
|
+
local_var_path = '/ad_accounts/{ad_account_id}/reports'.sub('{ad_account_id}', CGI.escape(ad_account_id.to_s))
|
|
1058
|
+
|
|
1059
|
+
# query parameters
|
|
1060
|
+
query_params = opts[:query_params] || {}
|
|
1061
|
+
query_params[:'token'] = token
|
|
1062
|
+
|
|
1063
|
+
# header parameters
|
|
1064
|
+
header_params = opts[:header_params] || {}
|
|
1065
|
+
# HTTP header 'Accept' (if needed)
|
|
1066
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1067
|
+
|
|
1068
|
+
# form parameters
|
|
1069
|
+
form_params = opts[:form_params] || {}
|
|
1070
|
+
|
|
1071
|
+
# http body (model)
|
|
1072
|
+
post_body = opts[:debug_body]
|
|
1073
|
+
|
|
1074
|
+
# return_type
|
|
1075
|
+
return_type = opts[:debug_return_type] || 'AdsAnalyticsGetAsyncResponse'
|
|
1076
|
+
|
|
1077
|
+
# auth_names
|
|
1078
|
+
auth_names = opts[:debug_auth_names] || ['pinterest_oauth2']
|
|
1079
|
+
|
|
1080
|
+
new_options = opts.merge(
|
|
1081
|
+
:operation => :"AdAccountsApi.analytics_get_report",
|
|
1082
|
+
:header_params => header_params,
|
|
1083
|
+
:query_params => query_params,
|
|
1084
|
+
:form_params => form_params,
|
|
1085
|
+
:body => post_body,
|
|
1086
|
+
:auth_names => auth_names,
|
|
1087
|
+
:return_type => return_type
|
|
1088
|
+
)
|
|
1082
1089
|
|
|
1083
|
-
|
|
1084
|
-
|
|
1090
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1091
|
+
if @api_client.config.debugging
|
|
1092
|
+
@api_client.config.logger.debug "API called: AdAccountsApi#analytics_get_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1085
1093
|
end
|
|
1094
|
+
return data, status_code, headers
|
|
1095
|
+
end
|
|
1096
|
+
|
|
1097
|
+
# Delete ads data for ad account in API Sandbox
|
|
1098
|
+
# Delete an ad account and all the ads data associated with that account. A string message is returned indicating the status of the delete operation. Note: This endpoint is only allowed in the Pinterest API Sandbox (https://api-sandbox.pinterest.com/v5). Go to /docs/developer-tools/sandbox/ for more information.
|
|
1099
|
+
# @param ad_account_id [String] Unique identifier of an ad account.
|
|
1100
|
+
# @param [Hash] opts the optional parameters
|
|
1101
|
+
# @return [String]
|
|
1102
|
+
def sandbox_delete(ad_account_id, opts = {})
|
|
1103
|
+
data, _status_code, _headers = sandbox_delete_with_http_info(ad_account_id, opts)
|
|
1104
|
+
data
|
|
1105
|
+
end
|
|
1086
1106
|
|
|
1087
|
-
|
|
1088
|
-
|
|
1089
|
-
|
|
1107
|
+
# Delete ads data for ad account in API Sandbox
|
|
1108
|
+
# Delete an ad account and all the ads data associated with that account. A string message is returned indicating the status of the delete operation. Note: This endpoint is only allowed in the Pinterest API Sandbox (https://api-sandbox.pinterest.com/v5). Go to /docs/developer-tools/sandbox/ for more information.
|
|
1109
|
+
# @param ad_account_id [String] Unique identifier of an ad account.
|
|
1110
|
+
# @param [Hash] opts the optional parameters
|
|
1111
|
+
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
|
1112
|
+
def sandbox_delete_with_http_info(ad_account_id, opts = {})
|
|
1113
|
+
if @api_client.config.debugging
|
|
1114
|
+
@api_client.config.logger.debug 'Calling API: AdAccountsApi.sandbox_delete ...'
|
|
1090
1115
|
end
|
|
1091
|
-
|
|
1092
|
-
|
|
1116
|
+
# verify the required parameter 'ad_account_id' is set
|
|
1117
|
+
if @api_client.config.client_side_validation && ad_account_id.nil?
|
|
1118
|
+
fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling AdAccountsApi.sandbox_delete"
|
|
1093
1119
|
end
|
|
1094
|
-
|
|
1095
|
-
|
|
1096
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AdAccountsApi.campaigns_list, must be greater than or equal to 1.'
|
|
1120
|
+
if @api_client.config.client_side_validation && ad_account_id.to_s.length > 18
|
|
1121
|
+
fail ArgumentError, 'invalid value for "ad_account_id" when calling AdAccountsApi.sandbox_delete, the character length must be smaller than or equal to 18.'
|
|
1097
1122
|
end
|
|
1098
1123
|
|
|
1099
|
-
|
|
1100
|
-
if @api_client.config.client_side_validation &&
|
|
1101
|
-
fail ArgumentError, "invalid value for
|
|
1124
|
+
pattern = Regexp.new(/^\d+$/)
|
|
1125
|
+
if @api_client.config.client_side_validation && ad_account_id !~ pattern
|
|
1126
|
+
fail ArgumentError, "invalid value for 'ad_account_id' when calling AdAccountsApi.sandbox_delete, must conform to the pattern #{pattern}."
|
|
1102
1127
|
end
|
|
1128
|
+
|
|
1103
1129
|
# resource path
|
|
1104
|
-
local_var_path = '/ad_accounts/{ad_account_id}/
|
|
1130
|
+
local_var_path = '/ad_accounts/{ad_account_id}/sandbox'.sub('{ad_account_id}', CGI.escape(ad_account_id.to_s))
|
|
1105
1131
|
|
|
1106
1132
|
# query parameters
|
|
1107
1133
|
query_params = opts[:query_params] || {}
|
|
1108
|
-
query_params[:'campaign_ids'] = @api_client.build_collection_param(opts[:'campaign_ids'], :multi) if !opts[:'campaign_ids'].nil?
|
|
1109
|
-
query_params[:'entity_statuses'] = @api_client.build_collection_param(opts[:'entity_statuses'], :multi) if !opts[:'entity_statuses'].nil?
|
|
1110
|
-
query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
1111
|
-
query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
|
|
1112
|
-
query_params[:'bookmark'] = opts[:'bookmark'] if !opts[:'bookmark'].nil?
|
|
1113
1134
|
|
|
1114
1135
|
# header parameters
|
|
1115
1136
|
header_params = opts[:header_params] || {}
|
|
1116
1137
|
# HTTP header 'Accept' (if needed)
|
|
1117
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1138
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1118
1139
|
|
|
1119
1140
|
# form parameters
|
|
1120
1141
|
form_params = opts[:form_params] || {}
|
|
@@ -1123,13 +1144,13 @@ module PinterestSdkClient
|
|
|
1123
1144
|
post_body = opts[:debug_body]
|
|
1124
1145
|
|
|
1125
1146
|
# return_type
|
|
1126
|
-
return_type = opts[:debug_return_type] || '
|
|
1147
|
+
return_type = opts[:debug_return_type] || 'String'
|
|
1127
1148
|
|
|
1128
1149
|
# auth_names
|
|
1129
1150
|
auth_names = opts[:debug_auth_names] || ['pinterest_oauth2']
|
|
1130
1151
|
|
|
1131
1152
|
new_options = opts.merge(
|
|
1132
|
-
:operation => :"AdAccountsApi.
|
|
1153
|
+
:operation => :"AdAccountsApi.sandbox_delete",
|
|
1133
1154
|
:header_params => header_params,
|
|
1134
1155
|
:query_params => query_params,
|
|
1135
1156
|
:form_params => form_params,
|
|
@@ -1138,122 +1159,72 @@ module PinterestSdkClient
|
|
|
1138
1159
|
:return_type => return_type
|
|
1139
1160
|
)
|
|
1140
1161
|
|
|
1141
|
-
data, status_code, headers = @api_client.call_api(:
|
|
1162
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
1142
1163
|
if @api_client.config.debugging
|
|
1143
|
-
@api_client.config.logger.debug "API called: AdAccountsApi#
|
|
1164
|
+
@api_client.config.logger.debug "API called: AdAccountsApi#sandbox_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1144
1165
|
end
|
|
1145
1166
|
return data, status_code, headers
|
|
1146
1167
|
end
|
|
1147
1168
|
|
|
1148
|
-
#
|
|
1149
|
-
#
|
|
1169
|
+
# List templates
|
|
1170
|
+
# Gets all Templates associated with an ad account ID.
|
|
1150
1171
|
# @param ad_account_id [String] Unique identifier of an ad account.
|
|
1151
|
-
# @param start_date [Date] Metric report start date (UTC). Format: YYYY-MM-DD
|
|
1152
|
-
# @param end_date [Date] Metric report end date (UTC). Format: YYYY-MM-DD
|
|
1153
|
-
# @param product_group_ids [Array<String>] List of Product group Ids to use to filter the results.
|
|
1154
|
-
# @param columns [Array<String>] Columns to retrieve. **NOTE**: Any metrics defined as MICRO_DOLLARS returns a value based on the advertiser profile's currency field. For USD,($1/1,000,000, or $0.000001 - one one-ten-thousandth of a cent). it's microdollars. Otherwise, it's in microunits of the advertiser's currency.<br/>For example, if the advertiser's currency is GBP (British pound sterling), all MICRO_DOLLARS fields will be in GBP microunits (1/1,000,000 British pound).<br/>If a column has no value, it may not be returned
|
|
1155
|
-
# @param granularity [Granularity] Granularity
|
|
1156
1172
|
# @param [Hash] opts the optional parameters
|
|
1157
|
-
# @option opts [
|
|
1158
|
-
# @option opts [Integer] :
|
|
1159
|
-
# @option opts [
|
|
1160
|
-
# @
|
|
1161
|
-
|
|
1162
|
-
|
|
1163
|
-
data, _status_code, _headers = product_groups_analytics_with_http_info(ad_account_id, start_date, end_date, product_group_ids, columns, granularity, opts)
|
|
1173
|
+
# @option opts [String] :bookmark Cursor used to fetch the next page of items
|
|
1174
|
+
# @option opts [Integer] :page_size Maximum number of items to include in a single page. See documentation on [Pagination](/docs/reference/pagination/) for more information. (default to 25)
|
|
1175
|
+
# @option opts [PinterestLibPaginationOrder] :order The order in which to sort the items returned: \"ASCENDING\" or \"DESCENDING\" by ID. Note that higher-value IDs are associated with more-recently added items.
|
|
1176
|
+
# @return [TemplatesList200Response]
|
|
1177
|
+
def templates_list(ad_account_id, opts = {})
|
|
1178
|
+
data, _status_code, _headers = templates_list_with_http_info(ad_account_id, opts)
|
|
1164
1179
|
data
|
|
1165
1180
|
end
|
|
1166
1181
|
|
|
1167
|
-
#
|
|
1168
|
-
#
|
|
1182
|
+
# List templates
|
|
1183
|
+
# Gets all Templates associated with an ad account ID.
|
|
1169
1184
|
# @param ad_account_id [String] Unique identifier of an ad account.
|
|
1170
|
-
# @param start_date [Date] Metric report start date (UTC). Format: YYYY-MM-DD
|
|
1171
|
-
# @param end_date [Date] Metric report end date (UTC). Format: YYYY-MM-DD
|
|
1172
|
-
# @param product_group_ids [Array<String>] List of Product group Ids to use to filter the results.
|
|
1173
|
-
# @param columns [Array<String>] Columns to retrieve. **NOTE**: Any metrics defined as MICRO_DOLLARS returns a value based on the advertiser profile's currency field. For USD,($1/1,000,000, or $0.000001 - one one-ten-thousandth of a cent). it's microdollars. Otherwise, it's in microunits of the advertiser's currency.<br/>For example, if the advertiser's currency is GBP (British pound sterling), all MICRO_DOLLARS fields will be in GBP microunits (1/1,000,000 British pound).<br/>If a column has no value, it may not be returned
|
|
1174
|
-
# @param granularity [Granularity] Granularity
|
|
1175
1185
|
# @param [Hash] opts the optional parameters
|
|
1176
|
-
# @option opts [
|
|
1177
|
-
# @option opts [Integer] :
|
|
1178
|
-
# @option opts [
|
|
1179
|
-
# @
|
|
1180
|
-
|
|
1181
|
-
def product_groups_analytics_with_http_info(ad_account_id, start_date, end_date, product_group_ids, columns, granularity, opts = {})
|
|
1186
|
+
# @option opts [String] :bookmark Cursor used to fetch the next page of items
|
|
1187
|
+
# @option opts [Integer] :page_size Maximum number of items to include in a single page. See documentation on [Pagination](/docs/reference/pagination/) for more information. (default to 25)
|
|
1188
|
+
# @option opts [PinterestLibPaginationOrder] :order The order in which to sort the items returned: \"ASCENDING\" or \"DESCENDING\" by ID. Note that higher-value IDs are associated with more-recently added items.
|
|
1189
|
+
# @return [Array<(TemplatesList200Response, Integer, Hash)>] TemplatesList200Response data, response status code and response headers
|
|
1190
|
+
def templates_list_with_http_info(ad_account_id, opts = {})
|
|
1182
1191
|
if @api_client.config.debugging
|
|
1183
|
-
@api_client.config.logger.debug 'Calling API: AdAccountsApi.
|
|
1192
|
+
@api_client.config.logger.debug 'Calling API: AdAccountsApi.templates_list ...'
|
|
1184
1193
|
end
|
|
1185
1194
|
# verify the required parameter 'ad_account_id' is set
|
|
1186
1195
|
if @api_client.config.client_side_validation && ad_account_id.nil?
|
|
1187
|
-
fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling AdAccountsApi.
|
|
1196
|
+
fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling AdAccountsApi.templates_list"
|
|
1197
|
+
end
|
|
1198
|
+
if @api_client.config.client_side_validation && ad_account_id.to_s.length > 18
|
|
1199
|
+
fail ArgumentError, 'invalid value for "ad_account_id" when calling AdAccountsApi.templates_list, the character length must be smaller than or equal to 18.'
|
|
1188
1200
|
end
|
|
1201
|
+
|
|
1189
1202
|
pattern = Regexp.new(/^\d+$/)
|
|
1190
1203
|
if @api_client.config.client_side_validation && ad_account_id !~ pattern
|
|
1191
|
-
fail ArgumentError, "invalid value for 'ad_account_id' when calling AdAccountsApi.
|
|
1204
|
+
fail ArgumentError, "invalid value for 'ad_account_id' when calling AdAccountsApi.templates_list, must conform to the pattern #{pattern}."
|
|
1192
1205
|
end
|
|
1193
1206
|
|
|
1194
|
-
|
|
1195
|
-
|
|
1196
|
-
fail ArgumentError, "Missing the required parameter 'start_date' when calling AdAccountsApi.product_groups_analytics"
|
|
1197
|
-
end
|
|
1198
|
-
# verify the required parameter 'end_date' is set
|
|
1199
|
-
if @api_client.config.client_side_validation && end_date.nil?
|
|
1200
|
-
fail ArgumentError, "Missing the required parameter 'end_date' when calling AdAccountsApi.product_groups_analytics"
|
|
1201
|
-
end
|
|
1202
|
-
# verify the required parameter 'product_group_ids' is set
|
|
1203
|
-
if @api_client.config.client_side_validation && product_group_ids.nil?
|
|
1204
|
-
fail ArgumentError, "Missing the required parameter 'product_group_ids' when calling AdAccountsApi.product_groups_analytics"
|
|
1205
|
-
end
|
|
1206
|
-
if @api_client.config.client_side_validation && product_group_ids.length > 100
|
|
1207
|
-
fail ArgumentError, 'invalid value for "product_group_ids" when calling AdAccountsApi.product_groups_analytics, number of items must be less than or equal to 100.'
|
|
1207
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 250
|
|
1208
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AdAccountsApi.templates_list, must be smaller than or equal to 250.'
|
|
1208
1209
|
end
|
|
1209
1210
|
|
|
1210
|
-
if @api_client.config.client_side_validation &&
|
|
1211
|
-
fail ArgumentError, 'invalid value for "
|
|
1211
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
|
1212
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AdAccountsApi.templates_list, must be greater than or equal to 1.'
|
|
1212
1213
|
end
|
|
1213
1214
|
|
|
1214
|
-
# verify the required parameter 'columns' is set
|
|
1215
|
-
if @api_client.config.client_side_validation && columns.nil?
|
|
1216
|
-
fail ArgumentError, "Missing the required parameter 'columns' when calling AdAccountsApi.product_groups_analytics"
|
|
1217
|
-
end
|
|
1218
|
-
# verify the required parameter 'granularity' is set
|
|
1219
|
-
if @api_client.config.client_side_validation && granularity.nil?
|
|
1220
|
-
fail ArgumentError, "Missing the required parameter 'granularity' when calling AdAccountsApi.product_groups_analytics"
|
|
1221
|
-
end
|
|
1222
|
-
allowable_values = [1, 7, 30, 60]
|
|
1223
|
-
if @api_client.config.client_side_validation && opts[:'click_window_days'] && !allowable_values.include?(opts[:'click_window_days'])
|
|
1224
|
-
fail ArgumentError, "invalid value for \"click_window_days\", must be one of #{allowable_values}"
|
|
1225
|
-
end
|
|
1226
|
-
allowable_values = [1, 7, 30, 60]
|
|
1227
|
-
if @api_client.config.client_side_validation && opts[:'engagement_window_days'] && !allowable_values.include?(opts[:'engagement_window_days'])
|
|
1228
|
-
fail ArgumentError, "invalid value for \"engagement_window_days\", must be one of #{allowable_values}"
|
|
1229
|
-
end
|
|
1230
|
-
allowable_values = [1, 7, 30, 60]
|
|
1231
|
-
if @api_client.config.client_side_validation && opts[:'view_window_days'] && !allowable_values.include?(opts[:'view_window_days'])
|
|
1232
|
-
fail ArgumentError, "invalid value for \"view_window_days\", must be one of #{allowable_values}"
|
|
1233
|
-
end
|
|
1234
|
-
allowable_values = ["TIME_OF_AD_ACTION", "TIME_OF_CONVERSION"]
|
|
1235
|
-
if @api_client.config.client_side_validation && opts[:'conversion_report_time'] && !allowable_values.include?(opts[:'conversion_report_time'])
|
|
1236
|
-
fail ArgumentError, "invalid value for \"conversion_report_time\", must be one of #{allowable_values}"
|
|
1237
|
-
end
|
|
1238
1215
|
# resource path
|
|
1239
|
-
local_var_path = '/ad_accounts/{ad_account_id}/
|
|
1216
|
+
local_var_path = '/ad_accounts/{ad_account_id}/templates'.sub('{ad_account_id}', CGI.escape(ad_account_id.to_s))
|
|
1240
1217
|
|
|
1241
1218
|
# query parameters
|
|
1242
1219
|
query_params = opts[:query_params] || {}
|
|
1243
|
-
query_params[:'
|
|
1244
|
-
query_params[:'
|
|
1245
|
-
query_params[:'
|
|
1246
|
-
query_params[:'columns'] = @api_client.build_collection_param(columns, :csv)
|
|
1247
|
-
query_params[:'granularity'] = granularity
|
|
1248
|
-
query_params[:'click_window_days'] = opts[:'click_window_days'] if !opts[:'click_window_days'].nil?
|
|
1249
|
-
query_params[:'engagement_window_days'] = opts[:'engagement_window_days'] if !opts[:'engagement_window_days'].nil?
|
|
1250
|
-
query_params[:'view_window_days'] = opts[:'view_window_days'] if !opts[:'view_window_days'].nil?
|
|
1251
|
-
query_params[:'conversion_report_time'] = opts[:'conversion_report_time'] if !opts[:'conversion_report_time'].nil?
|
|
1220
|
+
query_params[:'bookmark'] = opts[:'bookmark'] if !opts[:'bookmark'].nil?
|
|
1221
|
+
query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
1222
|
+
query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
|
|
1252
1223
|
|
|
1253
1224
|
# header parameters
|
|
1254
1225
|
header_params = opts[:header_params] || {}
|
|
1255
1226
|
# HTTP header 'Accept' (if needed)
|
|
1256
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1227
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1257
1228
|
|
|
1258
1229
|
# form parameters
|
|
1259
1230
|
form_params = opts[:form_params] || {}
|
|
@@ -1262,13 +1233,13 @@ module PinterestSdkClient
|
|
|
1262
1233
|
post_body = opts[:debug_body]
|
|
1263
1234
|
|
|
1264
1235
|
# return_type
|
|
1265
|
-
return_type = opts[:debug_return_type] || '
|
|
1236
|
+
return_type = opts[:debug_return_type] || 'TemplatesList200Response'
|
|
1266
1237
|
|
|
1267
1238
|
# auth_names
|
|
1268
1239
|
auth_names = opts[:debug_auth_names] || ['pinterest_oauth2']
|
|
1269
1240
|
|
|
1270
1241
|
new_options = opts.merge(
|
|
1271
|
-
:operation => :"AdAccountsApi.
|
|
1242
|
+
:operation => :"AdAccountsApi.templates_list",
|
|
1272
1243
|
:header_params => header_params,
|
|
1273
1244
|
:query_params => query_params,
|
|
1274
1245
|
:form_params => form_params,
|
|
@@ -1279,7 +1250,7 @@ module PinterestSdkClient
|
|
|
1279
1250
|
|
|
1280
1251
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1281
1252
|
if @api_client.config.debugging
|
|
1282
|
-
@api_client.config.logger.debug "API called: AdAccountsApi#
|
|
1253
|
+
@api_client.config.logger.debug "API called: AdAccountsApi#templates_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1283
1254
|
end
|
|
1284
1255
|
return data, status_code, headers
|
|
1285
1256
|
end
|