1. Packages
  2. Airbyte Provider
  3. API Docs
  4. SourcePinterest
airbyte 0.10.0 published on Monday, Apr 14, 2025 by airbytehq

airbyte.SourcePinterest

Explore with Pulumi AI

SourcePinterest Resource

Example Usage

Coming soon!
Coming soon!
Coming soon!
Coming soon!
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.airbyte.SourcePinterest;
import com.pulumi.airbyte.SourcePinterestArgs;
import com.pulumi.airbyte.inputs.SourcePinterestConfigurationArgs;
import com.pulumi.airbyte.inputs.SourcePinterestConfigurationCredentialsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var mySourcePinterest = new SourcePinterest("mySourcePinterest", SourcePinterestArgs.builder()
            .configuration(SourcePinterestConfigurationArgs.builder()
                .account_id("1234567890")
                .credentials(SourcePinterestConfigurationCredentialsArgs.builder()
                    .clientId("...my_client_id...")
                    .clientSecret("...my_client_secret...")
                    .refreshToken("...my_refresh_token...")
                    .build())
                .custom_reports(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .start_date("2022-07-28")
                .status("ACTIVE")
                .build())
            .definitionId("7540406c-2051-4504-8c28-ddff47d8716f")
            .secretId("...my_secret_id...")
            .workspaceId("4d479a13-e183-4090-af9e-7a388174d4f2")
            .build());

    }
}
Copy
resources:
  mySourcePinterest:
    type: airbyte:SourcePinterest
    properties:
      configuration:
        account_id: '1234567890'
        credentials:
          clientId: '...my_client_id...'
          clientSecret: '...my_client_secret...'
          refreshToken: '...my_refresh_token...'
        custom_reports:
          - attributionTypes:
              - INDIVIDUAL
            clickWindowDays: 60
            columns:
              - PIN_PROMOTION_ID
            conversionReportTime: TIME_OF_CONVERSION
            engagementWindowDays: 30
            granularity: MONTH
            level: CAMPAIGN
            name: '...my_name...'
            startDate: 2022-07-28
            viewWindowDays: 7
        start_date: 2022-07-28
        status:
          - ACTIVE
      definitionId: 7540406c-2051-4504-8c28-ddff47d8716f
      secretId: '...my_secret_id...'
      workspaceId: 4d479a13-e183-4090-af9e-7a388174d4f2
Copy

Create SourcePinterest Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SourcePinterest(name: string, args: SourcePinterestArgs, opts?: CustomResourceOptions);
@overload
def SourcePinterest(resource_name: str,
                    args: SourcePinterestArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def SourcePinterest(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    configuration: Optional[SourcePinterestConfigurationArgs] = None,
                    workspace_id: Optional[str] = None,
                    definition_id: Optional[str] = None,
                    name: Optional[str] = None,
                    secret_id: Optional[str] = None)
func NewSourcePinterest(ctx *Context, name string, args SourcePinterestArgs, opts ...ResourceOption) (*SourcePinterest, error)
public SourcePinterest(string name, SourcePinterestArgs args, CustomResourceOptions? opts = null)
public SourcePinterest(String name, SourcePinterestArgs args)
public SourcePinterest(String name, SourcePinterestArgs args, CustomResourceOptions options)
type: airbyte:SourcePinterest
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SourcePinterestArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SourcePinterestArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SourcePinterestArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SourcePinterestArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SourcePinterestArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var sourcePinterestResource = new Airbyte.SourcePinterest("sourcePinterestResource", new()
{
    Configuration = new Airbyte.Inputs.SourcePinterestConfigurationArgs
    {
        AccountId = "string",
        Credentials = new Airbyte.Inputs.SourcePinterestConfigurationCredentialsArgs
        {
            ClientId = "string",
            ClientSecret = "string",
            RefreshToken = "string",
        },
        CustomReports = new[]
        {
            new Airbyte.Inputs.SourcePinterestConfigurationCustomReportArgs
            {
                Name = "string",
                AttributionTypes = new[]
                {
                    "string",
                },
                ClickWindowDays = 0,
                Columns = new[]
                {
                    "string",
                },
                ConversionReportTime = "string",
                EngagementWindowDays = 0,
                Granularity = "string",
                Level = "string",
                StartDate = "string",
                ViewWindowDays = 0,
            },
        },
        StartDate = "string",
        Statuses = new[]
        {
            "string",
        },
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});
Copy
example, err := airbyte.NewSourcePinterest(ctx, "sourcePinterestResource", &airbyte.SourcePinterestArgs{
Configuration: &.SourcePinterestConfigurationArgs{
AccountId: pulumi.String("string"),
Credentials: &.SourcePinterestConfigurationCredentialsArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
RefreshToken: pulumi.String("string"),
},
CustomReports: .SourcePinterestConfigurationCustomReportArray{
&.SourcePinterestConfigurationCustomReportArgs{
Name: pulumi.String("string"),
AttributionTypes: pulumi.StringArray{
pulumi.String("string"),
},
ClickWindowDays: pulumi.Float64(0),
Columns: pulumi.StringArray{
pulumi.String("string"),
},
ConversionReportTime: pulumi.String("string"),
EngagementWindowDays: pulumi.Float64(0),
Granularity: pulumi.String("string"),
Level: pulumi.String("string"),
StartDate: pulumi.String("string"),
ViewWindowDays: pulumi.Float64(0),
},
},
StartDate: pulumi.String("string"),
Statuses: pulumi.StringArray{
pulumi.String("string"),
},
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})
Copy
var sourcePinterestResource = new SourcePinterest("sourcePinterestResource", SourcePinterestArgs.builder()
    .configuration(SourcePinterestConfigurationArgs.builder()
        .accountId("string")
        .credentials(SourcePinterestConfigurationCredentialsArgs.builder()
            .clientId("string")
            .clientSecret("string")
            .refreshToken("string")
            .build())
        .customReports(SourcePinterestConfigurationCustomReportArgs.builder()
            .name("string")
            .attributionTypes("string")
            .clickWindowDays(0)
            .columns("string")
            .conversionReportTime("string")
            .engagementWindowDays(0)
            .granularity("string")
            .level("string")
            .startDate("string")
            .viewWindowDays(0)
            .build())
        .startDate("string")
        .statuses("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());
Copy
source_pinterest_resource = airbyte.SourcePinterest("sourcePinterestResource",
    configuration={
        "account_id": "string",
        "credentials": {
            "client_id": "string",
            "client_secret": "string",
            "refresh_token": "string",
        },
        "custom_reports": [{
            "name": "string",
            "attribution_types": ["string"],
            "click_window_days": 0,
            "columns": ["string"],
            "conversion_report_time": "string",
            "engagement_window_days": 0,
            "granularity": "string",
            "level": "string",
            "start_date": "string",
            "view_window_days": 0,
        }],
        "start_date": "string",
        "statuses": ["string"],
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")
Copy
const sourcePinterestResource = new airbyte.SourcePinterest("sourcePinterestResource", {
    configuration: {
        accountId: "string",
        credentials: {
            clientId: "string",
            clientSecret: "string",
            refreshToken: "string",
        },
        customReports: [{
            name: "string",
            attributionTypes: ["string"],
            clickWindowDays: 0,
            columns: ["string"],
            conversionReportTime: "string",
            engagementWindowDays: 0,
            granularity: "string",
            level: "string",
            startDate: "string",
            viewWindowDays: 0,
        }],
        startDate: "string",
        statuses: ["string"],
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});
Copy
type: airbyte:SourcePinterest
properties:
    configuration:
        accountId: string
        credentials:
            clientId: string
            clientSecret: string
            refreshToken: string
        customReports:
            - attributionTypes:
                - string
              clickWindowDays: 0
              columns:
                - string
              conversionReportTime: string
              engagementWindowDays: 0
              granularity: string
              level: string
              name: string
              startDate: string
              viewWindowDays: 0
        startDate: string
        statuses:
            - string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string
Copy

SourcePinterest Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SourcePinterest resource accepts the following input properties:

Configuration This property is required. SourcePinterestConfiguration
WorkspaceId This property is required. string
DefinitionId string
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string
Name of the source e.g. dev-mysql-instance.
SecretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
Configuration This property is required. SourcePinterestConfigurationArgs
WorkspaceId This property is required. string
DefinitionId string
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string
Name of the source e.g. dev-mysql-instance.
SecretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
configuration This property is required. SourcePinterestConfiguration
workspaceId This property is required. String
definitionId String
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String
Name of the source e.g. dev-mysql-instance.
secretId String
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
configuration This property is required. SourcePinterestConfiguration
workspaceId This property is required. string
definitionId string
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name string
Name of the source e.g. dev-mysql-instance.
secretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
configuration This property is required. SourcePinterestConfigurationArgs
workspace_id This property is required. str
definition_id str
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name str
Name of the source e.g. dev-mysql-instance.
secret_id str
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
configuration This property is required. Property Map
workspaceId This property is required. String
definitionId String
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String
Name of the source e.g. dev-mysql-instance.
secretId String
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Outputs

All input properties are implicitly available as output properties. Additionally, the SourcePinterest resource produces the following output properties:

CreatedAt double
Id string
The provider-assigned unique ID for this managed resource.
ResourceAllocation SourcePinterestResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SourceId string
SourceType string
CreatedAt float64
Id string
The provider-assigned unique ID for this managed resource.
ResourceAllocation SourcePinterestResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SourceId string
SourceType string
createdAt Double
id String
The provider-assigned unique ID for this managed resource.
resourceAllocation SourcePinterestResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
sourceId String
sourceType String
createdAt number
id string
The provider-assigned unique ID for this managed resource.
resourceAllocation SourcePinterestResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
sourceId string
sourceType string
created_at float
id str
The provider-assigned unique ID for this managed resource.
resource_allocation SourcePinterestResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
source_id str
source_type str
createdAt Number
id String
The provider-assigned unique ID for this managed resource.
resourceAllocation Property Map
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
sourceId String
sourceType String

Look up Existing SourcePinterest Resource

Get an existing SourcePinterest resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SourcePinterestState, opts?: CustomResourceOptions): SourcePinterest
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourcePinterestConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        resource_allocation: Optional[SourcePinterestResourceAllocationArgs] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourcePinterest
func GetSourcePinterest(ctx *Context, name string, id IDInput, state *SourcePinterestState, opts ...ResourceOption) (*SourcePinterest, error)
public static SourcePinterest Get(string name, Input<string> id, SourcePinterestState? state, CustomResourceOptions? opts = null)
public static SourcePinterest get(String name, Output<String> id, SourcePinterestState state, CustomResourceOptions options)
resources:  _:    type: airbyte:SourcePinterest    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Configuration SourcePinterestConfiguration
CreatedAt double
DefinitionId string
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string
Name of the source e.g. dev-mysql-instance.
ResourceAllocation SourcePinterestResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SecretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string
Configuration SourcePinterestConfigurationArgs
CreatedAt float64
DefinitionId string
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string
Name of the source e.g. dev-mysql-instance.
ResourceAllocation SourcePinterestResourceAllocationArgs
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SecretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string
configuration SourcePinterestConfiguration
createdAt Double
definitionId String
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String
Name of the source e.g. dev-mysql-instance.
resourceAllocation SourcePinterestResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secretId String
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String
configuration SourcePinterestConfiguration
createdAt number
definitionId string
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name string
Name of the source e.g. dev-mysql-instance.
resourceAllocation SourcePinterestResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId string
sourceType string
workspaceId string
configuration SourcePinterestConfigurationArgs
created_at float
definition_id str
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name str
Name of the source e.g. dev-mysql-instance.
resource_allocation SourcePinterestResourceAllocationArgs
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secret_id str
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
source_id str
source_type str
workspace_id str
configuration Property Map
createdAt Number
definitionId String
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String
Name of the source e.g. dev-mysql-instance.
resourceAllocation Property Map
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secretId String
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

Supporting Types

SourcePinterestConfiguration
, SourcePinterestConfigurationArgs

AccountId string
The Pinterest account ID you want to fetch data for. This ID must be provided to filter the data for a specific account.
Credentials SourcePinterestConfigurationCredentials
CustomReports List<SourcePinterestConfigurationCustomReport>
A list which contains ad statistics entries, each entry must have a name and can contains fields, breakdowns or action*breakdowns. Click on "add" to fill this field.
StartDate string
A date in the format YYYY-MM-DD. If you have not set a date, it would be defaulted to latest allowed date by api (89 days from today).
Statuses List<string>
For the ads, ad_groups, and campaigns streams, specifying a status will filter out records that do not match the specified ones. If a status is not specified, the source will default to records with a status of either ACTIVE or PAUSED.
AccountId string
The Pinterest account ID you want to fetch data for. This ID must be provided to filter the data for a specific account.
Credentials SourcePinterestConfigurationCredentials
CustomReports []SourcePinterestConfigurationCustomReport
A list which contains ad statistics entries, each entry must have a name and can contains fields, breakdowns or action*breakdowns. Click on "add" to fill this field.
StartDate string
A date in the format YYYY-MM-DD. If you have not set a date, it would be defaulted to latest allowed date by api (89 days from today).
Statuses []string
For the ads, ad_groups, and campaigns streams, specifying a status will filter out records that do not match the specified ones. If a status is not specified, the source will default to records with a status of either ACTIVE or PAUSED.
accountId String
The Pinterest account ID you want to fetch data for. This ID must be provided to filter the data for a specific account.
credentials SourcePinterestConfigurationCredentials
customReports List<SourcePinterestConfigurationCustomReport>
A list which contains ad statistics entries, each entry must have a name and can contains fields, breakdowns or action*breakdowns. Click on "add" to fill this field.
startDate String
A date in the format YYYY-MM-DD. If you have not set a date, it would be defaulted to latest allowed date by api (89 days from today).
statuses List<String>
For the ads, ad_groups, and campaigns streams, specifying a status will filter out records that do not match the specified ones. If a status is not specified, the source will default to records with a status of either ACTIVE or PAUSED.
accountId string
The Pinterest account ID you want to fetch data for. This ID must be provided to filter the data for a specific account.
credentials SourcePinterestConfigurationCredentials
customReports SourcePinterestConfigurationCustomReport[]
A list which contains ad statistics entries, each entry must have a name and can contains fields, breakdowns or action*breakdowns. Click on "add" to fill this field.
startDate string
A date in the format YYYY-MM-DD. If you have not set a date, it would be defaulted to latest allowed date by api (89 days from today).
statuses string[]
For the ads, ad_groups, and campaigns streams, specifying a status will filter out records that do not match the specified ones. If a status is not specified, the source will default to records with a status of either ACTIVE or PAUSED.
account_id str
The Pinterest account ID you want to fetch data for. This ID must be provided to filter the data for a specific account.
credentials SourcePinterestConfigurationCredentials
custom_reports Sequence[SourcePinterestConfigurationCustomReport]
A list which contains ad statistics entries, each entry must have a name and can contains fields, breakdowns or action*breakdowns. Click on "add" to fill this field.
start_date str
A date in the format YYYY-MM-DD. If you have not set a date, it would be defaulted to latest allowed date by api (89 days from today).
statuses Sequence[str]
For the ads, ad_groups, and campaigns streams, specifying a status will filter out records that do not match the specified ones. If a status is not specified, the source will default to records with a status of either ACTIVE or PAUSED.
accountId String
The Pinterest account ID you want to fetch data for. This ID must be provided to filter the data for a specific account.
credentials Property Map
customReports List<Property Map>
A list which contains ad statistics entries, each entry must have a name and can contains fields, breakdowns or action*breakdowns. Click on "add" to fill this field.
startDate String
A date in the format YYYY-MM-DD. If you have not set a date, it would be defaulted to latest allowed date by api (89 days from today).
statuses List<String>
For the ads, ad_groups, and campaigns streams, specifying a status will filter out records that do not match the specified ones. If a status is not specified, the source will default to records with a status of either ACTIVE or PAUSED.

SourcePinterestConfigurationCredentials
, SourcePinterestConfigurationCredentialsArgs

ClientId This property is required. string
The Client ID of your OAuth application
ClientSecret This property is required. string
The Client Secret of your OAuth application.
RefreshToken This property is required. string
Refresh Token to obtain new Access Token, when it's expired.
ClientId This property is required. string
The Client ID of your OAuth application
ClientSecret This property is required. string
The Client Secret of your OAuth application.
RefreshToken This property is required. string
Refresh Token to obtain new Access Token, when it's expired.
clientId This property is required. String
The Client ID of your OAuth application
clientSecret This property is required. String
The Client Secret of your OAuth application.
refreshToken This property is required. String
Refresh Token to obtain new Access Token, when it's expired.
clientId This property is required. string
The Client ID of your OAuth application
clientSecret This property is required. string
The Client Secret of your OAuth application.
refreshToken This property is required. string
Refresh Token to obtain new Access Token, when it's expired.
client_id This property is required. str
The Client ID of your OAuth application
client_secret This property is required. str
The Client Secret of your OAuth application.
refresh_token This property is required. str
Refresh Token to obtain new Access Token, when it's expired.
clientId This property is required. String
The Client ID of your OAuth application
clientSecret This property is required. String
The Client Secret of your OAuth application.
refreshToken This property is required. String
Refresh Token to obtain new Access Token, when it's expired.

SourcePinterestConfigurationCustomReport
, SourcePinterestConfigurationCustomReportArgs

Name This property is required. string
The name value of report
AttributionTypes List<string>
List of types of attribution for the conversion report
ClickWindowDays double
Number of days to use as the conversion attribution window for a pin click action. Default: 30; must be one of ["0", "1", "7", "14", "30", "60"]
Columns List<string>
A list of chosen columns
ConversionReportTime string
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: "TIMEOFADACTION"; must be one of ["TIMEOFADACTION", "TIMEOFCONVERSION"]
EngagementWindowDays double
Number of days to use as the conversion attribution window for an engagement action. must be one of ["0", "1", "7", "14", "30", "60"]
Granularity string
Chosen granularity for API. Default: "TOTAL"; must be one of ["TOTAL", "DAY", "HOUR", "WEEK", "MONTH"]
Level string
Chosen level for API. Default: "ADVERTISER"; must be one of ["ADVERTISER", "ADVERTISERTARGETING", "CAMPAIGN", "CAMPAIGNTARGETING", "ADGROUP", "ADGROUPTARGETING", "PINPROMOTION", "PINPROMOTIONTARGETING", "KEYWORD", "PRODUCTGROUP", "PRODUCTGROUPTARGETING", "PRODUCTITEM"]
StartDate string
A date in the format YYYY-MM-DD. If you have not set a date, it would be defaulted to latest allowed date by report api (913 days from today).
ViewWindowDays double
Number of days to use as the conversion attribution window for a view action. must be one of ["0", "1", "7", "14", "30", "60"]
Name This property is required. string
The name value of report
AttributionTypes []string
List of types of attribution for the conversion report
ClickWindowDays float64
Number of days to use as the conversion attribution window for a pin click action. Default: 30; must be one of ["0", "1", "7", "14", "30", "60"]
Columns []string
A list of chosen columns
ConversionReportTime string
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: "TIMEOFADACTION"; must be one of ["TIMEOFADACTION", "TIMEOFCONVERSION"]
EngagementWindowDays float64
Number of days to use as the conversion attribution window for an engagement action. must be one of ["0", "1", "7", "14", "30", "60"]
Granularity string
Chosen granularity for API. Default: "TOTAL"; must be one of ["TOTAL", "DAY", "HOUR", "WEEK", "MONTH"]
Level string
Chosen level for API. Default: "ADVERTISER"; must be one of ["ADVERTISER", "ADVERTISERTARGETING", "CAMPAIGN", "CAMPAIGNTARGETING", "ADGROUP", "ADGROUPTARGETING", "PINPROMOTION", "PINPROMOTIONTARGETING", "KEYWORD", "PRODUCTGROUP", "PRODUCTGROUPTARGETING", "PRODUCTITEM"]
StartDate string
A date in the format YYYY-MM-DD. If you have not set a date, it would be defaulted to latest allowed date by report api (913 days from today).
ViewWindowDays float64
Number of days to use as the conversion attribution window for a view action. must be one of ["0", "1", "7", "14", "30", "60"]
name This property is required. String
The name value of report
attributionTypes List<String>
List of types of attribution for the conversion report
clickWindowDays Double
Number of days to use as the conversion attribution window for a pin click action. Default: 30; must be one of ["0", "1", "7", "14", "30", "60"]
columns List<String>
A list of chosen columns
conversionReportTime String
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: "TIMEOFADACTION"; must be one of ["TIMEOFADACTION", "TIMEOFCONVERSION"]
engagementWindowDays Double
Number of days to use as the conversion attribution window for an engagement action. must be one of ["0", "1", "7", "14", "30", "60"]
granularity String
Chosen granularity for API. Default: "TOTAL"; must be one of ["TOTAL", "DAY", "HOUR", "WEEK", "MONTH"]
level String
Chosen level for API. Default: "ADVERTISER"; must be one of ["ADVERTISER", "ADVERTISERTARGETING", "CAMPAIGN", "CAMPAIGNTARGETING", "ADGROUP", "ADGROUPTARGETING", "PINPROMOTION", "PINPROMOTIONTARGETING", "KEYWORD", "PRODUCTGROUP", "PRODUCTGROUPTARGETING", "PRODUCTITEM"]
startDate String
A date in the format YYYY-MM-DD. If you have not set a date, it would be defaulted to latest allowed date by report api (913 days from today).
viewWindowDays Double
Number of days to use as the conversion attribution window for a view action. must be one of ["0", "1", "7", "14", "30", "60"]
name This property is required. string
The name value of report
attributionTypes string[]
List of types of attribution for the conversion report
clickWindowDays number
Number of days to use as the conversion attribution window for a pin click action. Default: 30; must be one of ["0", "1", "7", "14", "30", "60"]
columns string[]
A list of chosen columns
conversionReportTime string
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: "TIMEOFADACTION"; must be one of ["TIMEOFADACTION", "TIMEOFCONVERSION"]
engagementWindowDays number
Number of days to use as the conversion attribution window for an engagement action. must be one of ["0", "1", "7", "14", "30", "60"]
granularity string
Chosen granularity for API. Default: "TOTAL"; must be one of ["TOTAL", "DAY", "HOUR", "WEEK", "MONTH"]
level string
Chosen level for API. Default: "ADVERTISER"; must be one of ["ADVERTISER", "ADVERTISERTARGETING", "CAMPAIGN", "CAMPAIGNTARGETING", "ADGROUP", "ADGROUPTARGETING", "PINPROMOTION", "PINPROMOTIONTARGETING", "KEYWORD", "PRODUCTGROUP", "PRODUCTGROUPTARGETING", "PRODUCTITEM"]
startDate string
A date in the format YYYY-MM-DD. If you have not set a date, it would be defaulted to latest allowed date by report api (913 days from today).
viewWindowDays number
Number of days to use as the conversion attribution window for a view action. must be one of ["0", "1", "7", "14", "30", "60"]
name This property is required. str
The name value of report
attribution_types Sequence[str]
List of types of attribution for the conversion report
click_window_days float
Number of days to use as the conversion attribution window for a pin click action. Default: 30; must be one of ["0", "1", "7", "14", "30", "60"]
columns Sequence[str]
A list of chosen columns
conversion_report_time str
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: "TIMEOFADACTION"; must be one of ["TIMEOFADACTION", "TIMEOFCONVERSION"]
engagement_window_days float
Number of days to use as the conversion attribution window for an engagement action. must be one of ["0", "1", "7", "14", "30", "60"]
granularity str
Chosen granularity for API. Default: "TOTAL"; must be one of ["TOTAL", "DAY", "HOUR", "WEEK", "MONTH"]
level str
Chosen level for API. Default: "ADVERTISER"; must be one of ["ADVERTISER", "ADVERTISERTARGETING", "CAMPAIGN", "CAMPAIGNTARGETING", "ADGROUP", "ADGROUPTARGETING", "PINPROMOTION", "PINPROMOTIONTARGETING", "KEYWORD", "PRODUCTGROUP", "PRODUCTGROUPTARGETING", "PRODUCTITEM"]
start_date str
A date in the format YYYY-MM-DD. If you have not set a date, it would be defaulted to latest allowed date by report api (913 days from today).
view_window_days float
Number of days to use as the conversion attribution window for a view action. must be one of ["0", "1", "7", "14", "30", "60"]
name This property is required. String
The name value of report
attributionTypes List<String>
List of types of attribution for the conversion report
clickWindowDays Number
Number of days to use as the conversion attribution window for a pin click action. Default: 30; must be one of ["0", "1", "7", "14", "30", "60"]
columns List<String>
A list of chosen columns
conversionReportTime String
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: "TIMEOFADACTION"; must be one of ["TIMEOFADACTION", "TIMEOFCONVERSION"]
engagementWindowDays Number
Number of days to use as the conversion attribution window for an engagement action. must be one of ["0", "1", "7", "14", "30", "60"]
granularity String
Chosen granularity for API. Default: "TOTAL"; must be one of ["TOTAL", "DAY", "HOUR", "WEEK", "MONTH"]
level String
Chosen level for API. Default: "ADVERTISER"; must be one of ["ADVERTISER", "ADVERTISERTARGETING", "CAMPAIGN", "CAMPAIGNTARGETING", "ADGROUP", "ADGROUPTARGETING", "PINPROMOTION", "PINPROMOTIONTARGETING", "KEYWORD", "PRODUCTGROUP", "PRODUCTGROUPTARGETING", "PRODUCTITEM"]
startDate String
A date in the format YYYY-MM-DD. If you have not set a date, it would be defaulted to latest allowed date by report api (913 days from today).
viewWindowDays Number
Number of days to use as the conversion attribution window for a view action. must be one of ["0", "1", "7", "14", "30", "60"]

SourcePinterestResourceAllocation
, SourcePinterestResourceAllocationArgs

Default SourcePinterestResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
JobSpecifics List<SourcePinterestResourceAllocationJobSpecific>
Default SourcePinterestResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
JobSpecifics []SourcePinterestResourceAllocationJobSpecific
default_ SourcePinterestResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics List<SourcePinterestResourceAllocationJobSpecific>
default SourcePinterestResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics SourcePinterestResourceAllocationJobSpecific[]
default SourcePinterestResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
job_specifics Sequence[SourcePinterestResourceAllocationJobSpecific]
default Property Map
optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics List<Property Map>

SourcePinterestResourceAllocationDefault
, SourcePinterestResourceAllocationDefaultArgs

SourcePinterestResourceAllocationJobSpecific
, SourcePinterestResourceAllocationJobSpecificArgs

JobType string
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
ResourceRequirements SourcePinterestResourceAllocationJobSpecificResourceRequirements
optional resource requirements to run workers (blank for unbounded allocations)
JobType string
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
ResourceRequirements SourcePinterestResourceAllocationJobSpecificResourceRequirements
optional resource requirements to run workers (blank for unbounded allocations)
jobType String
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resourceRequirements SourcePinterestResourceAllocationJobSpecificResourceRequirements
optional resource requirements to run workers (blank for unbounded allocations)
jobType string
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resourceRequirements SourcePinterestResourceAllocationJobSpecificResourceRequirements
optional resource requirements to run workers (blank for unbounded allocations)
job_type str
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resource_requirements SourcePinterestResourceAllocationJobSpecificResourceRequirements
optional resource requirements to run workers (blank for unbounded allocations)
jobType String
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resourceRequirements Property Map
optional resource requirements to run workers (blank for unbounded allocations)

SourcePinterestResourceAllocationJobSpecificResourceRequirements
, SourcePinterestResourceAllocationJobSpecificResourceRequirementsArgs

Import

$ pulumi import airbyte:index/sourcePinterest:SourcePinterest my_airbyte_source_pinterest ""
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
airbyte airbytehq/terraform-provider-airbyte
License
Notes
This Pulumi package is based on the airbyte Terraform Provider.